sentdm 0.25.0 → 0.27.0

data/rbi/sentdm/models/profiles/campaign_data.rbi

@@ -22,13 +22,7 @@ module Sentdm
         attr_accessor :type
 
         # List of use cases with sample messages
-        sig do
-          returns(
-            T::Array[
-              Sentdm::Profiles::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData
-            ]
-          )
-        end
+        sig { returns(T::Array[Sentdm::Profiles::CampaignUseCaseData]) }
         attr_accessor :use_cases
 
         # Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
@@ -67,16 +61,18 @@ module Sentdm
         sig { returns(T.nilable(String)) }
         attr_accessor :terms_and_conditions_link
 
+        # Expected messaging volume for this campaign. Numeric string (e.g. "1999",
+        # "5000"). Values below 2000 bill at the low-volume tier.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :volume
+
         # Campaign data for create or update operation
         sig do
           params(
             description: String,
             name: String,
             type: String,
-            use_cases:
-              T::Array[
-                Sentdm::Profiles::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData::OrHash
-              ],
+            use_cases: T::Array[Sentdm::Profiles::CampaignUseCaseData::OrHash],
             help_keywords: T.nilable(String),
             help_message: T.nilable(String),
             message_flow: T.nilable(String),
@@ -85,7 +81,8 @@ module Sentdm
             optout_keywords: T.nilable(String),
             optout_message: T.nilable(String),
             privacy_policy_link: T.nilable(String),
-            terms_and_conditions_link: T.nilable(String)
+            terms_and_conditions_link: T.nilable(String),
+            volume: T.nilable(String)
           ).returns(T.attached_class)
         end
         def self.new(
@@ -114,7 +111,10 @@ module Sentdm
           # URL to privacy policy
           privacy_policy_link: nil,
           # URL to terms and conditions
-          terms_and_conditions_link: nil
+          terms_and_conditions_link: nil,
+          # Expected messaging volume for this campaign. Numeric string (e.g. "1999",
+          # "5000"). Values below 2000 bill at the low-volume tier.
+          volume: nil
         )
         end
 
@@ -124,10 +124,7 @@ module Sentdm
               description: String,
               name: String,
               type: String,
-              use_cases:
-                T::Array[
-                  Sentdm::Profiles::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData
-                ],
+              use_cases: T::Array[Sentdm::Profiles::CampaignUseCaseData],
               help_keywords: T.nilable(String),
               help_message: T.nilable(String),
               message_flow: T.nilable(String),
@@ -136,7 +133,8 @@ module Sentdm
               optout_keywords: T.nilable(String),
               optout_message: T.nilable(String),
               privacy_policy_link: T.nilable(String),
-              terms_and_conditions_link: T.nilable(String)
+              terms_and_conditions_link: T.nilable(String),
+              volume: T.nilable(String)
             }
           )
         end

data/rbi/sentdm/models/profiles/campaign_use_case.rbi

@@ -0,0 +1,110 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Profiles
+      class CampaignUseCase < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Profiles::CampaignUseCase, Sentdm::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :campaign_id
+
+        sig { params(campaign_id: String).void }
+        attr_writer :campaign_id
+
+        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
+
+        sig do
+          returns(T.nilable(Sentdm::Profiles::MessagingUseCaseUs::TaggedSymbol))
+        end
+        attr_reader :messaging_use_case_us
+
+        sig do
+          params(
+            messaging_use_case_us:
+              Sentdm::Profiles::MessagingUseCaseUs::OrSymbol
+          ).void
+        end
+        attr_writer :messaging_use_case_us
+
+        # Sample messages submitted to the registry for this use case.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :sample_messages
+
+        sig { params(sample_messages: T::Array[String]).void }
+        attr_writer :sample_messages
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :updated_at
+
+        # Customer-facing use-case representation for the public v3 campaign contract.
+        # Exists for the same reason as BrandCampaignV3Response: nesting the
+        # TcrCampaignUseCase database entity in a public response means any column added
+        # to that table silently becomes part of the customer-facing contract. This DTO is
+        # an explicit allowlist, so a new column stays invisible until it is added here on
+        # purpose. This mirrors exactly the fields the entity already serialized, so it
+        # removes nothing from the current response shape. It only closes the future-leak
+        # path.
+        sig do
+          params(
+            id: String,
+            campaign_id: String,
+            created_at: Time,
+            customer_id: String,
+            messaging_use_case_us:
+              Sentdm::Profiles::MessagingUseCaseUs::OrSymbol,
+            sample_messages: T::Array[String],
+            updated_at: T.nilable(Time)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id: nil,
+          campaign_id: nil,
+          created_at: nil,
+          customer_id: nil,
+          messaging_use_case_us: nil,
+          # Sample messages submitted to the registry for this use case.
+          sample_messages: nil,
+          updated_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              campaign_id: String,
+              created_at: Time,
+              customer_id: String,
+              messaging_use_case_us:
+                Sentdm::Profiles::MessagingUseCaseUs::TaggedSymbol,
+              sample_messages: T::Array[String],
+              updated_at: T.nilable(Time)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/profiles/{sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbi → campaign_use_case_data.rbi}

@@ -3,11 +3,11 @@
 module Sentdm
   module Models
     module Profiles
-      class SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData < Sentdm::Internal::Type::BaseModel
+      class CampaignUseCaseData < Sentdm::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
             T.any(
-              Sentdm::Profiles::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData,
+              Sentdm::Profiles::CampaignUseCaseData,
               Sentdm::Internal::AnyHash
             )
           end

data/rbi/sentdm/models/{sent_dm_services_common_contracts_poc_os_template_body.rbi → template_body.rbi}

@@ -2,14 +2,9 @@
 
 module Sentdm
   module Models
-    class SentDmServicesCommonContractsPocOsTemplateBody < Sentdm::Internal::Type::BaseModel
+    class TemplateBody < Sentdm::Internal::Type::BaseModel
       OrHash =
-        T.type_alias do
-          T.any(
-            Sentdm::SentDmServicesCommonContractsPocOsTemplateBody,
-            Sentdm::Internal::AnyHash
-          )
-        end
+        T.type_alias { T.any(Sentdm::TemplateBody, Sentdm::Internal::AnyHash) }
 
       # Content that will be used for all channels (SMS and WhatsApp) unless
       # channel-specific content is provided

data/rbi/sentdm/models/{sent_dm_services_common_contracts_poc_os_template_button.rbi → template_button.rbi}

@@ -2,27 +2,17 @@
 
 module Sentdm
   module Models
-    class SentDmServicesCommonContractsPocOsTemplateButton < Sentdm::Internal::Type::BaseModel
+    class TemplateButton < Sentdm::Internal::Type::BaseModel
       OrHash =
         T.type_alias do
-          T.any(
-            Sentdm::SentDmServicesCommonContractsPocOsTemplateButton,
-            Sentdm::Internal::AnyHash
-          )
+          T.any(Sentdm::TemplateButton, Sentdm::Internal::AnyHash)
         end
 
       # Properties specific to the button type
-      sig do
-        returns(Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps)
-      end
+      sig { returns(Sentdm::TemplateButtonProps) }
       attr_reader :props
 
-      sig do
-        params(
-          props:
-            Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps::OrHash
-        ).void
-      end
+      sig { params(props: Sentdm::TemplateButtonProps::OrHash).void }
       attr_writer :props
 
       # The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
@@ -39,8 +29,7 @@ module Sentdm
       # Interactive button in a message template
       sig do
         params(
-          props:
-            Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps::OrHash,
+          props: Sentdm::TemplateButtonProps::OrHash,
           type: String,
           id: Integer
         ).returns(T.attached_class)
@@ -57,12 +46,7 @@ module Sentdm
 
       sig do
         override.returns(
-          {
-            props:
-              Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps,
-            type: String,
-            id: Integer
-          }
+          { props: Sentdm::TemplateButtonProps, type: String, id: Integer }
         )
       end
       def to_hash

data/rbi/sentdm/models/{sent_dm_services_common_contracts_poc_os_template_button_props.rbi → template_button_props.rbi}

@@ -2,13 +2,10 @@
 
 module Sentdm
   module Models
-    class SentDmServicesCommonContractsPocOsTemplateButtonProps < Sentdm::Internal::Type::BaseModel
+    class TemplateButtonProps < Sentdm::Internal::Type::BaseModel
       OrHash =
         T.type_alias do
-          T.any(
-            Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps,
-            Sentdm::Internal::AnyHash
-          )
+          T.any(Sentdm::TemplateButtonProps, Sentdm::Internal::AnyHash)
         end
 
       sig { returns(Integer) }

data/rbi/sentdm/models/template_definition.rbi

@@ -9,44 +9,25 @@ module Sentdm
         end
 
       # Body section of a message template with channel-specific content
-      sig { returns(Sentdm::SentDmServicesCommonContractsPocOsTemplateBody) }
+      sig { returns(Sentdm::TemplateBody) }
       attr_reader :body
 
-      sig do
-        params(
-          body: Sentdm::SentDmServicesCommonContractsPocOsTemplateBody::OrHash
-        ).void
-      end
+      sig { params(body: Sentdm::TemplateBody::OrHash).void }
       attr_writer :body
 
       # Configuration for AUTHENTICATION category templates
-      sig do
-        returns(
-          T.nilable(
-            Sentdm::SentDmServicesCommonContractsPocOsAuthenticationConfig
-          )
-        )
-      end
+      sig { returns(T.nilable(Sentdm::AuthenticationConfig)) }
       attr_reader :authentication_config
 
       sig do
         params(
-          authentication_config:
-            T.nilable(
-              Sentdm::SentDmServicesCommonContractsPocOsAuthenticationConfig::OrHash
-            )
+          authentication_config: T.nilable(Sentdm::AuthenticationConfig::OrHash)
         ).void
       end
       attr_writer :authentication_config
 
       # Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
-      sig do
-        returns(
-          T.nilable(
-            T::Array[Sentdm::SentDmServicesCommonContractsPocOsTemplateButton]
-          )
-        )
-      end
+      sig { returns(T.nilable(T::Array[Sentdm::TemplateButton])) }
       attr_accessor :buttons
 
       # The version of the template definition format
@@ -54,65 +35,30 @@ module Sentdm
       attr_accessor :definition_version
 
       # Footer section of a message template
-      sig do
-        returns(
-          T.nilable(Sentdm::SentDmServicesCommonContractsPocOsTemplateFooter)
-        )
-      end
+      sig { returns(T.nilable(Sentdm::TemplateFooter)) }
       attr_reader :footer
 
-      sig do
-        params(
-          footer:
-            T.nilable(
-              Sentdm::SentDmServicesCommonContractsPocOsTemplateFooter::OrHash
-            )
-        ).void
-      end
+      sig { params(footer: T.nilable(Sentdm::TemplateFooter::OrHash)).void }
       attr_writer :footer
 
       # Header section of a message template
-      sig do
-        returns(
-          T.nilable(Sentdm::SentDmServicesCommonContractsPocOsTemplateHeader)
-        )
-      end
+      sig { returns(T.nilable(Sentdm::TemplateHeader)) }
       attr_reader :header
 
-      sig do
-        params(
-          header:
-            T.nilable(
-              Sentdm::SentDmServicesCommonContractsPocOsTemplateHeader::OrHash
-            )
-        ).void
-      end
+      sig { params(header: T.nilable(Sentdm::TemplateHeader::OrHash)).void }
       attr_writer :header
 
       # Complete definition of a message template including header, body, footer, and
       # buttons
       sig do
         params(
-          body: Sentdm::SentDmServicesCommonContractsPocOsTemplateBody::OrHash,
+          body: Sentdm::TemplateBody::OrHash,
           authentication_config:
-            T.nilable(
-              Sentdm::SentDmServicesCommonContractsPocOsAuthenticationConfig::OrHash
-            ),
-          buttons:
-            T.nilable(
-              T::Array[
-                Sentdm::SentDmServicesCommonContractsPocOsTemplateButton::OrHash
-              ]
-            ),
+            T.nilable(Sentdm::AuthenticationConfig::OrHash),
+          buttons: T.nilable(T::Array[Sentdm::TemplateButton::OrHash]),
           definition_version: T.nilable(String),
-          footer:
-            T.nilable(
-              Sentdm::SentDmServicesCommonContractsPocOsTemplateFooter::OrHash
-            ),
-          header:
-            T.nilable(
-              Sentdm::SentDmServicesCommonContractsPocOsTemplateHeader::OrHash
-            )
+          footer: T.nilable(Sentdm::TemplateFooter::OrHash),
+          header: T.nilable(Sentdm::TemplateHeader::OrHash)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -134,26 +80,12 @@ module Sentdm
       sig do
         override.returns(
           {
-            body: Sentdm::SentDmServicesCommonContractsPocOsTemplateBody,
-            authentication_config:
-              T.nilable(
-                Sentdm::SentDmServicesCommonContractsPocOsAuthenticationConfig
-              ),
-            buttons:
-              T.nilable(
-                T::Array[
-                  Sentdm::SentDmServicesCommonContractsPocOsTemplateButton
-                ]
-              ),
+            body: Sentdm::TemplateBody,
+            authentication_config: T.nilable(Sentdm::AuthenticationConfig),
+            buttons: T.nilable(T::Array[Sentdm::TemplateButton]),
             definition_version: T.nilable(String),
-            footer:
-              T.nilable(
-                Sentdm::SentDmServicesCommonContractsPocOsTemplateFooter
-              ),
-            header:
-              T.nilable(
-                Sentdm::SentDmServicesCommonContractsPocOsTemplateHeader
-              )
+            footer: T.nilable(Sentdm::TemplateFooter),
+            header: T.nilable(Sentdm::TemplateHeader)
           }
         )
       end

data/rbi/sentdm/models/template_event.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class TemplateEvent < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::TemplateEvent, Sentdm::Internal::AnyHash) }
+
+      # The specific event within the family, for example message.delivered or
+      # message.received. Absent on events that have no subtype, so treat it as
+      # optional.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :event
+
+      # The event family, for example message or templates. Route on this first, then on
+      # event for the specific change.
+      sig { returns(T.nilable(String)) }
+      attr_reader :field
+
+      sig { params(field: String).void }
+      attr_writer :field
+
+      # Body of a template status event. Delivered when a template's review outcome
+      # changes, so you can react without polling.
+      sig { returns(T.nilable(Sentdm::TemplateEventPayload)) }
+      attr_reader :payload
+
+      sig do
+        params(payload: T.nilable(Sentdm::TemplateEventPayload::OrHash)).void
+      end
+      attr_writer :payload
+
+      # When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
+      # time, not the time the underlying change happened. Use the timestamp inside the
+      # payload for the latter.
+      sig { returns(T.nilable(String)) }
+      attr_reader :timestamp
+
+      sig { params(timestamp: String).void }
+      attr_writer :timestamp
+
+      # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
+      # this shape and varies only in Payload.
+      sig do
+        params(
+          event: T.nilable(String),
+          field: String,
+          payload: T.nilable(Sentdm::TemplateEventPayload::OrHash),
+          timestamp: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The specific event within the family, for example message.delivered or
+        # message.received. Absent on events that have no subtype, so treat it as
+        # optional.
+        event: nil,
+        # The event family, for example message or templates. Route on this first, then on
+        # event for the specific change.
+        field: nil,
+        # Body of a template status event. Delivered when a template's review outcome
+        # changes, so you can react without polling.
+        payload: nil,
+        # When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
+        # time, not the time the underlying change happened. Use the timestamp inside the
+        # payload for the latter.
+        timestamp: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            event: T.nilable(String),
+            field: String,
+            payload: T.nilable(Sentdm::TemplateEventPayload),
+            timestamp: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/template_event_payload.rbi

@@ -0,0 +1,131 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class TemplateEventPayload < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::TemplateEventPayload, Sentdm::Internal::AnyHash)
+        end
+
+      # The account the template belongs to.
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_id
+
+      sig { params(account_id: String).void }
+      attr_writer :account_id
+
+      # The template's category, for example UTILITY, MARKETING, or AUTHENTICATION.
+      sig { returns(T.nilable(String)) }
+      attr_reader :category
+
+      sig { params(category: String).void }
+      attr_writer :category
+
+      # The channel the template applies to.
+      sig { returns(T.nilable(String)) }
+      attr_reader :channel
+
+      sig { params(channel: String).void }
+      attr_writer :channel
+
+      # The template's language code, for example en_US.
+      sig { returns(T.nilable(String)) }
+      attr_reader :language
+
+      sig { params(language: String).void }
+      attr_writer :language
+
+      # Why the template reached Status, when a reason was given. Populated on a
+      # rejection.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :reason
+
+      # The review status the template just reached, for example APPROVED or REJECTED.
+      sig { returns(T.nilable(String)) }
+      attr_reader :status
+
+      sig { params(status: String).void }
+      attr_writer :status
+
+      # The template in Sent.
+      sig { returns(T.nilable(String)) }
+      attr_reader :template_id
+
+      sig { params(template_id: String).void }
+      attr_writer :template_id
+
+      # The template's display name.
+      sig { returns(T.nilable(String)) }
+      attr_reader :template_name
+
+      sig { params(template_name: String).void }
+      attr_writer :template_name
+
+      # The template's identifier with Meta, assigned when the template is submitted for
+      # review.
+      sig { returns(T.nilable(String)) }
+      attr_reader :whatsapp_template_id
+
+      sig { params(whatsapp_template_id: String).void }
+      attr_writer :whatsapp_template_id
+
+      # Body of a template status event. Delivered when a template's review outcome
+      # changes, so you can react without polling.
+      sig do
+        params(
+          account_id: String,
+          category: String,
+          channel: String,
+          language: String,
+          reason: T.nilable(String),
+          status: String,
+          template_id: String,
+          template_name: String,
+          whatsapp_template_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The account the template belongs to.
+        account_id: nil,
+        # The template's category, for example UTILITY, MARKETING, or AUTHENTICATION.
+        category: nil,
+        # The channel the template applies to.
+        channel: nil,
+        # The template's language code, for example en_US.
+        language: nil,
+        # Why the template reached Status, when a reason was given. Populated on a
+        # rejection.
+        reason: nil,
+        # The review status the template just reached, for example APPROVED or REJECTED.
+        status: nil,
+        # The template in Sent.
+        template_id: nil,
+        # The template's display name.
+        template_name: nil,
+        # The template's identifier with Meta, assigned when the template is submitted for
+        # review.
+        whatsapp_template_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            category: String,
+            channel: String,
+            language: String,
+            reason: T.nilable(String),
+            status: String,
+            template_id: String,
+            template_name: String,
+            whatsapp_template_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/{sent_dm_services_common_contracts_poc_os_template_footer.rbi → template_footer.rbi}

@@ -2,13 +2,10 @@
 
 module Sentdm
   module Models
-    class SentDmServicesCommonContractsPocOsTemplateFooter < Sentdm::Internal::Type::BaseModel
+    class TemplateFooter < Sentdm::Internal::Type::BaseModel
       OrHash =
         T.type_alias do
-          T.any(
-            Sentdm::SentDmServicesCommonContractsPocOsTemplateFooter,
-            Sentdm::Internal::AnyHash
-          )
+          T.any(Sentdm::TemplateFooter, Sentdm::Internal::AnyHash)
         end
 
       # The footer template text with optional variable placeholders