sentdm 0.46.0 → 0.48.0

data/rbi/sentdm/models/channels/sms/ten_dlc_update_campaign_params.rbi

@@ -0,0 +1,264 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      module SMS
+        class TenDlcUpdateCampaignParams < Sentdm::Internal::Type::BaseModel
+          extend Sentdm::Internal::Type::RequestParameters::Converter
+          include Sentdm::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::Channels::SMS::TenDlcUpdateCampaignParams,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :campaign_id
+
+          # 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`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :description
+
+          sig { params(description: String).void }
+          attr_writer :description
+
+          # Help keywords. TCR helpKeywords, comma separated, e.g. HELP,INFO. Required when
+          # `compliance.campaign.inherit != true`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :help_keywords
+
+          sig { params(help_keywords: String).void }
+          attr_writer :help_keywords
+
+          # Help reply. TCR helpMessage. Its presence is what sets subscriberHelp. Required
+          # when `compliance.campaign.inherit != true`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :help_message
+
+          sig { params(help_message: String).void }
+          attr_writer :help_message
+
+          # 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`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :message_flow
+
+          sig { params(message_flow: String).void }
+          attr_writer :message_flow
+
+          # Opt-in keywords. TCR optinKeywords, comma separated, e.g. START,YES. Required
+          # when `compliance.campaign.inherit != true`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :opt_in_keywords
+
+          sig { params(opt_in_keywords: String).void }
+          attr_writer :opt_in_keywords
+
+          # 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`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :opt_in_message
+
+          sig { params(opt_in_message: String).void }
+          attr_writer :opt_in_message
+
+          # 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`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :opt_out_keywords
+
+          sig { params(opt_out_keywords: String).void }
+          attr_writer :opt_out_keywords
+
+          # Opt-out confirmation. TCR optoutMessage. Its presence is what sets
+          # subscriberOptout. Required when `compliance.campaign.inherit != true`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :opt_out_message
+
+          sig { params(opt_out_message: String).void }
+          attr_writer :opt_out_message
+
+          # Privacy policy URL. TCR privacyPolicyLink. Required when
+          # `compliance.campaign.inherit != true`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :privacy_policy_link
+
+          sig { params(privacy_policy_link: String).void }
+          attr_writer :privacy_policy_link
+
+          # Sandbox flag - when true, the operation is simulated without side effects Useful
+          # for testing integrations without actual execution
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :sandbox
+
+          sig { params(sandbox: T::Boolean).void }
+          attr_writer :sandbox
+
+          # Terms and conditions URL. TCR termsAndConditionsLink. Required when
+          # `compliance.campaign.inherit != true`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :terms_and_conditions_link
+
+          sig { params(terms_and_conditions_link: String).void }
+          attr_writer :terms_and_conditions_link
+
+          # 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`.
+          sig do
+            returns(
+              T.nilable(T::Array[Sentdm::Channels::SMS::TenDlcCampaignUseCase])
+            )
+          end
+          attr_reader :use_cases
+
+          sig do
+            params(
+              use_cases:
+                T::Array[Sentdm::Channels::SMS::TenDlcCampaignUseCase::OrHash]
+            ).void
+          end
+          attr_writer :use_cases
+
+          # 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.
+          sig { returns(T.nilable(String)) }
+          attr_reader :volume
+
+          sig { params(volume: String).void }
+          attr_writer :volume
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :idempotency_key
+
+          sig { params(idempotency_key: String).void }
+          attr_writer :idempotency_key
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :x_profile_id
+
+          sig { params(x_profile_id: String).void }
+          attr_writer :x_profile_id
+
+          sig do
+            params(
+              campaign_id: String,
+              description: String,
+              help_keywords: String,
+              help_message: String,
+              message_flow: String,
+              opt_in_keywords: String,
+              opt_in_message: String,
+              opt_out_keywords: String,
+              opt_out_message: String,
+              privacy_policy_link: String,
+              sandbox: T::Boolean,
+              terms_and_conditions_link: String,
+              use_cases:
+                T::Array[Sentdm::Channels::SMS::TenDlcCampaignUseCase::OrHash],
+              volume: String,
+              idempotency_key: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            campaign_id:,
+            # 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`.
+            description: nil,
+            # Help keywords. TCR helpKeywords, comma separated, e.g. HELP,INFO. Required when
+            # `compliance.campaign.inherit != true`.
+            help_keywords: nil,
+            # Help reply. TCR helpMessage. Its presence is what sets subscriberHelp. Required
+            # when `compliance.campaign.inherit != true`.
+            help_message: nil,
+            # 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`.
+            message_flow: nil,
+            # Opt-in keywords. TCR optinKeywords, comma separated, e.g. START,YES. Required
+            # when `compliance.campaign.inherit != true`.
+            opt_in_keywords: nil,
+            # 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`.
+            opt_in_message: nil,
+            # 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`.
+            opt_out_keywords: nil,
+            # Opt-out confirmation. TCR optoutMessage. Its presence is what sets
+            # subscriberOptout. Required when `compliance.campaign.inherit != true`.
+            opt_out_message: nil,
+            # Privacy policy URL. TCR privacyPolicyLink. Required when
+            # `compliance.campaign.inherit != true`.
+            privacy_policy_link: nil,
+            # Sandbox flag - when true, the operation is simulated without side effects Useful
+            # for testing integrations without actual execution
+            sandbox: nil,
+            # Terms and conditions URL. TCR termsAndConditionsLink. Required when
+            # `compliance.campaign.inherit != true`.
+            terms_and_conditions_link: nil,
+            # 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`.
+            use_cases: nil,
+            # 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.
+            volume: nil,
+            idempotency_key: nil,
+            x_profile_id: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                campaign_id: String,
+                description: String,
+                help_keywords: String,
+                help_message: String,
+                message_flow: String,
+                opt_in_keywords: String,
+                opt_in_message: String,
+                opt_out_keywords: String,
+                opt_out_message: String,
+                privacy_policy_link: String,
+                sandbox: T::Boolean,
+                terms_and_conditions_link: String,
+                use_cases:
+                  T::Array[Sentdm::Channels::SMS::TenDlcCampaignUseCase],
+                volume: String,
+                idempotency_key: String,
+                x_profile_id: String,
+                request_options: Sentdm::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/channels/sms_market.rbi

@@ -67,12 +67,6 @@ module Sentdm
         sig { returns(T.nilable(String)) }
         attr_accessor :reason_code
 
-        # 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.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :sender_value
-
         # Where this market's sender stands, in terms of who is holding it up —
         # PROVISIONING, ACTION_NEEDED, PENDING_REVIEW or ACTIVE. Read-only.
         #
@@ -106,7 +100,6 @@ module Sentdm
             numbers: T::Array[Sentdm::Channels::SMSNumber::OrHash],
             reason: T.nilable(String),
             reason_code: T.nilable(String),
-            sender_value: T.nilable(String),
             status: T.nilable(Sentdm::Channels::SMSMarket::Status::OrSymbol)
           ).returns(T.attached_class)
         end
@@ -145,10 +138,6 @@ module Sentdm
           # this rather than on reason. Omitted while ACTIVE. Read-only; when nothing more
           # specific is known it is the generic reason for the status.
           reason_code: nil,
-          # 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.
-          sender_value: nil,
           # Where this market's sender stands, in terms of who is holding it up —
           # PROVISIONING, ACTION_NEEDED, PENDING_REVIEW or ACTIVE. Read-only.
           #
@@ -175,7 +164,6 @@ module Sentdm
               numbers: T::Array[Sentdm::Channels::SMSNumber],
               reason: T.nilable(String),
               reason_code: T.nilable(String),
-              sender_value: T.nilable(String),
               status:
                 T.nilable(Sentdm::Channels::SMSMarket::Status::TaggedSymbol)
             }

data/rbi/sentdm/models/channels/sms_number.rbi

@@ -14,6 +14,13 @@ module Sentdm
         sig { returns(T.nilable(String)) }
         attr_accessor :area_code
 
+        # 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.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :campaign_id
+
         # The number, or null while it is still to be assigned.
         sig { returns(T.nilable(String)) }
         attr_accessor :sender_value
@@ -27,6 +34,7 @@ module Sentdm
         sig do
           params(
             area_code: T.nilable(String),
+            campaign_id: T.nilable(String),
             sender_value: T.nilable(String),
             status: T.nilable(String)
           ).returns(T.attached_class)
@@ -35,6 +43,11 @@ module Sentdm
           # The number's area code, e.g. 212. While the number is still to be assigned, the
           # area code it was asked for, or null when it was asked for in any area code.
           area_code: nil,
+          # 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.
+          campaign_id: nil,
           # The number, or null while it is still to be assigned.
           sender_value: nil,
           # ACTIVE once the number can send; PROVISIONING while it is still to be assigned;
@@ -47,6 +60,7 @@ module Sentdm
           override.returns(
             {
               area_code: T.nilable(String),
+              campaign_id: T.nilable(String),
               sender_value: T.nilable(String),
               status: T.nilable(String)
             }

data/rbi/sentdm/models/channels/supplied_campaign.rbi

@@ -0,0 +1,13 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      SuppliedCampaign =
+        T.let(
+          Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::Unknown],
+          Sentdm::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/sentdm/models/channels/supplied_compliance.rbi

@@ -44,6 +44,26 @@ module Sentdm
         sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
         attr_accessor :campaign
 
+        # 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.
+        sig { returns(T.nilable(T::Array[T::Hash[Symbol, T.anything]])) }
+        attr_accessor :campaigns
+
         # What has been supplied for this market.
         #
         # Files, not values — the declared halves above carry the values. A document
@@ -77,6 +97,7 @@ module Sentdm
           params(
             brand: T.nilable(T::Hash[Symbol, T.anything]),
             campaign: T.nilable(T::Hash[Symbol, T.anything]),
+            campaigns: T.nilable(T::Array[T::Hash[Symbol, T.anything]]),
             documents:
               T.nilable(T::Array[Sentdm::Channels::SuppliedDocument::OrHash])
           ).returns(T.attached_class)
@@ -110,6 +131,24 @@ module Sentdm
           # refused if the caller sent this object back — which it is meant to be able to
           # do.
           campaign: nil,
+          # 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.
+          campaigns: nil,
           # What has been supplied for this market.
           #
           # Files, not values — the declared halves above carry the values. A document
@@ -128,6 +167,7 @@ module Sentdm
             {
               brand: T.nilable(T::Hash[Symbol, T.anything]),
               campaign: T.nilable(T::Hash[Symbol, T.anything]),
+              campaigns: T.nilable(T::Array[T::Hash[Symbol, T.anything]]),
               documents: T.nilable(T::Array[Sentdm::Channels::SuppliedDocument])
             }
           )

data/rbi/sentdm/models/profiles/brand_campaign.rbi

@@ -63,6 +63,15 @@ module Sentdm
         sig { returns(T.nilable(String)) }
         attr_accessor :help_message
 
+        # 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.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_inherited
+
+        sig { params(is_inherited: T::Boolean).void }
+        attr_writer :is_inherited
+
         sig { returns(T.nilable(String)) }
         attr_accessor :message_flow
 
@@ -152,6 +161,7 @@ module Sentdm
             has_submission_transaction: T::Boolean,
             help_keywords: T.nilable(String),
             help_message: T.nilable(String),
+            is_inherited: T::Boolean,
             message_flow: T.nilable(String),
             name: String,
             optin_keywords: T.nilable(String),
@@ -187,6 +197,10 @@ module Sentdm
           has_submission_transaction: nil,
           help_keywords: nil,
           help_message: nil,
+          # 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.
+          is_inherited: nil,
           message_flow: nil,
           name: nil,
           optin_keywords: nil,
@@ -229,6 +243,7 @@ module Sentdm
               has_submission_transaction: T::Boolean,
               help_keywords: T.nilable(String),
               help_message: T.nilable(String),
+              is_inherited: T::Boolean,
               message_flow: T.nilable(String),
               name: String,
               optin_keywords: T.nilable(String),

data/rbi/sentdm/models/voice/call.rbi

@@ -54,9 +54,10 @@ module Sentdm
         attr_accessor :ended_at
 
         # 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
         sig { returns(T.nilable(String)) }
         attr_accessor :failure_reason
 
@@ -179,9 +180,10 @@ module Sentdm
           # When the call ended (UTC). Null while the call is live
           ended_at: nil,
           # 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
           failure_reason: nil,
           # One end of a call
           from: nil,