telnyx 5.158.0 → 5.160.0

data/lib/telnyx/models/rcs/agent_email_contact.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      class AgentEmailContact < Telnyx::Internal::Type::BaseModel
+        # @!attribute address
+        #
+        #   @return [String]
+        required :address, String
+
+        # @!attribute label
+        #
+        #   @return [String]
+        required :label, String
+
+        # @!method initialize(address:, label:)
+        #   @param address [String]
+        #   @param label [String]
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/agent_interaction.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      class AgentInteraction < Telnyx::Internal::Type::BaseModel
+        # @!attribute interaction_type
+        #
+        #   @return [Symbol, Telnyx::Models::Rcs::AgentInteraction::InteractionType]
+        required :interaction_type, enum: -> { Telnyx::Rcs::AgentInteraction::InteractionType }
+
+        # @!attribute description
+        #   Required when interaction_type is `OTHER`.
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!method initialize(interaction_type:, description: nil)
+        #   @param interaction_type [Symbol, Telnyx::Models::Rcs::AgentInteraction::InteractionType]
+        #
+        #   @param description [String, nil] Required when interaction_type is `OTHER`.
+
+        # @see Telnyx::Models::Rcs::AgentInteraction#interaction_type
+        module InteractionType
+          extend Telnyx::Internal::Type::Enum
+
+          TRANSACTIONAL_UPDATES = :TRANSACTIONAL_UPDATES
+          CUSTOMER_SUPPORT = :CUSTOMER_SUPPORT
+          LOYALTY_OR_REWARD = :LOYALTY_OR_REWARD
+          MARKETING_OR_PROMOTIONAL = :MARKETING_OR_PROMOTIONAL
+          ACCOUNT_ALERTS = :ACCOUNT_ALERTS
+          TWO_WAY_CONVERSATION = :TWO_WAY_CONVERSATION
+          OTHER = :OTHER
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/agent_launch_params.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      # @see Telnyx::Resources::Rcs::Agents#launch
+      class AgentLaunchParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute campaign
+        #
+        #   @return [Telnyx::Models::Rcs::AgentLaunchParams::Campaign]
+        required :campaign, -> { Telnyx::Rcs::AgentLaunchParams::Campaign }
+
+        # @!attribute testing
+        #
+        #   @return [Telnyx::Models::Rcs::AgentTestingConfiguration]
+        required :testing, -> { Telnyx::Rcs::AgentTestingConfiguration }
+
+        # @!method initialize(id:, campaign:, testing:, request_options: {})
+        #   @param id [String]
+        #   @param campaign [Telnyx::Models::Rcs::AgentLaunchParams::Campaign]
+        #   @param testing [Telnyx::Models::Rcs::AgentTestingConfiguration]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        class Campaign < Telnyx::Models::Rcs::AgentCampaignConfiguration
+          # @!attribute agent_overview
+          #
+          #   @return [String]
+          required :agent_overview, String
+
+          # @!attribute consent_settings
+          #
+          #   @return [Telnyx::Models::Rcs::AgentConsentConfiguration]
+          required :consent_settings, -> { Telnyx::Rcs::AgentConsentConfiguration }
+
+          # @!attribute interactions
+          #
+          #   @return [Array<Telnyx::Models::Rcs::AgentInteraction>]
+          required :interactions, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Rcs::AgentInteraction] }
+
+          # @!attribute message_examples
+          #
+          #   @return [Array<String>]
+          required :message_examples, Telnyx::Internal::Type::ArrayOf[String]
+
+          # @!method initialize(agent_overview:, consent_settings:, interactions:, message_examples:)
+          #   @param agent_overview [String]
+          #   @param consent_settings [Telnyx::Models::Rcs::AgentConsentConfiguration]
+          #   @param interactions [Array<Telnyx::Models::Rcs::AgentInteraction>]
+          #   @param message_examples [Array<String>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/agent_list_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      # @see Telnyx::Resources::Rcs::Agents#list
+      class AgentListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute brand_id
+        #   Only return agents belonging to this brand.
+        #
+        #   @return [String, nil]
+        optional :brand_id, String
+
+        # @!method initialize(brand_id: nil, request_options: {})
+        #   @param brand_id [String] Only return agents belonging to this brand.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/agent_list_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      # @type [Telnyx::Internal::Type::Converter]
+      AgentListResponse = Telnyx::Internal::Type::ArrayOf[-> { Telnyx::Rcs::AgentResponse }]
+    end
+  end
+end

data/lib/telnyx/models/rcs/agent_phone_contact.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      class AgentPhoneContact < Telnyx::Internal::Type::BaseModel
+        # @!attribute label
+        #
+        #   @return [String]
+        required :label, String
+
+        # @!attribute number
+        #
+        #   @return [String]
+        required :number, String
+
+        # @!method initialize(label:, number:)
+        #   @param label [String]
+        #   @param number [String]
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/agent_response.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      # @see Telnyx::Resources::Rcs::Agents#create
+      class AgentResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute agent_id
+        #
+        #   @return [String]
+        required :agent_id, String
+
+        # @!attribute basics_status
+        #
+        #   @return [Symbol, Telnyx::Models::Rcs::AgentSubmissionStatus, nil]
+        required :basics_status, enum: -> { Telnyx::Rcs::AgentSubmissionStatus }, nil?: true
+
+        # @!attribute billing_category
+        #
+        #   @return [Symbol, Telnyx::Models::Rcs::AgentResponse::BillingCategory, nil]
+        required :billing_category, enum: -> { Telnyx::Rcs::AgentResponse::BillingCategory }, nil?: true
+
+        # @!attribute brand_id
+        #
+        #   @return [String]
+        required :brand_id, String
+
+        # @!attribute campaign_status
+        #
+        #   @return [Symbol, Telnyx::Models::Rcs::AgentSubmissionStatus, nil]
+        required :campaign_status, enum: -> { Telnyx::Rcs::AgentSubmissionStatus }, nil?: true
+
+        # @!attribute capabilities
+        #
+        #   @return [Telnyx::Models::Rcs::CapabilitiesResponse]
+        required :capabilities, -> { Telnyx::Rcs::CapabilitiesResponse }
+
+        # @!attribute carrier_approvals
+        #
+        #   @return [Array<Telnyx::Models::Rcs::CarrierApprovalResponse>]
+        required :carrier_approvals, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Rcs::CarrierApprovalResponse] }
+
+        # @!attribute configuration
+        #
+        #   @return [Telnyx::Models::Rcs::AgentConfiguration]
+        required :configuration, -> { Telnyx::Rcs::AgentConfiguration }
+
+        # @!attribute display_name
+        #
+        #   @return [String]
+        required :display_name, String
+
+        # @!attribute hosting_region
+        #
+        #   @return [String, nil]
+        required :hosting_region, String, nil?: true
+
+        # @!attribute profile_id
+        #
+        #   @return [String, nil]
+        required :profile_id, String, nil?: true
+
+        # @!attribute status
+        #
+        #   @return [Symbol, Telnyx::Models::Rcs::AgentResponse::Status]
+        required :status, enum: -> { Telnyx::Rcs::AgentResponse::Status }
+
+        # @!attribute test_devices
+        #
+        #   @return [Array<Telnyx::Models::Rcs::Agents::TestDeviceResponse>]
+        required :test_devices, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Rcs::Agents::TestDeviceResponse] }
+
+        # @!attribute testing_status
+        #
+        #   @return [Symbol, Telnyx::Models::Rcs::AgentSubmissionStatus, nil]
+        required :testing_status, enum: -> { Telnyx::Rcs::AgentSubmissionStatus }, nil?: true
+
+        # @!attribute use_case
+        #
+        #   @return [Symbol, Telnyx::Models::Rcs::AgentUseCase]
+        required :use_case, enum: -> { Telnyx::Rcs::AgentUseCase }
+
+        # @!method initialize(agent_id:, basics_status:, billing_category:, brand_id:, campaign_status:, capabilities:, carrier_approvals:, configuration:, display_name:, hosting_region:, profile_id:, status:, test_devices:, testing_status:, use_case:)
+        #   @param agent_id [String]
+        #   @param basics_status [Symbol, Telnyx::Models::Rcs::AgentSubmissionStatus, nil]
+        #   @param billing_category [Symbol, Telnyx::Models::Rcs::AgentResponse::BillingCategory, nil]
+        #   @param brand_id [String]
+        #   @param campaign_status [Symbol, Telnyx::Models::Rcs::AgentSubmissionStatus, nil]
+        #   @param capabilities [Telnyx::Models::Rcs::CapabilitiesResponse]
+        #   @param carrier_approvals [Array<Telnyx::Models::Rcs::CarrierApprovalResponse>]
+        #   @param configuration [Telnyx::Models::Rcs::AgentConfiguration]
+        #   @param display_name [String]
+        #   @param hosting_region [String, nil]
+        #   @param profile_id [String, nil]
+        #   @param status [Symbol, Telnyx::Models::Rcs::AgentResponse::Status]
+        #   @param test_devices [Array<Telnyx::Models::Rcs::Agents::TestDeviceResponse>]
+        #   @param testing_status [Symbol, Telnyx::Models::Rcs::AgentSubmissionStatus, nil]
+        #   @param use_case [Symbol, Telnyx::Models::Rcs::AgentUseCase]
+
+        # @see Telnyx::Models::Rcs::AgentResponse#billing_category
+        module BillingCategory
+          extend Telnyx::Internal::Type::Enum
+
+          NON_CONVERSATIONAL = :NON_CONVERSATIONAL
+          CONVERSATIONAL = :CONVERSATIONAL
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Telnyx::Models::Rcs::AgentResponse#status
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          CREATED = :CREATED
+          SUBMITTED = :SUBMITTED
+          VERIFYING = :VERIFYING
+          VERIFIED = :VERIFIED
+          LAUNCHING = :LAUNCHING
+          LAUNCHED = :LAUNCHED
+          LIVE = :LIVE
+          REJECTED = :REJECTED
+          FAILED = :FAILED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/agent_retrieve_carrier_approvals_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      # @see Telnyx::Resources::Rcs::Agents#retrieve_carrier_approvals
+      class AgentRetrieveCarrierApprovalsParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:, request_options: {})
+        #   @param id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/agent_retrieve_carrier_approvals_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      # @type [Telnyx::Internal::Type::Converter]
+      AgentRetrieveCarrierApprovalsResponse =
+        Telnyx::Internal::Type::ArrayOf[-> { Telnyx::Rcs::CarrierApprovalResponse }]
+    end
+  end
+end

data/lib/telnyx/models/rcs/agent_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      # @see Telnyx::Resources::Rcs::Agents#retrieve
+      class AgentRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:, request_options: {})
+        #   @param id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/agent_submission_status.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      module AgentSubmissionStatus
+        extend Telnyx::Internal::Type::Enum
+
+        SUBMITTED = :SUBMITTED
+        APPROVED = :APPROVED
+        REJECTED = :REJECTED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/agent_submit_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      # @see Telnyx::Resources::Rcs::Agents#submit
+      class AgentSubmitParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:, request_options: {})
+        #   @param id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/agent_testing_configuration.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      class AgentTestingConfiguration < Telnyx::Internal::Type::BaseModel
+        # @!attribute test_url
+        #   A publicly accessible test video or evidence URL.
+        #
+        #   @return [String]
+        required :test_url, String
+
+        # @!attribute additional_information
+        #
+        #   @return [String, nil]
+        optional :additional_information, String, nil?: true
+
+        # @!attribute message_id
+        #
+        #   @return [String, nil]
+        optional :message_id, String, nil?: true
+
+        # @!method initialize(test_url:, additional_information: nil, message_id: nil)
+        #   @param test_url [String] A publicly accessible test video or evidence URL.
+        #
+        #   @param additional_information [String, nil]
+        #
+        #   @param message_id [String, nil]
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/agent_update_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      # @see Telnyx::Resources::Rcs::Agents#update
+      class AgentUpdateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute configuration
+        #
+        #   @return [Telnyx::Models::Rcs::AgentConfiguration, nil]
+        optional :configuration, -> { Telnyx::Rcs::AgentConfiguration }
+
+        # @!attribute display_name
+        #
+        #   @return [String, nil]
+        optional :display_name, String
+
+        # @!attribute hosting_region
+        #
+        #   @return [String, nil]
+        optional :hosting_region, String
+
+        # @!attribute profile_id
+        #
+        #   @return [String, nil]
+        optional :profile_id, String
+
+        # @!attribute use_case
+        #
+        #   @return [Symbol, Telnyx::Models::Rcs::AgentUseCase, nil]
+        optional :use_case, enum: -> { Telnyx::Rcs::AgentUseCase }
+
+        # @!method initialize(id:, configuration: nil, display_name: nil, hosting_region: nil, profile_id: nil, use_case: nil, request_options: {})
+        #   @param id [String]
+        #   @param configuration [Telnyx::Models::Rcs::AgentConfiguration]
+        #   @param display_name [String]
+        #   @param hosting_region [String]
+        #   @param profile_id [String]
+        #   @param use_case [Symbol, Telnyx::Models::Rcs::AgentUseCase]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/agent_use_case.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      module AgentUseCase
+        extend Telnyx::Internal::Type::Enum
+
+        MULTI_USE = :MULTI_USE
+        PROMOTIONAL = :PROMOTIONAL
+        TRANSACTIONAL = :TRANSACTIONAL
+        OTP = :OTP
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/agent_website_contact.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      class AgentWebsiteContact < Telnyx::Internal::Type::BaseModel
+        # @!attribute label
+        #
+        #   @return [String]
+        required :label, String
+
+        # @!attribute url
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(label:, url:)
+        #   @param label [String]
+        #   @param url [String]
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/agents/test_device_create_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      module Agents
+        # @see Telnyx::Resources::Rcs::Agents::TestDevices#create
+        class TestDeviceCreateParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute phone_number
+          #
+          #   @return [String]
+          required :phone_number, String
+
+          # @!method initialize(id:, phone_number:, request_options: {})
+          #   @param id [String]
+          #   @param phone_number [String]
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/agents/test_device_delete_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      module Agents
+        # @see Telnyx::Resources::Rcs::Agents::TestDevices#delete
+        class TestDeviceDeleteParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute test_device_id
+          #
+          #   @return [String]
+          required :test_device_id, String
+
+          # @!method initialize(id:, test_device_id:, request_options: {})
+          #   @param id [String]
+          #   @param test_device_id [String]
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/agents/test_device_list_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      module Agents
+        # @see Telnyx::Resources::Rcs::Agents::TestDevices#list
+        class TestDeviceListParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:, request_options: {})
+          #   @param id [String]
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/rcs/agents/test_device_list_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      module Agents
+        # @type [Telnyx::Internal::Type::Converter]
+        TestDeviceListResponse = Telnyx::Internal::Type::ArrayOf[-> {
+          Telnyx::Rcs::Agents::TestDeviceResponse
+        }]
+      end
+    end
+  end
+end