sentdm 0.46.0 → 0.48.0

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

@@ -0,0 +1,117 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      module SMS
+        class APIResponseOfSuppliedCompliance < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::Channels::SMS::APIResponseOfSuppliedCompliance,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          # 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.
+          sig { returns(T.nilable(Sentdm::Channels::SuppliedCompliance)) }
+          attr_reader :data
+
+          sig do
+            params(
+              data: T.nilable(Sentdm::Channels::SuppliedCompliance::OrHash)
+            ).void
+          end
+          attr_writer :data
+
+          # Error information
+          sig { returns(T.nilable(Sentdm::ErrorDetail)) }
+          attr_reader :error
+
+          sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
+          attr_writer :error
+
+          # Request and response metadata
+          sig { returns(T.nilable(Sentdm::APIMeta)) }
+          attr_reader :meta
+
+          sig { params(meta: Sentdm::APIMeta::OrHash).void }
+          attr_writer :meta
+
+          # Indicates whether the request was successful
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :success
+
+          sig { params(success: T::Boolean).void }
+          attr_writer :success
+
+          # Standard API response envelope for all v3 endpoints
+          sig do
+            params(
+              data: T.nilable(Sentdm::Channels::SuppliedCompliance::OrHash),
+              error: T.nilable(Sentdm::ErrorDetail::OrHash),
+              meta: Sentdm::APIMeta::OrHash,
+              success: T::Boolean
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # 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.
+            data: nil,
+            # Error information
+            error: nil,
+            # Request and response metadata
+            meta: nil,
+            # Indicates whether the request was successful
+            success: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                data: T.nilable(Sentdm::Channels::SuppliedCompliance),
+                error: T.nilable(Sentdm::ErrorDetail),
+                meta: Sentdm::APIMeta,
+                success: T::Boolean
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,255 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      module SMS
+        class TenDlcAddCampaignParams < 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::TenDlcAddCampaignParams,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :idempotency_key
+
+          # 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 :x_profile_id
+
+          sig { params(x_profile_id: String).void }
+          attr_writer :x_profile_id
+
+          sig do
+            params(
+              idempotency_key: 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,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            idempotency_key:,
+            # 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,
+            x_profile_id: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                idempotency_key: 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,
+                x_profile_id: String,
+                request_options: Sentdm::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      module SMS
+        class TenDlcAddNumbersParams < 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::TenDlcAddNumbersParams,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          # The campaign to add the numbers to, as compliance.campaigns[].id reports it.
+          # Required.
+          sig { returns(String) }
+          attr_accessor :campaign_id
+
+          # 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.
+          sig do
+            returns(T::Array[T.nilable(Sentdm::Channels::SMSNumberRequest)])
+          end
+          attr_accessor :numbers
+
+          sig { returns(String) }
+          attr_accessor :idempotency_key
+
+          # 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
+
+          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,
+              numbers:
+                T::Array[T.nilable(Sentdm::Channels::SMSNumberRequest::OrHash)],
+              idempotency_key: String,
+              sandbox: T::Boolean,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The campaign to add the numbers to, as compliance.campaigns[].id reports it.
+            # Required.
+            campaign_id:,
+            # 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.
+            numbers:,
+            idempotency_key:,
+            # Sandbox flag - when true, the operation is simulated without side effects Useful
+            # for testing integrations without actual execution
+            sandbox: nil,
+            x_profile_id: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                campaign_id: String,
+                numbers:
+                  T::Array[T.nilable(Sentdm::Channels::SMSNumberRequest)],
+                idempotency_key: String,
+                sandbox: T::Boolean,
+                x_profile_id: String,
+                request_options: Sentdm::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,143 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      module SMS
+        class TenDlcCampaignUseCase < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::Channels::SMS::TenDlcCampaignUseCase,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          # Sample messages. TCR sample1..sample5 for this use case. One to five, each
+          # carrying the brand name and an opt-out instruction.
+          sig { returns(T::Array[T.anything]) }
+          attr_accessor :sample_messages
+
+          # Use case. What this entry sends. MIXED and LOW_VOLUME are refused — volume
+          # decides those.
+          sig do
+            returns(
+              Sentdm::Channels::SMS::TenDlcCampaignUseCase::UseCase::OrSymbol
+            )
+          end
+          attr_accessor :use_case
+
+          sig do
+            params(
+              sample_messages: T::Array[T.anything],
+              use_case:
+                Sentdm::Channels::SMS::TenDlcCampaignUseCase::UseCase::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Sample messages. TCR sample1..sample5 for this use case. One to five, each
+            # carrying the brand name and an opt-out instruction.
+            sample_messages:,
+            # Use case. What this entry sends. MIXED and LOW_VOLUME are refused — volume
+            # decides those.
+            use_case:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                sample_messages: T::Array[T.anything],
+                use_case:
+                  Sentdm::Channels::SMS::TenDlcCampaignUseCase::UseCase::OrSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Use case. What this entry sends. MIXED and LOW_VOLUME are refused — volume
+          # decides those.
+          module UseCase
+            extend Sentdm::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Sentdm::Channels::SMS::TenDlcCampaignUseCase::UseCase
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            MARKETING =
+              T.let(
+                :MARKETING,
+                Sentdm::Channels::SMS::TenDlcCampaignUseCase::UseCase::TaggedSymbol
+              )
+            ACCOUNT_NOTIFICATION =
+              T.let(
+                :ACCOUNT_NOTIFICATION,
+                Sentdm::Channels::SMS::TenDlcCampaignUseCase::UseCase::TaggedSymbol
+              )
+            CUSTOMER_CARE =
+              T.let(
+                :CUSTOMER_CARE,
+                Sentdm::Channels::SMS::TenDlcCampaignUseCase::UseCase::TaggedSymbol
+              )
+            FRAUD_ALERT =
+              T.let(
+                :FRAUD_ALERT,
+                Sentdm::Channels::SMS::TenDlcCampaignUseCase::UseCase::TaggedSymbol
+              )
+            USE_CASE_2_FA =
+              T.let(
+                :"2FA",
+                Sentdm::Channels::SMS::TenDlcCampaignUseCase::UseCase::TaggedSymbol
+              )
+            DELIVERY_NOTIFICATION =
+              T.let(
+                :DELIVERY_NOTIFICATION,
+                Sentdm::Channels::SMS::TenDlcCampaignUseCase::UseCase::TaggedSymbol
+              )
+            SECURITY_ALERT =
+              T.let(
+                :SECURITY_ALERT,
+                Sentdm::Channels::SMS::TenDlcCampaignUseCase::UseCase::TaggedSymbol
+              )
+            M2_M =
+              T.let(
+                :M2M,
+                Sentdm::Channels::SMS::TenDlcCampaignUseCase::UseCase::TaggedSymbol
+              )
+            HIGHER_EDUCATION =
+              T.let(
+                :HIGHER_EDUCATION,
+                Sentdm::Channels::SMS::TenDlcCampaignUseCase::UseCase::TaggedSymbol
+              )
+            POLLING_VOTING =
+              T.let(
+                :POLLING_VOTING,
+                Sentdm::Channels::SMS::TenDlcCampaignUseCase::UseCase::TaggedSymbol
+              )
+            PUBLIC_SERVICE_ANNOUNCEMENT =
+              T.let(
+                :PUBLIC_SERVICE_ANNOUNCEMENT,
+                Sentdm::Channels::SMS::TenDlcCampaignUseCase::UseCase::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Sentdm::Channels::SMS::TenDlcCampaignUseCase::UseCase::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      module SMS
+        class TenDlcRetrieveComplianceParams < 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::TenDlcRetrieveComplianceParams,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          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(
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(x_profile_id: nil, request_options: {})
+          end
+
+          sig do
+            override.returns(
+              { x_profile_id: String, request_options: Sentdm::RequestOptions }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end