Class: Telnyx::Models::Enterprises::DirListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/enterprises/dir_list_params.rb

Overview

See Also:

Defined Under Namespace

Modules: FilterStatus, 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(enterprise_id:, filter_call_reason_contains: nil, filter_display_name_contains: nil, filter_expiring_at_gte: nil, filter_expiring_at_lte: nil, filter_expiring_within_days: nil, filter_status: nil, page_number: nil, page_size: nil, sort: nil, request_options: {}) ⇒ Object

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

Parameters:

  • enterprise_id (String)
  • filter_call_reason_contains (String) (defaults to: nil) —

    Case-insensitive partial match on call reason.

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

    Case-insensitive partial match on display name.

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

    Return only DIRs whose ‘expiring_at` is at or after this ISO-8601 timestamp.

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

    Return only DIRs whose ‘expiring_at` is at or before this ISO-8601 timestamp.

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

    Convenience: returns DIRs whose ‘expiring_at` falls within the next N days (1–36

  • filter_status (Symbol, Telnyx::Models::Enterprises::DirListParams::FilterStatus) (defaults to: nil) —

    Filter by DIR status.

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

    1-based page number. Out-of-range values return an empty page with correct meta.

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

    Items per page. Maximum 250; values above are clamped to 250.

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

    Sort field. Allowed: ‘created_at`, `updated_at`, `display_name`, `status`, `subm

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



# File 'lib/telnyx/models/enterprises/dir_list_params.rb', line 75

Instance Attribute Details

#enterprise_id ⇒ String

Returns:

  • (String) 


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

required :enterprise_id, String

#filter_call_reason_contains ⇒ String?

Case-insensitive partial match on call reason.

Returns:

  • (String, nil) 


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

optional :filter_call_reason_contains, String

#filter_display_name_contains ⇒ String?

Case-insensitive partial match on display name.

Returns:

  • (String, nil) 


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

optional :filter_display_name_contains, String

#filter_expiring_at_gte ⇒ Time?

Return only DIRs whose ‘expiring_at` is at or after this ISO-8601 timestamp.

Returns:

  • (Time, nil) 


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

optional :filter_expiring_at_gte, Time

#filter_expiring_at_lte ⇒ Time?

Return only DIRs whose ‘expiring_at` is at or before this ISO-8601 timestamp.

Returns:

  • (Time, nil) 


38
 
# File 'lib/telnyx/models/enterprises/dir_list_params.rb', line 38

optional :filter_expiring_at_lte, Time

#filter_expiring_within_days ⇒ Integer?

Convenience: returns DIRs whose ‘expiring_at` falls within the next N days (1–365). Equivalent to setting `filter[gte]=<now>` + `filter[lte]=<now+N>`. Mutually exclusive with the explicit `[gte]`/`` filters - combining returns 400.

Returns:

  • (Integer, nil) 


47
 
# File 'lib/telnyx/models/enterprises/dir_list_params.rb', line 47

optional :filter_expiring_within_days, Integer

#filter_status ⇒ Symbol, ...

Filter by DIR status.

Returns:



53
 
# File 'lib/telnyx/models/enterprises/dir_list_params.rb', line 53

optional :filter_status, enum: -> { Telnyx::Enterprises::DirListParams::FilterStatus }

#page_number ⇒ Integer?

1-based page number. Out-of-range values return an empty page with correct meta.

Returns:

  • (Integer, nil) 


59
 
# File 'lib/telnyx/models/enterprises/dir_list_params.rb', line 59

optional :page_number, Integer

#page_size ⇒ Integer?

Items per page. Maximum 250; values above are clamped to 250.

Returns:

  • (Integer, nil) 


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

optional :page_size, Integer

#sort ⇒ Symbol, ...

Sort field. Allowed: ‘created_at`, `updated_at`, `display_name`, `status`, `submitted_at`, `verified_at`, `expiring_at`. Prefix with `-` for descending. Default `-created_at`.

Returns:



73
 
# File 'lib/telnyx/models/enterprises/dir_list_params.rb', line 73

optional :sort, enum: -> { Telnyx::Enterprises::DirListParams::Sort }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/enterprises/dir_list_params.rb', line 116