telnyx 5.7.0 → 5.7.1

data/lib/telnyx/models/texml/call_initiate_params.rb

@@ -1,427 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    module Texml
-      # @see Telnyx::Resources::Texml::Calls#initiate
-      class CallInitiateParams < Telnyx::Internal::Type::BaseModel
-        extend Telnyx::Internal::Type::RequestParameters::Converter
-        include Telnyx::Internal::Type::RequestParameters
-
-        # @!attribute from
-        #   The phone number of the party that initiated the call. Phone numbers are
-        #   formatted with a `+` and country code.
-        #
-        #   @return [String]
-        required :from, String, api_name: :From
-
-        # @!attribute to
-        #   The phone number of the called party. Phone numbers are formatted with a `+` and
-        #   country code.
-        #
-        #   @return [String]
-        required :to, String, api_name: :To
-
-        # @!attribute async_amd
-        #   Select whether to perform answering machine detection in the background. By
-        #   default execution is blocked until Answering Machine Detection is completed.
-        #
-        #   @return [Boolean, nil]
-        optional :async_amd, Telnyx::Internal::Type::Boolean, api_name: :AsyncAmd
-
-        # @!attribute async_amd_status_callback
-        #   URL destination for Telnyx to send AMD callback events to for the call.
-        #
-        #   @return [String, nil]
-        optional :async_amd_status_callback, String, api_name: :AsyncAmdStatusCallback
-
-        # @!attribute async_amd_status_callback_method
-        #   HTTP request type used for `AsyncAmdStatusCallback`. The default value is
-        #   inherited from TeXML Application setting.
-        #
-        #   @return [Symbol, Telnyx::Models::Texml::CallInitiateParams::AsyncAmdStatusCallbackMethod, nil]
-        optional :async_amd_status_callback_method,
-                 enum: -> { Telnyx::Texml::CallInitiateParams::AsyncAmdStatusCallbackMethod },
-                 api_name: :AsyncAmdStatusCallbackMethod
-
-        # @!attribute caller_id
-        #   To be used as the caller id name (SIP From Display Name) presented to the
-        #   destination (`To` number). The string should have a maximum of 128 characters,
-        #   containing only letters, numbers, spaces, and `-_~!.+` special characters. If
-        #   ommited, the display name will be the same as the number in the `From` field.
-        #
-        #   @return [String, nil]
-        optional :caller_id, String, api_name: :CallerId
-
-        # @!attribute cancel_playback_on_detect_message_end
-        #   Whether to cancel ongoing playback on `greeting ended` detection. Defaults to
-        #   `true`.
-        #
-        #   @return [Boolean, nil]
-        optional :cancel_playback_on_detect_message_end,
-                 Telnyx::Internal::Type::Boolean,
-                 api_name: :CancelPlaybackOnDetectMessageEnd
-
-        # @!attribute cancel_playback_on_machine_detection
-        #   Whether to cancel ongoing playback on `machine` detection. Defaults to `true`.
-        #
-        #   @return [Boolean, nil]
-        optional :cancel_playback_on_machine_detection,
-                 Telnyx::Internal::Type::Boolean,
-                 api_name: :CancelPlaybackOnMachineDetection
-
-        # @!attribute detection_mode
-        #   Allows you to chose between Premium and Standard detections.
-        #
-        #   @return [Symbol, Telnyx::Models::Texml::CallInitiateParams::DetectionMode, nil]
-        optional :detection_mode,
-                 enum: -> { Telnyx::Texml::CallInitiateParams::DetectionMode },
-                 api_name: :DetectionMode
-
-        # @!attribute fallback_url
-        #   A failover URL for which Telnyx will retrieve the TeXML call instructions if the
-        #   `Url` is not responding.
-        #
-        #   @return [String, nil]
-        optional :fallback_url, String, api_name: :FallbackUrl
-
-        # @!attribute machine_detection
-        #   Enables Answering Machine Detection.
-        #
-        #   @return [Symbol, Telnyx::Models::Texml::CallInitiateParams::MachineDetection, nil]
-        optional :machine_detection,
-                 enum: -> { Telnyx::Texml::CallInitiateParams::MachineDetection },
-                 api_name: :MachineDetection
-
-        # @!attribute machine_detection_silence_timeout
-        #   If initial silence duration is greater than this value, consider it a machine.
-        #   Ignored when `premium` detection is used.
-        #
-        #   @return [Integer, nil]
-        optional :machine_detection_silence_timeout, Integer, api_name: :MachineDetectionSilenceTimeout
-
-        # @!attribute machine_detection_speech_end_threshold
-        #   Silence duration threshold after a greeting message or voice for it be
-        #   considered human. Ignored when `premium` detection is used.
-        #
-        #   @return [Integer, nil]
-        optional :machine_detection_speech_end_threshold,
-                 Integer,
-                 api_name: :MachineDetectionSpeechEndThreshold
-
-        # @!attribute machine_detection_speech_threshold
-        #   Maximum threshold of a human greeting. If greeting longer than this value,
-        #   considered machine. Ignored when `premium` detection is used.
-        #
-        #   @return [Integer, nil]
-        optional :machine_detection_speech_threshold, Integer, api_name: :MachineDetectionSpeechThreshold
-
-        # @!attribute machine_detection_timeout
-        #   Maximum timeout threshold in milliseconds for overall detection.
-        #
-        #   @return [Integer, nil]
-        optional :machine_detection_timeout, Integer, api_name: :MachineDetectionTimeout
-
-        # @!attribute preferred_codecs
-        #   The list of comma-separated codecs to be offered on a call.
-        #
-        #   @return [String, nil]
-        optional :preferred_codecs, String, api_name: :PreferredCodecs
-
-        # @!attribute record
-        #   Whether to record the entire participant's call leg. Defaults to `false`.
-        #
-        #   @return [Boolean, nil]
-        optional :record, Telnyx::Internal::Type::Boolean, api_name: :Record
-
-        # @!attribute recording_channels
-        #   The number of channels in the final recording. Defaults to `mono`.
-        #
-        #   @return [Symbol, Telnyx::Models::Texml::CallInitiateParams::RecordingChannels, nil]
-        optional :recording_channels,
-                 enum: -> { Telnyx::Texml::CallInitiateParams::RecordingChannels },
-                 api_name: :RecordingChannels
-
-        # @!attribute recording_status_callback
-        #   The URL the recording callbacks will be sent to.
-        #
-        #   @return [String, nil]
-        optional :recording_status_callback, String, api_name: :RecordingStatusCallback
-
-        # @!attribute recording_status_callback_event
-        #   The changes to the recording's state that should generate a call to
-        #   `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`.
-        #   Separate multiple values with a space. Defaults to `completed`.
-        #
-        #   @return [String, nil]
-        optional :recording_status_callback_event, String, api_name: :RecordingStatusCallbackEvent
-
-        # @!attribute recording_status_callback_method
-        #   HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
-        #
-        #   @return [Symbol, Telnyx::Models::Texml::CallInitiateParams::RecordingStatusCallbackMethod, nil]
-        optional :recording_status_callback_method,
-                 enum: -> { Telnyx::Texml::CallInitiateParams::RecordingStatusCallbackMethod },
-                 api_name: :RecordingStatusCallbackMethod
-
-        # @!attribute recording_timeout
-        #   The number of seconds that Telnyx will wait for the recording to be stopped if
-        #   silence is detected. The timer only starts when the speech is detected. Please
-        #   note that the transcription is used to detect silence and the related charge
-        #   will be applied. The minimum value is 0. The default value is 0 (infinite)
-        #
-        #   @return [Integer, nil]
-        optional :recording_timeout, Integer, api_name: :RecordingTimeout
-
-        # @!attribute recording_track
-        #   The audio track to record for the call. The default is `both`.
-        #
-        #   @return [Symbol, Telnyx::Models::Texml::CallInitiateParams::RecordingTrack, nil]
-        optional :recording_track,
-                 enum: -> { Telnyx::Texml::CallInitiateParams::RecordingTrack },
-                 api_name: :RecordingTrack
-
-        # @!attribute sip_auth_password
-        #   The password to use for SIP authentication.
-        #
-        #   @return [String, nil]
-        optional :sip_auth_password, String, api_name: :SipAuthPassword
-
-        # @!attribute sip_auth_username
-        #   The username to use for SIP authentication.
-        #
-        #   @return [String, nil]
-        optional :sip_auth_username, String, api_name: :SipAuthUsername
-
-        # @!attribute status_callback
-        #   URL destination for Telnyx to send status callback events to for the call.
-        #
-        #   @return [String, nil]
-        optional :status_callback, String, api_name: :StatusCallback
-
-        # @!attribute status_callback_event
-        #   The call events for which Telnyx should send a webhook. Multiple events can be
-        #   defined when separated by a space.
-        #
-        #   @return [Symbol, Telnyx::Models::Texml::CallInitiateParams::StatusCallbackEvent, nil]
-        optional :status_callback_event,
-                 enum: -> { Telnyx::Texml::CallInitiateParams::StatusCallbackEvent },
-                 api_name: :StatusCallbackEvent
-
-        # @!attribute status_callback_method
-        #   HTTP request type used for `StatusCallback`.
-        #
-        #   @return [Symbol, Telnyx::Models::Texml::CallInitiateParams::StatusCallbackMethod, nil]
-        optional :status_callback_method,
-                 enum: -> { Telnyx::Texml::CallInitiateParams::StatusCallbackMethod },
-                 api_name: :StatusCallbackMethod
-
-        # @!attribute trim
-        #   Whether to trim any leading and trailing silence from the recording. Defaults to
-        #   `trim-silence`.
-        #
-        #   @return [Symbol, Telnyx::Models::Texml::CallInitiateParams::Trim, nil]
-        optional :trim, enum: -> { Telnyx::Texml::CallInitiateParams::Trim }, api_name: :Trim
-
-        # @!attribute url
-        #   The URL from which Telnyx will retrieve the TeXML call instructions.
-        #
-        #   @return [String, nil]
-        optional :url, String, api_name: :Url
-
-        # @!attribute url_method
-        #   HTTP request type used for `Url`. The default value is inherited from TeXML
-        #   Application setting.
-        #
-        #   @return [Symbol, Telnyx::Models::Texml::CallInitiateParams::URLMethod, nil]
-        optional :url_method, enum: -> { Telnyx::Texml::CallInitiateParams::URLMethod }, api_name: :UrlMethod
-
-        # @!method initialize(from:, to:, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, detection_mode: nil, fallback_url: nil, machine_detection: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, sip_auth_password: nil, sip_auth_username: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, trim: nil, url: nil, url_method: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {Telnyx::Models::Texml::CallInitiateParams} for more details.
-        #
-        #   @param from [String] The phone number of the party that initiated the call. Phone numbers are formatt
-        #
-        #   @param to [String] The phone number of the called party. Phone numbers are formatted with a `+` and
-        #
-        #   @param async_amd [Boolean] Select whether to perform answering machine detection in the background. By defa
-        #
-        #   @param async_amd_status_callback [String] URL destination for Telnyx to send AMD callback events to for the call.
-        #
-        #   @param async_amd_status_callback_method [Symbol, Telnyx::Models::Texml::CallInitiateParams::AsyncAmdStatusCallbackMethod] HTTP request type used for `AsyncAmdStatusCallback`. The default value is inheri
-        #
-        #   @param caller_id [String] To be used as the caller id name (SIP From Display Name) presented to the destin
-        #
-        #   @param cancel_playback_on_detect_message_end [Boolean] Whether to cancel ongoing playback on `greeting ended` detection. Defaults to `t
-        #
-        #   @param cancel_playback_on_machine_detection [Boolean] Whether to cancel ongoing playback on `machine` detection. Defaults to `true`.
-        #
-        #   @param detection_mode [Symbol, Telnyx::Models::Texml::CallInitiateParams::DetectionMode] Allows you to chose between Premium and Standard detections.
-        #
-        #   @param fallback_url [String] A failover URL for which Telnyx will retrieve the TeXML call instructions if the
-        #
-        #   @param machine_detection [Symbol, Telnyx::Models::Texml::CallInitiateParams::MachineDetection] Enables Answering Machine Detection.
-        #
-        #   @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
-        #
-        #   @param machine_detection_speech_end_threshold [Integer] Silence duration threshold after a greeting message or voice for it be considere
-        #
-        #   @param machine_detection_speech_threshold [Integer] Maximum threshold of a human greeting. If greeting longer than this value, consi
-        #
-        #   @param machine_detection_timeout [Integer] Maximum timeout threshold in milliseconds for overall detection.
-        #
-        #   @param preferred_codecs [String] The list of comma-separated codecs to be offered on a call.
-        #
-        #   @param record [Boolean] Whether to record the entire participant's call leg. Defaults to `false`.
-        #
-        #   @param recording_channels [Symbol, Telnyx::Models::Texml::CallInitiateParams::RecordingChannels] The number of channels in the final recording. Defaults to `mono`.
-        #
-        #   @param recording_status_callback [String] The URL the recording callbacks will be sent to.
-        #
-        #   @param recording_status_callback_event [String] The changes to the recording's state that should generate a call to `RecoridngSt
-        #
-        #   @param recording_status_callback_method [Symbol, Telnyx::Models::Texml::CallInitiateParams::RecordingStatusCallbackMethod] HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
-        #
-        #   @param recording_timeout [Integer] The number of seconds that Telnyx will wait for the recording to be stopped if s
-        #
-        #   @param recording_track [Symbol, Telnyx::Models::Texml::CallInitiateParams::RecordingTrack] The audio track to record for the call. The default is `both`.
-        #
-        #   @param sip_auth_password [String] The password to use for SIP authentication.
-        #
-        #   @param sip_auth_username [String] The username to use for SIP authentication.
-        #
-        #   @param status_callback [String] URL destination for Telnyx to send status callback events to for the call.
-        #
-        #   @param status_callback_event [Symbol, Telnyx::Models::Texml::CallInitiateParams::StatusCallbackEvent] The call events for which Telnyx should send a webhook. Multiple events can be d
-        #
-        #   @param status_callback_method [Symbol, Telnyx::Models::Texml::CallInitiateParams::StatusCallbackMethod] HTTP request type used for `StatusCallback`.
-        #
-        #   @param trim [Symbol, Telnyx::Models::Texml::CallInitiateParams::Trim] Whether to trim any leading and trailing silence from the recording. Defaults to
-        #
-        #   @param url [String] The URL from which Telnyx will retrieve the TeXML call instructions.
-        #
-        #   @param url_method [Symbol, Telnyx::Models::Texml::CallInitiateParams::URLMethod] HTTP request type used for `Url`. The default value is inherited from TeXML Appl
-        #
-        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
-
-        # HTTP request type used for `AsyncAmdStatusCallback`. The default value is
-        # inherited from TeXML Application setting.
-        module AsyncAmdStatusCallbackMethod
-          extend Telnyx::Internal::Type::Enum
-
-          GET = :GET
-          POST = :POST
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # Allows you to chose between Premium and Standard detections.
-        module DetectionMode
-          extend Telnyx::Internal::Type::Enum
-
-          PREMIUM = :Premium
-          REGULAR = :Regular
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # Enables Answering Machine Detection.
-        module MachineDetection
-          extend Telnyx::Internal::Type::Enum
-
-          ENABLE = :Enable
-          DISABLE = :Disable
-          DETECT_MESSAGE_END = :DetectMessageEnd
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # The number of channels in the final recording. Defaults to `mono`.
-        module RecordingChannels
-          extend Telnyx::Internal::Type::Enum
-
-          MONO = :mono
-          DUAL = :dual
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
-        module RecordingStatusCallbackMethod
-          extend Telnyx::Internal::Type::Enum
-
-          GET = :GET
-          POST = :POST
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # The audio track to record for the call. The default is `both`.
-        module RecordingTrack
-          extend Telnyx::Internal::Type::Enum
-
-          INBOUND = :inbound
-          OUTBOUND = :outbound
-          BOTH = :both
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # The call events for which Telnyx should send a webhook. Multiple events can be
-        # defined when separated by a space.
-        module StatusCallbackEvent
-          extend Telnyx::Internal::Type::Enum
-
-          INITIATED = :initiated
-          RINGING = :ringing
-          ANSWERED = :answered
-          COMPLETED = :completed
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # HTTP request type used for `StatusCallback`.
-        module StatusCallbackMethod
-          extend Telnyx::Internal::Type::Enum
-
-          GET = :GET
-          POST = :POST
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # Whether to trim any leading and trailing silence from the recording. Defaults to
-        # `trim-silence`.
-        module Trim
-          extend Telnyx::Internal::Type::Enum
-
-          TRIM_SILENCE = :"trim-silence"
-          DO_NOT_TRIM = :"do-not-trim"
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # HTTP request type used for `Url`. The default value is inherited from TeXML
-        # Application setting.
-        module URLMethod
-          extend Telnyx::Internal::Type::Enum
-
-          GET = :GET
-          POST = :POST
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end

data/lib/telnyx/models/texml/call_initiate_response.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    module Texml
-      # @see Telnyx::Resources::Texml::Calls#initiate
-      class CallInitiateResponse < Telnyx::Internal::Type::BaseModel
-        # @!attribute data
-        #
-        #   @return [Telnyx::Models::Texml::CallInitiateResponse::Data, nil]
-        optional :data, -> { Telnyx::Models::Texml::CallInitiateResponse::Data }
-
-        # @!method initialize(data: nil)
-        #   @param data [Telnyx::Models::Texml::CallInitiateResponse::Data]
-
-        # @see Telnyx::Models::Texml::CallInitiateResponse#data
-        class Data < Telnyx::Internal::Type::BaseModel
-          # @!attribute from
-          #
-          #   @return [String, nil]
-          optional :from, String
-
-          # @!attribute status
-          #
-          #   @return [String, nil]
-          optional :status, String
-
-          # @!attribute to
-          #
-          #   @return [String, nil]
-          optional :to, String
-
-          # @!method initialize(from: nil, status: nil, to: nil)
-          #   @param from [String]
-          #   @param status [String]
-          #   @param to [String]
-        end
-      end
-    end
-  end
-end

data/lib/telnyx/models/texml/call_update_params.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    module Texml
-      # @see Telnyx::Resources::Texml::Calls#update
-      class CallUpdateParams < Telnyx::Models::Texml::Accounts::UpdateCall
-        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
-end

data/lib/telnyx/models/texml/call_update_response.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    module Texml
-      # @see Telnyx::Resources::Texml::Calls#update
-      class CallUpdateResponse < Telnyx::Internal::Type::BaseModel
-        # @!attribute data
-        #
-        #   @return [Telnyx::Models::Texml::CallUpdateResponse::Data, nil]
-        optional :data, -> { Telnyx::Models::Texml::CallUpdateResponse::Data }
-
-        # @!method initialize(data: nil)
-        #   @param data [Telnyx::Models::Texml::CallUpdateResponse::Data]
-
-        # @see Telnyx::Models::Texml::CallUpdateResponse#data
-        class Data < Telnyx::Internal::Type::BaseModel
-          # @!attribute sid
-          #
-          #   @return [String, nil]
-          optional :sid, String
-
-          # @!attribute status
-          #
-          #   @return [String, nil]
-          optional :status, String
-
-          # @!method initialize(sid: nil, status: nil)
-          #   @param sid [String]
-          #   @param status [String]
-        end
-      end
-    end
-  end
-end