sentdm 0.29.0 → 0.31.0

data/rbi/sentdm/models/api_response_of_contact_message_summary.rbi

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

@@ -0,0 +1,79 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseOfConversationMessagesList < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::APIResponseOfConversationMessagesList,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      # A paginated list of messages — used by both conversation read endpoints.
+      sig { returns(T.nilable(Sentdm::ConversationMessagesList)) }
+      attr_reader :data
+
+      sig do
+        params(data: T.nilable(Sentdm::ConversationMessagesList::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::ConversationMessagesList::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 messages — used by both conversation read endpoints.
+        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::ConversationMessagesList),
+            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_profile_detail.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseOfProfileDetail < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::APIResponseOfProfileDetail, Sentdm::Internal::AnyHash)
+        end
+
+      # Detailed profile response for v3 API
+      sig { returns(T.nilable(Sentdm::ProfileDetail)) }
+      attr_reader :data
+
+      sig { params(data: T.nilable(Sentdm::ProfileDetail::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::ProfileDetail::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Detailed profile response for v3 API
+        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::ProfileDetail),
+            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_user.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseOfUser < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::APIResponseOfUser, Sentdm::Internal::AnyHash)
+        end
+
+      # User response for v3 API
+      sig { returns(T.nilable(Sentdm::UserResponse)) }
+      attr_reader :data
+
+      sig { params(data: T.nilable(Sentdm::UserResponse::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::UserResponse::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # User response for v3 API
+        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::UserResponse),
+            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_template.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseTemplate < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::APIResponseTemplate, Sentdm::Internal::AnyHash)
+        end
+
+      # Template response for v3 API
+      sig { returns(T.nilable(Sentdm::Template)) }
+      attr_reader :data
+
+      sig { params(data: T.nilable(Sentdm::Template::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::Template::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Template response for v3 API
+        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::Template),
+            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_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