telnyx 5.162.0 → 5.164.0

data/lib/telnyx/models/ai/collection_retrieve_documents_params.rb

@@ -1,104 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    module AI
-      # @see Telnyx::Resources::AI::Collections#retrieve_documents
-      class CollectionRetrieveDocumentsParams < Telnyx::Internal::Type::BaseModel
-        extend Telnyx::Internal::Type::RequestParameters::Converter
-        include Telnyx::Internal::Type::RequestParameters
-
-        # @!attribute slug
-        #
-        #   @return [String]
-        required :slug, String
-
-        # @!attribute filter
-        #   Field filters applied before ranking, using `filter[field][operator]=value`.
-        #   Supported operators: `eq` (default), `in`, `gte`, `gt`, `lte`, `lt`, `contains`.
-        #   Known fields: `record_type`, `record_id`, `user_id`, `record_created_at`,
-        #   `ingested_at`; any other name resolves to a `metadata.<field>` filter. Example:
-        #   `filter[record_id][eq]=rec_123`.
-        #
-        #   @return [Hash{Symbol=>Object}, nil]
-        optional :filter, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
-
-        # @!attribute page_number
-        #   Page number to return (1-based). Defaults to 1.
-        #
-        #   @return [Integer, nil]
-        optional :page_number, Integer
-
-        # @!attribute page_size
-        #   Number of results per page. Defaults to 20.
-        #
-        #   @return [Integer, nil]
-        optional :page_size, Integer
-
-        # @!attribute query
-        #   Natural-language search query. When provided, the text is matched against the
-        #   collection's document chunks using the collection's `retrieval_type` (vector or
-        #   hybrid). When omitted, documents are returned as a plain catalog listing.
-        #
-        #   @return [String, nil]
-        optional :query, String
-
-        # @!attribute retrieval_type
-        #   Override the collection's configured retrieval strategy for this request. Echoed
-        #   back in `meta.retrieval_type`.
-        #
-        #   @return [Symbol, Telnyx::Models::AI::CollectionRetrieveDocumentsParams::RetrievalType, nil]
-        optional :retrieval_type, enum: -> { Telnyx::AI::CollectionRetrieveDocumentsParams::RetrievalType }
-
-        # @!attribute sources
-        #   Comma-separated list of source types to restrict the search to. When omitted,
-        #   all of the collection's sources are searched.
-        #
-        #   @return [String, nil]
-        optional :sources, String
-
-        # @!attribute top_k
-        #   Maximum number of ranked results to consider. When omitted, the collection's
-        #   configured `top_k` setting is used.
-        #
-        #   @return [Integer, nil]
-        optional :top_k, Integer
-
-        # @!method initialize(slug:, filter: nil, page_number: nil, page_size: nil, query: nil, retrieval_type: nil, sources: nil, top_k: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {Telnyx::Models::AI::CollectionRetrieveDocumentsParams} for more details.
-        #
-        #   @param slug [String]
-        #
-        #   @param filter [Hash{Symbol=>Object}] Field filters applied before ranking, using `filter[field][operator]=value`. Sup
-        #
-        #   @param page_number [Integer] Page number to return (1-based). Defaults to 1.
-        #
-        #   @param page_size [Integer] Number of results per page. Defaults to 20.
-        #
-        #   @param query [String] Natural-language search query. When provided, the text is matched against the co
-        #
-        #   @param retrieval_type [Symbol, Telnyx::Models::AI::CollectionRetrieveDocumentsParams::RetrievalType] Override the collection's configured retrieval strategy for this request. Echoed
-        #
-        #   @param sources [String] Comma-separated list of source types to restrict the search to. When omitted, al
-        #
-        #   @param top_k [Integer] Maximum number of ranked results to consider. When omitted, the collection's con
-        #
-        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
-
-        # Override the collection's configured retrieval strategy for this request. Echoed
-        # back in `meta.retrieval_type`.
-        module RetrievalType
-          extend Telnyx::Internal::Type::Enum
-
-          VECTOR = :vector
-          HYBRID = :hybrid
-          KEYWORD = :keyword
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end

data/lib/telnyx/models/ai/collection_retrieve_documents_response.rb

@@ -1,180 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    module AI
-      # @see Telnyx::Resources::AI::Collections#retrieve_documents
-      class CollectionRetrieveDocumentsResponse < Telnyx::Internal::Type::BaseModel
-        # @!attribute data
-        #
-        #   @return [Array<Telnyx::Models::AI::CollectionRetrieveDocumentsResponse::Data>, nil]
-        optional :data,
-                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::AI::CollectionRetrieveDocumentsResponse::Data] }
-
-        # @!attribute meta
-        #
-        #   @return [Telnyx::Models::AI::CollectionRetrieveDocumentsResponse::Meta, nil]
-        optional :meta, -> { Telnyx::Models::AI::CollectionRetrieveDocumentsResponse::Meta }
-
-        # @!method initialize(data: nil, meta: nil)
-        #   @param data [Array<Telnyx::Models::AI::CollectionRetrieveDocumentsResponse::Data>]
-        #   @param meta [Telnyx::Models::AI::CollectionRetrieveDocumentsResponse::Meta]
-
-        class Data < Telnyx::Internal::Type::BaseModel
-          # @!attribute id
-          #
-          #   @return [String, nil]
-          optional :id, String
-
-          # @!attribute chunk_index
-          #
-          #   @return [Integer, nil]
-          optional :chunk_index, Integer
-
-          # @!attribute chunk_total
-          #
-          #   @return [Integer, nil]
-          optional :chunk_total, Integer
-
-          # @!attribute ingested_at
-          #
-          #   @return [Time, nil]
-          optional :ingested_at, Time
-
-          # @!attribute metadata
-          #
-          #   @return [Hash{Symbol=>Object}, nil]
-          optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
-
-          # @!attribute organization_id
-          #
-          #   @return [String, nil]
-          optional :organization_id, String
-
-          # @!attribute record_created_at
-          #
-          #   @return [Time, nil]
-          optional :record_created_at, Time
-
-          # @!attribute record_id
-          #
-          #   @return [String, nil]
-          optional :record_id, String
-
-          # @!attribute record_type
-          #   The source record kind this chunk came from (e.g. `voice`, `meeting_bot`,
-          #   `message`).
-          #
-          #   @return [String, nil]
-          optional :record_type, String
-
-          # @!attribute region
-          #
-          #   @return [String, nil]
-          optional :region, String
-
-          # @!attribute score
-          #   Relevance score (higher = more relevant) for ranked search. `0.0` for plain
-          #   catalog listings (when `query` is omitted).
-          #
-          #   @return [Float, nil]
-          optional :score, Float
-
-          # @!attribute text
-          #
-          #   @return [String, nil]
-          optional :text, String
-
-          # @!attribute user_id
-          #
-          #   @return [String, nil]
-          optional :user_id, String
-
-          # @!method initialize(id: nil, chunk_index: nil, chunk_total: nil, ingested_at: nil, metadata: nil, organization_id: nil, record_created_at: nil, record_id: nil, record_type: nil, region: nil, score: nil, text: nil, user_id: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Telnyx::Models::AI::CollectionRetrieveDocumentsResponse::Data} for more
-          #   details.
-          #
-          #   @param id [String]
-          #
-          #   @param chunk_index [Integer]
-          #
-          #   @param chunk_total [Integer]
-          #
-          #   @param ingested_at [Time]
-          #
-          #   @param metadata [Hash{Symbol=>Object}]
-          #
-          #   @param organization_id [String]
-          #
-          #   @param record_created_at [Time]
-          #
-          #   @param record_id [String]
-          #
-          #   @param record_type [String] The source record kind this chunk came from (e.g. `voice`, `meeting_bot`, `messa
-          #
-          #   @param region [String]
-          #
-          #   @param score [Float] Relevance score (higher = more relevant) for ranked search. `0.0` for plain cata
-          #
-          #   @param text [String]
-          #
-          #   @param user_id [String]
-        end
-
-        # @see Telnyx::Models::AI::CollectionRetrieveDocumentsResponse#meta
-        class Meta < Telnyx::Internal::Type::BaseModel
-          # @!attribute collection_slug
-          #
-          #   @return [String, nil]
-          optional :collection_slug, String
-
-          # @!attribute page_number
-          #
-          #   @return [Integer, nil]
-          optional :page_number, Integer
-
-          # @!attribute page_size
-          #
-          #   @return [Integer, nil]
-          optional :page_size, Integer
-
-          # @!attribute retrieval_type
-          #
-          #   @return [String, nil]
-          optional :retrieval_type, String
-
-          # @!attribute searched_sources
-          #
-          #   @return [Array<String>, nil]
-          optional :searched_sources, Telnyx::Internal::Type::ArrayOf[String]
-
-          # @!attribute top_k
-          #
-          #   @return [Integer, nil]
-          optional :top_k, Integer
-
-          # @!attribute total_pages
-          #
-          #   @return [Integer, nil]
-          optional :total_pages, Integer
-
-          # @!attribute total_results
-          #
-          #   @return [Integer, nil]
-          optional :total_results, Integer
-
-          # @!method initialize(collection_slug: nil, page_number: nil, page_size: nil, retrieval_type: nil, searched_sources: nil, top_k: nil, total_pages: nil, total_results: nil)
-          #   @param collection_slug [String]
-          #   @param page_number [Integer]
-          #   @param page_size [Integer]
-          #   @param retrieval_type [String]
-          #   @param searched_sources [Array<String>]
-          #   @param top_k [Integer]
-          #   @param total_pages [Integer]
-          #   @param total_results [Integer]
-        end
-      end
-    end
-  end
-end

data/lib/telnyx/models/billing_address.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    class BillingAddress < Telnyx::Internal::Type::BaseModel
-      # @!attribute administrative_area
-      #   State or province code (e.g. `IL`, `ON`).
-      #
-      #   @return [String]
-      required :administrative_area, String
-
-      # @!attribute city
-      #
-      #   @return [String]
-      required :city, String
-
-      # @!attribute country
-      #   ISO 3166-1 alpha-2 code (currently `US` or `CA`).
-      #
-      #   @return [String]
-      required :country, String
-
-      # @!attribute postal_code
-      #
-      #   @return [String]
-      required :postal_code, String
-
-      # @!attribute street_address
-      #
-      #   @return [String]
-      required :street_address, String
-
-      # @!attribute extended_address
-      #
-      #   @return [String, nil]
-      optional :extended_address, String, nil?: true
-
-      # @!method initialize(administrative_area:, city:, country:, postal_code:, street_address:, extended_address: nil)
-      #   @param administrative_area [String] State or province code (e.g. `IL`, `ON`).
-      #
-      #   @param city [String]
-      #
-      #   @param country [String] ISO 3166-1 alpha-2 code (currently `US` or `CA`).
-      #
-      #   @param postal_code [String]
-      #
-      #   @param street_address [String]
-      #
-      #   @param extended_address [String, nil]
-    end
-  end
-end

data/lib/telnyx/models/email_inbox_list_response.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    # @see Telnyx::Resources::EmailInboxes#list
-    class EmailInboxListResponse < Telnyx::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [Array<Telnyx::Models::EmailInbox>]
-      required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInbox] }
-
-      # @!attribute meta
-      #
-      #   @return [Telnyx::Models::EmailInboxListResponse::Meta]
-      required :meta, -> { Telnyx::Models::EmailInboxListResponse::Meta }
-
-      # @!method initialize(data:, meta:)
-      #   @param data [Array<Telnyx::Models::EmailInbox>]
-      #   @param meta [Telnyx::Models::EmailInboxListResponse::Meta]
-
-      # @see Telnyx::Models::EmailInboxListResponse#meta
-      class Meta < Telnyx::Internal::Type::BaseModel
-        # @!attribute page_size
-        #
-        #   @return [Integer]
-        required :page_size, Integer
-
-        # @!attribute page_cursor
-        #   Cursor for the next inbox page, when more results are available.
-        #
-        #   @return [String, nil]
-        optional :page_cursor, String
-
-        # @!method initialize(page_size:, page_cursor: nil)
-        #   @param page_size [Integer]
-        #
-        #   @param page_cursor [String] Cursor for the next inbox page, when more results are available.
-      end
-    end
-  end
-end

data/lib/telnyx/models/email_inboxes/draft_list_response.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    module EmailInboxes
-      # @see Telnyx::Resources::EmailInboxes::Drafts#list
-      class DraftListResponse < Telnyx::Internal::Type::BaseModel
-        # @!attribute data
-        #
-        #   @return [Array<Telnyx::Models::EmailInboxes::EmailDraft>]
-        required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::EmailDraft] }
-
-        # @!attribute meta
-        #
-        #   @return [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
-        required :meta, -> { Telnyx::EmailInboxes::EmailPaginationMeta }
-
-        # @!method initialize(data:, meta:)
-        #   @param data [Array<Telnyx::Models::EmailInboxes::EmailDraft>]
-        #   @param meta [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
-      end
-    end
-  end
-end

data/lib/telnyx/models/email_inboxes/message_list_response.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    module EmailInboxes
-      # @see Telnyx::Resources::EmailInboxes::Messages#list
-      class MessageListResponse < Telnyx::Internal::Type::BaseModel
-        # @!attribute data
-        #
-        #   @return [Array<Telnyx::Models::InboundMessage>]
-        required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::InboundMessage] }
-
-        # @!attribute meta
-        #
-        #   @return [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
-        required :meta, -> { Telnyx::EmailInboxes::EmailPaginationMeta }
-
-        # @!method initialize(data:, meta:)
-        #   @param data [Array<Telnyx::Models::InboundMessage>]
-        #   @param meta [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
-      end
-    end
-  end
-end

data/lib/telnyx/models/email_message_list_response.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    # @see Telnyx::Resources::EmailMessages#list
-    class EmailMessageListResponse < Telnyx::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [Array<Telnyx::Models::EmailInboxes::EmailMessage>]
-      required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::EmailMessage] }
-
-      # @!attribute meta
-      #
-      #   @return [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
-      required :meta, -> { Telnyx::EmailInboxes::EmailPaginationMeta }
-
-      # @!method initialize(data:, meta:)
-      #   @param data [Array<Telnyx::Models::EmailInboxes::EmailMessage>]
-      #   @param meta [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
-    end
-  end
-end

data/lib/telnyx/models/email_message_retrieve_events_response.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    # @see Telnyx::Resources::EmailMessages#retrieve_events
-    class EmailMessageRetrieveEventsResponse < Telnyx::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [Array<Telnyx::Models::MessageEvent>]
-      required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::MessageEvent] }
-
-      # @!attribute meta
-      #
-      #   @return [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
-      required :meta, -> { Telnyx::EmailInboxes::EmailPaginationMeta }
-
-      # @!method initialize(data:, meta:)
-      #   @param data [Array<Telnyx::Models::MessageEvent>]
-      #   @param meta [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
-    end
-  end
-end

data/lib/telnyx/models/email_messages/recipient_list_response.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    module EmailMessages
-      # @see Telnyx::Resources::EmailMessages::Recipients#list
-      class RecipientListResponse < Telnyx::Internal::Type::BaseModel
-        # @!attribute data
-        #
-        #   @return [Array<Telnyx::Models::EmailMessages::EmailRecipient>]
-        required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailMessages::EmailRecipient] }
-
-        # @!attribute meta
-        #
-        #   @return [Telnyx::Models::EmailMessages::RecipientListResponse::Meta]
-        required :meta, -> { Telnyx::Models::EmailMessages::RecipientListResponse::Meta }
-
-        # @!method initialize(data:, meta:)
-        #   @param data [Array<Telnyx::Models::EmailMessages::EmailRecipient>]
-        #   @param meta [Telnyx::Models::EmailMessages::RecipientListResponse::Meta]
-
-        # @see Telnyx::Models::EmailMessages::RecipientListResponse#meta
-        class Meta < Telnyx::Internal::Type::BaseModel
-          # @!attribute page_size
-          #
-          #   @return [Integer]
-          required :page_size, Integer
-
-          # @!attribute page_cursor
-          #   Cursor for the next page. Absent when there are no more results.
-          #
-          #   @return [String, nil]
-          optional :page_cursor, String, nil?: true
-
-          # @!method initialize(page_size:, page_cursor: nil)
-          #   @param page_size [Integer]
-          #
-          #   @param page_cursor [String, nil] Cursor for the next page. Absent when there are no more results.
-        end
-      end
-    end
-  end
-end

data/lib/telnyx/models/email_template_list_response.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    # @see Telnyx::Resources::EmailTemplates#list
-    class EmailTemplateListResponse < Telnyx::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [Array<Telnyx::Models::EmailTemplate>]
-      required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailTemplate] }
-
-      # @!attribute meta
-      #
-      #   @return [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
-      required :meta, -> { Telnyx::EmailInboxes::EmailPaginationMeta }
-
-      # @!method initialize(data:, meta:)
-      #   @param data [Array<Telnyx::Models::EmailTemplate>]
-      #   @param meta [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
-    end
-  end
-end

data/lib/telnyx/models/rime_voice_settings.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    class RimeVoiceSettings < Telnyx::Internal::Type::BaseModel
-      # @!attribute type
-      #   Voice settings provider type
-      #
-      #   @return [Symbol, Telnyx::Models::RimeVoiceSettings::Type]
-      required :type, enum: -> { Telnyx::RimeVoiceSettings::Type }
-
-      # @!attribute api_key_ref
-      #   The `identifier` for an integration secret
-      #   [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
-      #   that refers to your Rime API key. Only required when using your own Rime
-      #   account.
-      #
-      #   @return [String, nil]
-      optional :api_key_ref, String
-
-      # @!attribute voice_speed
-      #   Speech speed multiplier. Default is 1.0.
-      #
-      #   @return [Float, nil]
-      optional :voice_speed, Float
-
-      # @!method initialize(type:, api_key_ref: nil, voice_speed: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Telnyx::Models::RimeVoiceSettings} for more details.
-      #
-      #   @param type [Symbol, Telnyx::Models::RimeVoiceSettings::Type] Voice settings provider type
-      #
-      #   @param api_key_ref [String] The `identifier` for an integration secret [/v2/integration_secrets](https://dev
-      #
-      #   @param voice_speed [Float] Speech speed multiplier. Default is 1.0.
-
-      # Voice settings provider type
-      #
-      # @see Telnyx::Models::RimeVoiceSettings#type
-      module Type
-        extend Telnyx::Internal::Type::Enum
-
-        RIME = :rime
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/telnyx/models/speech_to_text_transcribe_params.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    # @see Telnyx::Resources::SpeechToText#transcribe
-    class SpeechToTextTranscribeParams < Telnyx::Internal::Type::BaseModel
-      extend Telnyx::Internal::Type::RequestParameters::Converter
-      include Telnyx::Internal::Type::RequestParameters
-
-      # @!method initialize(request_options: {})
-      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/telnyx/models/stream_client_event.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    class StreamClientEvent < Telnyx::Internal::Type::BaseModel
-      # @!attribute text
-      #   Text to convert to speech. Send `" "` (single space) as an initial handshake
-      #   with optional `voice_settings`. Subsequent messages contain the actual text to
-      #   synthesize.
-      #
-      #   @return [String]
-      required :text, String
-
-      # @!attribute force
-      #   When `true`, stops the current synthesis worker and starts a new one. Used to
-      #   interrupt speech mid-stream and begin synthesizing new text.
-      #
-      #   @return [Boolean, nil]
-      optional :force, Telnyx::Internal::Type::Boolean
-
-      # @!attribute voice_settings
-      #   Provider-specific voice settings sent with the initial handshake. Contents vary
-      #   by provider — e.g. `{"speed": 1.2}` for Minimax, `{"voice_speed": 1.5}` for
-      #   Telnyx.
-      #
-      #   @return [Hash{Symbol=>Object}, nil]
-      optional :voice_settings, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
-
-      # @!method initialize(text:, force: nil, voice_settings: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Telnyx::Models::StreamClientEvent} for more details.
-      #
-      #   Client-to-server frame containing text to synthesize.
-      #
-      #   @param text [String] Text to convert to speech. Send `" "` (single space) as an initial handshake wit
-      #
-      #   @param force [Boolean] When `true`, stops the current synthesis worker and starts a new one. Used to in
-      #
-      #   @param voice_settings [Hash{Symbol=>Object}] Provider-specific voice settings sent with the initial handshake. Contents vary
-    end
-  end
-end