sentdm 0.45.0 → 0.47.0

data/lib/sentdm/models/channels/market_compliance.rb

@@ -0,0 +1,409 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      class MarketCompliance < Sentdm::Internal::Type::BaseModel
+        # @!attribute brand
+        #   Business identity. The identity the registration is filed against. Omit to have
+        #   none; { "inherit": true } to register under your organization's.
+        #
+        #   @return [Sentdm::Models::Channels::MarketCompliance::Brand, nil]
+        optional :brand, -> { Sentdm::Channels::MarketCompliance::Brand }
+
+        # @!attribute campaign
+        #   Messaging campaign. What the programme sends and how recipients consented. Omit
+        #   to run on your organization's; supplying it takes one of your own. { "inherit":
+        #   true } says so outright. Required when `compliance.campaign.inherit != true`.
+        #
+        #   @return [Sentdm::Models::Channels::MarketCompliance::Campaign, nil]
+        optional :campaign, -> { Sentdm::Channels::MarketCompliance::Campaign }
+
+        # @!method initialize(brand: nil, campaign: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::MarketCompliance} for more details.
+        #
+        #   The compliance values a market registers with. `brand` and `campaign` apply to
+        #   US `TEN_DLC`; other markets fill this map with the document keys their own
+        #   requirements name.
+        #
+        #   @param brand [Sentdm::Models::Channels::MarketCompliance::Brand] Business identity. The identity the registration is filed against. Omit to have
+        #
+        #   @param campaign [Sentdm::Models::Channels::MarketCompliance::Campaign] Messaging campaign. What the programme sends and how recipients consented. Omit
+
+        # @see Sentdm::Models::Channels::MarketCompliance#brand
+        class Brand < Sentdm::Internal::Type::BaseModel
+          # @!attribute business_name
+          #   Public-facing name. TCR displayName — the name recipients would recognise. Named
+          #   for what it holds rather than for TCR's field, which is why it is not
+          #   `display_name`. Required when `compliance.brand.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :business_name, String
+
+          # @!attribute city
+          #   City. Required when `compliance.brand.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :city, String
+
+          # @!attribute contact_email
+          #   Contact email. TCR email. Required when `compliance.brand.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :contact_email, String
+
+          # @!attribute contact_name
+          #   Responsible contact. Split into TCR's firstName/lastName on submission.
+          #   BrandService refuses a blank one, so a missing name is reported here rather than
+          #   thrown after the profile was written. Required when
+          #   `compliance.brand.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :contact_name, String
+
+          # @!attribute contact_phone
+          #   Contact phone. TCR sends it as both phone and mobilePhone, so it is asked for
+          #   once. Named for the contact it belongs to rather than as a bare `phone` on a
+          #   block that also carries an address. Required when
+          #   `compliance.brand.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :contact_phone, String
+
+          # @!attribute country
+          #   Country of registration. Two letters — US. The country spelled out in full is
+          #   accepted too and stored as its code, which is what a read answers with and what
+          #   is filed. Required when `compliance.brand.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :country, String
+
+          # @!attribute ein_issuing_country
+          #   Country that issued the tax id. TCR einIssuingCountry — where the tax id was
+          #   issued, which is not always where the business trades. Defaults to `country`
+          #   when omitted, which is right for most. Takes the code or the country spelled
+          #   out, as `country` does.
+          #
+          #   @return [String, nil]
+          optional :ein_issuing_country, String
+
+          # @!attribute entity_type
+          #   Entity type. TCR entityType. Decides which vetting TCR applies and, for
+          #   SOLE_PROPRIETOR, fixes the campaign fee regardless of volume. Also refused at
+          #   submission if absent. Required when `compliance.brand.inherit != true`.
+          #
+          #   @return [Symbol, Sentdm::Models::Channels::MarketCompliance::Brand::EntityType, nil]
+          optional :entity_type, enum: -> { Sentdm::Channels::MarketCompliance::Brand::EntityType }
+
+          # @!attribute inherit
+          #   Run on the organization's brand. True to register under the parent
+          #   organization's identity rather than one of this profile's own; every field below
+          #   is then neither asked for nor accepted. Omitted, the brand is the organization's
+          #   unless this block supplies identity fields, which says plainly enough that it
+          #   wants one of its own.
+          #
+          #   @return [Boolean, nil]
+          optional :inherit, Sentdm::Internal::Type::Boolean
+
+          # @!attribute legal_name
+          #   Registered legal name. TCR companyName — the name on the incorporation
+          #   documents, which is often not the name recipients would recognise. Required when
+          #   `compliance.brand.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :legal_name, String
+
+          # @!attribute postal_code
+          #   Postal code. Required when `compliance.brand.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :postal_code, String
+
+          # @!attribute state
+          #   State or region. TCR state. Two letters for a US registration. Required when
+          #   `compliance.brand.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :state, String
+
+          # @!attribute street
+          #   Street address. Required when `compliance.brand.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :street, String
+
+          # @!attribute tax_id
+          #   Tax identifier. TCR ein. TcrBrandSubmissionValidator refuses a submission
+          #   without one, so it is wanted here rather than discovered at filing time.
+          #   Required when `compliance.brand.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :tax_id, String
+
+          # @!attribute tax_id_type
+          #   Kind of tax identifier. Which kind of identifier `tax_id` is, e.g. us_ein.
+          #   Derived onto the brand form, and not itself sent to TCR. Required when
+          #   `compliance.brand.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :tax_id_type, String
+
+          # @!attribute website
+          #   Website. TCR website. Optional, and worth sending: carriers weigh it when
+          #   vetting, so a brand that has one and omits it is vetted on less than it could
+          #   be.
+          #
+          #   @return [String, nil]
+          optional :website, String
+
+          # @!method initialize(business_name: nil, city: nil, contact_email: nil, contact_name: nil, contact_phone: nil, country: nil, ein_issuing_country: nil, entity_type: nil, inherit: nil, legal_name: nil, postal_code: nil, state: nil, street: nil, tax_id: nil, tax_id_type: nil, website: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::Channels::MarketCompliance::Brand} for more details.
+          #
+          #   Business identity. The identity the registration is filed against. Omit to have
+          #   none; { "inherit": true } to register under your organization's.
+          #
+          #   @param business_name [String] Public-facing name. TCR displayName — the name recipients would recognise. Named
+          #
+          #   @param city [String] City. Required when `compliance.brand.inherit != true`.
+          #
+          #   @param contact_email [String] Contact email. TCR email. Required when `compliance.brand.inherit != true`.
+          #
+          #   @param contact_name [String] Responsible contact. Split into TCR's firstName/lastName on submission. BrandSer
+          #
+          #   @param contact_phone [String] Contact phone. TCR sends it as both phone and mobilePhone, so it is asked for on
+          #
+          #   @param country [String] Country of registration. Two letters — US. The country spelled out in full is ac
+          #
+          #   @param ein_issuing_country [String] Country that issued the tax id. TCR einIssuingCountry — where the tax id was iss
+          #
+          #   @param entity_type [Symbol, Sentdm::Models::Channels::MarketCompliance::Brand::EntityType] Entity type. TCR entityType. Decides which vetting TCR applies and, for SOLE_PRO
+          #
+          #   @param inherit [Boolean] Run on the organization's brand. True to register under the parent organization'
+          #
+          #   @param legal_name [String] Registered legal name. TCR companyName — the name on the incorporation documents
+          #
+          #   @param postal_code [String] Postal code. Required when `compliance.brand.inherit != true`.
+          #
+          #   @param state [String] State or region. TCR state. Two letters for a US registration. Required when `co
+          #
+          #   @param street [String] Street address. Required when `compliance.brand.inherit != true`.
+          #
+          #   @param tax_id [String] Tax identifier. TCR ein. TcrBrandSubmissionValidator refuses a submission withou
+          #
+          #   @param tax_id_type [String] Kind of tax identifier. Which kind of identifier `tax_id` is, e.g. us_ein. Deriv
+          #
+          #   @param website [String] Website. TCR website. Optional, and worth sending: carriers weigh it when vettin
+
+          # Entity type. TCR entityType. Decides which vetting TCR applies and, for
+          # SOLE_PROPRIETOR, fixes the campaign fee regardless of volume. Also refused at
+          # submission if absent. Required when `compliance.brand.inherit != true`.
+          #
+          # @see Sentdm::Models::Channels::MarketCompliance::Brand#entity_type
+          module EntityType
+            extend Sentdm::Internal::Type::Enum
+
+            PRIVATE_PROFIT = :PRIVATE_PROFIT
+            PUBLIC_PROFIT = :PUBLIC_PROFIT
+            NON_PROFIT = :NON_PROFIT
+            SOLE_PROPRIETOR = :SOLE_PROPRIETOR
+            GOVERNMENT = :GOVERNMENT
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see Sentdm::Models::Channels::MarketCompliance#campaign
+        class Campaign < Sentdm::Internal::Type::BaseModel
+          # @!attribute description
+          #   What this programme sends. TCR description: what recipients will get and why, in
+          #   a sentence. The only one of these TCR takes verbatim as a description of the
+          #   programme, which is why it is asked for rather than derived from the customer's
+          #   name. Required when `compliance.campaign.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :description, String
+
+          # @!attribute help_keywords
+          #   Help keywords. TCR helpKeywords, comma separated, e.g. HELP,INFO. Required when
+          #   `compliance.campaign.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :help_keywords, String
+
+          # @!attribute help_message
+          #   Help reply. TCR helpMessage. Its presence is what sets subscriberHelp. Required
+          #   when `compliance.campaign.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :help_message, String
+
+          # @!attribute inherit
+          #   Run on the organization's campaign. True to register under the parent
+          #   organization's programme rather than one of this profile's own; every field
+          #   below is then neither asked for nor accepted. Owning the identity and inheriting
+          #   the campaign is refused — a campaign is filed against an identity registration,
+          #   and chk_tcr_inheritance forbids that pairing outright.
+          #
+          #   @return [Boolean, nil]
+          optional :inherit, Sentdm::Internal::Type::Boolean
+
+          # @!attribute message_flow
+          #   Consent narrative. TCR messageFlow: how recipients opt in, in prose. Under 40
+          #   characters is refused, and carriers reject vague descriptions — say where opt-in
+          #   happens, that the box is unchecked by default, and that consent is not a
+          #   condition of purchase. Required when `compliance.campaign.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :message_flow, String
+
+          # @!attribute opt_in_keywords
+          #   Opt-in keywords. TCR optinKeywords, comma separated, e.g. START,YES. Required
+          #   when `compliance.campaign.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :opt_in_keywords, String
+
+          # @!attribute opt_in_message
+          #   Opt-in confirmation. TCR optinMessage. Should state message frequency and that
+          #   rates may apply. Its presence is what sets subscriberOptin. Required when
+          #   `compliance.campaign.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :opt_in_message, String
+
+          # @!attribute opt_out_keywords
+          #   Opt-out keywords. TCR optoutKeywords, comma separated. STOP, END, CANCEL,
+          #   UNSUBSCRIBE and QUIT are honoured regardless of what is declared. Required when
+          #   `compliance.campaign.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :opt_out_keywords, String
+
+          # @!attribute opt_out_message
+          #   Opt-out confirmation. TCR optoutMessage. Its presence is what sets
+          #   subscriberOptout. Required when `compliance.campaign.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :opt_out_message, String
+
+          # @!attribute privacy_policy_link
+          #   Privacy policy URL. TCR privacyPolicyLink. Required when
+          #   `compliance.campaign.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :privacy_policy_link, String
+
+          # @!attribute terms_and_conditions_link
+          #   Terms and conditions URL. TCR termsAndConditionsLink. Required when
+          #   `compliance.campaign.inherit != true`.
+          #
+          #   @return [String, nil]
+          optional :terms_and_conditions_link, String
+
+          # @!attribute use_cases
+          #   Use cases. What the campaign sends, and an example of each. One to five entries;
+          #   how they register is decided by volume, never declared. Required when
+          #   `compliance.campaign.inherit != true`.
+          #
+          #   @return [Array<Sentdm::Models::Channels::MarketCompliance::Campaign::UseCase>, nil]
+          optional :use_cases,
+                   -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Channels::MarketCompliance::Campaign::UseCase] }
+
+          # @!attribute volume
+          #   Expected monthly volume. Decides how the campaign registers and which fee tier
+          #   applies: below the low-volume threshold it registers as LOW_VOLUME with
+          #   sub-use-cases, above it as a single use case or MIXED. Omitting it registers the
+          #   campaign at the higher-fee standard tier.
+          #
+          #   @return [String, nil]
+          optional :volume, String
+
+          # @!method initialize(description: nil, help_keywords: nil, help_message: nil, inherit: nil, message_flow: nil, opt_in_keywords: nil, opt_in_message: nil, opt_out_keywords: nil, opt_out_message: nil, privacy_policy_link: nil, terms_and_conditions_link: nil, use_cases: nil, volume: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::Channels::MarketCompliance::Campaign} for more details.
+          #
+          #   Messaging campaign. What the programme sends and how recipients consented. Omit
+          #   to run on your organization's; supplying it takes one of your own. { "inherit":
+          #   true } says so outright. Required when `compliance.campaign.inherit != true`.
+          #
+          #   @param description [String] What this programme sends. TCR description: what recipients will get and why, in
+          #
+          #   @param help_keywords [String] Help keywords. TCR helpKeywords, comma separated, e.g. HELP,INFO. Required when
+          #
+          #   @param help_message [String] Help reply. TCR helpMessage. Its presence is what sets subscriberHelp. Required
+          #
+          #   @param inherit [Boolean] Run on the organization's campaign. True to register under the parent organizati
+          #
+          #   @param message_flow [String] Consent narrative. TCR messageFlow: how recipients opt in, in prose. Under 40 ch
+          #
+          #   @param opt_in_keywords [String] Opt-in keywords. TCR optinKeywords, comma separated, e.g. START,YES. Required wh
+          #
+          #   @param opt_in_message [String] Opt-in confirmation. TCR optinMessage. Should state message frequency and that r
+          #
+          #   @param opt_out_keywords [String] Opt-out keywords. TCR optoutKeywords, comma separated. STOP, END, CANCEL, UNSUBS
+          #
+          #   @param opt_out_message [String] Opt-out confirmation. TCR optoutMessage. Its presence is what sets subscriberOpt
+          #
+          #   @param privacy_policy_link [String] Privacy policy URL. TCR privacyPolicyLink. Required when `compliance.campaign.in
+          #
+          #   @param terms_and_conditions_link [String] Terms and conditions URL. TCR termsAndConditionsLink. Required when `compliance.
+          #
+          #   @param use_cases [Array<Sentdm::Models::Channels::MarketCompliance::Campaign::UseCase>] Use cases. What the campaign sends, and an example of each. One to five entries;
+          #
+          #   @param volume [String] Expected monthly volume. Decides how the campaign registers and which fee tier a
+
+          class UseCase < Sentdm::Internal::Type::BaseModel
+            # @!attribute sample_messages
+            #   Sample messages. TCR sample1..sample5 for this use case. One to five, each
+            #   carrying the brand name and an opt-out instruction.
+            #
+            #   @return [Array<Object>]
+            required :sample_messages, Sentdm::Internal::Type::ArrayOf[Sentdm::Internal::Type::Unknown]
+
+            # @!attribute use_case
+            #   Use case. What this entry sends. MIXED and LOW_VOLUME are refused — volume
+            #   decides those.
+            #
+            #   @return [Symbol, Sentdm::Models::Channels::MarketCompliance::Campaign::UseCase::UseCase]
+            required :use_case, enum: -> { Sentdm::Channels::MarketCompliance::Campaign::UseCase::UseCase }
+
+            # @!method initialize(sample_messages:, use_case:)
+            #   Some parameter documentations has been truncated, see
+            #   {Sentdm::Models::Channels::MarketCompliance::Campaign::UseCase} for more
+            #   details.
+            #
+            #   @param sample_messages [Array<Object>] Sample messages. TCR sample1..sample5 for this use case. One to five, each carry
+            #
+            #   @param use_case [Symbol, Sentdm::Models::Channels::MarketCompliance::Campaign::UseCase::UseCase] Use case. What this entry sends. MIXED and LOW_VOLUME are refused — volume decid
+
+            # Use case. What this entry sends. MIXED and LOW_VOLUME are refused — volume
+            # decides those.
+            #
+            # @see Sentdm::Models::Channels::MarketCompliance::Campaign::UseCase#use_case
+            module UseCase
+              extend Sentdm::Internal::Type::Enum
+
+              MARKETING = :MARKETING
+              ACCOUNT_NOTIFICATION = :ACCOUNT_NOTIFICATION
+              CUSTOMER_CARE = :CUSTOMER_CARE
+              FRAUD_ALERT = :FRAUD_ALERT
+              USE_CASE_2_FA = :"2FA"
+              DELIVERY_NOTIFICATION = :DELIVERY_NOTIFICATION
+              SECURITY_ALERT = :SECURITY_ALERT
+              M2_M = :M2M
+              HIGHER_EDUCATION = :HIGHER_EDUCATION
+              POLLING_VOTING = :POLLING_VOTING
+              PUBLIC_SERVICE_ANNOUNCEMENT = :PUBLIC_SERVICE_ANNOUNCEMENT
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/rc_create_params.rb

@@ -0,0 +1,260 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::Rcs#create
+      class RcCreateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute agent_use_case
+        #   Which kind of traffic the agent carries. One of the accepted use cases; the
+        #   error names the set.
+        #
+        #   @return [Symbol, Sentdm::Models::Channels::RcCreateParams::AgentUseCase, nil]
+        optional :agent_use_case, enum: -> { Sentdm::Channels::RcCreateParams::AgentUseCase }
+
+        # @!attribute banner_url
+        #
+        #   @return [String, nil]
+        optional :banner_url, String
+
+        # @!attribute brand_color
+        #   Primary brand colour, as #RRGGBB. Three-digit shorthand is refused: the value is
+        #   submitted verbatim, so two spellings of one colour is only a way for the stored
+        #   value to disagree with the form.
+        #
+        #   @return [String, nil]
+        optional :brand_color, String
+
+        # @!attribute brand_email
+        #
+        #   @return [String, nil]
+        optional :brand_email, String
+
+        # @!attribute brand_name
+        #   The brand this agent presents over RCS.
+        #
+        #   Not taken from your compliance.brand: a business may present a different brand
+        #   on RCS than the one its 10DLC registration is filed against, and the carriers
+        #   vet this one.
+        #
+        #   @return [String, nil]
+        optional :brand_name, String
+
+        # @!attribute brand_phone_number
+        #   The brand's own number. Also becomes the agent's canonical sending number for
+        #   routing, which is why it is normalised to E.164 rather than stored as sent.
+        #
+        #   @return [String, nil]
+        optional :brand_phone_number, String
+
+        # @!attribute brief_company_description
+        #
+        #   @return [String, nil]
+        optional :brief_company_description, String
+
+        # @!attribute company_ein
+        #
+        #   @return [String, nil]
+        optional :company_ein, String
+
+        # @!attribute contact_name_and_title
+        #
+        #   @return [String, nil]
+        optional :contact_name_and_title, String
+
+        # @!attribute customer_support_email
+        #
+        #   @return [String, nil]
+        optional :customer_support_email, String
+
+        # @!attribute customer_support_phone_number
+        #
+        #   @return [String, nil]
+        optional :customer_support_phone_number, String
+
+        # @!attribute description
+        #   What the agent is for, shown to recipients. Capped by the carriers, not by us.
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute display_name
+        #   The name the agent shows in the messaging client.
+        #
+        #   @return [String, nil]
+        optional :display_name, String
+
+        # @!attribute entity_type
+        #
+        #   @return [String, nil]
+        optional :entity_type, String
+
+        # @!attribute help_message
+        #
+        #   @return [String, nil]
+        optional :help_message, String
+
+        # @!attribute logo_url
+        #   Publicly reachable logo. It has to be fetchable without authentication at review
+        #   time, so a URL behind a login passes this call and fails the review.
+        #
+        #   @return [String, nil]
+        optional :logo_url, String
+
+        # @!attribute official_address
+        #   The registered address of the company behind the agent.
+        #
+        #   @return [Sentdm::Models::Channels::RcsAddress, nil]
+        optional :official_address, -> { Sentdm::Channels::RcsAddress }
+
+        # @!attribute opt_in_process_description
+        #   How recipients opt in, in prose. The carriers read this one.
+        #
+        #   @return [String, nil]
+        optional :opt_in_process_description, String
+
+        # @!attribute opt_in_screenshot_url
+        #   A screenshot of the opt-in, as a publicly fetchable URL.
+        #
+        #   @return [String, nil]
+        optional :opt_in_screenshot_url, String, nil?: true
+
+        # @!attribute privacy_policy_url
+        #   Required by US carriers. Must be an absolute http(s) URL they can fetch.
+        #
+        #   @return [String, nil]
+        optional :privacy_policy_url, String
+
+        # @!attribute sample_messages
+        #   Examples of what the agent will send, for the review.
+        #
+        #   @return [Array<String>, nil]
+        optional :sample_messages, Sentdm::Internal::Type::ArrayOf[String]
+
+        # @!attribute sandbox
+        #   Sandbox flag - when true, the operation is simulated without side effects Useful
+        #   for testing integrations without actual execution
+        #
+        #   @return [Boolean, nil]
+        optional :sandbox, Sentdm::Internal::Type::Boolean
+
+        # @!attribute start_message
+        #
+        #   @return [String, nil]
+        optional :start_message, String
+
+        # @!attribute stop_message
+        #
+        #   @return [String, nil]
+        optional :stop_message, String
+
+        # @!attribute terms_and_conditions_url
+        #
+        #   @return [String, nil]
+        optional :terms_and_conditions_url, String
+
+        # @!attribute website_url
+        #   The brand's own site.
+        #
+        #   @return [String, nil]
+        optional :website_url, String
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_profile_id
+        #
+        #   @return [String, nil]
+        optional :x_profile_id, String
+
+        # @!method initialize(agent_use_case: nil, banner_url: nil, brand_color: nil, brand_email: nil, brand_name: nil, brand_phone_number: nil, brief_company_description: nil, company_ein: nil, contact_name_and_title: nil, customer_support_email: nil, customer_support_phone_number: nil, description: nil, display_name: nil, entity_type: nil, help_message: nil, logo_url: nil, official_address: nil, opt_in_process_description: nil, opt_in_screenshot_url: nil, privacy_policy_url: nil, sample_messages: nil, sandbox: nil, start_message: nil, stop_message: nil, terms_and_conditions_url: nil, website_url: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::RcCreateParams} for more details.
+        #
+        #   @param agent_use_case [Symbol, Sentdm::Models::Channels::RcCreateParams::AgentUseCase] Which kind of traffic the agent carries. One of the accepted use cases; the erro
+        #
+        #   @param banner_url [String]
+        #
+        #   @param brand_color [String] Primary brand colour, as #RRGGBB. Three-digit shorthand is refused: the value is
+        #
+        #   @param brand_email [String]
+        #
+        #   @param brand_name [String] The brand this agent presents over RCS.
+        #
+        #   @param brand_phone_number [String] The brand's own number. Also becomes the agent's canonical sending number for ro
+        #
+        #   @param brief_company_description [String]
+        #
+        #   @param company_ein [String]
+        #
+        #   @param contact_name_and_title [String]
+        #
+        #   @param customer_support_email [String]
+        #
+        #   @param customer_support_phone_number [String]
+        #
+        #   @param description [String] What the agent is for, shown to recipients. Capped by the carriers, not by us.
+        #
+        #   @param display_name [String] The name the agent shows in the messaging client.
+        #
+        #   @param entity_type [String]
+        #
+        #   @param help_message [String]
+        #
+        #   @param logo_url [String] Publicly reachable logo. It has to be fetchable without authentication at review
+        #
+        #   @param official_address [Sentdm::Models::Channels::RcsAddress] The registered address of the company behind the agent.
+        #
+        #   @param opt_in_process_description [String] How recipients opt in, in prose. The carriers read this one.
+        #
+        #   @param opt_in_screenshot_url [String, nil] A screenshot of the opt-in, as a publicly fetchable URL.
+        #
+        #   @param privacy_policy_url [String] Required by US carriers. Must be an absolute http(s) URL they can fetch.
+        #
+        #   @param sample_messages [Array<String>] Examples of what the agent will send, for the review.
+        #
+        #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+        #
+        #   @param start_message [String]
+        #
+        #   @param stop_message [String]
+        #
+        #   @param terms_and_conditions_url [String]
+        #
+        #   @param website_url [String] The brand's own site.
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param x_profile_id [String]
+        #
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+
+        # Which kind of traffic the agent carries. One of the accepted use cases; the
+        # error names the set.
+        module AgentUseCase
+          extend Sentdm::Internal::Type::Enum
+
+          # One-time passcodes and identity checks. Expects no reply, and is held to the strictest delivery review.
+          VERIFICATION = :VERIFICATION
+
+          # Transactional updates the recipient asked for — orders, deliveries, appointments, account activity.
+          NOTIFICATIONS = :NOTIFICATIONS
+
+          # Promotional content. Requires the clearest opt-in evidence of the four, because the carriers review consent hardest here.
+          MARKETING = :MARKETING
+
+          # More than one of the above from a single agent. Vetted against the strictest use case it covers, so declare it only if you genuinely need one agent to do several jobs.
+          MULTI_USE = :MULTI_USE
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end