sentdm 0.46.0 → 0.48.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 819f750414001d5ce375dfda603f82bdf86ac538321ad3c9a507211cbf03e961
-  data.tar.gz: 438e1fa1e2c0dc0566f22a96af84026c640db01e4605635e3156fdfd81c6a0b7
+  metadata.gz: d38c44fc0e4e6d7b1e17992e546d60c09313b6d3a6713e00a57b307b92b08a0f
+  data.tar.gz: 13b0a8172433b58b21c01bb556247b9fbae2d8ffa5a059f27fdcb4299053945d
 SHA512:
-  metadata.gz: 31802c8938ba238bae598ec3c37fd21103d8627752dc936f503c33ada9ba8bc7580840db2bb6572b04badc9da775a45eec55820b5b1e675dc20a3b54cfbce6e5
-  data.tar.gz: 5a9d28dcae2395c7f925a04dd8dc825d0ca2c17df646ade6304a31fd0679ee136af4ff0f01270762cc82d2ab08e3d6b5e5b1beeed3f148576480fffc70bac936
+  metadata.gz: 5ff32390e560a211ac42f30d920b6ba078cb125e6af8fc10df9da6646724736955cedb6c0638cff56fe80b48e8cd4de56ea0fc390d6dcf11c1486c35d70daf6c
+  data.tar.gz: 6f1fa6cc5cb690d1a0f5a3ae4df2009219e3fbb863dbfe38cb09f2d06265ee1fdcf128c538a6b47fa2c9653a8d22e13ddd40ca17f148dc818db2cd8d8512f9c4

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [0.48.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.47.0...v0.48.0) (2026-11-12)
+
+
+### Features
+
+* **api:** methods for the US 10DLC campaigns, numbers and market compliance ([ebf5826](https://github.com/sentdm/sent-dm-ruby/commit/ebf582605d11941f03d1bc9b251fb3f6599be090))
+
+## [0.47.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.46.0...v0.47.0) (2026-11-12)
+
+
+### ⚠ BREAKING CHANGES
+
+* **api:** sync OpenAPI spec from production
+
+### Features
+
+* **api:** sync OpenAPI spec from production ([1403c2d](https://github.com/sentdm/sent-dm-ruby/commit/1403c2d4d4e9ca6cbb853c760ea14475f1da03a6))
+
 ## [0.46.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.45.0...v0.46.0) (2026-11-06)
 
 

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "sentdm", "~> 0.46.0"
+gem "sentdm", "~> 0.48.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/sentdm/client.rb

@@ -75,8 +75,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.

data/lib/sentdm/models/channels/sms/api_response_of_supplied_compliance.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      module SMS
+        # @see Sentdm::Resources::Channels::SMS::TenDlc#retrieve_compliance
+        class APIResponseOfSuppliedCompliance < Sentdm::Internal::Type::BaseModel
+          # @!attribute data
+          #   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 :data, -> { Sentdm::Channels::SuppliedCompliance }, nil?: true
+
+          # @!attribute error
+          #   Error information
+          #
+          #   @return [Sentdm::Models::ErrorDetail, nil]
+          optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+          # @!attribute meta
+          #   Request and response metadata
+          #
+          #   @return [Sentdm::Models::APIMeta, nil]
+          optional :meta, -> { Sentdm::APIMeta }
+
+          # @!attribute success
+          #   Indicates whether the request was successful
+          #
+          #   @return [Boolean, nil]
+          optional :success, Sentdm::Internal::Type::Boolean
+
+          # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::Channels::SMS::APIResponseOfSuppliedCompliance} for more
+          #   details.
+          #
+          #   Standard API response envelope for all v3 endpoints
+          #
+          #   @param data [Sentdm::Models::Channels::SuppliedCompliance, nil] What a market has been given: the identity it registers under, its programme, an
+          #
+          #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+          #
+          #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+          #
+          #   @param success [Boolean] Indicates whether the request was successful
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/sms/ten_dlc_add_campaign_params.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      module SMS
+        # @see Sentdm::Resources::Channels::SMS::TenDlc#add_campaign
+        class TenDlcAddCampaignParams < Sentdm::Internal::Type::BaseModel
+          extend Sentdm::Internal::Type::RequestParameters::Converter
+          include Sentdm::Internal::Type::RequestParameters
+
+          # @!attribute idempotency_key
+          #
+          #   @return [String]
+          required :idempotency_key, String
+
+          # @!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 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 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 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::SMS::TenDlcCampaignUseCase>, nil]
+          optional :use_cases, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Channels::SMS::TenDlcCampaignUseCase] }
+
+          # @!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
+
+          # @!attribute x_profile_id
+          #
+          #   @return [String, nil]
+          optional :x_profile_id, String
+
+          # @!method initialize(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: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::Channels::SMS::TenDlcAddCampaignParams} for more details.
+          #
+          #   @param idempotency_key [String]
+          #
+          #   @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 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 sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+          #
+          #   @param terms_and_conditions_link [String] Terms and conditions URL. TCR termsAndConditionsLink. Required when `compliance.
+          #
+          #   @param use_cases [Array<Sentdm::Models::Channels::SMS::TenDlcCampaignUseCase>] 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
+          #
+          #   @param x_profile_id [String]
+          #
+          #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/sms/ten_dlc_add_numbers_params.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      module SMS
+        # @see Sentdm::Resources::Channels::SMS::TenDlc#add_numbers
+        class TenDlcAddNumbersParams < Sentdm::Internal::Type::BaseModel
+          extend Sentdm::Internal::Type::RequestParameters::Converter
+          include Sentdm::Internal::Type::RequestParameters
+
+          # @!attribute campaign_id
+          #   The campaign to add the numbers to, as compliance.campaigns[].id reports it.
+          #   Required.
+          #
+          #   @return [String]
+          required :campaign_id, String
+
+          # @!attribute numbers
+          #   The numbers to add, one entry per area code, e.g. [{"area_code": "415",
+          #   "quantity": 2}, {"quantity": 1}]. quantity defaults to 1, and an entry without
+          #   area_code means any area code. Required.
+          #
+          #   Added to what the campaign already asks for, never replacing it.
+          #
+          #   @return [Array<Sentdm::Models::Channels::SMSNumberRequest, nil>]
+          required :numbers, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Channels::SMSNumberRequest, nil?: true] }
+
+          # @!attribute idempotency_key
+          #
+          #   @return [String]
+          required :idempotency_key, 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 x_profile_id
+          #
+          #   @return [String, nil]
+          optional :x_profile_id, String
+
+          # @!method initialize(campaign_id:, numbers:, idempotency_key:, sandbox: nil, x_profile_id: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::Channels::SMS::TenDlcAddNumbersParams} for more details.
+          #
+          #   @param campaign_id [String] The campaign to add the numbers to, as compliance.campaigns[].id reports it. Req
+          #
+          #   @param numbers [Array<Sentdm::Models::Channels::SMSNumberRequest, nil>] The numbers to add, one entry per area code, e.g. [{"area_code": "415", "quantit
+          #
+          #   @param idempotency_key [String]
+          #
+          #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+          #
+          #   @param x_profile_id [String]
+          #
+          #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/sms/ten_dlc_campaign_use_case.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      module SMS
+        class TenDlcCampaignUseCase < 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::SMS::TenDlcCampaignUseCase::UseCase]
+          required :use_case, enum: -> { Sentdm::Channels::SMS::TenDlcCampaignUseCase::UseCase }
+
+          # @!method initialize(sample_messages:, use_case:)
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::Channels::SMS::TenDlcCampaignUseCase} 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::SMS::TenDlcCampaignUseCase::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::SMS::TenDlcCampaignUseCase#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

data/lib/sentdm/models/channels/sms/ten_dlc_retrieve_compliance_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      module SMS
+        # @see Sentdm::Resources::Channels::SMS::TenDlc#retrieve_compliance
+        class TenDlcRetrieveComplianceParams < Sentdm::Internal::Type::BaseModel
+          extend Sentdm::Internal::Type::RequestParameters::Converter
+          include Sentdm::Internal::Type::RequestParameters
+
+          # @!attribute x_profile_id
+          #
+          #   @return [String, nil]
+          optional :x_profile_id, String
+
+          # @!method initialize(x_profile_id: nil, request_options: {})
+          #   @param x_profile_id [String]
+          #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/sms/ten_dlc_update_campaign_params.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      module SMS
+        # @see Sentdm::Resources::Channels::SMS::TenDlc#update_campaign
+        class TenDlcUpdateCampaignParams < Sentdm::Internal::Type::BaseModel
+          extend Sentdm::Internal::Type::RequestParameters::Converter
+          include Sentdm::Internal::Type::RequestParameters
+
+          # @!attribute campaign_id
+          #
+          #   @return [String]
+          required :campaign_id, String
+
+          # @!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 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 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 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::SMS::TenDlcCampaignUseCase>, nil]
+          optional :use_cases, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Channels::SMS::TenDlcCampaignUseCase] }
+
+          # @!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
+
+          # @!attribute idempotency_key
+          #
+          #   @return [String, nil]
+          optional :idempotency_key, String
+
+          # @!attribute x_profile_id
+          #
+          #   @return [String, nil]
+          optional :x_profile_id, String
+
+          # @!method initialize(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: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::Channels::SMS::TenDlcUpdateCampaignParams} for more details.
+          #
+          #   @param campaign_id [String]
+          #
+          #   @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 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 sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+          #
+          #   @param terms_and_conditions_link [String] Terms and conditions URL. TCR termsAndConditionsLink. Required when `compliance.
+          #
+          #   @param use_cases [Array<Sentdm::Models::Channels::SMS::TenDlcCampaignUseCase>] 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
+          #
+          #   @param idempotency_key [String]
+          #
+          #   @param x_profile_id [String]
+          #
+          #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -62,14 +62,6 @@ module Sentdm
         #   @return [String, nil]
         optional :reason_code, String, nil?: true
 
-        # @!attribute sender_value
-        #   The sender itself. Null until a carrier-assigned number is procured. For a
-        #   market holding several numbers, the first active one (the first assigned while
-        #   none is active) — every number is in numbers.
-        #
-        #   @return [String, nil]
-        optional :sender_value, String, nil?: true
-
         # @!attribute status
         #   Where this market's sender stands, in terms of who is holding it up —
         #   PROVISIONING, ACTION_NEEDED, PENDING_REVIEW or ACTIVE. Read-only.
@@ -88,7 +80,7 @@ module Sentdm
         #   @return [Symbol, Sentdm::Models::Channels::SMSMarket::Status, nil]
         optional :status, enum: -> { Sentdm::Channels::SMSMarket::Status }, nil?: true
 
-        # @!method initialize(compliance: nil, country: nil, number_type: nil, numbers: nil, reason: nil, reason_code: nil, sender_value: nil, status: nil)
+        # @!method initialize(compliance: nil, country: nil, number_type: nil, numbers: nil, reason: nil, reason_code: nil, status: nil)
         #   Some parameter documentations has been truncated, see
         #   {Sentdm::Models::Channels::SMSMarket} for more details.
         #
@@ -112,8 +104,6 @@ module Sentdm
         #
         #   @param reason_code [String, nil] Why the market is not ACTIVE, as a stable code: an ErrorCodes CHANNEL_xxx value
         #
-        #   @param sender_value [String, nil] The sender itself. Null until a carrier-assigned number is procured. For a marke
-        #
         #   @param status [Symbol, Sentdm::Models::Channels::SMSMarket::Status, nil] Where this market's sender stands, in terms of who is holding it up — PROVISIONI
 
         # Where this market's sender stands, in terms of who is holding it up —

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

@@ -11,6 +11,15 @@ module Sentdm
         #   @return [String, nil]
         optional :area_code, String, nil?: true
 
+        # @!attribute campaign_id
+        #   The campaign the number is on, or is owed for: the id of its entry in
+        #   compliance.campaigns. Omitted for a market that registers no campaigns, and
+        #   where the campaign is not known — a number recorded without one, or one owed on
+        #   a campaign inherited from the organization.
+        #
+        #   @return [String, nil]
+        optional :campaign_id, String, nil?: true
+
         # @!attribute sender_value
         #   The number, or null while it is still to be assigned.
         #
@@ -24,7 +33,7 @@ module Sentdm
         #   @return [String, nil]
         optional :status, String, nil?: true
 
-        # @!method initialize(area_code: nil, sender_value: nil, status: nil)
+        # @!method initialize(area_code: nil, campaign_id: nil, sender_value: nil, status: nil)
         #   Some parameter documentations has been truncated, see
         #   {Sentdm::Models::Channels::SMSNumber} for more details.
         #
@@ -32,6 +41,8 @@ module Sentdm
         #
         #   @param area_code [String, nil] The number's area code, e.g. 212. While the number is still to be assigned, the
         #
+        #   @param campaign_id [String, nil] The campaign the number is on, or is owed for: the id of its entry in compliance
+        #
         #   @param sender_value [String, nil] The number, or null while it is still to be assigned.
         #
         #   @param status [String, nil] ACTIVE once the number can send; PROVISIONING while it is still to be assigned;