telnyx 5.159.0 → 5.161.0

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      class AgentCampaignConfiguration < Telnyx::Internal::Type::BaseModel
+        # @!attribute company_overview
+        #
+        #   @return [String]
+        required :company_overview, String
+
+        # @!attribute additional_information
+        #
+        #   @return [String, nil]
+        optional :additional_information, String, nil?: true
+
+        # @!attribute agent_overview
+        #
+        #   @return [String, nil]
+        optional :agent_overview, String, nil?: true
+
+        # @!attribute consent_settings
+        #
+        #   @return [Telnyx::Models::Rcs::AgentConsentConfiguration, nil]
+        optional :consent_settings, -> { Telnyx::Rcs::AgentConsentConfiguration }, nil?: true
+
+        # @!attribute interactions
+        #
+        #   @return [Array<Telnyx::Models::Rcs::AgentInteraction>, nil]
+        optional :interactions, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Rcs::AgentInteraction] }
+
+        # @!attribute message_examples
+        #
+        #   @return [Array<String>, nil]
+        optional :message_examples, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(company_overview:, additional_information: nil, agent_overview: nil, consent_settings: nil, interactions: nil, message_examples: nil)
+        #   @param company_overview [String]
+        #   @param additional_information [String, nil]
+        #   @param agent_overview [String, nil]
+        #   @param consent_settings [Telnyx::Models::Rcs::AgentConsentConfiguration, nil]
+        #   @param interactions [Array<Telnyx::Models::Rcs::AgentInteraction>]
+        #   @param message_examples [Array<String>]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,227 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      class AgentConfiguration < Telnyx::Internal::Type::BaseModel
+        # @!attribute basics
+        #   Basic agent identity and contact information. At least one complete phone,
+        #   website, or email contact is required.
+        #
+        #   @return [Telnyx::Models::Rcs::AgentConfiguration::Basics::UnionMember0, Telnyx::Models::Rcs::AgentConfiguration::Basics::UnionMember1, Telnyx::Models::Rcs::AgentConfiguration::Basics::UnionMember2]
+        required :basics, union: -> { Telnyx::Rcs::AgentConfiguration::Basics }
+
+        # @!attribute campaign
+        #
+        #   @return [Telnyx::Models::Rcs::AgentCampaignConfiguration, nil]
+        optional :campaign, -> { Telnyx::Rcs::AgentCampaignConfiguration }, nil?: true
+
+        # @!attribute testing
+        #
+        #   @return [Telnyx::Models::Rcs::AgentTestingConfiguration, nil]
+        optional :testing, -> { Telnyx::Rcs::AgentTestingConfiguration }, nil?: true
+
+        # @!method initialize(basics:, campaign: nil, testing: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Rcs::AgentConfiguration} for more details.
+        #
+        #   @param basics [Telnyx::Models::Rcs::AgentConfiguration::Basics::UnionMember0, Telnyx::Models::Rcs::AgentConfiguration::Basics::UnionMember1, Telnyx::Models::Rcs::AgentConfiguration::Basics::UnionMember2] Basic agent identity and contact information. At least one complete phone, websi
+        #
+        #   @param campaign [Telnyx::Models::Rcs::AgentCampaignConfiguration, nil]
+        #
+        #   @param testing [Telnyx::Models::Rcs::AgentTestingConfiguration, nil]
+
+        # Basic agent identity and contact information. At least one complete phone,
+        # website, or email contact is required.
+        #
+        # @see Telnyx::Models::Rcs::AgentConfiguration#basics
+        module Basics
+          extend Telnyx::Internal::Type::Union
+
+          variant -> { Telnyx::Rcs::AgentConfiguration::Basics::UnionMember0 }
+
+          variant -> { Telnyx::Rcs::AgentConfiguration::Basics::UnionMember1 }
+
+          variant -> { Telnyx::Rcs::AgentConfiguration::Basics::UnionMember2 }
+
+          class UnionMember0 < Telnyx::Internal::Type::BaseModel
+            # @!attribute phone_number
+            #
+            #   @return [Telnyx::Models::Rcs::AgentPhoneContact]
+            required :phone_number, -> { Telnyx::Rcs::AgentPhoneContact }
+
+            # @!attribute brand_color
+            #
+            #   @return [String, nil]
+            optional :brand_color, String
+
+            # @!attribute description
+            #
+            #   @return [String, nil]
+            optional :description, String
+
+            # @!attribute email
+            #
+            #   @return [Telnyx::Models::Rcs::AgentEmailContact, nil]
+            optional :email, -> { Telnyx::Rcs::AgentEmailContact }, nil?: true
+
+            # @!attribute hero_url
+            #
+            #   @return [String, nil]
+            optional :hero_url, String
+
+            # @!attribute logo_url
+            #
+            #   @return [String, nil]
+            optional :logo_url, String
+
+            # @!attribute privacy_policy_url
+            #
+            #   @return [String, nil]
+            optional :privacy_policy_url, String
+
+            # @!attribute terms_and_conditions_url
+            #
+            #   @return [String, nil]
+            optional :terms_and_conditions_url, String
+
+            # @!attribute website
+            #
+            #   @return [Telnyx::Models::Rcs::AgentWebsiteContact, nil]
+            optional :website, -> { Telnyx::Rcs::AgentWebsiteContact }, nil?: true
+
+            # @!method initialize(phone_number:, brand_color: nil, description: nil, email: nil, hero_url: nil, logo_url: nil, privacy_policy_url: nil, terms_and_conditions_url: nil, website: nil)
+            #   @param phone_number [Telnyx::Models::Rcs::AgentPhoneContact]
+            #   @param brand_color [String]
+            #   @param description [String]
+            #   @param email [Telnyx::Models::Rcs::AgentEmailContact, nil]
+            #   @param hero_url [String]
+            #   @param logo_url [String]
+            #   @param privacy_policy_url [String]
+            #   @param terms_and_conditions_url [String]
+            #   @param website [Telnyx::Models::Rcs::AgentWebsiteContact, nil]
+          end
+
+          class UnionMember1 < Telnyx::Internal::Type::BaseModel
+            # @!attribute website
+            #
+            #   @return [Telnyx::Models::Rcs::AgentWebsiteContact]
+            required :website, -> { Telnyx::Rcs::AgentWebsiteContact }
+
+            # @!attribute brand_color
+            #
+            #   @return [String, nil]
+            optional :brand_color, String
+
+            # @!attribute description
+            #
+            #   @return [String, nil]
+            optional :description, String
+
+            # @!attribute email
+            #
+            #   @return [Telnyx::Models::Rcs::AgentEmailContact, nil]
+            optional :email, -> { Telnyx::Rcs::AgentEmailContact }, nil?: true
+
+            # @!attribute hero_url
+            #
+            #   @return [String, nil]
+            optional :hero_url, String
+
+            # @!attribute logo_url
+            #
+            #   @return [String, nil]
+            optional :logo_url, String
+
+            # @!attribute phone_number
+            #
+            #   @return [Telnyx::Models::Rcs::AgentPhoneContact, nil]
+            optional :phone_number, -> { Telnyx::Rcs::AgentPhoneContact }, nil?: true
+
+            # @!attribute privacy_policy_url
+            #
+            #   @return [String, nil]
+            optional :privacy_policy_url, String
+
+            # @!attribute terms_and_conditions_url
+            #
+            #   @return [String, nil]
+            optional :terms_and_conditions_url, String
+
+            # @!method initialize(website:, brand_color: nil, description: nil, email: nil, hero_url: nil, logo_url: nil, phone_number: nil, privacy_policy_url: nil, terms_and_conditions_url: nil)
+            #   @param website [Telnyx::Models::Rcs::AgentWebsiteContact]
+            #   @param brand_color [String]
+            #   @param description [String]
+            #   @param email [Telnyx::Models::Rcs::AgentEmailContact, nil]
+            #   @param hero_url [String]
+            #   @param logo_url [String]
+            #   @param phone_number [Telnyx::Models::Rcs::AgentPhoneContact, nil]
+            #   @param privacy_policy_url [String]
+            #   @param terms_and_conditions_url [String]
+          end
+
+          class UnionMember2 < Telnyx::Internal::Type::BaseModel
+            # @!attribute email
+            #
+            #   @return [Telnyx::Models::Rcs::AgentEmailContact]
+            required :email, -> { Telnyx::Rcs::AgentEmailContact }
+
+            # @!attribute brand_color
+            #
+            #   @return [String, nil]
+            optional :brand_color, String
+
+            # @!attribute description
+            #
+            #   @return [String, nil]
+            optional :description, String
+
+            # @!attribute hero_url
+            #
+            #   @return [String, nil]
+            optional :hero_url, String
+
+            # @!attribute logo_url
+            #
+            #   @return [String, nil]
+            optional :logo_url, String
+
+            # @!attribute phone_number
+            #
+            #   @return [Telnyx::Models::Rcs::AgentPhoneContact, nil]
+            optional :phone_number, -> { Telnyx::Rcs::AgentPhoneContact }, nil?: true
+
+            # @!attribute privacy_policy_url
+            #
+            #   @return [String, nil]
+            optional :privacy_policy_url, String
+
+            # @!attribute terms_and_conditions_url
+            #
+            #   @return [String, nil]
+            optional :terms_and_conditions_url, String
+
+            # @!attribute website
+            #
+            #   @return [Telnyx::Models::Rcs::AgentWebsiteContact, nil]
+            optional :website, -> { Telnyx::Rcs::AgentWebsiteContact }, nil?: true
+
+            # @!method initialize(email:, brand_color: nil, description: nil, hero_url: nil, logo_url: nil, phone_number: nil, privacy_policy_url: nil, terms_and_conditions_url: nil, website: nil)
+            #   @param email [Telnyx::Models::Rcs::AgentEmailContact]
+            #   @param brand_color [String]
+            #   @param description [String]
+            #   @param hero_url [String]
+            #   @param logo_url [String]
+            #   @param phone_number [Telnyx::Models::Rcs::AgentPhoneContact, nil]
+            #   @param privacy_policy_url [String]
+            #   @param terms_and_conditions_url [String]
+            #   @param website [Telnyx::Models::Rcs::AgentWebsiteContact, nil]
+          end
+
+          # @!method self.variants
+          #   @return [Array(Telnyx::Models::Rcs::AgentConfiguration::Basics::UnionMember0, Telnyx::Models::Rcs::AgentConfiguration::Basics::UnionMember1, Telnyx::Models::Rcs::AgentConfiguration::Basics::UnionMember2)]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      class AgentConsentConfiguration < Telnyx::Internal::Type::BaseModel
+        # @!attribute call_to_action
+        #
+        #   @return [String]
+        required :call_to_action, String
+
+        # @!attribute double_opt_in
+        #
+        #   @return [Boolean]
+        required :double_opt_in, Telnyx::Internal::Type::Boolean
+
+        # @!attribute help_response
+        #
+        #   @return [String]
+        required :help_response, String
+
+        # @!attribute opt_in_message
+        #
+        #   @return [String]
+        required :opt_in_message, String
+
+        # @!attribute opt_in_methods
+        #
+        #   @return [Array<Telnyx::Models::Rcs::AgentConsentConfiguration::OptInMethod>]
+        required :opt_in_methods,
+                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Rcs::AgentConsentConfiguration::OptInMethod] }
+
+        # @!attribute opt_out_response
+        #
+        #   @return [String]
+        required :opt_out_response, String
+
+        # @!attribute call_to_action_media_url
+        #   Required when an opt-in method is `WEBSITE` or `MOBILE_APP`.
+        #
+        #   @return [String, nil]
+        optional :call_to_action_media_url, String, nil?: true
+
+        # @!attribute call_to_action_url
+        #   Required when an opt-in method is `WEBSITE`.
+        #
+        #   @return [String, nil]
+        optional :call_to_action_url, String, nil?: true
+
+        # @!attribute double_opt_in_message
+        #   Required when double_opt_in is true.
+        #
+        #   @return [String, nil]
+        optional :double_opt_in_message, String, nil?: true
+
+        # @!method initialize(call_to_action:, double_opt_in:, help_response:, opt_in_message:, opt_in_methods:, opt_out_response:, call_to_action_media_url: nil, call_to_action_url: nil, double_opt_in_message: nil)
+        #   @param call_to_action [String]
+        #
+        #   @param double_opt_in [Boolean]
+        #
+        #   @param help_response [String]
+        #
+        #   @param opt_in_message [String]
+        #
+        #   @param opt_in_methods [Array<Telnyx::Models::Rcs::AgentConsentConfiguration::OptInMethod>]
+        #
+        #   @param opt_out_response [String]
+        #
+        #   @param call_to_action_media_url [String, nil] Required when an opt-in method is `WEBSITE` or `MOBILE_APP`.
+        #
+        #   @param call_to_action_url [String, nil] Required when an opt-in method is `WEBSITE`.
+        #
+        #   @param double_opt_in_message [String, nil] Required when double_opt_in is true.
+
+        class OptInMethod < Telnyx::Internal::Type::BaseModel
+          # @!attribute method_type
+          #
+          #   @return [Symbol, Telnyx::Models::Rcs::AgentConsentConfiguration::OptInMethod::MethodType]
+          required :method_type, enum: -> { Telnyx::Rcs::AgentConsentConfiguration::OptInMethod::MethodType }
+
+          # @!attribute description
+          #   Required when method_type is `OTHER`.
+          #
+          #   @return [String, nil]
+          optional :description, String, nil?: true
+
+          # @!method initialize(method_type:, description: nil)
+          #   @param method_type [Symbol, Telnyx::Models::Rcs::AgentConsentConfiguration::OptInMethod::MethodType]
+          #
+          #   @param description [String, nil] Required when method_type is `OTHER`.
+
+          # @see Telnyx::Models::Rcs::AgentConsentConfiguration::OptInMethod#method_type
+          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
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      # @see Telnyx::Resources::Rcs::Agents#create
+      class AgentCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute brand_id
+        #
+        #   @return [String]
+        required :brand_id, String
+
+        # @!attribute configuration
+        #
+        #   @return [Telnyx::Models::Rcs::AgentConfiguration]
+        required :configuration, -> { Telnyx::Rcs::AgentConfiguration }
+
+        # @!attribute display_name
+        #
+        #   @return [String]
+        required :display_name, String
+
+        # @!attribute use_case
+        #
+        #   @return [Symbol, Telnyx::Models::Rcs::AgentUseCase]
+        required :use_case, enum: -> { Telnyx::Rcs::AgentUseCase }
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String]
+        required :idempotency_key, String
+
+        # @!attribute hosting_region
+        #
+        #   @return [String, nil]
+        optional :hosting_region, String, nil?: true
+
+        # @!attribute profile_id
+        #   A Messaging Profile owned by the authenticated organization. When omitted, the
+        #   agent inherits the brand profile.
+        #
+        #   @return [String, nil]
+        optional :profile_id, String, nil?: true
+
+        # @!method initialize(brand_id:, configuration:, display_name:, use_case:, idempotency_key:, hosting_region: nil, profile_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Rcs::AgentCreateParams} for more details.
+        #
+        #   @param brand_id [String]
+        #
+        #   @param configuration [Telnyx::Models::Rcs::AgentConfiguration]
+        #
+        #   @param display_name [String]
+        #
+        #   @param use_case [Symbol, Telnyx::Models::Rcs::AgentUseCase]
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param hosting_region [String, nil]
+        #
+        #   @param profile_id [String, nil] A Messaging Profile owned by the authenticated organization. When omitted, the a
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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