Class: Knockapi::Models::MessageListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/knockapi/models/message_list_params.rb

Overview

See Also:

Defined Under Namespace

Modules: EngagementStatus, Status Classes: InsertedAt

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

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, 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

#initialize(gt: nil, gte: nil, lt: nil, lte: nil) ⇒ Object

Parameters:

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

    Limits the results to messages inserted after the given date.

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

    Limits the results to messages inserted after or on the given date.

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

    Limits the results to messages inserted before the given date.

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

    Limits the results to messages inserted before or on the given date.




# File 'lib/knockapi/models/message_list_params.rb', line 173

Instance Attribute Details

#after ⇒ String?

The cursor to fetch entries after.

Returns:

  • (String, nil) 


14
 
# File 'lib/knockapi/models/message_list_params.rb', line 14

optional :after, String

#before ⇒ String?

The cursor to fetch entries before.

Returns:

  • (String, nil) 


20
 
# File 'lib/knockapi/models/message_list_params.rb', line 20

optional :before, String

#channel_id ⇒ String?

Limits the results to items with the corresponding channel ID.

Returns:

  • (String, nil) 


26
 
# File 'lib/knockapi/models/message_list_params.rb', line 26

optional :channel_id, String

#engagement_status ⇒ Array<Symbol, Knockapi::Models::MessageListParams::EngagementStatus>?

Limits the results to messages with the given engagement status.

Returns:



32
33
 
# File 'lib/knockapi/models/message_list_params.rb', line 32

optional :engagement_status,
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::MessageListParams::EngagementStatus] }

#inserted_at ⇒ Knockapi::Models::MessageListParams::InsertedAt?

Returns:



38
 
# File 'lib/knockapi/models/message_list_params.rb', line 38

optional :inserted_at, -> { Knockapi::MessageListParams::InsertedAt }

#message_ids ⇒ Array<String>?

Limits the results to only the message IDs given (max 50). Note: when using this option, the results will be subject to any other filters applied to the query.

Returns:

  • (Array<String>, nil) 


45
 
# File 'lib/knockapi/models/message_list_params.rb', line 45

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

#page_size ⇒ Integer?

The number of items per page (defaults to 50).

Returns:

  • (Integer, nil) 


51
 
# File 'lib/knockapi/models/message_list_params.rb', line 51

optional :page_size, Integer

#source ⇒ String?

Limits the results to messages triggered by the given workflow key.

Returns:

  • (String, nil) 


57
 
# File 'lib/knockapi/models/message_list_params.rb', line 57

optional :source, String

#status ⇒ Array<Symbol, Knockapi::Models::MessageListParams::Status>?

Limits the results to messages with the given delivery status.

Returns:



63
 
# File 'lib/knockapi/models/message_list_params.rb', line 63

optional :status, -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::MessageListParams::Status] }

#tenant ⇒ String?

Limits the results to items with the corresponding tenant.

Returns:

  • (String, nil) 


69
 
# File 'lib/knockapi/models/message_list_params.rb', line 69

optional :tenant, 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) 


77
 
# File 'lib/knockapi/models/message_list_params.rb', line 77

optional :trigger_data, String

#workflow_categories ⇒ Array<String>?

Limits the results to messages related to any of the provided categories.

Returns:

  • (Array<String>, nil) 


83
 
# File 'lib/knockapi/models/message_list_params.rb', line 83

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

#workflow_recipient_run_id ⇒ String?

Limits the results to messages for a specific recipient’s workflow run.

Returns:

  • (String, nil) 


89
 
# File 'lib/knockapi/models/message_list_params.rb', line 89

optional :workflow_recipient_run_id, String

#workflow_run_id ⇒ String?

Limits the results to messages associated with the top-level workflow run ID returned by the workflow trigger request.

Returns:

  • (String, nil) 


96
 
# File 'lib/knockapi/models/message_list_params.rb', line 96

optional :workflow_run_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/knockapi/models/message_list_params.rb', line 144