Class: Telnyx::Models::EmailBlockListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/email_block_list_params.rb,
sig/telnyx/models/email_block_list_params.rbs

Overview

See Also:

  • Telnyx::Resources::EmailBlocks#list

Defined Under Namespace

Modules: FilterReason, Sort

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(filter_created_after: nil, filter_created_before: nil, filter_domain_id: nil, filter_reason: nil, page_after: nil, page_before: nil, page_number: nil, page_size: nil, sort: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::EmailBlockListParams for more details.

Parameters:

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

    created_at > value (ISO 8601).

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

    created_at < value (ISO 8601).

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

    Exact-match filter on domain_id (UUID).

  • filter_reason (Symbol, Telnyx::Models::EmailBlockListParams::FilterReason) (defaults to: nil) —

    Exact-match filter on reason.

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

    Opaque cursor (Base.url_encode64 of {"created_at","id"}). Cursor mode; mutua

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

    Opaque cursor (see page[after]). Mutually exclusive with page[after] and `pa

  • page_number (Integer) (defaults to: nil) —

    Offset page number (≥1, default 1).

  • page_size (Integer) (defaults to: nil) —

    Page size (1–100, default 25).

  • sort (Symbol, Telnyx::Models::EmailBlockListParams::Sort) (defaults to: nil) —

    Sort field. Leading - = desc; only created_at is sortable. Default `-created

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



# File 'lib/telnyx/models/email_block_list_params.rb', line 67

Instance Attribute Details

#filter_created_after ⇒ Time?

created_at > value (ISO 8601).

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


14
 
# File 'lib/telnyx/models/email_block_list_params.rb', line 14

optional :filter_created_after, Time

#filter_created_before ⇒ Time?

created_at < value (ISO 8601).

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


20
 
# File 'lib/telnyx/models/email_block_list_params.rb', line 20

optional :filter_created_before, Time

#filter_domain_id ⇒ String?

Exact-match filter on domain_id (UUID).

Parameters:

  • (String)

Returns:

  • (String, nil) 


26
 
# File 'lib/telnyx/models/email_block_list_params.rb', line 26

optional :filter_domain_id, String

#filter_reason ⇒ Symbol, ...

Exact-match filter on reason.

Returns:



32
 
# File 'lib/telnyx/models/email_block_list_params.rb', line 32

optional :filter_reason, enum: -> { Telnyx::EmailBlockListParams::FilterReason }

#page_after ⇒ String?

Opaque cursor (Base.url_encode64 of {"created_at","id"}). Cursor mode; mutually exclusive with page[number] and page[before].

Parameters:

  • (String)

Returns:

  • (String, nil) 


39
 
# File 'lib/telnyx/models/email_block_list_params.rb', line 39

optional :page_after, String

#page_before ⇒ String?

Opaque cursor (see page[after]). Mutually exclusive with page[after] and page[number].

Parameters:

  • (String)

Returns:

  • (String, nil) 


46
 
# File 'lib/telnyx/models/email_block_list_params.rb', line 46

optional :page_before, String

#page_number ⇒ Integer?

Offset page number (≥1, default 1).

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


52
 
# File 'lib/telnyx/models/email_block_list_params.rb', line 52

optional :page_number, Integer

#page_size ⇒ Integer?

Page size (1–100, default 25).

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


58
 
# File 'lib/telnyx/models/email_block_list_params.rb', line 58

optional :page_size, Integer

#sort ⇒ Symbol, ...

Sort field. Leading - = desc; only created_at is sortable. Default -created_at. -- is an error.

Returns:



65
 
# File 'lib/telnyx/models/email_block_list_params.rb', line 65

optional :sort, enum: -> { Telnyx::EmailBlockListParams::Sort }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/email_block_list_params.rb', line 101

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


74
 
# File 'sig/telnyx/models/email_block_list_params.rbs', line 74

def to_hash: -> {