Class BulkUpdateMessageStatusParams.Body
-
- All Implemented Interfaces:
public final class BulkUpdateMessageStatusParams.BodyUpdates message statuses in a specified channel. Use the
channel_idparameter to target the channel and thestatusparameter to define what the status should be changed to (e.g.archive,unarchive). Apply to all messages or use filters to target a subset. For in-app channels, messages can be updated indefinitely via this operation. For all other channel types, messages outside the account's retention window will not be updated as part of this operation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBulkUpdateMessageStatusParams.Body.BuilderA builder for Body.
-
Method Summary
Modifier and Type Method Description final Optional<BulkUpdateMessageStatusParams.Archived>archived()Limits the results to messages with the given archived status. final Optional<BulkUpdateMessageStatusParams.DeliveryStatus>deliveryStatus()Limits the results to messages with the given delivery status. final Optional<BulkUpdateMessageStatusParams.EngagementStatus>engagementStatus()Limits the results to messages with the given engagement status. final Optional<Boolean>hasTenant()Limits the results to messages that have a tenant or not. final Optional<OffsetDateTime>newerThan()Limits the results to messages inserted after the given date. final Optional<OffsetDateTime>olderThan()Limits the results to messages inserted before the given date. final Optional<List<String>>recipientIds()Limits the results to messages with the given recipient IDs. final Optional<List<String>>tenants()Limits the results to messages with the given tenant IDs. final Optional<String>triggerData()Limits the results to only messages that were generated with the given data. final Optional<List<String>>workflows()Limits the results to messages with the given workflow keys. final JsonField<BulkUpdateMessageStatusParams.Archived>_archived()Returns the raw JSON value of archived. final JsonField<BulkUpdateMessageStatusParams.DeliveryStatus>_deliveryStatus()Returns the raw JSON value of deliveryStatus. final JsonField<BulkUpdateMessageStatusParams.EngagementStatus>_engagementStatus()Returns the raw JSON value of engagementStatus. final JsonField<Boolean>_hasTenant()Returns the raw JSON value of hasTenant. final JsonField<OffsetDateTime>_newerThan()Returns the raw JSON value of newerThan. final JsonField<OffsetDateTime>_olderThan()Returns the raw JSON value of olderThan. final JsonField<List<String>>_recipientIds()Returns the raw JSON value of recipientIds. final JsonField<List<String>>_tenants()Returns the raw JSON value of tenants. final JsonField<String>_triggerData()Returns the raw JSON value of triggerData. final JsonField<List<String>>_workflows()Returns the raw JSON value of workflows. final Map<String, JsonValue>_additionalProperties()final BulkUpdateMessageStatusParams.Body.BuildertoBuilder()final BulkUpdateMessageStatusParams.Bodyvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static BulkUpdateMessageStatusParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. -
-
Method Detail
-
archived
final Optional<BulkUpdateMessageStatusParams.Archived> archived()
Limits the results to messages with the given archived status.
-
deliveryStatus
final Optional<BulkUpdateMessageStatusParams.DeliveryStatus> deliveryStatus()
Limits the results to messages with the given delivery status.
-
engagementStatus
final Optional<BulkUpdateMessageStatusParams.EngagementStatus> engagementStatus()
Limits the results to messages with the given engagement status.
-
hasTenant
final Optional<Boolean> hasTenant()
Limits the results to messages that have a tenant or not.
-
newerThan
final Optional<OffsetDateTime> newerThan()
Limits the results to messages inserted after the given date.
-
olderThan
final Optional<OffsetDateTime> olderThan()
Limits the results to messages inserted before the given date.
-
recipientIds
final Optional<List<String>> recipientIds()
Limits the results to messages with the given recipient IDs.
-
tenants
final Optional<List<String>> tenants()
Limits the results to messages with the given tenant IDs.
-
triggerData
final Optional<String> triggerData()
Limits the results to only messages that were generated with the given data. See /api-reference/overview/trigger-data-filtering for more information.
-
workflows
final Optional<List<String>> workflows()
Limits the results to messages with the given workflow keys.
-
_archived
final JsonField<BulkUpdateMessageStatusParams.Archived> _archived()
Returns the raw JSON value of archived.
Unlike archived, this method doesn't throw if the JSON field has an unexpected type.
-
_deliveryStatus
final JsonField<BulkUpdateMessageStatusParams.DeliveryStatus> _deliveryStatus()
Returns the raw JSON value of deliveryStatus.
Unlike deliveryStatus, this method doesn't throw if the JSON field has an unexpected type.
-
_engagementStatus
final JsonField<BulkUpdateMessageStatusParams.EngagementStatus> _engagementStatus()
Returns the raw JSON value of engagementStatus.
Unlike engagementStatus, this method doesn't throw if the JSON field has an unexpected type.
-
_hasTenant
final JsonField<Boolean> _hasTenant()
Returns the raw JSON value of hasTenant.
Unlike hasTenant, this method doesn't throw if the JSON field has an unexpected type.
-
_newerThan
final JsonField<OffsetDateTime> _newerThan()
Returns the raw JSON value of newerThan.
Unlike newerThan, this method doesn't throw if the JSON field has an unexpected type.
-
_olderThan
final JsonField<OffsetDateTime> _olderThan()
Returns the raw JSON value of olderThan.
Unlike olderThan, this method doesn't throw if the JSON field has an unexpected type.
-
_recipientIds
final JsonField<List<String>> _recipientIds()
Returns the raw JSON value of recipientIds.
Unlike recipientIds, this method doesn't throw if the JSON field has an unexpected type.
-
_tenants
final JsonField<List<String>> _tenants()
Returns the raw JSON value of tenants.
Unlike tenants, this method doesn't throw if the JSON field has an unexpected type.
-
_triggerData
final JsonField<String> _triggerData()
Returns the raw JSON value of triggerData.
Unlike triggerData, this method doesn't throw if the JSON field has an unexpected type.
-
_workflows
final JsonField<List<String>> _workflows()
Returns the raw JSON value of workflows.
Unlike workflows, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final BulkUpdateMessageStatusParams.Body.Builder toBuilder()
-
validate
final BulkUpdateMessageStatusParams.Body validate()
-
builder
final static BulkUpdateMessageStatusParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
-
-
-
-