Class: Telnyx::Models::RequirementGroupListParams::Filter

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/requirement_group_list_params.rb,
sig/telnyx/models/requirement_group_list_params.rbs

Defined Under Namespace

Modules: Action, PhoneNumberType, Status

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(action: nil, country_code: nil, customer_reference: nil, phone_number_type: nil, status: nil) ⇒ Object

Consolidated filter parameter (deepObject style). Originally: filter, filter, filter, filter, filter

Parameters:



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/telnyx/models/requirement_group_list_params.rb', line 26

class Filter < Telnyx::Internal::Type::BaseModel
  # @!attribute action
  #   Filter requirement groups by action type
  #
  #   @return [Symbol, Telnyx::Models::RequirementGroupListParams::Filter::Action, nil]
  optional :action, enum: -> { Telnyx::RequirementGroupListParams::Filter::Action }

  # @!attribute country_code
  #   Filter requirement groups by country code (iso alpha 2)
  #
  #   @return [String, nil]
  optional :country_code, String

  # @!attribute customer_reference
  #   Filter requirement groups by customer reference
  #
  #   @return [String, nil]
  optional :customer_reference, String

  # @!attribute phone_number_type
  #   Filter requirement groups by phone number type.
  #
  #   @return [Symbol, Telnyx::Models::RequirementGroupListParams::Filter::PhoneNumberType, nil]
  optional :phone_number_type, enum: -> { Telnyx::RequirementGroupListParams::Filter::PhoneNumberType }

  # @!attribute status
  #   Filter requirement groups by status
  #
  #   @return [Symbol, Telnyx::Models::RequirementGroupListParams::Filter::Status, nil]
  optional :status, enum: -> { Telnyx::RequirementGroupListParams::Filter::Status }

  # @!method initialize(action: nil, country_code: nil, customer_reference: nil, phone_number_type: nil, status: nil)
  #   Consolidated filter parameter (deepObject style). Originally:
  #   filter[country_code], filter[phone_number_type], filter[action], filter[status],
  #   filter[customer_reference]
  #
  #   @param action [Symbol, Telnyx::Models::RequirementGroupListParams::Filter::Action] Filter requirement groups by action type
  #
  #   @param country_code [String] Filter requirement groups by country code (iso alpha 2)
  #
  #   @param customer_reference [String] Filter requirement groups by customer reference
  #
  #   @param phone_number_type [Symbol, Telnyx::Models::RequirementGroupListParams::Filter::PhoneNumberType] Filter requirement groups by phone number type.
  #
  #   @param status [Symbol, Telnyx::Models::RequirementGroupListParams::Filter::Status] Filter requirement groups by status

  # Filter requirement groups by action type
  #
  # @see Telnyx::Models::RequirementGroupListParams::Filter#action
  module Action
    extend Telnyx::Internal::Type::Enum

    ORDERING = :ordering
    PORTING = :porting
    ACTION = :action

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # Filter requirement groups by phone number type.
  #
  # @see Telnyx::Models::RequirementGroupListParams::Filter#phone_number_type
  module PhoneNumberType
    extend Telnyx::Internal::Type::Enum

    LOCAL = :local
    TOLL_FREE = :toll_free
    MOBILE = :mobile
    NATIONAL = :national
    SHARED_COST = :shared_cost

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # Filter requirement groups by status
  #
  # @see Telnyx::Models::RequirementGroupListParams::Filter#status
  module Status
    extend Telnyx::Internal::Type::Enum

    APPROVED = :approved
    UNAPPROVED = :unapproved
    PENDING_APPROVAL = :"pending-approval"
    DECLINED = :declined
    EXPIRED = :expired

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#action ⇒ Symbol, ...

Filter requirement groups by action type

Returns:



31
 
# File 'lib/telnyx/models/requirement_group_list_params.rb', line 31

optional :action, enum: -> { Telnyx::RequirementGroupListParams::Filter::Action }

#country_code ⇒ String?

Filter requirement groups by country code (iso alpha 2)

Parameters:

  • (String)

Returns:

  • (String, nil) 


37
 
# File 'lib/telnyx/models/requirement_group_list_params.rb', line 37

optional :country_code, String

#customer_reference ⇒ String?

Filter requirement groups by customer reference

Parameters:

  • (String)

Returns:

  • (String, nil) 


43
 
# File 'lib/telnyx/models/requirement_group_list_params.rb', line 43

optional :customer_reference, String

#phone_number_type ⇒ Symbol, ...

Filter requirement groups by phone number type.

Returns:



49
 
# File 'lib/telnyx/models/requirement_group_list_params.rb', line 49

optional :phone_number_type, enum: -> { Telnyx::RequirementGroupListParams::Filter::PhoneNumberType }

#status ⇒ Symbol, ...

Filter requirement groups by status

Returns:



55
 
# File 'lib/telnyx/models/requirement_group_list_params.rb', line 55

optional :status, enum: -> { Telnyx::RequirementGroupListParams::Filter::Status }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/requirement_group_list_params.rb', line 82

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


71
 
# File 'sig/telnyx/models/requirement_group_list_params.rbs', line 71

def to_hash: -> {