sentdm 0.46.0 → 0.48.0

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @type [Sentdm::Internal::Type::Converter]
+      SuppliedCampaign = Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::Unknown]
+    end
+  end
+end

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

@@ -40,6 +40,30 @@ module Sentdm
         #   @return [Hash{Symbol=>Object}, nil]
         optional :campaign, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::Unknown], nil?: true
 
+        # @!attribute campaigns
+        #   Every campaign this market registers, each with inherit saying whose it is —
+        #   oldest first.
+        #
+        #   A list, because a market can now be on more than one. POST
+        #   /v3/channels/sms/compliances/US/TEN_DLC/campaigns adds a campaign of the
+        #   customer's own beside the one it has, and a profile running on its
+        #   organization's campaign keeps that one when it adds its own. Campaign can only
+        #   show one of them, so it stays as it was, for callers that read it, and this is
+        #   where the rest are.
+        #
+        #   The organization's campaign reads "inherit": true and the customer's own read
+        #   "inherit": false. Each entry is the shape of Campaign plus id, the campaign's
+        #   own id, so several can be told apart. Campaign carries no id, because it is sent
+        #   back to PATCH, which refuses a key it does not declare; this list is read-only.
+        #
+        #   Absent for a market that registers with nobody; empty for one that registers and
+        #   has no campaign yet.
+        #
+        #   @return [Array<Hash{Symbol=>Object}>, nil]
+        optional :campaigns,
+                 Sentdm::Internal::Type::ArrayOf[Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::Unknown]],
+                 nil?: true
+
         # @!attribute documents
         #   What has been supplied for this market.
         #
@@ -56,7 +80,7 @@ module Sentdm
                  -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Channels::SuppliedDocument] },
                  nil?: true
 
-        # @!method initialize(brand: nil, campaign: nil, documents: nil)
+        # @!method initialize(brand: nil, campaign: nil, campaigns: nil, documents: nil)
         #   Some parameter documentations has been truncated, see
         #   {Sentdm::Models::Channels::SuppliedCompliance} for more details.
         #
@@ -82,6 +106,8 @@ module Sentdm
         #
         #   @param campaign [Hash{Symbol=>Object}, nil] The programme this market registers, with inherit saying whose it is.
         #
+        #   @param campaigns [Array<Hash{Symbol=>Object}>, nil] Every campaign this market registers, each with inherit saying whose it is — old
+        #
         #   @param documents [Array<Sentdm::Models::Channels::SuppliedDocument>, nil] What has been supplied for this market.
       end
     end

data/lib/sentdm/models/profiles/brand_campaign.rb

@@ -72,6 +72,14 @@ module Sentdm
         #   @return [String, nil]
         optional :help_message, String, api_name: :helpMessage, nil?: true
 
+        # @!attribute is_inherited
+        #   Whether the campaign is the organization's, which the profile runs on, rather
+        #   than one of the profile's own. A profile running on its organization's campaign
+        #   can hold campaigns of its own beside it, and the list returns both.
+        #
+        #   @return [Boolean, nil]
+        optional :is_inherited, Sentdm::Internal::Type::Boolean, api_name: :isInherited
+
         # @!attribute message_flow
         #
         #   @return [String, nil]
@@ -166,7 +174,7 @@ module Sentdm
         #   @return [String, nil]
         optional :volume, String, nil?: true
 
-        # @!method initialize(id: nil, billed_date: nil, brand_id: nil, cost: nil, created_at: nil, customer_id: nil, dca_elections_complete: nil, dca_elections_completed_at: nil, description: nil, has_submission_transaction: nil, help_keywords: nil, help_message: nil, message_flow: nil, name: nil, optin_keywords: nil, optin_message: nil, optout_keywords: nil, optout_message: nil, privacy_policy_link: nil, status: nil, submitted_at: nil, submitted_to_tcr: nil, tcr_campaign_id: nil, tcr_sync_error: nil, terms_and_conditions_link: nil, type: nil, updated_at: nil, use_cases: nil, volume: nil)
+        # @!method initialize(id: nil, billed_date: nil, brand_id: nil, cost: nil, created_at: nil, customer_id: nil, dca_elections_complete: nil, dca_elections_completed_at: nil, description: nil, has_submission_transaction: nil, help_keywords: nil, help_message: nil, is_inherited: nil, message_flow: nil, name: nil, optin_keywords: nil, optin_message: nil, optout_keywords: nil, optout_message: nil, privacy_policy_link: nil, status: nil, submitted_at: nil, submitted_to_tcr: nil, tcr_campaign_id: nil, tcr_sync_error: nil, terms_and_conditions_link: nil, type: nil, updated_at: nil, use_cases: nil, volume: nil)
         #   Some parameter documentations has been truncated, see
         #   {Sentdm::Models::Profiles::BrandCampaign} for more details.
         #
@@ -196,6 +204,8 @@ module Sentdm
         #
         #   @param help_message [String, nil]
         #
+        #   @param is_inherited [Boolean] Whether the campaign is the organization's, which the profile runs on, rather th
+        #
         #   @param message_flow [String, nil]
         #
         #   @param name [String]

data/lib/sentdm/models/voice/call.rb

@@ -63,9 +63,10 @@ module Sentdm
 
         # @!attribute failure_reason
         #   Why the call did not complete: callback_timeout, invalid_answer,
-        #   insufficient_balance, destination_blocked, callback_not_configured, rejected,
-        #   no_answer, or for an agent call agent_busy or agent_unreachable. Null while the
-        #   call is live, when it completed, and when it failed without a recorded reason
+        #   insufficient_balance, payment_method_missing, destination_blocked,
+        #   callback_not_configured, rejected, no_answer, or for an agent call agent_busy or
+        #   agent_unreachable. Null while the call is live, when it completed, and when it
+        #   failed without a recorded reason
         #
         #   @return [String, nil]
         optional :failure_reason, String, nil?: true

data/lib/sentdm/resources/channels/sms/ten_dlc.rb

@@ -0,0 +1,310 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Resources
+    class Channels
+      class SMS
+        # The senders you send from, one per channel.
+        #
+        # **SMS is a list of markets**, each keyed by `(country, number_type)` — a
+        # customer can hold `us/10dlc` and `gb/alphanumeric` at once, so a market is
+        # addressed by the pair rather than by country alone. **WhatsApp and RCS are
+        # single**: a customer has one business account and one agent. **Voice is per
+        # number**: each number you hold can carry phone calls on its own
+        # (`POST /v3/channels/voice`), each with the callback URL Sent asks what to do
+        # with its calls, one of them is the default line for calls placed from your app,
+        # and voice tokens are minted with `POST /v3/voice/tokens`. Read your voice
+        # numbers with `GET /v3/channels/voice` and change one with
+        # `PATCH /v3/channels/voice/{number}`.
+        #
+        # ## Compliance lives on the market
+        #
+        # Adding a market records everything that market registers with, in its
+        # `compliance` object. Only **US `TEN_DLC`** registers with a regime — The
+        # Campaign Registry — and it is the only market whose compliance carries `brand`
+        # and `campaign`. Everywhere else compliance is documents, and many markets ask
+        # for none at all.
+        #
+        # `GET` and `PATCH` on a market return and accept the same shape, so what comes
+        # back can be sent back: an omitted key is left alone, and a key reported in
+        # `requirements` is the path into the body that clears it.
+        #
+        # Call `GET /v3/compliance/requirements` first — it answers what a market demands
+        # before you hold it, with a body you can fill in and post.
+        class TenDlc
+          # Some parameter documentations has been truncated, see
+          # {Sentdm::Models::Channels::SMS::TenDlcAddCampaignParams} for more details.
+          #
+          # Registers **a new campaign** on the US `TEN_DLC` market you already hold — the
+          # one market that registers campaigns. Use it when you want numbers for a
+          # different use case than the market's existing campaign covers. The campaign is
+          # filed under the brand the market files under — your organization's when you
+          # inherit its identity.
+          #
+          # ## What to send
+          #
+          # The new campaign's fields, at the top level of the body: use cases, consent
+          # narrative, volume, sample messages and keywords, under the
+          # `compliance.campaign.*` keys
+          # `GET /v3/compliance/requirements?country=US&type=TEN_DLC` lists, without that
+          # prefix. It has to be complete. A rejected field is keyed by its name
+          # (`description`). `id` and `inherit` are ignored, so an entry of
+          # `compliance.campaigns` can be sent as read.
+          #
+          # The identity is the market's and is not sent here. A market whose identity has
+          # no registration yet, or one not yet submitted for review, is `400`.
+          #
+          # ## What happens
+          #
+          # The campaign is recorded and goes for review; it is not filed with The Campaign
+          # Registry by this call. **It comes without numbers**: send its `id` from
+          # `compliance.campaigns` to `POST /v3/channels/sms/numbers/US/TEN_DLC` to give it
+          # some. **The campaign you already have, and its numbers, are not touched** —
+          # including a campaign you run on from your organization.
+          #
+          # **Each call files a new campaign**, which is charged when it is submitted. Send
+          # an `Idempotency-Key` so a retried request does not file a second one.
+          #
+          # To change the campaign a market already has, use
+          # `PATCH /v3/channels/sms/US/TEN_DLC`. Once a market holds more than one campaign,
+          # that `PATCH` refuses a campaign or numbers change (`409`) rather than guess
+          # which campaign is meant; numbers are added to a named campaign with
+          # `POST /v3/channels/sms/numbers/US/TEN_DLC`.
+          #
+          # Returns **the market**, in the shape `GET /v3/channels/sms/US/TEN_DLC` returns,
+          # with `202`.
+          #
+          # @overload add_campaign(idempotency_key:, description: nil, help_keywords: nil, help_message: nil, message_flow: nil, opt_in_keywords: nil, opt_in_message: nil, opt_out_keywords: nil, opt_out_message: nil, privacy_policy_link: nil, sandbox: nil, terms_and_conditions_link: nil, use_cases: nil, volume: nil, x_profile_id: nil, request_options: {})
+          #
+          # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
+          #
+          # @param description [String] Body param: What this programme sends. TCR description: what recipients will get
+          #
+          # @param help_keywords [String] Body param: Help keywords. TCR helpKeywords, comma separated, e.g. HELP,INFO. Re
+          #
+          # @param help_message [String] Body param: Help reply. TCR helpMessage. Its presence is what sets subscriberHel
+          #
+          # @param message_flow [String] Body param: Consent narrative. TCR messageFlow: how recipients opt in, in prose.
+          #
+          # @param opt_in_keywords [String] Body param: Opt-in keywords. TCR optinKeywords, comma separated, e.g. START,YES.
+          #
+          # @param opt_in_message [String] Body param: Opt-in confirmation. TCR optinMessage. Should state message frequenc
+          #
+          # @param opt_out_keywords [String] Body param: Opt-out keywords. TCR optoutKeywords, comma separated. STOP, END, CA
+          #
+          # @param opt_out_message [String] Body param: Opt-out confirmation. TCR optoutMessage. Its presence is what sets s
+          #
+          # @param privacy_policy_link [String] Body param: Privacy policy URL. TCR privacyPolicyLink. Required when `compliance
+          #
+          # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
+          #
+          # @param terms_and_conditions_link [String] Body param: Terms and conditions URL. TCR termsAndConditionsLink. Required when
+          #
+          # @param use_cases [Array<Sentdm::Models::Channels::SMS::TenDlcCampaignUseCase>] Body param: Use cases. What the campaign sends, and an example of each. One to f
+          #
+          # @param volume [String] Body param: Expected monthly volume. Decides how the campaign registers and whic
+          #
+          # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+          #
+          # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Sentdm::Models::Channels::APIResponseOfSMSMarket]
+          #
+          # @see Sentdm::Models::Channels::SMS::TenDlcAddCampaignParams
+          def add_campaign(params)
+            parsed, options = Sentdm::Channels::SMS::TenDlcAddCampaignParams.dump_request(params)
+            header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
+            @client.request(
+              method: :post,
+              path: "v3/channels/sms/compliances/US/TEN_DLC/campaigns",
+              headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+              body: parsed.except(*header_params.keys),
+              model: Sentdm::Channels::APIResponseOfSMSMarket,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {Sentdm::Models::Channels::SMS::TenDlcAddNumbersParams} for more details.
+          #
+          # Adds numbers to **one campaign of your own** on the US `TEN_DLC` market you
+          # hold, named by `campaign_id` — the `id` of an entry in the market's
+          # `compliance.campaigns`.
+          #
+          # ## What to send
+          #
+          # - `campaign_id` — the campaign. One you inherit from your organization is `400`:
+          #   its numbers are the organization's. One out of service — expired, deactivated
+          #   or released — is `409`.
+          # - `numbers` — the list `POST /v3/channels/sms` takes, one entry per area code.
+          #
+          # ## What happens
+          #
+          # The entries are **added** to what the campaign already asks for. With everything
+          # it asks for, a campaign holds at most 49 numbers, counting one for each sender
+          # profile inheriting it. A campaign the carriers have not approved yet gets its
+          # numbers when they do; an approved one gets them now. Until a number is assigned
+          # it reads as `PROVISIONING` in the market's `numbers`, with the area code it was
+          # asked for.
+          #
+          # Returns **the market**, in the shape `GET /v3/channels/sms/US/TEN_DLC` returns,
+          # with `202`.
+          #
+          # @overload add_numbers(campaign_id:, numbers:, idempotency_key:, sandbox: nil, x_profile_id: nil, request_options: {})
+          #
+          # @param campaign_id [String] Body param: The campaign to add the numbers to, as compliance.campaigns[].id rep
+          #
+          # @param numbers [Array<Sentdm::Models::Channels::SMSNumberRequest, nil>] Body param: The numbers to add, one entry per area code, e.g. [{"area_code": "41
+          #
+          # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
+          #
+          # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
+          #
+          # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+          #
+          # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Sentdm::Models::Channels::APIResponseOfSMSMarket]
+          #
+          # @see Sentdm::Models::Channels::SMS::TenDlcAddNumbersParams
+          def add_numbers(params)
+            parsed, options = Sentdm::Channels::SMS::TenDlcAddNumbersParams.dump_request(params)
+            header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
+            @client.request(
+              method: :post,
+              path: "v3/channels/sms/numbers/US/TEN_DLC",
+              headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+              body: parsed.except(*header_params.keys),
+              model: Sentdm::Channels::APIResponseOfSMSMarket,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {Sentdm::Models::Channels::SMS::TenDlcRetrieveComplianceParams} for more
+          # details.
+          #
+          # Reads what the US `TEN_DLC` market you hold has registered: the `brand` it files
+          # under, **every campaign** under `campaigns` (each with its `id` and `inherit`),
+          # and its `documents`. It is the `compliance` object
+          # `GET /v3/channels/sms/US/TEN_DLC` returns, without the sender and numbers.
+          #
+          # Use a campaign's `id` to change it with
+          # `PATCH /v3/channels/sms/compliances/US/TEN_DLC/campaigns/{campaignId}`, or to
+          # add numbers to it with `POST /v3/channels/sms/numbers/US/TEN_DLC`.
+          #
+          # Send `x-profile-id` with an organization key to read one of your profiles'
+          # markets.
+          #
+          # @overload retrieve_compliance(x_profile_id: nil, request_options: {})
+          #
+          # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
+          #
+          # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Sentdm::Models::Channels::SMS::APIResponseOfSuppliedCompliance]
+          #
+          # @see Sentdm::Models::Channels::SMS::TenDlcRetrieveComplianceParams
+          def retrieve_compliance(params = {})
+            parsed, options = Sentdm::Channels::SMS::TenDlcRetrieveComplianceParams.dump_request(params)
+            @client.request(
+              method: :get,
+              path: "v3/channels/sms/compliances/US/TEN_DLC",
+              headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
+              model: Sentdm::Channels::SMS::APIResponseOfSuppliedCompliance,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {Sentdm::Models::Channels::SMS::TenDlcUpdateCampaignParams} for more details.
+          #
+          # Changes **one campaign of your own** on the US `TEN_DLC` market, named by its
+          # `id` in the market's `compliance.campaigns`.
+          #
+          # ## What to send
+          #
+          # The fields to change, at the top level of the body, under the
+          # `compliance.campaign.*` keys
+          # `GET /v3/compliance/requirements?country=US&type=TEN_DLC` lists, without that
+          # prefix. A field you leave out keeps its value, and a rejected one is keyed by
+          # its name. `id` and `"inherit": false` are ignored, so an entry of
+          # `compliance.campaigns` can be sent as read; `"inherit": true` is `400`, because
+          # this call changes a campaign's fields, not whose campaign you run on. The
+          # campaign only: add numbers with `POST /v3/channels/sms/numbers/US/TEN_DLC`, and
+          # change the brand or documents with `PATCH /v3/channels/sms/US/TEN_DLC`.
+          #
+          # ## When it can be changed
+          #
+          # Until it is filed with The Campaign Registry, and again when we ask you to
+          # correct it. That correction sends it back for review. A filed campaign is
+          # otherwise `409`, and so is a change between low and high volume once it is
+          # registered. A campaign you run on from your organization is `409` too: it is the
+          # organization's to change. So is one out of service: expired, deactivated or
+          # released.
+          #
+          # Returns **the market**, in the shape `GET /v3/channels/sms/US/TEN_DLC` returns.
+          #
+          # @overload update_campaign(campaign_id, description: nil, help_keywords: nil, help_message: nil, message_flow: nil, opt_in_keywords: nil, opt_in_message: nil, opt_out_keywords: nil, opt_out_message: nil, privacy_policy_link: nil, sandbox: nil, terms_and_conditions_link: nil, use_cases: nil, volume: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+          #
+          # @param campaign_id [String] Path param: The campaign: its id in the market's compliance.campaigns.
+          #
+          # @param description [String] Body param: What this programme sends. TCR description: what recipients will get
+          #
+          # @param help_keywords [String] Body param: Help keywords. TCR helpKeywords, comma separated, e.g. HELP,INFO. Re
+          #
+          # @param help_message [String] Body param: Help reply. TCR helpMessage. Its presence is what sets subscriberHel
+          #
+          # @param message_flow [String] Body param: Consent narrative. TCR messageFlow: how recipients opt in, in prose.
+          #
+          # @param opt_in_keywords [String] Body param: Opt-in keywords. TCR optinKeywords, comma separated, e.g. START,YES.
+          #
+          # @param opt_in_message [String] Body param: Opt-in confirmation. TCR optinMessage. Should state message frequenc
+          #
+          # @param opt_out_keywords [String] Body param: Opt-out keywords. TCR optoutKeywords, comma separated. STOP, END, CA
+          #
+          # @param opt_out_message [String] Body param: Opt-out confirmation. TCR optoutMessage. Its presence is what sets s
+          #
+          # @param privacy_policy_link [String] Body param: Privacy policy URL. TCR privacyPolicyLink. Required when `compliance
+          #
+          # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
+          #
+          # @param terms_and_conditions_link [String] Body param: Terms and conditions URL. TCR termsAndConditionsLink. Required when
+          #
+          # @param use_cases [Array<Sentdm::Models::Channels::SMS::TenDlcCampaignUseCase>] Body param: Use cases. What the campaign sends, and an example of each. One to f
+          #
+          # @param volume [String] Body param: Expected monthly volume. Decides how the campaign registers and whic
+          #
+          # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
+          #
+          # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+          #
+          # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Sentdm::Models::Channels::APIResponseOfSMSMarket]
+          #
+          # @see Sentdm::Models::Channels::SMS::TenDlcUpdateCampaignParams
+          def update_campaign(campaign_id, params = {})
+            parsed, options = Sentdm::Channels::SMS::TenDlcUpdateCampaignParams.dump_request(params)
+            header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
+            @client.request(
+              method: :patch,
+              path: ["v3/channels/sms/compliances/US/TEN_DLC/campaigns/%1$s", campaign_id],
+              headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+              body: parsed.except(*header_params.keys),
+              model: Sentdm::Channels::APIResponseOfSMSMarket,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Sentdm::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/resources/channels/sms.rb

@@ -31,6 +31,36 @@ module Sentdm
       # Call `GET /v3/compliance/requirements` first — it answers what a market demands
       # before you hold it, with a body you can fill in and post.
       class SMS
+        # The senders you send from, one per channel.
+        #
+        # **SMS is a list of markets**, each keyed by `(country, number_type)` — a
+        # customer can hold `us/10dlc` and `gb/alphanumeric` at once, so a market is
+        # addressed by the pair rather than by country alone. **WhatsApp and RCS are
+        # single**: a customer has one business account and one agent. **Voice is per
+        # number**: each number you hold can carry phone calls on its own
+        # (`POST /v3/channels/voice`), each with the callback URL Sent asks what to do
+        # with its calls, one of them is the default line for calls placed from your app,
+        # and voice tokens are minted with `POST /v3/voice/tokens`. Read your voice
+        # numbers with `GET /v3/channels/voice` and change one with
+        # `PATCH /v3/channels/voice/{number}`.
+        #
+        # ## Compliance lives on the market
+        #
+        # Adding a market records everything that market registers with, in its
+        # `compliance` object. Only **US `TEN_DLC`** registers with a regime — The
+        # Campaign Registry — and it is the only market whose compliance carries `brand`
+        # and `campaign`. Everywhere else compliance is documents, and many markets ask
+        # for none at all.
+        #
+        # `GET` and `PATCH` on a market return and accept the same shape, so what comes
+        # back can be sent back: an omitted key is left alone, and a key reported in
+        # `requirements` is the path into the body that clears it.
+        #
+        # Call `GET /v3/compliance/requirements` first — it answers what a market demands
+        # before you hold it, with a body you can fill in and post.
+        # @return [Sentdm::Resources::Channels::SMS::TenDlc]
+        attr_reader :ten_dlc
+
         # Some parameter documentations has been truncated, see
         # {Sentdm::Models::Channels::SMSCreateParams} for more details.
         #
@@ -105,7 +135,10 @@ module Sentdm
         # read as `PROVISIONING` in the response's `numbers`, each with the area code it
         # was asked for. A profile inheriting your organization's campaign cannot request
         # `numbers` (`400`). `numbers` on a `TEN_DLC` market you already hold is `409`:
-        # its numbers belong to its one campaign and are set when the market is created.
+        # change its campaign's numbers with `PATCH /v3/channels/sms/{country}/{type}`,
+        # add numbers to one of its campaigns with
+        # `POST /v3/channels/sms/numbers/US/TEN_DLC`, or add a new campaign with
+        # `POST /v3/channels/sms/compliances/US/TEN_DLC/campaigns`.
         #
         # **A market you already send in is `409`**: adding what is already there is a
         # mistake worth reporting rather than a silent no-op. A market is a
@@ -410,6 +443,7 @@ module Sentdm
         # @param client [Sentdm::Client]
         def initialize(client:)
           @client = client
+          @ten_dlc = Sentdm::Resources::Channels::SMS::TenDlc.new(client: client)
         end
       end
     end

data/lib/sentdm/resources/profiles/campaigns.rb

@@ -118,7 +118,10 @@ module Sentdm
         # explicitly.
         #
         # Retrieves all campaigns linked to the profile's brand, including use cases and
-        # sample messages. Returns inherited campaigns if inherit_tcr_campaign=true.
+        # sample messages. A profile with inherit_tcr_campaign=true gets its
+        # organization's campaigns and, beside them, any campaign of its own (added with
+        # POST /v3/channels/sms/compliances/US/TEN_DLC/campaigns); `isInherited` says
+        # which is which.
         #
         # @overload list(profile_id, x_profile_id: nil, request_options: {})
         #

data/lib/sentdm/resources/sender_profiles.rb

@@ -14,8 +14,8 @@ module Sentdm
     # instead.
     #
     # **A sender is the exception.** A brand and a campaign can be inherited; a number
-    # cannot. A profile either has a sender of its own or terminates through your
-    # shared routes.
+    # cannot. A profile either has a sender of its own or reaches only the countries
+    # Sent runs a shared route for, and the US is not one of them.
     #
     # To act for a profile on any other resource, send `x-profile-id` with your
     # organization key rather than looking for a parallel set of endpoints.
@@ -37,7 +37,9 @@ module Sentdm
       #
       # **A sender is not one of them.** The brand and the campaign can be inherited; a
       # number cannot. A profile either has a sender of its own — `channels.sms` — or it
-      # has none and terminates through the shared routes for that country.
+      # has none and reaches only the countries Sent runs a shared route for. The US has
+      # none: without a `TEN_DLC` number of its own, a profile's SMS to US numbers ends
+      # as `FAILED` with `DELIVERY_003`.
       #
       # ## Saying what a profile owns
       #

data/lib/sentdm/resources/voice/calls/participants.rb

@@ -118,11 +118,11 @@ module Sentdm
           # conference room, and answers with the participant's own call record. The
           # participant is a call of their own: it has its own id, can be looked up and hung
           # up, and is billed and reported through call.completed and call.failed like any
-          # other call. Every participant needs a positive balance. A phone participant is
-          # called from caller_id, which must be one of your numbers, or from the call's
-          # owning number when omitted, and needs a destination you may call. Only a call
-          # your answer connected to a conference can take participants: a call connected to
-          # a user or a number answers 409.
+          # other call. Every participant needs a payment method on file and a positive
+          # balance. A phone participant is called from caller_id, which must be one of your
+          # numbers, or from the call's owning number when omitted, and needs a destination
+          # you may call. Only a call your answer connected to a conference can take
+          # participants: a call connected to a user or a number answers 409.
           #
           # @overload add(id, caller_id: nil, sandbox: nil, to: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
           #

data/lib/sentdm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sentdm
-  VERSION = "0.46.0"
+  VERSION = "0.48.0"
 end

data/lib/sentdm.rb

@@ -128,6 +128,12 @@ require_relative "sentdm/models/channels/market_compliance"
 require_relative "sentdm/models/channels/rc_create_params"
 require_relative "sentdm/models/channels/rcs_address"
 require_relative "sentdm/models/channels/rcs_agent"
+require_relative "sentdm/models/channels/sms/api_response_of_supplied_compliance"
+require_relative "sentdm/models/channels/sms/ten_dlc_add_campaign_params"
+require_relative "sentdm/models/channels/sms/ten_dlc_add_numbers_params"
+require_relative "sentdm/models/channels/sms/ten_dlc_campaign_use_case"
+require_relative "sentdm/models/channels/sms/ten_dlc_retrieve_compliance_params"
+require_relative "sentdm/models/channels/sms/ten_dlc_update_campaign_params"
 require_relative "sentdm/models/channels/sms_create_params"
 require_relative "sentdm/models/channels/sms_list_params"
 require_relative "sentdm/models/channels/sms_market"
@@ -135,6 +141,7 @@ require_relative "sentdm/models/channels/sms_number"
 require_relative "sentdm/models/channels/sms_number_request"
 require_relative "sentdm/models/channels/sms_retrieve_params"
 require_relative "sentdm/models/channels/sms_update_params"
+require_relative "sentdm/models/channels/supplied_campaign"
 require_relative "sentdm/models/channels/supplied_compliance"
 require_relative "sentdm/models/channels/supplied_document"
 require_relative "sentdm/models/channels/voice_callback_test"
@@ -349,6 +356,7 @@ require_relative "sentdm/models"
 require_relative "sentdm/resources/channels"
 require_relative "sentdm/resources/channels/rcs"
 require_relative "sentdm/resources/channels/sms"
+require_relative "sentdm/resources/channels/sms/ten_dlc"
 require_relative "sentdm/resources/channels/voice"
 require_relative "sentdm/resources/channels/whatsapp"
 require_relative "sentdm/resources/compliance"

data/rbi/sentdm/client.rbi

@@ -70,8 +70,8 @@ module Sentdm
     # instead.
     #
     # **A sender is the exception.** A brand and a campaign can be inherited; a number
-    # cannot. A profile either has a sender of its own or terminates through your
-    # shared routes.
+    # cannot. A profile either has a sender of its own or reaches only the countries
+    # Sent runs a shared route for, and the US is not one of them.
     #
     # To act for a profile on any other resource, send `x-profile-id` with your
     # organization key rather than looking for a parallel set of endpoints.