Class: Knockapi::Models::Channels::BulkUpdateMessageStatusParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Knockapi::Models::Channels::BulkUpdateMessageStatusParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/knockapi/models/channels/bulk_update_message_status_params.rb

Overview

See Also:

• Resources::Channels::Bulk#update_message_status

Defined Under Namespace

Modules: Action, Archived, DeliveryStatus, EngagementStatus

Instance Attribute Summary

• #archived ⇒ Symbol, ...

  Limits the results to messages with the given archived status.

• #delivery_status ⇒ Symbol, ...

  Limits the results to messages with the given delivery status.

• #engagement_status ⇒ Symbol, ...

  Limits the results to messages with the given engagement status.

• #has_tenant ⇒ Boolean^?

  Limits the results to messages that have a tenant or not.

• #newer_than ⇒ Time^?

  Limits the results to messages inserted after the given date.

• #older_than ⇒ Time^?

  Limits the results to messages inserted before the given date.

• #recipient_ids ⇒ Array<String>^?

  Limits the results to messages with the given recipient IDs.

• #tenants ⇒ Array<String>^?

  Limits the results to messages with the given tenant IDs.

• #trigger_data ⇒ String^?

  Limits the results to only messages that were generated with the given data.

• #workflows ⇒ Array<String>^?

  Limits the results to messages with the given workflow keys.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

#==, ==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

This class inherits a constructor from Knockapi::Internal::Type::BaseModel

Instance Attribute Details

#archived ⇒ Symbol, ...

Limits the results to messages with the given archived status.

Returns:

• (Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived, nil)

# File 'lib/knockapi/models/channels/bulk_update_message_status_params.rb', line 15

optional :archived, enum: -> { Knockapi::Channels::BulkUpdateMessageStatusParams::Archived }

#delivery_status ⇒ Symbol, ...

Limits the results to messages with the given delivery status.

Returns:

• (Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus, nil)

# File 'lib/knockapi/models/channels/bulk_update_message_status_params.rb', line 21

optional :delivery_status, enum: -> { Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus }

#engagement_status ⇒ Symbol, ...

Limits the results to messages with the given engagement status.

Returns:

• (Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus, nil)

# File 'lib/knockapi/models/channels/bulk_update_message_status_params.rb', line 27

optional :engagement_status,
enum: -> { Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus }

#has_tenant ⇒ Boolean^?

Limits the results to messages that have a tenant or not.

Returns:

• (Boolean, nil)

# File 'lib/knockapi/models/channels/bulk_update_message_status_params.rb', line 34

optional :has_tenant, Knockapi::Internal::Type::Boolean

#newer_than ⇒ Time^?

Limits the results to messages inserted after the given date.

Returns:

• (Time, nil)

# File 'lib/knockapi/models/channels/bulk_update_message_status_params.rb', line 40

optional :newer_than, Time

#older_than ⇒ Time^?

Limits the results to messages inserted before the given date.

Returns:

• (Time, nil)

# File 'lib/knockapi/models/channels/bulk_update_message_status_params.rb', line 46

optional :older_than, Time

#recipient_ids ⇒ Array<String>^?

Limits the results to messages with the given recipient IDs.

Returns:

• (Array<String>, nil)

# File 'lib/knockapi/models/channels/bulk_update_message_status_params.rb', line 52

optional :recipient_ids, Knockapi::Internal::Type::ArrayOf[String]

#tenants ⇒ Array<String>^?

Limits the results to messages with the given tenant IDs.

Returns:

• (Array<String>, nil)

# File 'lib/knockapi/models/channels/bulk_update_message_status_params.rb', line 58

optional :tenants, Knockapi::Internal::Type::ArrayOf[String]

#trigger_data ⇒ String^?

Limits the results to only messages that were generated with the given data. See [trigger data filtering](/api-reference/overview/trigger-data-filtering) for more information.

Returns:

• (String, nil)

# File 'lib/knockapi/models/channels/bulk_update_message_status_params.rb', line 66

optional :trigger_data, String

#workflows ⇒ Array<String>^?

Limits the results to messages with the given workflow keys.

Returns:

• (Array<String>, nil)

# File 'lib/knockapi/models/channels/bulk_update_message_status_params.rb', line 72

optional :workflows, Knockapi::Internal::Type::ArrayOf[String]

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/knockapi/models/channels/bulk_update_message_status_params.rb', line 114