Module: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action

Extended by:

Internal::Type::Enum

Defined in:

lib/knockapi/models/channels/bulk_update_message_status_params.rb,
sig/knockapi/models/channels/bulk_update_message_status_params.rbs

Constant Summary

SEEN =

Returns:

• (:seen)

:seen

UNSEEN =

Returns:

• (:unseen)

:unseen

READ =

Returns:

• (:read)

:read

UNREAD =

Returns:

• (:unread)

:unread

ARCHIVED =

Returns:

• (:archived)

:archived

UNARCHIVED =

Returns:

• (:unarchived)

:unarchived

INTERACTED =

Returns:

• (:interacted)

:interacted

ARCHIVE =

Returns:

• (:archive)

:archive

UNARCHIVE =

Returns:

• (:unarchive)

:unarchive

DELETE =

Returns:

• (:delete)

:delete

Instance Method Summary

• #initialize(channel_id:, action:, archived: nil, delivery_status: nil, engagement_status: nil, has_tenant: nil, newer_than: nil, older_than: nil, recipient_ids: nil, tenants: nil, trigger_data: nil, workflows: nil, request_options: {}) ⇒ Object

  Some parameter documentations has been truncated, see Knockapi::Models::Channels::BulkUpdateMessageStatusParams for more details.

• #self?.values ⇒ ::Array[Knockapi::Models::Channels::BulkUpdateMessageStatusParams::action]

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values, values

Methods included from Internal::Util::SorbetRuntimeSupport

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

Methods included from Internal::Type::Converter

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

Instance Method Details

#initialize(channel_id:, action:, archived: nil, delivery_status: nil, engagement_status: nil, has_tenant: nil, newer_than: nil, older_than: nil, recipient_ids: nil, tenants: nil, trigger_data: nil, workflows: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Knockapi::Models::Channels::BulkUpdateMessageStatusParams for more details.

Parameters:

• channel_id (String)
• action (Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action)
• archived (Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived) (defaults to: nil) —

  Limits the results to messages with the given archived status.

• delivery_status (Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus) (defaults to: nil) —

  Limits the results to messages with the given delivery status.

• engagement_status (Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus) (defaults to: nil) —

  Limits the results to messages with the given engagement status.

• has_tenant (Boolean) (defaults to: nil) —

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

• newer_than (Time) (defaults to: nil) —

  Limits the results to messages inserted after the given date.

• older_than (Time) (defaults to: nil) —

  Limits the results to messages inserted before the given date.

• recipient_ids (Array<String>) (defaults to: nil) —

  Limits the results to messages with the given recipient IDs.

• tenants (Array<String>) (defaults to: nil) —

  Limits the results to messages with the given tenant IDs.

• trigger_data (String) (defaults to: nil) —

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

• workflows (Array<String>) (defaults to: nil) —

  Limits the results to messages with the given workflow keys.

• request_options (Knockapi::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

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

module Action
  extend Knockapi::Internal::Type::Enum

  SEEN = :seen
  UNSEEN = :unseen
  READ = :read
  UNREAD = :unread
  ARCHIVED = :archived
  UNARCHIVED = :unarchived
  INTERACTED = :interacted
  ARCHIVE = :archive
  UNARCHIVE = :unarchive
  DELETE = :delete

  # @!method self.values
  #   @return [Array<Symbol>]
end

#self?.values ⇒ ::Array[Knockapi::Models::Channels::BulkUpdateMessageStatusParams::action]

Returns:

• (::Array[Knockapi::Models::Channels::BulkUpdateMessageStatusParams::action])

# File 'sig/knockapi/models/channels/bulk_update_message_status_params.rbs', line 133

def self?.values: -> ::Array[Knockapi::Models::Channels::BulkUpdateMessageStatusParams::action]