Class: Zavudev::Models::Broadcasts::ContactListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Zavudev::Models::Broadcasts::ContactListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/zavudev/models/broadcasts/contact_list_params.rb,
sig/zavudev/models/broadcasts/contact_list_params.rbs

Overview

See Also:

• Zavudev::Resources::Broadcasts::Contacts#list

Instance Attribute Summary

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

  Status of a contact within a broadcast.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(broadcast_id:, cursor: nil, limit: nil, status: 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(broadcast_id:, cursor: nil, limit: nil, status: nil, request_options: {}) ⇒ Object

Parameters:

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

  Status of a contact within a broadcast.

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

# File 'lib/zavudev/models/broadcasts/contact_list_params.rb', line 32

Instance Attribute Details

#broadcast_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :broadcast_id, String

#cursor ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :cursor, String

#limit ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :limit, Integer

#status ⇒ Symbol, ...

Status of a contact within a broadcast.

Returns:

• (Symbol, Zavudev::Models::BroadcastContactStatus, nil)

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

optional :status, enum: -> { Zavudev::BroadcastContactStatus }

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/zavudev/models/broadcasts/contact_list_params.rbs', line 41

def to_hash: -> {