Class: Trycourier::Models::MessageListParams

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

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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(archived: nil, cursor: nil, enqueued_after: nil, event: nil, list: nil, message_id: nil, notification: nil, provider: nil, recipient: nil, status: nil, tag: nil, tags: nil, tenant_id: nil, trace_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Trycourier::Models::MessageListParams for more details.

Parameters:

  • archived (Boolean, nil) (defaults to: nil) —

    A boolean value that indicates whether archived messages should be included in t

  • cursor (String, nil) (defaults to: nil) —

    A unique identifier that allows for fetching the next set of messages.

  • enqueued_after (String, nil) (defaults to: nil) —

    The enqueued datetime of a message to filter out messages received before.

  • event (String, nil) (defaults to: nil) —

    A unique identifier representing the event that was used to send the event.

  • list (String, nil) (defaults to: nil) —

    A unique identifier representing the list the message was sent to.

  • message_id (String, nil) (defaults to: nil) —

    A unique identifier representing the message_id returned from either /send or /s

  • notification (String, nil) (defaults to: nil) —

    A unique identifier representing the notification that was used to send the even

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

    The key assocated to the provider you want to filter on. E.g., sendgrid, inbox,

  • recipient (String, nil) (defaults to: nil) —

    A unique identifier representing the recipient associated with the requested pro

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

    An indicator of the current status of the message. Allows multiple values to be

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

    A tag placed in the metadata.tags during a notification send. Allows multiple va

  • tags (String, nil) (defaults to: nil) —

    A comma delimited list of ‘tags’. Messages will be returned if they match any of

  • tenant_id (String, nil) (defaults to: nil) —

    Messages sent with the context of a Tenant

  • trace_id (String, nil) (defaults to: nil) —

    The unique identifier used to trace the requests

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



# File 'lib/trycourier/models/message_list_params.rb', line 103

Instance Attribute Details

#archived ⇒ Boolean?

A boolean value that indicates whether archived messages should be included in the response.

Returns:

  • (Boolean, nil) 


15
 
# File 'lib/trycourier/models/message_list_params.rb', line 15

optional :archived, Trycourier::Internal::Type::Boolean, nil?: true

#cursor ⇒ String?

A unique identifier that allows for fetching the next set of messages.

Returns:

  • (String, nil) 


21
 
# File 'lib/trycourier/models/message_list_params.rb', line 21

optional :cursor, String, nil?: true

#enqueued_after ⇒ String?

The enqueued datetime of a message to filter out messages received before.

Returns:

  • (String, nil) 


27
 
# File 'lib/trycourier/models/message_list_params.rb', line 27

optional :enqueued_after, String, nil?: true

#event ⇒ String?

A unique identifier representing the event that was used to send the event.

Returns:

  • (String, nil) 


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

optional :event, String, nil?: true

#list ⇒ String?

A unique identifier representing the list the message was sent to.

Returns:

  • (String, nil) 


39
 
# File 'lib/trycourier/models/message_list_params.rb', line 39

optional :list, String, nil?: true

#message_id ⇒ String?

A unique identifier representing the message_id returned from either /send or /send/list.

Returns:

  • (String, nil) 


46
 
# File 'lib/trycourier/models/message_list_params.rb', line 46

optional :message_id, String, nil?: true

#notification ⇒ String?

A unique identifier representing the notification that was used to send the event.

Returns:

  • (String, nil) 


53
 
# File 'lib/trycourier/models/message_list_params.rb', line 53

optional :notification, String, nil?: true

#provider ⇒ Array<String, nil>?

The key assocated to the provider you want to filter on. E.g., sendgrid, inbox, twilio, slack, msteams, etc. Allows multiple values to be set in query parameters.

Returns:

  • (Array<String, nil>, nil) 


61
 
# File 'lib/trycourier/models/message_list_params.rb', line 61

optional :provider, Trycourier::Internal::Type::ArrayOf[String, nil?: true]

#recipient ⇒ String?

A unique identifier representing the recipient associated with the requested profile.

Returns:

  • (String, nil) 


68
 
# File 'lib/trycourier/models/message_list_params.rb', line 68

optional :recipient, String, nil?: true

#status ⇒ Array<String, nil>?

An indicator of the current status of the message. Allows multiple values to be set in query parameters.

Returns:

  • (Array<String, nil>, nil) 


75
 
# File 'lib/trycourier/models/message_list_params.rb', line 75

optional :status, Trycourier::Internal::Type::ArrayOf[String, nil?: true]

#tag ⇒ Array<String, nil>?

A tag placed in the metadata.tags during a notification send. Allows multiple values to be set in query parameters.

Returns:

  • (Array<String, nil>, nil) 


82
 
# File 'lib/trycourier/models/message_list_params.rb', line 82

optional :tag, Trycourier::Internal::Type::ArrayOf[String, nil?: true]

#tags ⇒ String?

A comma delimited list of ‘tags’. Messages will be returned if they match any of the tags passed in.

Returns:

  • (String, nil) 


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

optional :tags, String, nil?: true

#tenant_id ⇒ String?

Messages sent with the context of a Tenant

Returns:

  • (String, nil) 


95
 
# File 'lib/trycourier/models/message_list_params.rb', line 95

optional :tenant_id, String, nil?: true

#trace_id ⇒ String?

The unique identifier used to trace the requests

Returns:

  • (String, nil) 


101
 
# File 'lib/trycourier/models/message_list_params.rb', line 101

optional :trace_id, String, nil?: true