sentdm 0.45.0 → 0.47.0

data/rbi/sentdm/models/api_response_of_webhook_secret.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseOfWebhookSecret < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::APIResponseOfWebhookSecret, Sentdm::Internal::AnyHash)
+        end
+
+      # The response data (null if error)
+      sig { returns(T.nilable(Sentdm::WebhookSecret)) }
+      attr_reader :data
+
+      sig { params(data: T.nilable(Sentdm::WebhookSecret::OrHash)).void }
+      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::WebhookSecret::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)
+        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::WebhookSecret),
+            error: T.nilable(Sentdm::ErrorDetail),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/api_response_of_webhook_test.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseOfWebhookTest < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::APIResponseOfWebhookTest, Sentdm::Internal::AnyHash)
+        end
+
+      # The response data (null if error)
+      sig { returns(T.nilable(Sentdm::WebhookTest)) }
+      attr_reader :data
+
+      sig { params(data: T.nilable(Sentdm::WebhookTest::OrHash)).void }
+      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::WebhookTest::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)
+        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::WebhookTest),
+            error: T.nilable(Sentdm::ErrorDetail),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/api_response_of_webhooks_list.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseOfWebhooksList < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::APIResponseOfWebhooksList, Sentdm::Internal::AnyHash)
+        end
+
+      # A paginated list of webhooks.
+      sig { returns(T.nilable(Sentdm::WebhooksList)) }
+      attr_reader :data
+
+      sig { params(data: T.nilable(Sentdm::WebhooksList::OrHash)).void }
+      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::WebhooksList::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A paginated list of webhooks.
+        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::WebhooksList),
+            error: T.nilable(Sentdm::ErrorDetail),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/billing_contact.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class BillingContact < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::BillingContact, Sentdm::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :address
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :email
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone
+
+      # Billing contact info returned in profile responses
+      sig do
+        params(
+          address: T.nilable(String),
+          email: T.nilable(String),
+          name: T.nilable(String),
+          phone: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(address: nil, email: nil, name: nil, phone: nil)
+      end
+
+      sig do
+        override.returns(
+          {
+            address: T.nilable(String),
+            email: T.nilable(String),
+            name: T.nilable(String),
+            phone: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/brand_business.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class BrandBusiness < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::BrandBusiness, Sentdm::Internal::AnyHash) }
+
+      # City
+      sig { returns(T.nilable(String)) }
+      attr_accessor :city
+
+      # Country code (e.g., US, CA)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :country
+
+      # Country where the business is registered
+      sig { returns(T.nilable(String)) }
+      attr_accessor :country_of_registration
+
+      # Business entity type
+      sig { returns(T.nilable(String)) }
+      attr_accessor :entity_type
+
+      # Legal business name
+      sig { returns(T.nilable(String)) }
+      attr_accessor :legal_name
+
+      # Postal/ZIP code
+      sig { returns(T.nilable(String)) }
+      attr_accessor :postal_code
+
+      # State/province code
+      sig { returns(T.nilable(String)) }
+      attr_accessor :state
+
+      # Street address
+      sig { returns(T.nilable(String)) }
+      attr_accessor :street
+
+      # Tax ID/EIN number
+      sig { returns(T.nilable(String)) }
+      attr_accessor :tax_id
+
+      # Type of tax ID (e.g., us_ein, ca_bn)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :tax_id_type
+
+      # Business website URL
+      sig { returns(T.nilable(String)) }
+      attr_accessor :url
+
+      sig do
+        params(
+          city: T.nilable(String),
+          country: T.nilable(String),
+          country_of_registration: T.nilable(String),
+          entity_type: T.nilable(String),
+          legal_name: T.nilable(String),
+          postal_code: T.nilable(String),
+          state: T.nilable(String),
+          street: T.nilable(String),
+          tax_id: T.nilable(String),
+          tax_id_type: T.nilable(String),
+          url: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # City
+        city: nil,
+        # Country code (e.g., US, CA)
+        country: nil,
+        # Country where the business is registered
+        country_of_registration: nil,
+        # Business entity type
+        entity_type: nil,
+        # Legal business name
+        legal_name: nil,
+        # Postal/ZIP code
+        postal_code: nil,
+        # State/province code
+        state: nil,
+        # Street address
+        street: nil,
+        # Tax ID/EIN number
+        tax_id: nil,
+        # Type of tax ID (e.g., us_ein, ca_bn)
+        tax_id_type: nil,
+        # Business website URL
+        url: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            city: T.nilable(String),
+            country: T.nilable(String),
+            country_of_registration: T.nilable(String),
+            entity_type: T.nilable(String),
+            legal_name: T.nilable(String),
+            postal_code: T.nilable(String),
+            state: T.nilable(String),
+            street: T.nilable(String),
+            tax_id: T.nilable(String),
+            tax_id_type: T.nilable(String),
+            url: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/brand_business_info.rbi

@@ -20,9 +20,7 @@ module Sentdm
       sig { returns(T.nilable(String)) }
       attr_accessor :country_of_registration
 
-      sig do
-        returns(T.nilable(Sentdm::BrandBusinessInfo::EntityType::OrSymbol))
-      end
+      sig { returns(T.nilable(Sentdm::EntityType::OrSymbol)) }
       attr_accessor :entity_type
 
       # Legal business name
@@ -59,8 +57,7 @@ module Sentdm
           city: T.nilable(String),
           country: T.nilable(String),
           country_of_registration: T.nilable(String),
-          entity_type:
-            T.nilable(Sentdm::BrandBusinessInfo::EntityType::OrSymbol),
+          entity_type: T.nilable(Sentdm::EntityType::OrSymbol),
           legal_name: T.nilable(String),
           postal_code: T.nilable(String),
           state: T.nilable(String),
@@ -101,8 +98,7 @@ module Sentdm
             city: T.nilable(String),
             country: T.nilable(String),
             country_of_registration: T.nilable(String),
-            entity_type:
-              T.nilable(Sentdm::BrandBusinessInfo::EntityType::OrSymbol),
+            entity_type: T.nilable(Sentdm::EntityType::OrSymbol),
             legal_name: T.nilable(String),
             postal_code: T.nilable(String),
             state: T.nilable(String),
@@ -115,48 +111,6 @@ module Sentdm
       end
       def to_hash
       end
-
-      module EntityType
-        extend Sentdm::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias { T.all(Symbol, Sentdm::BrandBusinessInfo::EntityType) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        PRIVATE_PROFIT =
-          T.let(
-            :PRIVATE_PROFIT,
-            Sentdm::BrandBusinessInfo::EntityType::TaggedSymbol
-          )
-        PUBLIC_PROFIT =
-          T.let(
-            :PUBLIC_PROFIT,
-            Sentdm::BrandBusinessInfo::EntityType::TaggedSymbol
-          )
-        NON_PROFIT =
-          T.let(
-            :NON_PROFIT,
-            Sentdm::BrandBusinessInfo::EntityType::TaggedSymbol
-          )
-        SOLE_PROPRIETOR =
-          T.let(
-            :SOLE_PROPRIETOR,
-            Sentdm::BrandBusinessInfo::EntityType::TaggedSymbol
-          )
-        GOVERNMENT =
-          T.let(
-            :GOVERNMENT,
-            Sentdm::BrandBusinessInfo::EntityType::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[Sentdm::BrandBusinessInfo::EntityType::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end

data/rbi/sentdm/models/brand_compliance.rbi

@@ -0,0 +1,108 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class BrandCompliance < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::BrandCompliance, Sentdm::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(Sentdm::TcrBrandRelationship::TaggedSymbol)) }
+      attr_accessor :brand_relationship
+
+      # List of destination countries for messaging
+      sig { returns(T.nilable(T::Array[Sentdm::DestinationCountry])) }
+      attr_reader :destination_countries
+
+      sig do
+        params(
+          destination_countries: T::Array[Sentdm::DestinationCountry::OrHash]
+        ).void
+      end
+      attr_writer :destination_countries
+
+      # Whether this is a TCR (Campaign Registry) application
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :is_tcr_application
+
+      sig { params(is_tcr_application: T::Boolean).void }
+      attr_writer :is_tcr_application
+
+      # Additional notes about the business or use case
+      sig { returns(T.nilable(String)) }
+      attr_accessor :notes
+
+      # Phone number prefix for messaging (e.g., "+1")
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone_number_prefix
+
+      # Always null. The brand's free-text primary use case is no longer stored: it
+      # reached neither TCR nor any decision, and its column is dropped with no
+      # backfill, because the values were prose and the typed equivalent is the
+      # campaign's MessagingUseCaseUS.
+      #
+      # Retained so existing v3 clients reading primary_use_case keep deserializing.
+      # Unlike the profile sharing flags, which can answer false truthfully, there is no
+      # value to report here — the field is present and empty rather than present and
+      # wrong.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :primary_use_case
+
+      sig { returns(T.nilable(Sentdm::TcrVertical::TaggedSymbol)) }
+      attr_accessor :vertical
+
+      sig do
+        params(
+          brand_relationship: T.nilable(Sentdm::TcrBrandRelationship::OrSymbol),
+          destination_countries: T::Array[Sentdm::DestinationCountry::OrHash],
+          is_tcr_application: T::Boolean,
+          notes: T.nilable(String),
+          phone_number_prefix: T.nilable(String),
+          primary_use_case: T.nilable(String),
+          vertical: T.nilable(Sentdm::TcrVertical::OrSymbol)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        brand_relationship: nil,
+        # List of destination countries for messaging
+        destination_countries: nil,
+        # Whether this is a TCR (Campaign Registry) application
+        is_tcr_application: nil,
+        # Additional notes about the business or use case
+        notes: nil,
+        # Phone number prefix for messaging (e.g., "+1")
+        phone_number_prefix: nil,
+        # Always null. The brand's free-text primary use case is no longer stored: it
+        # reached neither TCR nor any decision, and its column is dropped with no
+        # backfill, because the values were prose and the typed equivalent is the
+        # campaign's MessagingUseCaseUS.
+        #
+        # Retained so existing v3 clients reading primary_use_case keep deserializing.
+        # Unlike the profile sharing flags, which can answer false truthfully, there is no
+        # value to report here — the field is present and empty rather than present and
+        # wrong.
+        primary_use_case: nil,
+        vertical: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            brand_relationship:
+              T.nilable(Sentdm::TcrBrandRelationship::TaggedSymbol),
+            destination_countries: T::Array[Sentdm::DestinationCountry],
+            is_tcr_application: T::Boolean,
+            notes: T.nilable(String),
+            phone_number_prefix: T.nilable(String),
+            primary_use_case: T.nilable(String),
+            vertical: T.nilable(Sentdm::TcrVertical::TaggedSymbol)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/brand_contact.rbi

@@ -0,0 +1,78 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class BrandContact < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::BrandContact, Sentdm::Internal::AnyHash) }
+
+      # Business/brand name
+      sig { returns(T.nilable(String)) }
+      attr_accessor :business_name
+
+      # Contact email address
+      sig { returns(T.nilable(String)) }
+      attr_accessor :email
+
+      # Primary contact name
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # Contact phone number in E.164 format
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone
+
+      # Contact phone country code (e.g., "1" for US)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone_country_code
+
+      # Contact's role in the business
+      sig { returns(T.nilable(String)) }
+      attr_accessor :role
+
+      sig do
+        params(
+          business_name: T.nilable(String),
+          email: T.nilable(String),
+          name: String,
+          phone: T.nilable(String),
+          phone_country_code: T.nilable(String),
+          role: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Business/brand name
+        business_name: nil,
+        # Contact email address
+        email: nil,
+        # Primary contact name
+        name: nil,
+        # Contact phone number in E.164 format
+        phone: nil,
+        # Contact phone country code (e.g., "1" for US)
+        phone_country_code: nil,
+        # Contact's role in the business
+        role: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            business_name: T.nilable(String),
+            email: T.nilable(String),
+            name: String,
+            phone: T.nilable(String),
+            phone_country_code: T.nilable(String),
+            role: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end