telnyx 4.3.0 → 4.4.0

data/lib/telnyx/models/webhook_unsafe_unwrap_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::Webhooks#unsafe_unwrap
+    class WebhookUnsafeUnwrapParams < 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.rb

@@ -71,6 +71,8 @@ module Telnyx
 
   AddressRetrieveParams = Telnyx::Models::AddressRetrieveParams
 
+  AdvancedOrder = Telnyx::Models::AdvancedOrder
+
   AdvancedOrderCreateParams = Telnyx::Models::AdvancedOrderCreateParams
 
   AdvancedOrderListParams = Telnyx::Models::AdvancedOrderListParams
@@ -433,6 +435,8 @@ module Telnyx
 
   DocumentUpdateParams = Telnyx::Models::DocumentUpdateParams
 
+  DocumentUploadJsonParams = Telnyx::Models::DocumentUploadJsonParams
+
   DocumentUploadParams = Telnyx::Models::DocumentUploadParams
 
   DtmfType = Telnyx::Models::DtmfType
@@ -701,6 +705,8 @@ module Telnyx
 
   MessageSendShortCodeParams = Telnyx::Models::MessageSendShortCodeParams
 
+  MessageTemplate = Telnyx::Models::MessageTemplate
+
   Messaging = Telnyx::Models::Messaging
 
   MessagingError = Telnyx::Models::MessagingError
@@ -942,6 +948,10 @@ module Telnyx
 
   PaginationMeta = Telnyx::Models::PaginationMeta
 
+  PaginationMetaCloudflareIPListSync = Telnyx::Models::PaginationMetaCloudflareIPListSync
+
+  PaginationMetaOAuth = Telnyx::Models::PaginationMetaOAuth
+
   PartnerCampaignListParams = Telnyx::Models::PartnerCampaignListParams
 
   PartnerCampaignListSharedByMeParams = Telnyx::Models::PartnerCampaignListSharedByMeParams
@@ -1309,6 +1319,8 @@ module Telnyx
 
   StreamBidirectionalMode = Telnyx::Models::StreamBidirectionalMode
 
+  StreamBidirectionalSamplingRate = Telnyx::Models::StreamBidirectionalSamplingRate
+
   StreamBidirectionalTargetLegs = Telnyx::Models::StreamBidirectionalTargetLegs
 
   StreamCodec = Telnyx::Models::StreamCodec
@@ -1390,6 +1402,8 @@ module Telnyx
 
   TransportProtocol = Telnyx::Models::TransportProtocol
 
+  UnsafeUnwrapWebhookEvent = Telnyx::Models::UnsafeUnwrapWebhookEvent
+
   UnwrapWebhookEvent = Telnyx::Models::UnwrapWebhookEvent
 
   UpdateRegulatoryRequirement = Telnyx::Models::UpdateRegulatoryRequirement
@@ -1482,6 +1496,8 @@ module Telnyx
 
   WebhookDeliveryRetrieveParams = Telnyx::Models::WebhookDeliveryRetrieveParams
 
+  WebhookUnsafeUnwrapParams = Telnyx::Models::WebhookUnsafeUnwrapParams
+
   WebhookUnwrapParams = Telnyx::Models::WebhookUnwrapParams
 
   WellKnownRetrieveAuthorizationServerMetadataParams =

data/lib/telnyx/resources/advanced_orders.rb

@@ -15,9 +15,9 @@ module Telnyx
       #
       # @param customer_reference [String]
       #
-      # @param features [Array<Symbol, Telnyx::Models::AdvancedOrderCreateParams::Feature>]
+      # @param features [Array<Symbol, Telnyx::Models::AdvancedOrder::Feature>]
       #
-      # @param phone_number_type [Symbol, Telnyx::Models::AdvancedOrderCreateParams::PhoneNumberType]
+      # @param phone_number_type [Symbol, Telnyx::Models::AdvancedOrder::PhoneNumberType]
       #
       # @param quantity [Integer]
       #
@@ -90,9 +90,9 @@ module Telnyx
       #
       # @param customer_reference [String]
       #
-      # @param features [Array<Symbol, Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::Feature>]
+      # @param features [Array<Symbol, Telnyx::Models::AdvancedOrder::Feature>]
       #
-      # @param phone_number_type [Symbol, Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::PhoneNumberType]
+      # @param phone_number_type [Symbol, Telnyx::Models::AdvancedOrder::PhoneNumberType]
       #
       # @param quantity [Integer]
       #

data/lib/telnyx/resources/ai/assistants/versions.rb

@@ -17,7 +17,7 @@ module Telnyx
           #
           # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [Telnyx::Models::AI::Assistants::VersionRetrieveResponse]
+          # @return [Telnyx::Models::AI::InferenceEmbedding]
           #
           # @see Telnyx::Models::AI::Assistants::VersionRetrieveParams
           def retrieve(version_id, params)
@@ -30,7 +30,7 @@ module Telnyx
               method: :get,
               path: ["ai/assistants/%1$s/versions/%2$s", assistant_id, version_id],
               query: parsed,
-              model: Telnyx::Models::AI::Assistants::VersionRetrieveResponse,
+              model: Telnyx::AI::InferenceEmbedding,
               options: options
             )
           end
@@ -81,7 +81,7 @@ module Telnyx
           #
           # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [Telnyx::Models::AI::Assistants::VersionUpdateResponse]
+          # @return [Telnyx::Models::AI::InferenceEmbedding]
           #
           # @see Telnyx::Models::AI::Assistants::VersionUpdateParams
           def update(version_id, params)
@@ -94,7 +94,7 @@ module Telnyx
               method: :post,
               path: ["ai/assistants/%1$s/versions/%2$s", assistant_id, version_id],
               body: parsed,
-              model: Telnyx::Models::AI::Assistants::VersionUpdateResponse,
+              model: Telnyx::AI::InferenceEmbedding,
               options: options
             )
           end
@@ -155,7 +155,7 @@ module Telnyx
           # @param assistant_id [String]
           # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [Telnyx::Models::AI::Assistants::VersionPromoteResponse]
+          # @return [Telnyx::Models::AI::InferenceEmbedding]
           #
           # @see Telnyx::Models::AI::Assistants::VersionPromoteParams
           def promote(version_id, params)
@@ -167,7 +167,7 @@ module Telnyx
             @client.request(
               method: :post,
               path: ["ai/assistants/%1$s/versions/%2$s/promote", assistant_id, version_id],
-              model: Telnyx::Models::AI::Assistants::VersionPromoteResponse,
+              model: Telnyx::AI::InferenceEmbedding,
               options: options
             )
           end

data/lib/telnyx/resources/ai/assistants.rb

@@ -60,7 +60,7 @@ module Telnyx
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Telnyx::Models::AI::AssistantCreateResponse]
+        # @return [Telnyx::Models::AI::InferenceEmbedding]
         #
         # @see Telnyx::Models::AI::AssistantCreateParams
         def create(params)
@@ -69,7 +69,7 @@ module Telnyx
             method: :post,
             path: "ai/assistants",
             body: parsed,
-            model: Telnyx::Models::AI::AssistantCreateResponse,
+            model: Telnyx::AI::InferenceEmbedding,
             options: options
           )
         end
@@ -85,7 +85,7 @@ module Telnyx
         # @param to [String]
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Telnyx::Models::AI::AssistantRetrieveResponse]
+        # @return [Telnyx::Models::AI::InferenceEmbedding]
         #
         # @see Telnyx::Models::AI::AssistantRetrieveParams
         def retrieve(assistant_id, params = {})
@@ -94,7 +94,7 @@ module Telnyx
             method: :get,
             path: ["ai/assistants/%1$s", assistant_id],
             query: parsed,
-            model: Telnyx::Models::AI::AssistantRetrieveResponse,
+            model: Telnyx::AI::InferenceEmbedding,
             options: options
           )
         end
@@ -237,14 +237,14 @@ module Telnyx
         # @param assistant_id [String]
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Telnyx::Models::AI::AssistantCloneResponse]
+        # @return [Telnyx::Models::AI::InferenceEmbedding]
         #
         # @see Telnyx::Models::AI::AssistantCloneParams
         def clone_(assistant_id, params = {})
           @client.request(
             method: :post,
             path: ["ai/assistants/%1$s/clone", assistant_id],
-            model: Telnyx::Models::AI::AssistantCloneResponse,
+            model: Telnyx::AI::InferenceEmbedding,
             options: params[:request_options]
           )
         end

data/lib/telnyx/resources/calls/actions.rb

@@ -1104,7 +1104,7 @@ module Telnyx
         #
         # @param stream_bidirectional_mode [Symbol, Telnyx::Models::StreamBidirectionalMode] Configures method of bidirectional streaming (mp3, rtp).
         #
-        # @param stream_bidirectional_sampling_rate [Integer, Telnyx::Models::Calls::ActionStartStreamingParams::StreamBidirectionalSamplingRate] Audio sampling rate.
+        # @param stream_bidirectional_sampling_rate [Integer, Telnyx::Models::StreamBidirectionalSamplingRate] Audio sampling rate.
         #
         # @param stream_bidirectional_target_legs [Symbol, Telnyx::Models::StreamBidirectionalTargetLegs] Specifies which call legs should receive the bidirectional stream audio.
         #

data/lib/telnyx/resources/calls.rb

@@ -107,7 +107,7 @@ module Telnyx
       #
       # @param stream_bidirectional_mode [Symbol, Telnyx::Models::StreamBidirectionalMode] Configures method of bidirectional streaming (mp3, rtp).
       #
-      # @param stream_bidirectional_sampling_rate [Integer, Telnyx::Models::CallDialParams::StreamBidirectionalSamplingRate] Audio sampling rate.
+      # @param stream_bidirectional_sampling_rate [Integer, Telnyx::Models::StreamBidirectionalSamplingRate] Audio sampling rate.
       #
       # @param stream_bidirectional_target_legs [Symbol, Telnyx::Models::StreamBidirectionalTargetLegs] Specifies which call legs should receive the bidirectional stream audio.
       #

data/lib/telnyx/resources/documents.rb

@@ -167,13 +167,45 @@ module Telnyx
         parsed, options = Telnyx::DocumentUploadParams.dump_request(params)
         @client.request(
           method: :post,
-          path: "documents",
+          path: "documents?content-type=multipart",
           body: parsed,
           model: Telnyx::Models::DocumentUploadResponse,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::DocumentUploadJsonParams} for more details.
+      #
+      # Upload a document.<br /><br />Uploaded files must be linked to a service within
+      # 30 minutes or they will be automatically deleted.
+      #
+      # @overload upload_json(url:, file:, customer_reference: nil, filename: nil, request_options: {})
+      #
+      # @param url [String] If the file is already hosted publicly, you can provide a URL and have the docum
+      #
+      # @param file [String] The Base64 encoded contents of the file you are uploading.
+      #
+      # @param customer_reference [String] A customer reference string for customer look ups.
+      #
+      # @param filename [String] The filename of the document.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::DocumentUploadJsonResponse]
+      #
+      # @see Telnyx::Models::DocumentUploadJsonParams
+      def upload_json(params)
+        parsed, options = Telnyx::DocumentUploadJsonParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "documents",
+          body: parsed,
+          model: Telnyx::Models::DocumentUploadJsonResponse,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [Telnyx::Client]

data/lib/telnyx/resources/messaging_tollfree/verification/requests.rb

@@ -63,7 +63,7 @@ module Telnyx
           #
           # @param doing_business_as [String, nil] Doing Business As (DBA) name if different from legal name
           #
-          # @param entity_type [Symbol, Telnyx::Models::MessagingTollfree::Verification::TfVerificationRequest::EntityType, nil] Business entity classification
+          # @param entity_type [Symbol, Telnyx::Models::MessagingTollfree::Verification::TollFreeVerificationEntityType, nil] Business entity classification
           #
           # @param help_message_response [String, nil] The message returned when users text 'HELP'
           #
@@ -173,7 +173,7 @@ module Telnyx
           #
           # @param doing_business_as [String, nil] Doing Business As (DBA) name if different from legal name
           #
-          # @param entity_type [Symbol, Telnyx::Models::MessagingTollfree::Verification::TfVerificationRequest::EntityType, nil] Business entity classification
+          # @param entity_type [Symbol, Telnyx::Models::MessagingTollfree::Verification::TollFreeVerificationEntityType, nil] Business entity classification
           #
           # @param help_message_response [String, nil] The message returned when users text 'HELP'
           #

data/lib/telnyx/resources/verify_profiles.rb

@@ -141,7 +141,7 @@ module Telnyx
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Telnyx::Models::VerifyProfileCreateTemplateResponse]
+      # @return [Telnyx::Models::MessageTemplate]
       #
       # @see Telnyx::Models::VerifyProfileCreateTemplateParams
       def create_template(params)
@@ -150,7 +150,7 @@ module Telnyx
           method: :post,
           path: "verify_profiles/templates",
           body: parsed,
-          model: Telnyx::Models::VerifyProfileCreateTemplateResponse,
+          model: Telnyx::MessageTemplate,
           options: options
         )
       end
@@ -183,7 +183,7 @@ module Telnyx
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Telnyx::Models::VerifyProfileUpdateTemplateResponse]
+      # @return [Telnyx::Models::MessageTemplate]
       #
       # @see Telnyx::Models::VerifyProfileUpdateTemplateParams
       def update_template(template_id, params)
@@ -192,7 +192,7 @@ module Telnyx
           method: :patch,
           path: ["verify_profiles/templates/%1$s", template_id],
           body: parsed,
-          model: Telnyx::Models::VerifyProfileUpdateTemplateResponse,
+          model: Telnyx::MessageTemplate,
           options: options
         )
       end

data/lib/telnyx/resources/webhooks.rb

@@ -3,6 +3,14 @@
 module Telnyx
   module Resources
     class Webhooks
+      # @param payload [String] The raw webhook payload as a string
+      #
+      # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CustomerServiceRecordStatusChangedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CampaignStatusUpdateWebhookEvent, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChangedWebhookEvent, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDeliveredWebhookEvent, Telnyx::Models::FaxFailedWebhookEvent, Telnyx::Models::FaxMediaProcessedWebhookEvent, Telnyx::Models::FaxQueuedWebhookEvent, Telnyx::Models::FaxSendingStartedWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::StreamingFailedWebhookEvent, Telnyx::Models::StreamingStartedWebhookEvent, Telnyx::Models::StreamingStoppedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]
+      def unsafe_unwrap(payload)
+        parsed = JSON.parse(payload, symbolize_names: true)
+        Telnyx::Internal::Type::Converter.coerce(Telnyx::Models::UnsafeUnwrapWebhookEvent, parsed)
+      end
+
       # @param payload [String] The raw webhook payload as a string
       #
       # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CustomerServiceRecordStatusChangedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CampaignStatusUpdateWebhookEvent, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChangedWebhookEvent, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDeliveredWebhookEvent, Telnyx::Models::FaxFailedWebhookEvent, Telnyx::Models::FaxMediaProcessedWebhookEvent, Telnyx::Models::FaxQueuedWebhookEvent, Telnyx::Models::FaxSendingStartedWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::StreamingFailedWebhookEvent, Telnyx::Models::StreamingStartedWebhookEvent, Telnyx::Models::StreamingStoppedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]

data/lib/telnyx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Telnyx
-  VERSION = "4.3.0"
+  VERSION = "4.4.0"
 end