Class: Zavudev::Models::MessageListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Zavudev::Models::MessageListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/zavudev/models/message_list_params.rb,
sig/zavudev/models/message_list_params.rbs

Overview

See Also:

• Zavudev::Resources::Messages#list

Defined Under Namespace

Modules: Channel, Status

Instance Attribute Summary

• #channel ⇒ Symbol, ...

  Filter by delivery channel.

• #cursor ⇒ String^?
• #limit ⇒ Integer^?
• #status ⇒ Symbol, ...

  Filter by status.

• #to ⇒ String^?

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(channel: nil, cursor: nil, limit: nil, status: nil, to: nil, request_options: {}) ⇒ Object constructor
• #to_hash ⇒ {

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(channel: nil, cursor: nil, limit: nil, status: nil, to: nil, request_options: {}) ⇒ Object

Parameters:

• channel (Symbol, Zavudev::Models::MessageListParams::Channel) (defaults to: nil) —

  Filter by delivery channel.

• cursor (String) (defaults to: nil)
• limit (Integer) (defaults to: nil)
• status (Symbol, Zavudev::Models::MessageListParams::Status) (defaults to: nil) —

  Filter by status. Not all stored statuses are filterable.

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

# File 'lib/zavudev/models/message_list_params.rb', line 37

Instance Attribute Details

#channel ⇒ Symbol, ...

Filter by delivery channel.

Returns:

• (Symbol, Zavudev::Models::MessageListParams::Channel, nil)

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

optional :channel, enum: -> { Zavudev::MessageListParams::Channel }

#cursor ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/zavudev/models/message_list_params.rb', line 19

optional :cursor, String

#limit ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/zavudev/models/message_list_params.rb', line 24

optional :limit, Integer

#status ⇒ Symbol, ...

Filter by status. Not all stored statuses are filterable.

Returns:

• (Symbol, Zavudev::Models::MessageListParams::Status, nil)

# File 'lib/zavudev/models/message_list_params.rb', line 30

optional :status, enum: -> { Zavudev::MessageListParams::Status }

#to ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/zavudev/models/message_list_params.rb', line 35

optional :to, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/zavudev/models/message_list_params.rbs', line 50

def to_hash: -> {