sentdm 0.25.0 → 0.27.0

data/rbi/sentdm/models/message_event_payload.rbi

@@ -0,0 +1,132 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class MessageEventPayload < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::MessageEventPayload, Sentdm::Internal::AnyHash)
+        end
+
+      # The account the message belongs to.
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_id
+
+      sig { params(account_id: String).void }
+      attr_writer :account_id
+
+      # The agent attributed to the send, when the send was attributed to one.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :agent_id
+
+      # The channel the message went out on, for example sms or whatsapp. A message that
+      # falls back to another channel reports the channel actually used.
+      sig { returns(T.nilable(String)) }
+      attr_reader :channel
+
+      sig { params(channel: String).void }
+      attr_writer :channel
+
+      # The message this event describes. Stable across every event in the message's
+      # lifecycle, so use it to correlate them.
+      sig { returns(T.nilable(String)) }
+      attr_reader :message_id
+
+      sig { params(message_id: String).void }
+      attr_writer :message_id
+
+      # The status the message just reached, for example SENT, DELIVERED, or FAILED.
+      # Sent means dispatched and delivered means confirmed, so treat them as distinct
+      # outcomes.
+      sig { returns(T.nilable(String)) }
+      attr_reader :message_status
+
+      sig { params(message_status: String).void }
+      attr_writer :message_status
+
+      # The recipient's number in E.164 format.
+      sig { returns(T.nilable(String)) }
+      attr_reader :outbound_number
+
+      sig { params(outbound_number: String).void }
+      attr_writer :outbound_number
+
+      # The template the message was sent from, when it was sent from one.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :template_id
+
+      # Name of the template the message was sent from. Omitted when the message wasn't
+      # template-based.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :template_name
+
+      # When the message reached MessageStatus, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+      sig { returns(T.nilable(String)) }
+      attr_reader :updated_at
+
+      sig { params(updated_at: String).void }
+      attr_writer :updated_at
+
+      # Body of an outbound message lifecycle event. Delivered once per status change,
+      # so a single message produces several of these as it moves toward a terminal
+      # status.
+      sig do
+        params(
+          account_id: String,
+          agent_id: T.nilable(String),
+          channel: String,
+          message_id: String,
+          message_status: String,
+          outbound_number: String,
+          template_id: T.nilable(String),
+          template_name: T.nilable(String),
+          updated_at: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The account the message belongs to.
+        account_id: nil,
+        # The agent attributed to the send, when the send was attributed to one.
+        agent_id: nil,
+        # The channel the message went out on, for example sms or whatsapp. A message that
+        # falls back to another channel reports the channel actually used.
+        channel: nil,
+        # The message this event describes. Stable across every event in the message's
+        # lifecycle, so use it to correlate them.
+        message_id: nil,
+        # The status the message just reached, for example SENT, DELIVERED, or FAILED.
+        # Sent means dispatched and delivered means confirmed, so treat them as distinct
+        # outcomes.
+        message_status: nil,
+        # The recipient's number in E.164 format.
+        outbound_number: nil,
+        # The template the message was sent from, when it was sent from one.
+        template_id: nil,
+        # Name of the template the message was sent from. Omitted when the message wasn't
+        # template-based.
+        template_name: nil,
+        # When the message reached MessageStatus, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+        updated_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            agent_id: T.nilable(String),
+            channel: String,
+            message_id: String,
+            message_status: String,
+            outbound_number: String,
+            template_id: T.nilable(String),
+            template_name: T.nilable(String),
+            updated_at: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/message_send_response.rbi

@@ -103,8 +103,7 @@ module Sentdm
         end
         attr_writer :recipients
 
-        # Overall request status: "QUEUED" when the batch has been accepted and published
-        # to Kafka.
+        # Overall request status: "QUEUED" when the batch has been accepted for delivery.
         sig { returns(T.nilable(String)) }
         attr_reader :status
 
@@ -140,8 +139,7 @@ module Sentdm
         def self.new(
           # Per-recipient message results
           recipients: nil,
-          # Overall request status: "QUEUED" when the batch has been accepted and published
-          # to Kafka.
+          # Overall request status: "QUEUED" when the batch has been accepted for delivery.
           status: nil,
           # Template ID that was used
           template_id: nil,

data/rbi/sentdm/models/profile_detail.rbi

@@ -122,7 +122,7 @@ module Sentdm
       sig { returns(T.nilable(String)) }
       attr_accessor :sending_phone_number
 
-      # Reference to another profile for SMS/Telnyx configuration
+      # Reference to another profile whose SMS configuration this profile uses
       sig { returns(T.nilable(String)) }
       attr_accessor :sending_phone_number_profile_id
 
@@ -224,7 +224,7 @@ module Sentdm
         organization_id: nil,
         # Direct SMS phone number
         sending_phone_number: nil,
-        # Reference to another profile for SMS/Telnyx configuration
+        # Reference to another profile whose SMS configuration this profile uses
         sending_phone_number_profile_id: nil,
         # Reference to another profile for WhatsApp configuration
         sending_whatsapp_number_profile_id: nil,
@@ -378,7 +378,10 @@ module Sentdm
         sig { params(created_at: Time).void }
         attr_writer :created_at
 
-        # CSP (Campaign Service Provider) ID
+        # Deprecated and scheduled for removal. Identifies the Campaign Service Provider
+        # that registered the brand, which is Sent, so the value is the same for every
+        # brand and every account. Nothing on your side can act on it and there is no
+        # replacement. Stop reading it.
         sig { returns(T.nilable(String)) }
         attr_accessor :csp_id
 
@@ -459,7 +462,10 @@ module Sentdm
           contact: nil,
           # When the brand was created
           created_at: nil,
-          # CSP (Campaign Service Provider) ID
+          # Deprecated and scheduled for removal. Identifies the Campaign Service Provider
+          # that registered the brand, which is Sent, so the value is the same for every
+          # brand and every account. Nothing on your side can act on it and there is no
+          # replacement. Stop reading it.
           csp_id: nil,
           identity_status: nil,
           # Whether this brand is inherited from the parent organization
@@ -645,10 +651,6 @@ module Sentdm
           end
           attr_writer :destination_countries
 
-          # Expected daily messaging volume
-          sig { returns(T.nilable(String)) }
-          attr_accessor :expected_messaging_volume
-
           # Whether this is a TCR (Campaign Registry) application
           sig { returns(T.nilable(T::Boolean)) }
           attr_reader :is_tcr_application
@@ -678,7 +680,6 @@ module Sentdm
                 T.nilable(Sentdm::TcrBrandRelationship::OrSymbol),
               destination_countries:
                 T::Array[Sentdm::DestinationCountry::OrHash],
-              expected_messaging_volume: T.nilable(String),
               is_tcr_application: T::Boolean,
               notes: T.nilable(String),
               phone_number_prefix: T.nilable(String),
@@ -690,8 +691,6 @@ module Sentdm
             brand_relationship: nil,
             # List of destination countries for messaging
             destination_countries: nil,
-            # Expected daily messaging volume
-            expected_messaging_volume: nil,
             # Whether this is a TCR (Campaign Registry) application
             is_tcr_application: nil,
             # Additional notes about the business or use case
@@ -710,7 +709,6 @@ module Sentdm
                 brand_relationship:
                   T.nilable(Sentdm::TcrBrandRelationship::TaggedSymbol),
                 destination_countries: T::Array[Sentdm::DestinationCountry],
-                expected_messaging_volume: T.nilable(String),
                 is_tcr_application: T::Boolean,
                 notes: T.nilable(String),
                 phone_number_prefix: T.nilable(String),

data/rbi/sentdm/models/profile_update_params.rbi

@@ -106,7 +106,7 @@ module Sentdm
       sig { returns(T.nilable(String)) }
       attr_accessor :sending_phone_number
 
-      # Reference to another profile to use for SMS/Telnyx configuration (optional)
+      # Reference to another profile to use for SMS configuration (optional)
       sig { returns(T.nilable(String)) }
       attr_accessor :sending_phone_number_profile_id
 
@@ -208,7 +208,7 @@ module Sentdm
         sandbox: nil,
         # Direct phone number for SMS sending (optional)
         sending_phone_number: nil,
-        # Reference to another profile to use for SMS/Telnyx configuration (optional)
+        # Reference to another profile to use for SMS configuration (optional)
         sending_phone_number_profile_id: nil,
         # Reference to another profile to use for WhatsApp configuration (optional)
         sending_whatsapp_number_profile_id: nil,

data/rbi/sentdm/models/profiles/{api_response_of_tcr_campaign_with_use_cases.rbi → api_response_of_brand_campaign.rbi}

@@ -3,23 +3,21 @@
 module Sentdm
   module Models
     module Profiles
-      class APIResponseOfTcrCampaignWithUseCases < Sentdm::Internal::Type::BaseModel
+      class APIResponseOfBrandCampaign < Sentdm::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
             T.any(
-              Sentdm::Profiles::APIResponseOfTcrCampaignWithUseCases,
+              Sentdm::Profiles::APIResponseOfBrandCampaign,
               Sentdm::Internal::AnyHash
             )
           end
 
-        # The response data (null if error)
-        sig { returns(T.nilable(Sentdm::Profiles::TcrCampaignWithUseCases)) }
+        # A 10DLC campaign registered for a brand.
+        sig { returns(T.nilable(Sentdm::Profiles::BrandCampaign)) }
         attr_reader :data
 
         sig do
-          params(
-            data: T.nilable(Sentdm::Profiles::TcrCampaignWithUseCases::OrHash)
-          ).void
+          params(data: T.nilable(Sentdm::Profiles::BrandCampaign::OrHash)).void
         end
         attr_writer :data
 
@@ -47,14 +45,14 @@ module Sentdm
         # Standard API response envelope for all v3 endpoints
         sig do
           params(
-            data: T.nilable(Sentdm::Profiles::TcrCampaignWithUseCases::OrHash),
+            data: T.nilable(Sentdm::Profiles::BrandCampaign::OrHash),
             error: T.nilable(Sentdm::ErrorDetail::OrHash),
             meta: Sentdm::APIMeta::OrHash,
             success: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
-          # The response data (null if error)
+          # A 10DLC campaign registered for a brand.
           data: nil,
           # Error information
           error: nil,
@@ -68,7 +66,7 @@ module Sentdm
         sig do
           override.returns(
             {
-              data: T.nilable(Sentdm::Profiles::TcrCampaignWithUseCases),
+              data: T.nilable(Sentdm::Profiles::BrandCampaign),
               error: T.nilable(Sentdm::ErrorDetail),
               meta: Sentdm::APIMeta,
               success: T::Boolean

data/rbi/sentdm/models/profiles/{campaign_list_response.rbi → api_response_of_list_of_brand_campaign.rbi}

@@ -3,21 +3,17 @@
 module Sentdm
   module Models
     module Profiles
-      class CampaignListResponse < Sentdm::Internal::Type::BaseModel
+      class APIResponseOfListOfBrandCampaign < Sentdm::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
             T.any(
-              Sentdm::Models::Profiles::CampaignListResponse,
+              Sentdm::Profiles::APIResponseOfListOfBrandCampaign,
               Sentdm::Internal::AnyHash
             )
           end
 
         # The response data (null if error)
-        sig do
-          returns(
-            T.nilable(T::Array[Sentdm::Profiles::TcrCampaignWithUseCases])
-          )
-        end
+        sig { returns(T.nilable(T::Array[Sentdm::Profiles::BrandCampaign])) }
         attr_accessor :data
 
         # Error information
@@ -44,10 +40,7 @@ module Sentdm
         # Standard API response envelope for all v3 endpoints
         sig do
           params(
-            data:
-              T.nilable(
-                T::Array[Sentdm::Profiles::TcrCampaignWithUseCases::OrHash]
-              ),
+            data: T.nilable(T::Array[Sentdm::Profiles::BrandCampaign::OrHash]),
             error: T.nilable(Sentdm::ErrorDetail::OrHash),
             meta: Sentdm::APIMeta::OrHash,
             success: T::Boolean
@@ -68,8 +61,7 @@ module Sentdm
         sig do
           override.returns(
             {
-              data:
-                T.nilable(T::Array[Sentdm::Profiles::TcrCampaignWithUseCases]),
+              data: T.nilable(T::Array[Sentdm::Profiles::BrandCampaign]),
               error: T.nilable(Sentdm::ErrorDetail),
               meta: Sentdm::APIMeta,
               success: T::Boolean

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

@@ -0,0 +1,299 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Profiles
+      class BrandCampaign < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Profiles::BrandCampaign, Sentdm::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :billed_date
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :brand_id
+
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :cost
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :customer_id
+
+        sig { params(customer_id: String).void }
+        attr_writer :customer_id
+
+        # True once every carrier has completed its DCA election and the campaign is
+        # operationally ready for traffic.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :dca_elections_complete
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :dca_elections_completed_at
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        # True when the one-time campaign submission fee has already been charged.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :has_submission_transaction
+
+        sig { params(has_submission_transaction: T::Boolean).void }
+        attr_writer :has_submission_transaction
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :help_keywords
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :help_message
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :message_flow
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :optin_keywords
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :optin_message
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :optout_keywords
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :optout_message
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :privacy_policy_link
+
+        sig do
+          returns(
+            T.nilable(Sentdm::Profiles::BrandCampaign::Status::TaggedSymbol)
+          )
+        end
+        attr_accessor :status
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :submitted_at
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :submitted_to_tcr
+
+        sig { params(submitted_to_tcr: T::Boolean).void }
+        attr_writer :submitted_to_tcr
+
+        # The Campaign Registry identifier, once the campaign has been accepted.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :tcr_campaign_id
+
+        # Surfaced so customers can see why a submission did not reach the registry.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :tcr_sync_error
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :terms_and_conditions_link
+
+        # Campaign type (for example KYC or App).
+        sig { returns(T.nilable(String)) }
+        attr_reader :type
+
+        sig { params(type: String).void }
+        attr_writer :type
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :updated_at
+
+        sig { returns(T.nilable(T::Array[Sentdm::Profiles::CampaignUseCase])) }
+        attr_reader :use_cases
+
+        sig do
+          params(
+            use_cases: T::Array[Sentdm::Profiles::CampaignUseCase::OrHash]
+          ).void
+        end
+        attr_writer :use_cases
+
+        # Expected messaging volume for this campaign — customer-supplied on
+        # create/update, and the input to both the TCR usecase classification (LOW_VOLUME
+        # vs MIXED/specific) and the campaign fee tier. Surfaced so customers can read
+        # back the value they set.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :volume
+
+        # A 10DLC campaign registered for a brand.
+        sig do
+          params(
+            id: String,
+            billed_date: T.nilable(Time),
+            brand_id: T.nilable(String),
+            cost: T.nilable(Float),
+            created_at: Time,
+            customer_id: String,
+            dca_elections_complete: T.nilable(T::Boolean),
+            dca_elections_completed_at: T.nilable(Time),
+            description: String,
+            has_submission_transaction: T::Boolean,
+            help_keywords: T.nilable(String),
+            help_message: T.nilable(String),
+            message_flow: T.nilable(String),
+            name: String,
+            optin_keywords: T.nilable(String),
+            optin_message: T.nilable(String),
+            optout_keywords: T.nilable(String),
+            optout_message: T.nilable(String),
+            privacy_policy_link: T.nilable(String),
+            status:
+              T.nilable(Sentdm::Profiles::BrandCampaign::Status::OrSymbol),
+            submitted_at: T.nilable(Time),
+            submitted_to_tcr: T::Boolean,
+            tcr_campaign_id: T.nilable(String),
+            tcr_sync_error: T.nilable(String),
+            terms_and_conditions_link: T.nilable(String),
+            type: String,
+            updated_at: T.nilable(Time),
+            use_cases: T::Array[Sentdm::Profiles::CampaignUseCase::OrHash],
+            volume: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id: nil,
+          billed_date: nil,
+          brand_id: nil,
+          cost: nil,
+          created_at: nil,
+          customer_id: nil,
+          # True once every carrier has completed its DCA election and the campaign is
+          # operationally ready for traffic.
+          dca_elections_complete: nil,
+          dca_elections_completed_at: nil,
+          description: nil,
+          # True when the one-time campaign submission fee has already been charged.
+          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,
+          # The Campaign Registry identifier, once the campaign has been accepted.
+          tcr_campaign_id: nil,
+          # Surfaced so customers can see why a submission did not reach the registry.
+          tcr_sync_error: nil,
+          terms_and_conditions_link: nil,
+          # Campaign type (for example KYC or App).
+          type: nil,
+          updated_at: nil,
+          use_cases: nil,
+          # Expected messaging volume for this campaign — customer-supplied on
+          # create/update, and the input to both the TCR usecase classification (LOW_VOLUME
+          # vs MIXED/specific) and the campaign fee tier. Surfaced so customers can read
+          # back the value they set.
+          volume: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              billed_date: T.nilable(Time),
+              brand_id: T.nilable(String),
+              cost: T.nilable(Float),
+              created_at: Time,
+              customer_id: String,
+              dca_elections_complete: T.nilable(T::Boolean),
+              dca_elections_completed_at: T.nilable(Time),
+              description: String,
+              has_submission_transaction: T::Boolean,
+              help_keywords: T.nilable(String),
+              help_message: T.nilable(String),
+              message_flow: T.nilable(String),
+              name: String,
+              optin_keywords: T.nilable(String),
+              optin_message: T.nilable(String),
+              optout_keywords: T.nilable(String),
+              optout_message: T.nilable(String),
+              privacy_policy_link: T.nilable(String),
+              status:
+                T.nilable(
+                  Sentdm::Profiles::BrandCampaign::Status::TaggedSymbol
+                ),
+              submitted_at: T.nilable(Time),
+              submitted_to_tcr: T::Boolean,
+              tcr_campaign_id: T.nilable(String),
+              tcr_sync_error: T.nilable(String),
+              terms_and_conditions_link: T.nilable(String),
+              type: String,
+              updated_at: T.nilable(Time),
+              use_cases: T::Array[Sentdm::Profiles::CampaignUseCase],
+              volume: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Status
+          extend Sentdm::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Sentdm::Profiles::BrandCampaign::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SENT_CREATED =
+            T.let(
+              :SENT_CREATED,
+              Sentdm::Profiles::BrandCampaign::Status::TaggedSymbol
+            )
+          ACTIVE =
+            T.let(
+              :ACTIVE,
+              Sentdm::Profiles::BrandCampaign::Status::TaggedSymbol
+            )
+          EXPIRED =
+            T.let(
+              :EXPIRED,
+              Sentdm::Profiles::BrandCampaign::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Sentdm::Profiles::BrandCampaign::Status::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end