sentdm 0.28.0 → 0.30.0

data/rbi/sentdm/models/api_response_webhook.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseWebhook < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::APIResponseWebhook, Sentdm::Internal::AnyHash)
+        end
+
+      # The response data (null if error)
+      sig { returns(T.nilable(Sentdm::WebhookResponse)) }
+      attr_reader :data
+
+      sig { params(data: T.nilable(Sentdm::WebhookResponse::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::WebhookResponse::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::WebhookResponse),
+            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_info.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class BillingContactInfo < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::BillingContactInfo, Sentdm::Internal::AnyHash)
+        end
+
+      # Email address where invoices will be sent (required)
+      sig { returns(String) }
+      attr_accessor :email
+
+      # Full name of the billing contact or company (required)
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Billing address (optional). Free-form text including street, city, state, postal
+      # code, and country.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :address
+
+      # Phone number for the billing contact (optional)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone
+
+      # Billing contact information for a profile. Required when billing_model is
+      # "profile" or "profile_and_organization".
+      sig do
+        params(
+          email: String,
+          name: String,
+          address: T.nilable(String),
+          phone: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Email address where invoices will be sent (required)
+        email:,
+        # Full name of the billing contact or company (required)
+        name:,
+        # Billing address (optional). Free-form text including street, city, state, postal
+        # code, and country.
+        address: nil,
+        # Phone number for the billing contact (optional)
+        phone: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            email: String,
+            name: String,
+            address: T.nilable(String),
+            phone: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/brand_business_info.rbi

@@ -0,0 +1,162 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class BrandBusinessInfo < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::BrandBusinessInfo, Sentdm::Internal::AnyHash)
+        end
+
+      # 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
+
+      sig do
+        returns(T.nilable(Sentdm::BrandBusinessInfo::EntityType::OrSymbol))
+      end
+      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
+
+      # Business details and address for brand KYC
+      sig do
+        params(
+          city: T.nilable(String),
+          country: T.nilable(String),
+          country_of_registration: T.nilable(String),
+          entity_type:
+            T.nilable(Sentdm::BrandBusinessInfo::EntityType::OrSymbol),
+          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,
+        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(Sentdm::BrandBusinessInfo::EntityType::OrSymbol),
+            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
+
+      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_info.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class BrandComplianceInfo < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::BrandComplianceInfo, Sentdm::Internal::AnyHash)
+        end
+
+      sig { returns(Sentdm::TcrBrandRelationship::OrSymbol) }
+      attr_accessor :brand_relationship
+
+      sig { returns(Sentdm::TcrVertical::OrSymbol) }
+      attr_accessor :vertical
+
+      # List of destination countries for messaging
+      sig { returns(T.nilable(T::Array[Sentdm::DestinationCountry])) }
+      attr_accessor :destination_countries
+
+      # Whether this is a TCR (Campaign Registry) application
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :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
+
+      # Compliance and TCR information for brand registration
+      sig do
+        params(
+          brand_relationship: Sentdm::TcrBrandRelationship::OrSymbol,
+          vertical: Sentdm::TcrVertical::OrSymbol,
+          destination_countries:
+            T.nilable(T::Array[Sentdm::DestinationCountry::OrHash]),
+          is_tcr_application: T.nilable(T::Boolean),
+          notes: T.nilable(String),
+          phone_number_prefix: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        brand_relationship:,
+        vertical:,
+        # 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
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            brand_relationship: Sentdm::TcrBrandRelationship::OrSymbol,
+            vertical: Sentdm::TcrVertical::OrSymbol,
+            destination_countries:
+              T.nilable(T::Array[Sentdm::DestinationCountry]),
+            is_tcr_application: T.nilable(T::Boolean),
+            notes: T.nilable(String),
+            phone_number_prefix: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/brand_contact_info.rbi

@@ -0,0 +1,78 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class BrandContactInfo < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::BrandContactInfo, Sentdm::Internal::AnyHash)
+        end
+
+      # Primary contact name (required)
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Business/brand name
+      sig { returns(T.nilable(String)) }
+      attr_accessor :business_name
+
+      # Contact email address
+      sig { returns(T.nilable(String)) }
+      attr_accessor :email
+
+      # 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
+
+      # Contact information for brand KYC
+      sig do
+        params(
+          name: String,
+          business_name: T.nilable(String),
+          email: T.nilable(String),
+          phone: T.nilable(String),
+          phone_country_code: T.nilable(String),
+          role: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Primary contact name (required)
+        name:,
+        # Business/brand name
+        business_name: nil,
+        # Contact email address
+        email: 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(
+          {
+            name: String,
+            business_name: T.nilable(String),
+            email: T.nilable(String),
+            phone: T.nilable(String),
+            phone_country_code: T.nilable(String),
+            role: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/brands_brand_data.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class BrandsBrandData < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::BrandsBrandData, Sentdm::Internal::AnyHash)
+        end
+
+      # Compliance and TCR information for brand registration
+      sig { returns(Sentdm::BrandComplianceInfo) }
+      attr_reader :compliance
+
+      sig { params(compliance: Sentdm::BrandComplianceInfo::OrHash).void }
+      attr_writer :compliance
+
+      # Contact information for brand KYC
+      sig { returns(Sentdm::BrandContactInfo) }
+      attr_reader :contact
+
+      sig { params(contact: Sentdm::BrandContactInfo::OrHash).void }
+      attr_writer :contact
+
+      # Business details and address for brand KYC
+      sig { returns(T.nilable(Sentdm::BrandBusinessInfo)) }
+      attr_reader :business
+
+      sig do
+        params(business: T.nilable(Sentdm::BrandBusinessInfo::OrHash)).void
+      end
+      attr_writer :business
+
+      # Brand and KYC data grouped into contact, business, and compliance sections
+      sig do
+        params(
+          compliance: Sentdm::BrandComplianceInfo::OrHash,
+          contact: Sentdm::BrandContactInfo::OrHash,
+          business: T.nilable(Sentdm::BrandBusinessInfo::OrHash)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Compliance and TCR information for brand registration
+        compliance:,
+        # Contact information for brand KYC
+        contact:,
+        # Business details and address for brand KYC
+        business: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            compliance: Sentdm::BrandComplianceInfo,
+            contact: Sentdm::BrandContactInfo,
+            business: T.nilable(Sentdm::BrandBusinessInfo)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/contact_delete_params.rbi

@@ -2,7 +2,7 @@
 
 module Sentdm
   module Models
-    class ContactDeleteParams < Sentdm::Internal::Type::BaseModel
+    class ContactDeleteParams < Sentdm::Models::MutationRequest
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
@@ -14,14 +14,6 @@ module Sentdm
       sig { returns(String) }
       attr_accessor :id
 
-      # 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
 
@@ -31,26 +23,17 @@ module Sentdm
       sig do
         params(
           id: String,
-          sandbox: T::Boolean,
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        id:,
-        # 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: {}
-      )
+      def self.new(id:, x_profile_id: nil, request_options: {})
       end
 
       sig do
         override.returns(
           {
             id: String,
-            sandbox: T::Boolean,
             x_profile_id: String,
             request_options: Sentdm::RequestOptions
           }