telnyx 5.99.0 → 5.100.0

data/lib/telnyx/models/uac_connection_list_params.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::UacConnections#list
+    class UacConnectionListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute filter
+      #   Consolidated filter parameter (deepObject style). Originally:
+      #   filter[connection_name], filter[fqdn], filter[outbound_voice_profile_id],
+      #   filter[outbound.outbound_voice_profile_id]
+      #
+      #   @return [Telnyx::Models::UacConnectionListParams::Filter, nil]
+      optional :filter, -> { Telnyx::UacConnectionListParams::Filter }
+
+      # @!attribute page_number
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer
+
+      # @!attribute page_size
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute sort
+      #   Specifies the sort order for results. By default sorting direction is ascending.
+      #   To have the results sorted in descending order add the <code> -</code>
+      #   prefix.<br/><br/> That is: <ul>
+      #
+      #     <li>
+      #       <code>connection_name</code>: sorts the result by the
+      #       <code>connection_name</code> field in ascending order.
+      #     </li>
+      #
+      #     <li>
+      #       <code>-connection_name</code>: sorts the result by the
+      #       <code>connection_name</code> field in descending order.
+      #     </li>
+      #   </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order.
+      #
+      #   @return [Symbol, Telnyx::Models::UacConnectionListParams::Sort, nil]
+      optional :sort, enum: -> { Telnyx::UacConnectionListParams::Sort }
+
+      # @!method initialize(filter: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::UacConnectionListParams} for more details.
+      #
+      #   @param filter [Telnyx::Models::UacConnectionListParams::Filter] Consolidated filter parameter (deepObject style). Originally:
+      #   filter[connection\_
+      #
+      #   @param page_number [Integer]
+      #
+      #   @param page_size [Integer]
+      #
+      #   @param sort [Symbol, Telnyx::Models::UacConnectionListParams::Sort] Specifies the sort order for results. By default sorting direction is ascending.
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      class Filter < Telnyx::Internal::Type::BaseModel
+        # @!attribute connection_name
+        #   Filter by connection_name using nested operations
+        #
+        #   @return [Telnyx::Models::UacConnectionListParams::Filter::ConnectionName, nil]
+        optional :connection_name, -> { Telnyx::UacConnectionListParams::Filter::ConnectionName }
+
+        # @!attribute fqdn
+        #   If present, connections with an `fqdn` that equals the given value will be
+        #   returned. Matching is case-sensitive, and the full string must match.
+        #
+        #   @return [String, nil]
+        optional :fqdn, String
+
+        # @!attribute outbound_voice_profile_id
+        #   Identifies the associated outbound voice profile.
+        #
+        #   @return [String, nil]
+        optional :outbound_voice_profile_id, String
+
+        # @!method initialize(connection_name: nil, fqdn: nil, outbound_voice_profile_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::UacConnectionListParams::Filter} for more details.
+        #
+        #   Consolidated filter parameter (deepObject style). Originally:
+        #   filter[connection_name], filter[fqdn], filter[outbound_voice_profile_id],
+        #   filter[outbound.outbound_voice_profile_id]
+        #
+        #   @param connection_name [Telnyx::Models::UacConnectionListParams::Filter::ConnectionName] Filter by connection_name using nested operations
+        #
+        #   @param fqdn [String] If present, connections with an `fqdn` that equals the given value will be retur
+        #
+        #   @param outbound_voice_profile_id [String] Identifies the associated outbound voice profile.
+
+        # @see Telnyx::Models::UacConnectionListParams::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::UacConnectionListParams::Filter::ConnectionName} for more
+          #   details.
+          #
+          #   Filter by connection_name using nested operations
+          #
+          #   @param contains [String] If present, connections with <code>connection_name</code> containing the given v
+        end
+      end
+
+      # Specifies the sort order for results. By default sorting direction is ascending.
+      # To have the results sorted in descending order add the <code> -</code>
+      # prefix.<br/><br/> That is: <ul>
+      #
+      #   <li>
+      #     <code>connection_name</code>: sorts the result by the
+      #     <code>connection_name</code> field in ascending order.
+      #   </li>
+      #
+      #   <li>
+      #     <code>-connection_name</code>: sorts the result by the
+      #     <code>connection_name</code> field in descending order.
+      #   </li>
+      # </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order.
+      module Sort
+        extend Telnyx::Internal::Type::Enum
+
+        CREATED_AT = :created_at
+        CONNECTION_NAME = :connection_name
+        ACTIVE = :active
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end