telnyx 5.158.0 → 5.160.0

data/lib/telnyx/models/pricing/product_retrieve_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Pricing
+      # @see Telnyx::Resources::Pricing::Products#retrieve
+      class ProductRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute slug
+        #
+        #   @return [String]
+        required :slug, String
+
+        # @!attribute filter_country_iso
+        #
+        #   @return [String, nil]
+        optional :filter_country_iso, String, nil?: true
+
+        # @!attribute page_number
+        #   Page number (1-based).
+        #
+        #   @return [Integer, nil]
+        optional :page_number, Integer
+
+        # @!attribute page_size
+        #   Number of items per page (max 100).
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!method initialize(slug:, filter_country_iso: nil, page_number: nil, page_size: nil, request_options: {})
+        #   @param slug [String]
+        #
+        #   @param filter_country_iso [String, nil]
+        #
+        #   @param page_number [Integer] Page number (1-based).
+        #
+        #   @param page_size [Integer] Number of items per page (max 100).
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/pricing/product_retrieve_response.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Pricing
+      # @see Telnyx::Resources::Pricing::Products#retrieve
+      class ProductRetrieveResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<Telnyx::Models::Pricing::ProductRetrieveResponse::Data>]
+        required :data,
+                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Pricing::ProductRetrieveResponse::Data] }
+
+        # @!attribute meta
+        #
+        #   @return [Telnyx::Models::Pricing::PricingPaginationMeta]
+        required :meta, -> { Telnyx::Pricing::PricingPaginationMeta }
+
+        # @!method initialize(data:, meta:)
+        #   @param data [Array<Telnyx::Models::Pricing::ProductRetrieveResponse::Data>]
+        #   @param meta [Telnyx::Models::Pricing::PricingPaginationMeta]
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute cached_input_rate
+          #   Cached input token rate. Present only on inference product entries.
+          #
+          #   @return [String, nil]
+          optional :cached_input_rate, String
+
+          # @!attribute cached_input_tiers
+          #   Cached input token tiered pricing. Present only on inference product entries.
+          #
+          #   @return [Array<Telnyx::Models::Pricing::PricingTier>, nil]
+          optional :cached_input_tiers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Pricing::PricingTier] }
+
+          # @!attribute country_iso
+          #   ISO country code. Null for non-geographic products.
+          #
+          #   @return [String, nil]
+          optional :country_iso, String, nil?: true
+
+          # @!attribute currency
+          #   ISO currency code (e.g., USD).
+          #
+          #   @return [String, nil]
+          optional :currency, String
+
+          # @!attribute direction
+          #   Direction (e.g., termination). Null for non-directional products.
+          #
+          #   @return [String, nil]
+          optional :direction, String, nil?: true
+
+          # @!attribute input_rate
+          #   Input token rate. Present only on inference product entries.
+          #
+          #   @return [String, nil]
+          optional :input_rate, String
+
+          # @!attribute input_tiers
+          #   Input token tiered pricing. Present only on inference product entries.
+          #
+          #   @return [Array<Telnyx::Models::Pricing::PricingTier>, nil]
+          optional :input_tiers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Pricing::PricingTier] }
+
+          # @!attribute model
+          #   Model identifier. Present only on inference product entries.
+          #
+          #   @return [String, nil]
+          optional :model, String
+
+          # @!attribute name
+          #   Human-readable name describing the pricing entry.
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute note
+          #   Additional note for rate-deck products (e.g., "Pricing is determined by the
+          #   WhatsApp rate deck.").
+          #
+          #   @return [String, nil]
+          optional :note, String, nil?: true
+
+          # @!attribute output_rate
+          #   Output token rate. Present only on inference product entries.
+          #
+          #   @return [String, nil]
+          optional :output_rate, String
+
+          # @!attribute output_tiers
+          #   Output token tiered pricing. Present only on inference product entries.
+          #
+          #   @return [Array<Telnyx::Models::Pricing::PricingTier>, nil]
+          optional :output_tiers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Pricing::PricingTier] }
+
+          # @!attribute pricing_type
+          #   Pricing type for non-standard products (e.g., rate_deck). Absent on standard
+          #   products.
+          #
+          #   @return [String, nil]
+          optional :pricing_type, String, nil?: true
+
+          # @!attribute rate
+          #   Per-unit rate. Numeric for standard products, string for inference products.
+          #   Null for rate-deck products.
+          #
+          #   @return [Float, String, nil]
+          optional :rate, union: -> { Telnyx::Models::Pricing::ProductRetrieveResponse::Data::Rate }, nil?: true
+
+          # @!attribute tiers
+          #   Volume-based tiered pricing. Empty for rate-deck products.
+          #
+          #   @return [Array<Telnyx::Models::Pricing::PricingTier>, nil]
+          optional :tiers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Pricing::PricingTier] }
+
+          # @!attribute type
+          #   Pricing type (e.g., usage).
+          #
+          #   @return [String, nil]
+          optional :type, String
+
+          # @!attribute unit
+          #   Unit of measurement (e.g., part, message, GB, per_1k_tokens).
+          #
+          #   @return [String, nil]
+          optional :unit, String
+
+          # @!method initialize(cached_input_rate: nil, cached_input_tiers: nil, country_iso: nil, currency: nil, direction: nil, input_rate: nil, input_tiers: nil, model: nil, name: nil, note: nil, output_rate: nil, output_tiers: nil, pricing_type: nil, rate: nil, tiers: nil, type: nil, unit: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::Pricing::ProductRetrieveResponse::Data} for more details.
+          #
+          #   A single pricing entry. Standard products include rate, unit, currency, type,
+          #   country_iso, direction, and tiers. Inference products include model, input_rate,
+          #   output_rate, cached_input_rate, and their respective tier arrays. Rate-deck
+          #   products include pricing_type and note fields with null rate and empty tiers.
+          #
+          #   @param cached_input_rate [String] Cached input token rate. Present only on inference product entries.
+          #
+          #   @param cached_input_tiers [Array<Telnyx::Models::Pricing::PricingTier>] Cached input token tiered pricing. Present only on inference product entries.
+          #
+          #   @param country_iso [String, nil] ISO country code. Null for non-geographic products.
+          #
+          #   @param currency [String] ISO currency code (e.g., USD).
+          #
+          #   @param direction [String, nil] Direction (e.g., termination). Null for non-directional products.
+          #
+          #   @param input_rate [String] Input token rate. Present only on inference product entries.
+          #
+          #   @param input_tiers [Array<Telnyx::Models::Pricing::PricingTier>] Input token tiered pricing. Present only on inference product entries.
+          #
+          #   @param model [String] Model identifier. Present only on inference product entries.
+          #
+          #   @param name [String] Human-readable name describing the pricing entry.
+          #
+          #   @param note [String, nil] Additional note for rate-deck products (e.g., "Pricing is determined by the What
+          #
+          #   @param output_rate [String] Output token rate. Present only on inference product entries.
+          #
+          #   @param output_tiers [Array<Telnyx::Models::Pricing::PricingTier>] Output token tiered pricing. Present only on inference product entries.
+          #
+          #   @param pricing_type [String, nil] Pricing type for non-standard products (e.g., rate_deck). Absent on standard pro
+          #
+          #   @param rate [Float, String, nil] Per-unit rate. Numeric for standard products, string for inference products. Nul
+          #
+          #   @param tiers [Array<Telnyx::Models::Pricing::PricingTier>] Volume-based tiered pricing. Empty for rate-deck products.
+          #
+          #   @param type [String] Pricing type (e.g., usage).
+          #
+          #   @param unit [String] Unit of measurement (e.g., part, message, GB, per_1k_tokens).
+
+          # Per-unit rate. Numeric for standard products, string for inference products.
+          # Null for rate-deck products.
+          #
+          # @see Telnyx::Models::Pricing::ProductRetrieveResponse::Data#rate
+          module Rate
+            extend Telnyx::Internal::Type::Union
+
+            # Rate for standard products (e.g., 0.004).
+            variant Float
+
+            # Rate for inference products (e.g., "0.001").
+            variant String
+
+            # @!method self.variants
+            #   @return [Array(Float, String)]
+          end
+        end
+      end
+    end
+  end
+end

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