sentdm 0.44.0 → 0.46.0

data/lib/sentdm/models/profiles_list.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class ProfilesList < Sentdm::Internal::Type::BaseModel
+      # @!attribute pagination
+      #   Pagination metadata for list responses
+      #
+      #   @return [Sentdm::Models::PaginationMeta, nil]
+      optional :pagination, -> { Sentdm::PaginationMeta }
+
+      # @!attribute profiles
+      #   The profiles on this page.
+      #
+      #   @return [Array<Sentdm::Models::ProfileDetail>, nil]
+      optional :profiles, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ProfileDetail] }
+
+      # @!method initialize(pagination: nil, profiles: nil)
+      #   The profiles in the organization.
+      #
+      #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
+      #
+      #   @param profiles [Array<Sentdm::Models::ProfileDetail>] The profiles on this page.
+    end
+  end
+end

data/lib/sentdm/models/sender_profile.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::SenderProfiles#list
+    class SenderProfile < Sentdm::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute api_key
+      #   The API key for this profile.
+      #
+      #   Returned by create and by nothing else. It is shown once; a read that repeated
+      #   it would turn every profile list into a credential dump and put the key into any
+      #   log or cache that keeps a response body.
+      #
+      #   Omitted rather than null on a read. A key field that is always present and
+      #   always empty suggests it could be populated, which is an invitation to populate
+      #   it; absent says there is nothing to look for. Doing it with a serializer
+      #   condition rather than a second response type keeps create and read on one shape,
+      #   which is what stops them drifting.
+      #
+      #   @return [String, nil]
+      optional :api_key, String, nil?: true
+
+      # @!attribute billing
+      #   Who pays for a sender profile's traffic, as a read reports it.
+      #
+      #   Its own type, field for field the same as BillingRequest. Same reason as the
+      #   brand: a response is not a request, whatever it carries.
+      #
+      #   @return [Sentdm::Models::SenderProfileBilling, nil]
+      optional :billing, -> { Sentdm::SenderProfileBilling }, nil?: true
+
+      # @!attribute channels
+      #   The channels a profile sends on. SMS is a list because a profile can send in
+      #   several markets; WhatsApp and RCS are single, because a profile has one business
+      #   account and one agent.
+      #
+      #   @return [Sentdm::Models::ChannelsState, nil]
+      optional :channels, -> { Sentdm::ChannelsState }, nil?: true
+
+      # @!attribute compliance
+      #   What a market has been given: the identity it registers under, its programme,
+      #   and any documents attached.
+      #
+      #   What it does not carry is what the market asks for. That is the subject of GET
+      #   /v3/compliance/requirements, and it is the same answer for every caller — a
+      #   description of what a compliance regime wants, not a record of one customer's
+      #   progress through it. It was reported here as well for a while, which put the
+      #   same array in six response shapes and left a caller deciding which of two
+      #   sources to believe.
+      #
+      #   Present on a list read for markets that register (carrying brand and campaign),
+      #   but with documents absent — documents are not fetched for a list, because a
+      #   catalog lookup and a document read per market would multiply across a page.
+      #   Absent documents is distinct from an empty list: absent says they were not
+      #   fetched; empty says the market has been given none. The parent object is null
+      #   only when the market registers with nobody and compliance was not computed —
+      #   nothing to show at all.
+      #
+      #   @return [Sentdm::Models::Channels::SuppliedCompliance, nil]
+      optional :compliance, -> { Sentdm::Channels::SuppliedCompliance }, nil?: true
+
+      # @!attribute created_at
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute notifications
+      #   Who is notified about this profile's events: ORGANIZATION, SENDER_PROFILE, or
+      #   ORGANIZATION_AND_SENDER_PROFILE. Always present — a profile that never chose
+      #   reports as ORGANIZATION, the value a create would send to get the default
+      #   behaviour.
+      #
+      #   @return [String, nil]
+      optional :notifications, String, nil?: true
+
+      # @!attribute organization_id
+      #
+      #   @return [String, nil]
+      optional :organization_id, String, nil?: true
+
+      # @!attribute short_name
+      #
+      #   @return [String, nil]
+      optional :short_name, String, nil?: true
+
+      # @!method initialize(id: nil, api_key: nil, billing: nil, channels: nil, compliance: nil, created_at: nil, description: nil, name: nil, notifications: nil, organization_id: nil, short_name: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::SenderProfile} for more details.
+      #
+      #   A sender profile as the API reports it — the same document the create call
+      #   accepts, plus the read-only facts it cannot: each market's status and what it
+      #   still owes.
+      #
+      #   No status at the profile, brand or campaign level. Brand and campaign are
+      #   identity, and identity has no lifecycle. What has one is the registration of a
+      #   sender in a market, and the approval of a channel — so status lives there, where
+      #   it says which specific thing is blocked rather than flattening several answers
+      #   into one.
+      #
+      #   @param id [String]
+      #
+      #   @param api_key [String, nil] The API key for this profile.
+      #
+      #   @param billing [Sentdm::Models::SenderProfileBilling, nil] Who pays for a sender profile's traffic, as a read reports it.
+      #
+      #   @param channels [Sentdm::Models::ChannelsState, nil] The channels a profile sends on. SMS is a list because a profile can send in sev
+      #
+      #   @param compliance [Sentdm::Models::Channels::SuppliedCompliance, nil] What a market has been given: the identity it registers under, its programme, an
+      #
+      #   @param created_at [Time]
+      #
+      #   @param description [String, nil]
+      #
+      #   @param name [String]
+      #
+      #   @param notifications [String, nil] Who is notified about this profile's events: ORGANIZATION, SENDER_PROFILE, or
+      #
+      #   @param organization_id [String, nil]
+      #
+      #   @param short_name [String, nil]
+    end
+  end
+end

data/lib/sentdm/models/sender_profile_billing.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class SenderProfileBilling < Sentdm::Internal::Type::BaseModel
+      # @!attribute inherit
+      #   Whether the organization pays, rather than the profile.
+      #
+      #   @return [Boolean, nil]
+      optional :inherit, Sentdm::Internal::Type::Boolean
+
+      # @!method initialize(inherit: nil)
+      #   Who pays for a sender profile's traffic, as a read reports it.
+      #
+      #   Its own type, field for field the same as BillingRequest. Same reason as the
+      #   brand: a response is not a request, whatever it carries.
+      #
+      #   @param inherit [Boolean] Whether the organization pays, rather than the profile.
+    end
+  end
+end

data/lib/sentdm/models/sender_profile_billing_request.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class SenderProfileBillingRequest < Sentdm::Internal::Type::BaseModel
+      # @!attribute inherit
+      #   Whether the parent organization pays. false is the profile paying for itself.
+      #
+      #   @return [Boolean, nil]
+      optional :inherit, Sentdm::Internal::Type::Boolean
+
+      # @!method initialize(inherit: nil)
+      #   Who pays for what a sender profile sends.
+      #
+      #   Ownership reads the same way as BrandRequest and CampaignRequest: inherit: true
+      #   is the organization paying; inherit: false (or an empty block) is the profile
+      #   paying for itself.
+      #
+      #   An absent block is the one place billing differs from brand and campaign: a
+      #   profile still has to be paid for, so omitting billing stores
+      #   ProfileAndOrganizationBilling — the profile pays first and its organization
+      #   covers what the profile's balance cannot (see ResolveStored). { "name": "..." }
+      #   stays a complete request.
+      #
+      #   Billing carries no fields of its own yet, so a profile paying for itself is {
+      #   "inherit": false } — or an empty block, which means the same. That is thinner
+      #   than brand and campaign, where supplying data is the act of owning; it becomes
+      #   ordinary the moment billing gains a contact or a payment method to carry.
+      #
+      #   @param inherit [Boolean] Whether the parent organization pays. false is the profile paying for itself.
+    end
+  end
+end

data/lib/sentdm/models/sender_profile_channels.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class SenderProfileChannels < Sentdm::Internal::Type::BaseModel
+      # @!attribute rcs
+      #   Asks for an RCS agent of the profile's own, optionally with the full order form
+      #   inline.
+      #
+      #   Two modes, distinguished by whether any field is populated: "rcs": {} — intent
+      #   only. Records that the profile wants its own agent; the order form is submitted
+      #   separately through POST /v3/channels/rcs once the fields are ready. "rcs": {
+      #   ...fields... } — full form. All required fields must be present; the agent is
+      #   created alongside the profile in one call. Omitting opt_in_screenshot_url is
+      #   allowed.
+      #
+      #   @return [Sentdm::Models::SenderProfileRcs, nil]
+      optional :rcs, -> { Sentdm::SenderProfileRcs }, nil?: true
+
+      # @!attribute sms
+      #   One SMS market a profile sends in — a country and a sender type.
+      #
+      #   A profile may have several. It is a tenant, not a market: a business sending to
+      #   two countries is one customer of yours, and forcing it into two profiles would
+      #   give it two API keys, two inboxes and two contact lists for one business. The
+      #   platform already assumes many — CustomerChannelProviders is unique on (customer,
+      #   channel, iso, number).
+      #
+      #   No mode: a sender is the profile's own or it has none. Listing a market is the
+      #   request for one.
+      #
+      #   Also the discriminator for everything else: the compliance catalog is keyed on
+      #   (country, number type), and that pair decides which fields brand accepts and
+      #   what compliance is asked for.
+      #
+      #   @return [Sentdm::Models::SenderProfileSMS, nil]
+      optional :sms, -> { Sentdm::SenderProfileSMS }, nil?: true
+
+      # @!attribute whatsapp
+      #   The profile's own WhatsApp Business Account, named by the two identifiers the
+      #   organization cannot answer for you.
+      #
+      #   No mode: a profile's WABA is its own or it has none. Sharing the organization's
+      #   would mean sharing its inbox and its throughput, which makes the two
+      #   indistinguishable to a recipient — so inheriting is not offered rather than
+      #   refused.
+      #
+      #   Everything derivable is derived. Whenever this block is present, the solution
+      #   the account arrived through, the client business portfolio that owns it, the
+      #   access token and that token's expiry are all resolved from the organization by
+      #   IPartnerSolutionService.ResolveAccountCredentialsAsync — the first two off the
+      #   org's shared-account listing, the token minted against the org's own solution.
+      #   They were previously asked for and are no longer accepted: solution_id and
+      #   owner_business_id are Meta's answer about provenance, so taking them from the
+      #   caller let a request assert a partnership Meta disagreed with, and the listing
+      #   has to be consulted regardless because it is what proves the account is one this
+      #   organization may reach.
+      #
+      #   No access token, and there never was one here: it is minted per client business
+      #   portfolio and rotates roughly every sixty days, so a pasted value would be stale
+      #   before it was useful. Asking a customer to mint a System User token in Meta
+      #   Business Manager is skilled work in a console they were never meant to see, and
+      #   it would say nothing about which solution the account came from or when it is
+      #   revoked.
+      #
+      #   @return [Sentdm::Models::SenderProfileWhatsapp, nil]
+      optional :whatsapp, -> { Sentdm::SenderProfileWhatsapp }, nil?: true
+
+      # @!method initialize(rcs: nil, sms: nil, whatsapp: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::SenderProfileChannels} for more details.
+      #
+      #   The channels the profile sends on. Each is independently the profile's own or
+      #   absent — none can be inherited, so none carries a mode and presence is the whole
+      #   of the request.
+      #
+      #   A profile can send SMS in several markets, but create takes one — the market it
+      #   starts in. Further markets are added through POST /v3/channels/sms with
+      #   x-profile-id, and a read returns them all as a list. Create stays singular
+      #   permanently rather than being a list that accepts one entry: the constraint is
+      #   in the type, and there is no later widening to break the contract.
+      #
+      #   @param rcs [Sentdm::Models::SenderProfileRcs, nil] Asks for an RCS agent of the profile's own, optionally with the full order form
+      #
+      #   @param sms [Sentdm::Models::SenderProfileSMS, nil] One SMS market a profile sends in — a country and a sender type.
+      #
+      #   @param whatsapp [Sentdm::Models::SenderProfileWhatsapp, nil] The profile's own WhatsApp Business Account, named by the two identifiers the or
+    end
+  end
+end

data/lib/sentdm/models/sender_profile_create_params.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::SenderProfiles#create
+    class SenderProfileCreateParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute billing
+      #   Who pays for what a sender profile sends.
+      #
+      #   Ownership reads the same way as BrandRequest and CampaignRequest: inherit: true
+      #   is the organization paying; inherit: false (or an empty block) is the profile
+      #   paying for itself.
+      #
+      #   An absent block is the one place billing differs from brand and campaign: a
+      #   profile still has to be paid for, so omitting billing stores
+      #   ProfileAndOrganizationBilling — the profile pays first and its organization
+      #   covers what the profile's balance cannot (see ResolveStored). { "name": "..." }
+      #   stays a complete request.
+      #
+      #   Billing carries no fields of its own yet, so a profile paying for itself is {
+      #   "inherit": false } — or an empty block, which means the same. That is thinner
+      #   than brand and campaign, where supplying data is the act of owning; it becomes
+      #   ordinary the moment billing gains a contact or a payment method to carry.
+      #
+      #   @return [Sentdm::Models::SenderProfileBillingRequest, nil]
+      optional :billing, -> { Sentdm::SenderProfileBillingRequest }, nil?: true
+
+      # @!attribute channels
+      #   The channels the profile sends on. Each is independently the profile's own or
+      #   absent — none can be inherited, so none carries a mode and presence is the whole
+      #   of the request.
+      #
+      #   A profile can send SMS in several markets, but create takes one — the market it
+      #   starts in. Further markets are added through POST /v3/channels/sms with
+      #   x-profile-id, and a read returns them all as a list. Create stays singular
+      #   permanently rather than being a list that accepts one entry: the constraint is
+      #   in the type, and there is no later widening to break the contract.
+      #
+      #   @return [Sentdm::Models::SenderProfileChannels, nil]
+      optional :channels, -> { Sentdm::SenderProfileChannels }, nil?: true
+
+      # @!attribute compliance
+      #   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.
+      #
+      #   @return [Sentdm::Models::Channels::MarketCompliance, nil]
+      optional :compliance, -> { Sentdm::Channels::MarketCompliance }
+
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute name
+      #   Display name for the profile. Required.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute notifications
+      #   Who is notified about this profile's events: ORGANIZATION, SENDER_PROFILE, or
+      #   ORGANIZATION_AND_SENDER_PROFILE. Omitting it leaves the profile on the
+      #   Organization default.
+      #
+      #   @return [String, nil]
+      optional :notifications, String, nil?: true
+
+      # @!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 short_name
+      #   Short name, which is also the SMS sender id — required. 3–11 characters of
+      #   letters, numbers and spaces, with at least one letter.
+      #
+      #   @return [String, nil]
+      optional :short_name, String
+
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!method initialize(billing: nil, channels: nil, compliance: nil, description: nil, name: nil, notifications: nil, sandbox: nil, short_name: nil, idempotency_key: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::SenderProfileCreateParams} for more details.
+      #
+      #   @param billing [Sentdm::Models::SenderProfileBillingRequest, nil] Who pays for what a sender profile sends.
+      #
+      #   @param channels [Sentdm::Models::SenderProfileChannels, nil] The channels the profile sends on. Each is independently the profile's own or ab
+      #
+      #   @param compliance [Sentdm::Models::Channels::MarketCompliance] The compliance values a market registers with. `brand` and `campaign` apply to U
+      #
+      #   @param description [String, nil]
+      #
+      #   @param name [String] Display name for the profile. Required.
+      #
+      #   @param notifications [String, nil] Who is notified about this profile's events: ORGANIZATION, SENDER_PROFILE, or
+      #
+      #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+      #
+      #   @param short_name [String] Short name, which is also the SMS sender id — required. 3–11 characters of lette
+      #
+      #   @param idempotency_key [String]
+      #
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/sender_profile_delete_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::SenderProfiles#delete
+    class SenderProfileDeleteParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/sender_profile_list_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::SenderProfiles#list
+    class SenderProfileListParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute page
+      #   Page number, 1-indexed.
+      #
+      #   @return [Integer, nil]
+      optional :page, Integer
+
+      # @!attribute page_size
+      #   Profiles per page. Between 1 and 100.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!method initialize(page: nil, page_size: nil, request_options: {})
+      #   @param page [Integer] Page number, 1-indexed.
+      #
+      #   @param page_size [Integer] Profiles per page. Between 1 and 100.
+      #
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/sender_profile_rcs.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class SenderProfileRcs < Sentdm::Internal::Type::BaseModel
+      # @!attribute description
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute agent_use_case
+      #
+      #   @return [String, nil]
+      optional :agent_use_case, String, nil?: true
+
+      # @!attribute banner_url
+      #
+      #   @return [String, nil]
+      optional :banner_url, String, nil?: true
+
+      # @!attribute billing_category
+      #
+      #   @return [String, nil]
+      optional :billing_category, String, nil?: true
+
+      # @!attribute brand_color
+      #
+      #   @return [String, nil]
+      optional :brand_color, String, nil?: true
+
+      # @!attribute brand_email
+      #
+      #   @return [String, nil]
+      optional :brand_email, String, nil?: true
+
+      # @!attribute brand_name
+      #
+      #   @return [String, nil]
+      optional :brand_name, String, nil?: true
+
+      # @!attribute brand_phone_number
+      #
+      #   @return [String, nil]
+      optional :brand_phone_number, String, nil?: true
+
+      # @!attribute brief_company_description
+      #
+      #   @return [String, nil]
+      optional :brief_company_description, String, nil?: true
+
+      # @!attribute company_ein
+      #
+      #   @return [String, nil]
+      optional :company_ein, String, nil?: true
+
+      # @!attribute contact_name_and_title
+      #
+      #   @return [String, nil]
+      optional :contact_name_and_title, String, nil?: true
+
+      # @!attribute customer_support_email
+      #
+      #   @return [String, nil]
+      optional :customer_support_email, String, nil?: true
+
+      # @!attribute customer_support_phone_number
+      #
+      #   @return [String, nil]
+      optional :customer_support_phone_number, String, nil?: true
+
+      # @!attribute display_name
+      #
+      #   @return [String, nil]
+      optional :display_name, String, nil?: true
+
+      # @!attribute entity_type
+      #
+      #   @return [String, nil]
+      optional :entity_type, String, nil?: true
+
+      # @!attribute help_message
+      #
+      #   @return [String, nil]
+      optional :help_message, String, nil?: true
+
+      # @!attribute hosting_region
+      #
+      #   @return [String, nil]
+      optional :hosting_region, String, nil?: true
+
+      # @!attribute logo_url
+      #
+      #   @return [String, nil]
+      optional :logo_url, String, nil?: true
+
+      # @!attribute official_address
+      #   The registered address of the company behind the agent.
+      #
+      #   @return [Sentdm::Models::Channels::RcsAddress, nil]
+      optional :official_address, -> { Sentdm::Channels::RcsAddress }, nil?: true
+
+      # @!attribute opt_in_process_description
+      #
+      #   @return [String, nil]
+      optional :opt_in_process_description, String, nil?: true
+
+      # @!attribute opt_in_screenshot_url
+      #   Optional — uploaded separately and its URL may not be known at submission time.
+      #
+      #   @return [String, nil]
+      optional :opt_in_screenshot_url, String, nil?: true
+
+      # @!attribute privacy_policy_url
+      #
+      #   @return [String, nil]
+      optional :privacy_policy_url, String, nil?: true
+
+      # @!attribute sample_messages
+      #
+      #   @return [Array<String>, nil]
+      optional :sample_messages, Sentdm::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute start_message
+      #
+      #   @return [String, nil]
+      optional :start_message, String, nil?: true
+
+      # @!attribute stop_message
+      #
+      #   @return [String, nil]
+      optional :stop_message, String, nil?: true
+
+      # @!attribute terms_and_conditions_url
+      #
+      #   @return [String, nil]
+      optional :terms_and_conditions_url, String, nil?: true
+
+      # @!attribute website_url
+      #
+      #   @return [String, nil]
+      optional :website_url, String, nil?: true
+
+      # @!method initialize(description:, agent_use_case: nil, banner_url: nil, billing_category: 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, display_name: nil, entity_type: nil, help_message: nil, hosting_region: nil, logo_url: nil, official_address: nil, opt_in_process_description: nil, opt_in_screenshot_url: nil, privacy_policy_url: nil, sample_messages: nil, start_message: nil, stop_message: nil, terms_and_conditions_url: nil, website_url: nil)
+      #   Asks for an RCS agent of the profile's own, optionally with the full order form
+      #   inline.
+      #
+      #   Two modes, distinguished by whether any field is populated: "rcs": {} — intent
+      #   only. Records that the profile wants its own agent; the order form is submitted
+      #   separately through POST /v3/channels/rcs once the fields are ready. "rcs": {
+      #   ...fields... } — full form. All required fields must be present; the agent is
+      #   created alongside the profile in one call. Omitting opt_in_screenshot_url is
+      #   allowed.
+      #
+      #   @param description [String]
+      #
+      #   @param agent_use_case [String, nil]
+      #
+      #   @param banner_url [String, nil]
+      #
+      #   @param billing_category [String, nil]
+      #
+      #   @param brand_color [String, nil]
+      #
+      #   @param brand_email [String, nil]
+      #
+      #   @param brand_name [String, nil]
+      #
+      #   @param brand_phone_number [String, nil]
+      #
+      #   @param brief_company_description [String, nil]
+      #
+      #   @param company_ein [String, nil]
+      #
+      #   @param contact_name_and_title [String, nil]
+      #
+      #   @param customer_support_email [String, nil]
+      #
+      #   @param customer_support_phone_number [String, nil]
+      #
+      #   @param display_name [String, nil]
+      #
+      #   @param entity_type [String, nil]
+      #
+      #   @param help_message [String, nil]
+      #
+      #   @param hosting_region [String, nil]
+      #
+      #   @param logo_url [String, nil]
+      #
+      #   @param official_address [Sentdm::Models::Channels::RcsAddress, nil] The registered address of the company behind the agent.
+      #
+      #   @param opt_in_process_description [String, nil]
+      #
+      #   @param opt_in_screenshot_url [String, nil] Optional — uploaded separately and its URL may not be known at submission time.
+      #
+      #   @param privacy_policy_url [String, nil]
+      #
+      #   @param sample_messages [Array<String>, nil]
+      #
+      #   @param start_message [String, nil]
+      #
+      #   @param stop_message [String, nil]
+      #
+      #   @param terms_and_conditions_url [String, nil]
+      #
+      #   @param website_url [String, nil]
+    end
+  end
+end