telnyx 5.159.0 → 5.160.0

data/rbi/telnyx/models/rcs/agent_create_params.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Rcs
+      class AgentCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Rcs::AgentCreateParams, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :brand_id
+
+        sig { returns(Telnyx::Rcs::AgentConfiguration) }
+        attr_reader :configuration
+
+        sig do
+          params(configuration: Telnyx::Rcs::AgentConfiguration::OrHash).void
+        end
+        attr_writer :configuration
+
+        sig { returns(String) }
+        attr_accessor :display_name
+
+        sig { returns(Telnyx::Rcs::AgentUseCase::OrSymbol) }
+        attr_accessor :use_case
+
+        sig { returns(String) }
+        attr_accessor :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :hosting_region
+
+        # A Messaging Profile owned by the authenticated organization. When omitted, the
+        # agent inherits the brand profile.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :profile_id
+
+        sig do
+          params(
+            brand_id: String,
+            configuration: Telnyx::Rcs::AgentConfiguration::OrHash,
+            display_name: String,
+            use_case: Telnyx::Rcs::AgentUseCase::OrSymbol,
+            idempotency_key: String,
+            hosting_region: T.nilable(String),
+            profile_id: T.nilable(String),
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          brand_id:,
+          configuration:,
+          display_name:,
+          use_case:,
+          idempotency_key:,
+          hosting_region: nil,
+          # A Messaging Profile owned by the authenticated organization. When omitted, the
+          # agent inherits the brand profile.
+          profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              brand_id: String,
+              configuration: Telnyx::Rcs::AgentConfiguration,
+              display_name: String,
+              use_case: Telnyx::Rcs::AgentUseCase::OrSymbol,
+              idempotency_key: String,
+              hosting_region: T.nilable(String),
+              profile_id: T.nilable(String),
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/rcs/agent_email_contact.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Rcs
+      class AgentEmailContact < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Rcs::AgentEmailContact, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :address
+
+        sig { returns(String) }
+        attr_accessor :label
+
+        sig { params(address: String, label: String).returns(T.attached_class) }
+        def self.new(address:, label:)
+        end
+
+        sig { override.returns({ address: String, label: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/rcs/agent_interaction.rbi

@@ -0,0 +1,105 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Rcs
+      class AgentInteraction < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Rcs::AgentInteraction, Telnyx::Internal::AnyHash)
+          end
+
+        sig do
+          returns(Telnyx::Rcs::AgentInteraction::InteractionType::OrSymbol)
+        end
+        attr_accessor :interaction_type
+
+        # Required when interaction_type is `OTHER`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        sig do
+          params(
+            interaction_type:
+              Telnyx::Rcs::AgentInteraction::InteractionType::OrSymbol,
+            description: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          interaction_type:,
+          # Required when interaction_type is `OTHER`.
+          description: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              interaction_type:
+                Telnyx::Rcs::AgentInteraction::InteractionType::OrSymbol,
+              description: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module InteractionType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::Rcs::AgentInteraction::InteractionType)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          TRANSACTIONAL_UPDATES =
+            T.let(
+              :TRANSACTIONAL_UPDATES,
+              Telnyx::Rcs::AgentInteraction::InteractionType::TaggedSymbol
+            )
+          CUSTOMER_SUPPORT =
+            T.let(
+              :CUSTOMER_SUPPORT,
+              Telnyx::Rcs::AgentInteraction::InteractionType::TaggedSymbol
+            )
+          LOYALTY_OR_REWARD =
+            T.let(
+              :LOYALTY_OR_REWARD,
+              Telnyx::Rcs::AgentInteraction::InteractionType::TaggedSymbol
+            )
+          MARKETING_OR_PROMOTIONAL =
+            T.let(
+              :MARKETING_OR_PROMOTIONAL,
+              Telnyx::Rcs::AgentInteraction::InteractionType::TaggedSymbol
+            )
+          ACCOUNT_ALERTS =
+            T.let(
+              :ACCOUNT_ALERTS,
+              Telnyx::Rcs::AgentInteraction::InteractionType::TaggedSymbol
+            )
+          TWO_WAY_CONVERSATION =
+            T.let(
+              :TWO_WAY_CONVERSATION,
+              Telnyx::Rcs::AgentInteraction::InteractionType::TaggedSymbol
+            )
+          OTHER =
+            T.let(
+              :OTHER,
+              Telnyx::Rcs::AgentInteraction::InteractionType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Rcs::AgentInteraction::InteractionType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/rcs/agent_launch_params.rbi

@@ -0,0 +1,120 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Rcs
+      class AgentLaunchParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Rcs::AgentLaunchParams, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Telnyx::Rcs::AgentLaunchParams::Campaign) }
+        attr_reader :campaign
+
+        sig do
+          params(
+            campaign: Telnyx::Rcs::AgentLaunchParams::Campaign::OrHash
+          ).void
+        end
+        attr_writer :campaign
+
+        sig { returns(Telnyx::Rcs::AgentTestingConfiguration) }
+        attr_reader :testing
+
+        sig do
+          params(testing: Telnyx::Rcs::AgentTestingConfiguration::OrHash).void
+        end
+        attr_writer :testing
+
+        sig do
+          params(
+            id: String,
+            campaign: Telnyx::Rcs::AgentLaunchParams::Campaign::OrHash,
+            testing: Telnyx::Rcs::AgentTestingConfiguration::OrHash,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(id:, campaign:, testing:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              campaign: Telnyx::Rcs::AgentLaunchParams::Campaign,
+              testing: Telnyx::Rcs::AgentTestingConfiguration,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Campaign < Telnyx::Models::Rcs::AgentCampaignConfiguration
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Rcs::AgentLaunchParams::Campaign,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :agent_overview
+
+          sig { returns(Telnyx::Rcs::AgentConsentConfiguration) }
+          attr_reader :consent_settings
+
+          sig do
+            params(
+              consent_settings: Telnyx::Rcs::AgentConsentConfiguration::OrHash
+            ).void
+          end
+          attr_writer :consent_settings
+
+          sig { returns(T::Array[Telnyx::Rcs::AgentInteraction]) }
+          attr_accessor :interactions
+
+          sig { returns(T::Array[String]) }
+          attr_accessor :message_examples
+
+          sig do
+            params(
+              agent_overview: String,
+              consent_settings: Telnyx::Rcs::AgentConsentConfiguration::OrHash,
+              interactions: T::Array[Telnyx::Rcs::AgentInteraction::OrHash],
+              message_examples: T::Array[String]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            agent_overview:,
+            consent_settings:,
+            interactions:,
+            message_examples:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                agent_overview: String,
+                consent_settings: Telnyx::Rcs::AgentConsentConfiguration,
+                interactions: T::Array[Telnyx::Rcs::AgentInteraction],
+                message_examples: T::Array[String]
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/rcs/agent_list_params.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Rcs
+      class AgentListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Rcs::AgentListParams, Telnyx::Internal::AnyHash)
+          end
+
+        # Only return agents belonging to this brand.
+        sig { returns(T.nilable(String)) }
+        attr_reader :brand_id
+
+        sig { params(brand_id: String).void }
+        attr_writer :brand_id
+
+        sig do
+          params(
+            brand_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Only return agents belonging to this brand.
+          brand_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            { brand_id: String, request_options: Telnyx::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/rcs/agent_list_response.rbi

@@ -0,0 +1,13 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Rcs
+      AgentListResponse =
+        T.let(
+          Telnyx::Internal::Type::ArrayOf[Telnyx::Rcs::AgentResponse],
+          Telnyx::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/telnyx/models/rcs/agent_phone_contact.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Rcs
+      class AgentPhoneContact < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Rcs::AgentPhoneContact, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :label
+
+        sig { returns(String) }
+        attr_accessor :number
+
+        sig { params(label: String, number: String).returns(T.attached_class) }
+        def self.new(label:, number:)
+        end
+
+        sig { override.returns({ label: String, number: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/rcs/agent_response.rbi

@@ -0,0 +1,218 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Rcs
+      class AgentResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Rcs::AgentResponse, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :agent_id
+
+        sig do
+          returns(T.nilable(Telnyx::Rcs::AgentSubmissionStatus::TaggedSymbol))
+        end
+        attr_accessor :basics_status
+
+        sig do
+          returns(
+            T.nilable(Telnyx::Rcs::AgentResponse::BillingCategory::TaggedSymbol)
+          )
+        end
+        attr_accessor :billing_category
+
+        sig { returns(String) }
+        attr_accessor :brand_id
+
+        sig do
+          returns(T.nilable(Telnyx::Rcs::AgentSubmissionStatus::TaggedSymbol))
+        end
+        attr_accessor :campaign_status
+
+        sig { returns(Telnyx::Rcs::CapabilitiesResponse) }
+        attr_reader :capabilities
+
+        sig do
+          params(capabilities: Telnyx::Rcs::CapabilitiesResponse::OrHash).void
+        end
+        attr_writer :capabilities
+
+        sig { returns(T::Array[Telnyx::Rcs::CarrierApprovalResponse]) }
+        attr_accessor :carrier_approvals
+
+        sig { returns(Telnyx::Rcs::AgentConfiguration) }
+        attr_reader :configuration
+
+        sig do
+          params(configuration: Telnyx::Rcs::AgentConfiguration::OrHash).void
+        end
+        attr_writer :configuration
+
+        sig { returns(String) }
+        attr_accessor :display_name
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :hosting_region
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :profile_id
+
+        sig { returns(Telnyx::Rcs::AgentResponse::Status::TaggedSymbol) }
+        attr_accessor :status
+
+        sig { returns(T::Array[Telnyx::Rcs::Agents::TestDeviceResponse]) }
+        attr_accessor :test_devices
+
+        sig do
+          returns(T.nilable(Telnyx::Rcs::AgentSubmissionStatus::TaggedSymbol))
+        end
+        attr_accessor :testing_status
+
+        sig { returns(Telnyx::Rcs::AgentUseCase::TaggedSymbol) }
+        attr_accessor :use_case
+
+        sig do
+          params(
+            agent_id: String,
+            basics_status:
+              T.nilable(Telnyx::Rcs::AgentSubmissionStatus::OrSymbol),
+            billing_category:
+              T.nilable(Telnyx::Rcs::AgentResponse::BillingCategory::OrSymbol),
+            brand_id: String,
+            campaign_status:
+              T.nilable(Telnyx::Rcs::AgentSubmissionStatus::OrSymbol),
+            capabilities: Telnyx::Rcs::CapabilitiesResponse::OrHash,
+            carrier_approvals:
+              T::Array[Telnyx::Rcs::CarrierApprovalResponse::OrHash],
+            configuration: Telnyx::Rcs::AgentConfiguration::OrHash,
+            display_name: String,
+            hosting_region: T.nilable(String),
+            profile_id: T.nilable(String),
+            status: Telnyx::Rcs::AgentResponse::Status::OrSymbol,
+            test_devices:
+              T::Array[Telnyx::Rcs::Agents::TestDeviceResponse::OrHash],
+            testing_status:
+              T.nilable(Telnyx::Rcs::AgentSubmissionStatus::OrSymbol),
+            use_case: Telnyx::Rcs::AgentUseCase::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          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:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              agent_id: String,
+              basics_status:
+                T.nilable(Telnyx::Rcs::AgentSubmissionStatus::TaggedSymbol),
+              billing_category:
+                T.nilable(
+                  Telnyx::Rcs::AgentResponse::BillingCategory::TaggedSymbol
+                ),
+              brand_id: String,
+              campaign_status:
+                T.nilable(Telnyx::Rcs::AgentSubmissionStatus::TaggedSymbol),
+              capabilities: Telnyx::Rcs::CapabilitiesResponse,
+              carrier_approvals: T::Array[Telnyx::Rcs::CarrierApprovalResponse],
+              configuration: Telnyx::Rcs::AgentConfiguration,
+              display_name: String,
+              hosting_region: T.nilable(String),
+              profile_id: T.nilable(String),
+              status: Telnyx::Rcs::AgentResponse::Status::TaggedSymbol,
+              test_devices: T::Array[Telnyx::Rcs::Agents::TestDeviceResponse],
+              testing_status:
+                T.nilable(Telnyx::Rcs::AgentSubmissionStatus::TaggedSymbol),
+              use_case: Telnyx::Rcs::AgentUseCase::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module BillingCategory
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::Rcs::AgentResponse::BillingCategory)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          NON_CONVERSATIONAL =
+            T.let(
+              :NON_CONVERSATIONAL,
+              Telnyx::Rcs::AgentResponse::BillingCategory::TaggedSymbol
+            )
+          CONVERSATIONAL =
+            T.let(
+              :CONVERSATIONAL,
+              Telnyx::Rcs::AgentResponse::BillingCategory::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Rcs::AgentResponse::BillingCategory::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Telnyx::Rcs::AgentResponse::Status) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CREATED =
+            T.let(:CREATED, Telnyx::Rcs::AgentResponse::Status::TaggedSymbol)
+          SUBMITTED =
+            T.let(:SUBMITTED, Telnyx::Rcs::AgentResponse::Status::TaggedSymbol)
+          VERIFYING =
+            T.let(:VERIFYING, Telnyx::Rcs::AgentResponse::Status::TaggedSymbol)
+          VERIFIED =
+            T.let(:VERIFIED, Telnyx::Rcs::AgentResponse::Status::TaggedSymbol)
+          LAUNCHING =
+            T.let(:LAUNCHING, Telnyx::Rcs::AgentResponse::Status::TaggedSymbol)
+          LAUNCHED =
+            T.let(:LAUNCHED, Telnyx::Rcs::AgentResponse::Status::TaggedSymbol)
+          LIVE = T.let(:LIVE, Telnyx::Rcs::AgentResponse::Status::TaggedSymbol)
+          REJECTED =
+            T.let(:REJECTED, Telnyx::Rcs::AgentResponse::Status::TaggedSymbol)
+          FAILED =
+            T.let(:FAILED, Telnyx::Rcs::AgentResponse::Status::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::Rcs::AgentResponse::Status::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/rcs/agent_retrieve_carrier_approvals_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Rcs
+      class AgentRetrieveCarrierApprovalsParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Rcs::AgentRetrieveCarrierApprovalsParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig do
+          params(
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { id: String, request_options: Telnyx::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/rcs/agent_retrieve_carrier_approvals_response.rbi

@@ -0,0 +1,13 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Rcs
+      AgentRetrieveCarrierApprovalsResponse =
+        T.let(
+          Telnyx::Internal::Type::ArrayOf[Telnyx::Rcs::CarrierApprovalResponse],
+          Telnyx::Internal::Type::Converter
+        )
+    end
+  end
+end