Class: Telnyx::Models::ExternalConnectionListParams::Filter

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

Defined Under Namespace

Modules: ExternalSipConnection Classes: ConnectionName, PhoneNumber

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(contains: nil) ⇒ Object

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

Parameters:

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

    If present, connections with connection_name containing the given v



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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/telnyx/models/external_connection_list_params.rb', line 39

class Filter < Telnyx::Internal::Type::BaseModel
  # @!attribute id
  #   If present, connections with <code>id</code> matching the given value will be
  #   returned.
  #
  #   @return [String, nil]
  optional :id, String

  # @!attribute connection_name
  #
  #   @return [Telnyx::Models::ExternalConnectionListParams::Filter::ConnectionName, nil]
  optional :connection_name, -> { Telnyx::ExternalConnectionListParams::Filter::ConnectionName }

  # @!attribute created_at
  #   If present, connections with <code>created_at</code> date matching the given
  #   YYYY-MM-DD date will be returned.
  #
  #   @return [String, nil]
  optional :created_at, String

  # @!attribute external_sip_connection
  #   If present, connections with <code>external_sip_connection</code> matching the
  #   given value will be returned.
  #
  #   @return [Symbol, Telnyx::Models::ExternalConnectionListParams::Filter::ExternalSipConnection, nil]
  optional :external_sip_connection,
           enum: -> { Telnyx::ExternalConnectionListParams::Filter::ExternalSipConnection }

  # @!attribute phone_number
  #   Phone number filter for connections. Note: Despite the 'contains' name, this
  #   requires a full E164 match per the original specification.
  #
  #   @return [Telnyx::Models::ExternalConnectionListParams::Filter::PhoneNumber, nil]
  optional :phone_number, -> { Telnyx::ExternalConnectionListParams::Filter::PhoneNumber }

  # @!method initialize(id: nil, connection_name: nil, created_at: nil, external_sip_connection: nil, phone_number: nil)
  #   Some parameter documentations has been truncated, see
  #   {Telnyx::Models::ExternalConnectionListParams::Filter} for more details.
  #
  #   Filter parameter for external connections (deepObject style). Supports filtering
  #   by connection_name, external_sip_connection, id, created_at, and phone_number.
  #
  #   @param id [String] If present, connections with <code>id</code> matching the given value will be re
  #
  #   @param connection_name [Telnyx::Models::ExternalConnectionListParams::Filter::ConnectionName]
  #
  #   @param created_at [String] If present, connections with <code>created_at</code> date matching the given YYY
  #
  #   @param external_sip_connection [Symbol, Telnyx::Models::ExternalConnectionListParams::Filter::ExternalSipConnection] If present, connections with <code>external_sip_connection</code> matching the g
  #
  #   @param phone_number [Telnyx::Models::ExternalConnectionListParams::Filter::PhoneNumber] Phone number filter for connections. Note: Despite the 'contains' name, this req

  # @see Telnyx::Models::ExternalConnectionListParams::Filter#connection_name
  class ConnectionName < Telnyx::Internal::Type::BaseModel
    # @!attribute contains
    #   If present, connections with <code>connection_name</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::ExternalConnectionListParams::Filter::ConnectionName} for more
    #   details.
    #
    #   @param contains [String] If present, connections with <code>connection_name</code> containing the given v
  end

  # If present, connections with <code>external_sip_connection</code> matching the
  # given value will be returned.
  #
  # @see Telnyx::Models::ExternalConnectionListParams::Filter#external_sip_connection
  module ExternalSipConnection
    extend Telnyx::Internal::Type::Enum

    ZOOM = :zoom
    OPERATOR_CONNECT = :operator_connect

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

  # @see Telnyx::Models::ExternalConnectionListParams::Filter#phone_number
  class PhoneNumber < Telnyx::Internal::Type::BaseModel
    # @!attribute contains
    #   If present, connections associated with the given phone_number will be returned.
    #   A full match is necessary with a e164 format.
    #
    #   @return [String, nil]
    optional :contains, String

    # @!method initialize(contains: nil)
    #   Some parameter documentations has been truncated, see
    #   {Telnyx::Models::ExternalConnectionListParams::Filter::PhoneNumber} for more
    #   details.
    #
    #   Phone number filter for connections. Note: Despite the 'contains' name, this
    #   requires a full E164 match per the original specification.
    #
    #   @param contains [String] If present, connections associated with the given phone_number will be returned.
  end
end

Instance Attribute Details

#connection_name ⇒ Telnyx::Models::ExternalConnectionListParams::Filter::ConnectionName?

Returns:



50
 
# File 'lib/telnyx/models/external_connection_list_params.rb', line 50

optional :connection_name, -> { Telnyx::ExternalConnectionListParams::Filter::ConnectionName }

#created_at ⇒ String?

If present, connections with created_at date matching the given YYYY-MM-DD date will be returned.

Parameters:

  • (String)

Returns:

  • (String, nil) 


57
 
# File 'lib/telnyx/models/external_connection_list_params.rb', line 57

optional :created_at, String

#external_sip_connection ⇒ Symbol, ...

If present, connections with external_sip_connection matching the given value will be returned.

Returns:



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

optional :external_sip_connection,
enum: -> { Telnyx::ExternalConnectionListParams::Filter::ExternalSipConnection }

#id ⇒ String?

If present, connections with id matching the given value will be returned.

Parameters:

  • (String)

Returns:

  • (String, nil) 


45
 
# File 'lib/telnyx/models/external_connection_list_params.rb', line 45

optional :id, String

#phone_number ⇒ Telnyx::Models::ExternalConnectionListParams::Filter::PhoneNumber?

Phone number filter for connections. Note: Despite the 'contains' name, this requires a full E164 match per the original specification.

Returns:



72
 
# File 'lib/telnyx/models/external_connection_list_params.rb', line 72

optional :phone_number, -> { Telnyx::ExternalConnectionListParams::Filter::PhoneNumber }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/external_connection_list_params.rb', line 119

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


87
 
# File 'sig/telnyx/models/external_connection_list_params.rbs', line 87

def to_hash: -> {