telnyx 5.159.0 → 5.161.0

data/sig/telnyx/models/rcs/agent_configuration.rbs

@@ -0,0 +1,250 @@
+module Telnyx
+  module Models
+    module Rcs
+      type agent_configuration =
+        {
+          basics: Telnyx::Models::Rcs::AgentConfiguration::basics,
+          campaign: Telnyx::Rcs::AgentCampaignConfiguration?,
+          testing: Telnyx::Rcs::AgentTestingConfiguration?
+        }
+
+      class AgentConfiguration < Telnyx::Internal::Type::BaseModel
+        attr_accessor basics: Telnyx::Models::Rcs::AgentConfiguration::basics
+
+        attr_accessor campaign: Telnyx::Rcs::AgentCampaignConfiguration?
+
+        attr_accessor testing: Telnyx::Rcs::AgentTestingConfiguration?
+
+        def initialize: (
+          basics: Telnyx::Models::Rcs::AgentConfiguration::basics,
+          ?campaign: Telnyx::Rcs::AgentCampaignConfiguration?,
+          ?testing: Telnyx::Rcs::AgentTestingConfiguration?
+        ) -> void
+
+        def to_hash: -> {
+          basics: Telnyx::Models::Rcs::AgentConfiguration::basics,
+          campaign: Telnyx::Rcs::AgentCampaignConfiguration?,
+          testing: Telnyx::Rcs::AgentTestingConfiguration?
+        }
+
+        type basics =
+          Telnyx::Rcs::AgentConfiguration::Basics::UnionMember0
+          | Telnyx::Rcs::AgentConfiguration::Basics::UnionMember1
+          | Telnyx::Rcs::AgentConfiguration::Basics::UnionMember2
+
+        module Basics
+          extend Telnyx::Internal::Type::Union
+
+          type union_member0 =
+            {
+              phone_number: Telnyx::Rcs::AgentPhoneContact,
+              brand_color: String,
+              description: String,
+              email: Telnyx::Rcs::AgentEmailContact?,
+              hero_url: String,
+              logo_url: String,
+              privacy_policy_url: String,
+              terms_and_conditions_url: String,
+              website: Telnyx::Rcs::AgentWebsiteContact?
+            }
+
+          class UnionMember0 < Telnyx::Internal::Type::BaseModel
+            attr_accessor phone_number: Telnyx::Rcs::AgentPhoneContact
+
+            attr_reader brand_color: String?
+
+            def brand_color=: (String) -> String
+
+            attr_reader description: String?
+
+            def description=: (String) -> String
+
+            attr_accessor email: Telnyx::Rcs::AgentEmailContact?
+
+            attr_reader hero_url: String?
+
+            def hero_url=: (String) -> String
+
+            attr_reader logo_url: String?
+
+            def logo_url=: (String) -> String
+
+            attr_reader privacy_policy_url: String?
+
+            def privacy_policy_url=: (String) -> String
+
+            attr_reader terms_and_conditions_url: String?
+
+            def terms_and_conditions_url=: (String) -> String
+
+            attr_accessor website: Telnyx::Rcs::AgentWebsiteContact?
+
+            def initialize: (
+              phone_number: Telnyx::Rcs::AgentPhoneContact,
+              ?brand_color: String,
+              ?description: String,
+              ?email: Telnyx::Rcs::AgentEmailContact?,
+              ?hero_url: String,
+              ?logo_url: String,
+              ?privacy_policy_url: String,
+              ?terms_and_conditions_url: String,
+              ?website: Telnyx::Rcs::AgentWebsiteContact?
+            ) -> void
+
+            def to_hash: -> {
+              phone_number: Telnyx::Rcs::AgentPhoneContact,
+              brand_color: String,
+              description: String,
+              email: Telnyx::Rcs::AgentEmailContact?,
+              hero_url: String,
+              logo_url: String,
+              privacy_policy_url: String,
+              terms_and_conditions_url: String,
+              website: Telnyx::Rcs::AgentWebsiteContact?
+            }
+          end
+
+          type union_member1 =
+            {
+              website: Telnyx::Rcs::AgentWebsiteContact,
+              brand_color: String,
+              description: String,
+              email: Telnyx::Rcs::AgentEmailContact?,
+              hero_url: String,
+              logo_url: String,
+              phone_number: Telnyx::Rcs::AgentPhoneContact?,
+              privacy_policy_url: String,
+              terms_and_conditions_url: String
+            }
+
+          class UnionMember1 < Telnyx::Internal::Type::BaseModel
+            attr_accessor website: Telnyx::Rcs::AgentWebsiteContact
+
+            attr_reader brand_color: String?
+
+            def brand_color=: (String) -> String
+
+            attr_reader description: String?
+
+            def description=: (String) -> String
+
+            attr_accessor email: Telnyx::Rcs::AgentEmailContact?
+
+            attr_reader hero_url: String?
+
+            def hero_url=: (String) -> String
+
+            attr_reader logo_url: String?
+
+            def logo_url=: (String) -> String
+
+            attr_accessor phone_number: Telnyx::Rcs::AgentPhoneContact?
+
+            attr_reader privacy_policy_url: String?
+
+            def privacy_policy_url=: (String) -> String
+
+            attr_reader terms_and_conditions_url: String?
+
+            def terms_and_conditions_url=: (String) -> String
+
+            def initialize: (
+              website: Telnyx::Rcs::AgentWebsiteContact,
+              ?brand_color: String,
+              ?description: String,
+              ?email: Telnyx::Rcs::AgentEmailContact?,
+              ?hero_url: String,
+              ?logo_url: String,
+              ?phone_number: Telnyx::Rcs::AgentPhoneContact?,
+              ?privacy_policy_url: String,
+              ?terms_and_conditions_url: String
+            ) -> void
+
+            def to_hash: -> {
+              website: Telnyx::Rcs::AgentWebsiteContact,
+              brand_color: String,
+              description: String,
+              email: Telnyx::Rcs::AgentEmailContact?,
+              hero_url: String,
+              logo_url: String,
+              phone_number: Telnyx::Rcs::AgentPhoneContact?,
+              privacy_policy_url: String,
+              terms_and_conditions_url: String
+            }
+          end
+
+          type union_member2 =
+            {
+              email: Telnyx::Rcs::AgentEmailContact,
+              brand_color: String,
+              description: String,
+              hero_url: String,
+              logo_url: String,
+              phone_number: Telnyx::Rcs::AgentPhoneContact?,
+              privacy_policy_url: String,
+              terms_and_conditions_url: String,
+              website: Telnyx::Rcs::AgentWebsiteContact?
+            }
+
+          class UnionMember2 < Telnyx::Internal::Type::BaseModel
+            attr_accessor email: Telnyx::Rcs::AgentEmailContact
+
+            attr_reader brand_color: String?
+
+            def brand_color=: (String) -> String
+
+            attr_reader description: String?
+
+            def description=: (String) -> String
+
+            attr_reader hero_url: String?
+
+            def hero_url=: (String) -> String
+
+            attr_reader logo_url: String?
+
+            def logo_url=: (String) -> String
+
+            attr_accessor phone_number: Telnyx::Rcs::AgentPhoneContact?
+
+            attr_reader privacy_policy_url: String?
+
+            def privacy_policy_url=: (String) -> String
+
+            attr_reader terms_and_conditions_url: String?
+
+            def terms_and_conditions_url=: (String) -> String
+
+            attr_accessor website: Telnyx::Rcs::AgentWebsiteContact?
+
+            def initialize: (
+              email: Telnyx::Rcs::AgentEmailContact,
+              ?brand_color: String,
+              ?description: String,
+              ?hero_url: String,
+              ?logo_url: String,
+              ?phone_number: Telnyx::Rcs::AgentPhoneContact?,
+              ?privacy_policy_url: String,
+              ?terms_and_conditions_url: String,
+              ?website: Telnyx::Rcs::AgentWebsiteContact?
+            ) -> void
+
+            def to_hash: -> {
+              email: Telnyx::Rcs::AgentEmailContact,
+              brand_color: String,
+              description: String,
+              hero_url: String,
+              logo_url: String,
+              phone_number: Telnyx::Rcs::AgentPhoneContact?,
+              privacy_policy_url: String,
+              terms_and_conditions_url: String,
+              website: Telnyx::Rcs::AgentWebsiteContact?
+            }
+          end
+
+          def self?.variants: -> ::Array[Telnyx::Models::Rcs::AgentConfiguration::basics]
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/rcs/agent_consent_configuration.rbs

@@ -0,0 +1,100 @@
+module Telnyx
+  module Models
+    module Rcs
+      type agent_consent_configuration =
+        {
+          call_to_action: String,
+          double_opt_in: bool,
+          help_response: String,
+          opt_in_message: String,
+          opt_in_methods: ::Array[Telnyx::Rcs::AgentConsentConfiguration::OptInMethod],
+          opt_out_response: String,
+          call_to_action_media_url: String?,
+          call_to_action_url: String?,
+          double_opt_in_message: String?
+        }
+
+      class AgentConsentConfiguration < Telnyx::Internal::Type::BaseModel
+        attr_accessor call_to_action: String
+
+        attr_accessor double_opt_in: bool
+
+        attr_accessor help_response: String
+
+        attr_accessor opt_in_message: String
+
+        attr_accessor opt_in_methods: ::Array[Telnyx::Rcs::AgentConsentConfiguration::OptInMethod]
+
+        attr_accessor opt_out_response: String
+
+        attr_accessor call_to_action_media_url: String?
+
+        attr_accessor call_to_action_url: String?
+
+        attr_accessor double_opt_in_message: String?
+
+        def initialize: (
+          call_to_action: String,
+          double_opt_in: bool,
+          help_response: String,
+          opt_in_message: String,
+          opt_in_methods: ::Array[Telnyx::Rcs::AgentConsentConfiguration::OptInMethod],
+          opt_out_response: String,
+          ?call_to_action_media_url: String?,
+          ?call_to_action_url: String?,
+          ?double_opt_in_message: String?
+        ) -> void
+
+        def to_hash: -> {
+          call_to_action: String,
+          double_opt_in: bool,
+          help_response: String,
+          opt_in_message: String,
+          opt_in_methods: ::Array[Telnyx::Rcs::AgentConsentConfiguration::OptInMethod],
+          opt_out_response: String,
+          call_to_action_media_url: String?,
+          call_to_action_url: String?,
+          double_opt_in_message: String?
+        }
+
+        type opt_in_method =
+          {
+            method_type: Telnyx::Models::Rcs::AgentConsentConfiguration::OptInMethod::method_type,
+            description: String?
+          }
+
+        class OptInMethod < Telnyx::Internal::Type::BaseModel
+          attr_accessor method_type: Telnyx::Models::Rcs::AgentConsentConfiguration::OptInMethod::method_type
+
+          attr_accessor description: String?
+
+          def initialize: (
+            method_type: Telnyx::Models::Rcs::AgentConsentConfiguration::OptInMethod::method_type,
+            ?description: String?
+          ) -> void
+
+          def to_hash: -> {
+            method_type: Telnyx::Models::Rcs::AgentConsentConfiguration::OptInMethod::method_type,
+            description: String?
+          }
+
+          type method_type =
+            :SMS | :WEBSITE | :MOBILE_APP | :QR_CODE | :SALE_POINT | :OTHER
+
+          module MethodType
+            extend Telnyx::Internal::Type::Enum
+
+            SMS: :SMS
+            WEBSITE: :WEBSITE
+            MOBILE_APP: :MOBILE_APP
+            QR_CODE: :QR_CODE
+            SALE_POINT: :SALE_POINT
+            OTHER: :OTHER
+
+            def self?.values: -> ::Array[Telnyx::Models::Rcs::AgentConsentConfiguration::OptInMethod::method_type]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/rcs/agent_create_params.rbs

@@ -0,0 +1,58 @@
+module Telnyx
+  module Models
+    module Rcs
+      type agent_create_params =
+        {
+          brand_id: String,
+          configuration: Telnyx::Rcs::AgentConfiguration,
+          display_name: String,
+          use_case: Telnyx::Models::Rcs::agent_use_case,
+          idempotency_key: String,
+          hosting_region: String?,
+          profile_id: String?
+        }
+        & Telnyx::Internal::Type::request_parameters
+
+      class AgentCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        attr_accessor brand_id: String
+
+        attr_accessor configuration: Telnyx::Rcs::AgentConfiguration
+
+        attr_accessor display_name: String
+
+        attr_accessor use_case: Telnyx::Models::Rcs::agent_use_case
+
+        attr_accessor idempotency_key: String
+
+        attr_accessor hosting_region: String?
+
+        attr_accessor profile_id: String?
+
+        def initialize: (
+          brand_id: String,
+          configuration: Telnyx::Rcs::AgentConfiguration,
+          display_name: String,
+          use_case: Telnyx::Models::Rcs::agent_use_case,
+          idempotency_key: String,
+          ?hosting_region: String?,
+          ?profile_id: String?,
+          ?request_options: Telnyx::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          brand_id: String,
+          configuration: Telnyx::Rcs::AgentConfiguration,
+          display_name: String,
+          use_case: Telnyx::Models::Rcs::agent_use_case,
+          idempotency_key: String,
+          hosting_region: String?,
+          profile_id: String?,
+          request_options: Telnyx::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/telnyx/models/rcs/agent_email_contact.rbs

@@ -0,0 +1,17 @@
+module Telnyx
+  module Models
+    module Rcs
+      type agent_email_contact = { address: String, label: String }
+
+      class AgentEmailContact < Telnyx::Internal::Type::BaseModel
+        attr_accessor address: String
+
+        attr_accessor label: String
+
+        def initialize: (address: String, label: String) -> void
+
+        def to_hash: -> { address: String, label: String }
+      end
+    end
+  end
+end

data/sig/telnyx/models/rcs/agent_interaction.rbs

@@ -0,0 +1,50 @@
+module Telnyx
+  module Models
+    module Rcs
+      type agent_interaction =
+        {
+          interaction_type: Telnyx::Models::Rcs::AgentInteraction::interaction_type,
+          description: String?
+        }
+
+      class AgentInteraction < Telnyx::Internal::Type::BaseModel
+        attr_accessor interaction_type: Telnyx::Models::Rcs::AgentInteraction::interaction_type
+
+        attr_accessor description: String?
+
+        def initialize: (
+          interaction_type: Telnyx::Models::Rcs::AgentInteraction::interaction_type,
+          ?description: String?
+        ) -> void
+
+        def to_hash: -> {
+          interaction_type: Telnyx::Models::Rcs::AgentInteraction::interaction_type,
+          description: String?
+        }
+
+        type interaction_type =
+          :TRANSACTIONAL_UPDATES
+          | :CUSTOMER_SUPPORT
+          | :LOYALTY_OR_REWARD
+          | :MARKETING_OR_PROMOTIONAL
+          | :ACCOUNT_ALERTS
+          | :TWO_WAY_CONVERSATION
+          | :OTHER
+
+        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
+
+          def self?.values: -> ::Array[Telnyx::Models::Rcs::AgentInteraction::interaction_type]
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/rcs/agent_launch_params.rbs

@@ -0,0 +1,82 @@
+module Telnyx
+  module Models
+    module Rcs
+      type agent_launch_params =
+        {
+          id: String,
+          campaign: Telnyx::Rcs::AgentLaunchParams::Campaign,
+          testing: Telnyx::Rcs::AgentTestingConfiguration
+        }
+        & Telnyx::Internal::Type::request_parameters
+
+      class AgentLaunchParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_accessor campaign: Telnyx::Rcs::AgentLaunchParams::Campaign
+
+        attr_accessor testing: Telnyx::Rcs::AgentTestingConfiguration
+
+        def initialize: (
+          id: String,
+          campaign: Telnyx::Rcs::AgentLaunchParams::Campaign,
+          testing: Telnyx::Rcs::AgentTestingConfiguration,
+          ?request_options: Telnyx::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          campaign: Telnyx::Rcs::AgentLaunchParams::Campaign,
+          testing: Telnyx::Rcs::AgentTestingConfiguration,
+          request_options: Telnyx::RequestOptions
+        }
+
+        type campaign =
+          {
+            agent_overview: String,
+            consent_settings: Telnyx::Rcs::AgentConsentConfiguration,
+            interactions: ::Array[Telnyx::Rcs::AgentInteraction],
+            message_examples: ::Array[String]
+          }
+
+        class Campaign < Telnyx::Models::Rcs::AgentCampaignConfiguration
+          def agent_overview: -> String
+
+          def agent_overview=: (String _) -> String
+
+          def consent_settings: -> Telnyx::Rcs::AgentConsentConfiguration
+
+          def consent_settings=: (
+            Telnyx::Rcs::AgentConsentConfiguration _
+          ) -> Telnyx::Rcs::AgentConsentConfiguration
+
+          def interactions: -> ::Array[Telnyx::Rcs::AgentInteraction]
+
+          def interactions=: (
+            ::Array[Telnyx::Rcs::AgentInteraction] _
+          ) -> ::Array[Telnyx::Rcs::AgentInteraction]
+
+          def message_examples: -> ::Array[String]
+
+          def message_examples=: (::Array[String] _) -> ::Array[String]
+
+          def initialize: (
+            agent_overview: String,
+            consent_settings: Telnyx::Rcs::AgentConsentConfiguration,
+            interactions: ::Array[Telnyx::Rcs::AgentInteraction],
+            message_examples: ::Array[String]
+          ) -> void
+
+          def to_hash: -> {
+            agent_overview: String,
+            consent_settings: Telnyx::Rcs::AgentConsentConfiguration,
+            interactions: ::Array[Telnyx::Rcs::AgentInteraction],
+            message_examples: ::Array[String]
+          }
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/rcs/agent_list_params.rbs

@@ -0,0 +1,27 @@
+module Telnyx
+  module Models
+    module Rcs
+      type agent_list_params =
+        { brand_id: String } & Telnyx::Internal::Type::request_parameters
+
+      class AgentListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        attr_reader brand_id: String?
+
+        def brand_id=: (String) -> String
+
+        def initialize: (
+          ?brand_id: String,
+          ?request_options: Telnyx::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          brand_id: String,
+          request_options: Telnyx::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/telnyx/models/rcs/agent_list_response.rbs

@@ -0,0 +1,9 @@
+module Telnyx
+  module Models
+    module Rcs
+      type agent_list_response = ::Array[Telnyx::Rcs::AgentResponse]
+
+      AgentListResponse: Telnyx::Internal::Type::Converter
+    end
+  end
+end

data/sig/telnyx/models/rcs/agent_phone_contact.rbs

@@ -0,0 +1,17 @@
+module Telnyx
+  module Models
+    module Rcs
+      type agent_phone_contact = { label: String, number: String }
+
+      class AgentPhoneContact < Telnyx::Internal::Type::BaseModel
+        attr_accessor label: String
+
+        attr_accessor number: String
+
+        def initialize: (label: String, number: String) -> void
+
+        def to_hash: -> { label: String, number: String }
+      end
+    end
+  end
+end