Class: Telnyx::Models::UserAddressListParams::Filter

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

Defined Under Namespace

Classes: CustomerReference, StreetAddress

Instance Attribute 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(contains: nil, eq: nil) ⇒ Object

Some parameter documentations has been truncated, see CustomerReference for more details.

Filter user addresses via the customer reference. Supports both exact matching (eq) and partial matching (contains). Matching is not case-sensitive.

Parameters:

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

    If present, user addresses with customer_reference containing the g

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

    Filter user addresses via exact customer reference match. Matching is not case-s



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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/telnyx/models/user_address_list_params.rb', line 61

class Filter < Telnyx::Internal::Type::BaseModel
  # @!attribute customer_reference
  #   Filter user addresses via the customer reference. Supports both exact matching
  #   (eq) and partial matching (contains). Matching is not case-sensitive.
  #
  #   @return [Telnyx::Models::UserAddressListParams::Filter::CustomerReference, nil]
  optional :customer_reference, -> { Telnyx::UserAddressListParams::Filter::CustomerReference }

  # @!attribute street_address
  #   Filter user addresses via street address. Supports partial matching (contains).
  #   Matching is not case-sensitive.
  #
  #   @return [Telnyx::Models::UserAddressListParams::Filter::StreetAddress, nil]
  optional :street_address, -> { Telnyx::UserAddressListParams::Filter::StreetAddress }

  # @!method initialize(customer_reference: nil, street_address: nil)
  #   Some parameter documentations has been truncated, see
  #   {Telnyx::Models::UserAddressListParams::Filter} for more details.
  #
  #   Consolidated filter parameter (deepObject style). Originally:
  #   filter[customer_reference][eq], filter[customer_reference][contains],
  #   filter[street_address][contains]
  #
  #   @param customer_reference [Telnyx::Models::UserAddressListParams::Filter::CustomerReference] Filter user addresses via the customer reference. Supports both exact matching (
  #
  #   @param street_address [Telnyx::Models::UserAddressListParams::Filter::StreetAddress] Filter user addresses via street address. Supports partial matching (contains).

  # @see Telnyx::Models::UserAddressListParams::Filter#customer_reference
  class CustomerReference < Telnyx::Internal::Type::BaseModel
    # @!attribute contains
    #   If present, user addresses with <code>customer_reference</code> containing the
    #   given value will be returned. Matching is not case-sensitive.
    #
    #   @return [String, nil]
    optional :contains, String

    # @!attribute eq
    #   Filter user addresses via exact customer reference match. Matching is not
    #   case-sensitive.
    #
    #   @return [String, nil]
    optional :eq, String

    # @!method initialize(contains: nil, eq: nil)
    #   Some parameter documentations has been truncated, see
    #   {Telnyx::Models::UserAddressListParams::Filter::CustomerReference} for more
    #   details.
    #
    #   Filter user addresses via the customer reference. Supports both exact matching
    #   (eq) and partial matching (contains). Matching is not case-sensitive.
    #
    #   @param contains [String] If present, user addresses with <code>customer_reference</code> containing the g
    #
    #   @param eq [String] Filter user addresses via exact customer reference match. Matching is not case-s
  end

  # @see Telnyx::Models::UserAddressListParams::Filter#street_address
  class StreetAddress < Telnyx::Internal::Type::BaseModel
    # @!attribute contains
    #   If present, user addresses with <code>street_address</code> containing the given
    #   value will be returned. Matching is not case-sensitive. Requires at least three
    #   characters.
    #
    #   @return [String, nil]
    optional :contains, String

    # @!method initialize(contains: nil)
    #   Some parameter documentations has been truncated, see
    #   {Telnyx::Models::UserAddressListParams::Filter::StreetAddress} for more details.
    #
    #   Filter user addresses via street address. Supports partial matching (contains).
    #   Matching is not case-sensitive.
    #
    #   @param contains [String] If present, user addresses with <code>street_address</code> containing the given
  end
end

Instance Attribute Details

#customer_reference ⇒ Telnyx::Models::UserAddressListParams::Filter::CustomerReference?

Filter user addresses via the customer reference. Supports both exact matching (eq) and partial matching (contains). Matching is not case-sensitive.

Returns:



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

optional :customer_reference, -> { Telnyx::UserAddressListParams::Filter::CustomerReference }

#street_address ⇒ Telnyx::Models::UserAddressListParams::Filter::StreetAddress?

Filter user addresses via street address. Supports partial matching (contains). Matching is not case-sensitive.

Returns:



74
 
# File 'lib/telnyx/models/user_address_list_params.rb', line 74

optional :street_address, -> { Telnyx::UserAddressListParams::Filter::StreetAddress }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


76
 
# File 'sig/telnyx/models/user_address_list_params.rbs', line 76

def to_hash: -> {