sentdm 0.3.1 → 0.5.0

data/rbi/sentdm/models/brand_create_params.rbi

@@ -1,68 +0,0 @@
-# typed: strong
-
-module Sentdm
-  module Models
-    class BrandCreateParams < Sentdm::Internal::Type::BaseModel
-      extend Sentdm::Internal::Type::RequestParameters::Converter
-      include Sentdm::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(Sentdm::BrandCreateParams, Sentdm::Internal::AnyHash)
-        end
-
-      # Brand and KYC information
-      sig { returns(Sentdm::BrandData) }
-      attr_reader :brand
-
-      sig { params(brand: Sentdm::BrandData::OrHash).void }
-      attr_writer :brand
-
-      # Test mode 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 :test_mode
-
-      sig { params(test_mode: T::Boolean).void }
-      attr_writer :test_mode
-
-      sig { returns(T.nilable(String)) }
-      attr_reader :idempotency_key
-
-      sig { params(idempotency_key: String).void }
-      attr_writer :idempotency_key
-
-      sig do
-        params(
-          brand: Sentdm::BrandData::OrHash,
-          test_mode: T::Boolean,
-          idempotency_key: String,
-          request_options: Sentdm::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # Brand and KYC information
-        brand:,
-        # Test mode flag - when true, the operation is simulated without side effects
-        # Useful for testing integrations without actual execution
-        test_mode: nil,
-        idempotency_key: nil,
-        request_options: {}
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            brand: Sentdm::BrandData,
-            test_mode: T::Boolean,
-            idempotency_key: String,
-            request_options: Sentdm::RequestOptions
-          }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/sentdm/models/brand_data.rbi

@@ -1,266 +0,0 @@
-# typed: strong
-
-module Sentdm
-  module Models
-    class BrandData < Sentdm::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias { T.any(Sentdm::BrandData, Sentdm::Internal::AnyHash) }
-
-      # Brand relationship level with TCR (required for TCR)
-      sig { returns(Sentdm::TcrBrandRelationship::OrSymbol) }
-      attr_accessor :brand_relationship
-
-      # Primary contact name (required)
-      sig { returns(String) }
-      attr_accessor :contact_name
-
-      # Business vertical/industry category (required for TCR)
-      sig { returns(Sentdm::TcrVertical::OrSymbol) }
-      attr_accessor :vertical
-
-      # Brand name for KYC submission
-      sig { returns(T.nilable(String)) }
-      attr_accessor :brand_name
-
-      # Legal business name
-      sig { returns(T.nilable(String)) }
-      attr_accessor :business_legal_name
-
-      # Business/brand name
-      sig { returns(T.nilable(String)) }
-      attr_accessor :business_name
-
-      # Contact's role in the business
-      sig { returns(T.nilable(String)) }
-      attr_accessor :business_role
-
-      # Business website URL
-      sig { returns(T.nilable(String)) }
-      attr_accessor :business_url
-
-      # City
-      sig { returns(T.nilable(String)) }
-      attr_accessor :city
-
-      # Contact email address
-      sig { returns(T.nilable(String)) }
-      attr_accessor :contact_email
-
-      # Contact phone number in E.164 format
-      sig { returns(T.nilable(String)) }
-      attr_accessor :contact_phone
-
-      # Contact phone country code (e.g., "1" for US)
-      sig { returns(T.nilable(String)) }
-      attr_accessor :contact_phone_country_code
-
-      # 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
-
-      # List of destination countries for messaging
-      sig { returns(T.nilable(T::Array[Sentdm::DestinationCountry])) }
-      attr_accessor :destination_countries
-
-      # Business entity type
-      sig { returns(T.nilable(Sentdm::BrandData::EntityType::OrSymbol)) }
-      attr_accessor :entity_type
-
-      # 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_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
-
-      # Postal/ZIP code
-      sig { returns(T.nilable(String)) }
-      attr_accessor :postal_code
-
-      # Primary messaging use case description
-      sig { returns(T.nilable(String)) }
-      attr_accessor :primary_use_case
-
-      # 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
-
-      # Brand and KYC data
-      sig do
-        params(
-          brand_relationship: Sentdm::TcrBrandRelationship::OrSymbol,
-          contact_name: String,
-          vertical: Sentdm::TcrVertical::OrSymbol,
-          brand_name: T.nilable(String),
-          business_legal_name: T.nilable(String),
-          business_name: T.nilable(String),
-          business_role: T.nilable(String),
-          business_url: T.nilable(String),
-          city: T.nilable(String),
-          contact_email: T.nilable(String),
-          contact_phone: T.nilable(String),
-          contact_phone_country_code: T.nilable(String),
-          country: T.nilable(String),
-          country_of_registration: T.nilable(String),
-          destination_countries:
-            T.nilable(T::Array[Sentdm::DestinationCountry::OrHash]),
-          entity_type: T.nilable(Sentdm::BrandData::EntityType::OrSymbol),
-          expected_messaging_volume: T.nilable(String),
-          is_tcr_application: T.nilable(T::Boolean),
-          notes: T.nilable(String),
-          phone_number_prefix: T.nilable(String),
-          postal_code: T.nilable(String),
-          primary_use_case: T.nilable(String),
-          state: T.nilable(String),
-          street: T.nilable(String),
-          tax_id: T.nilable(String),
-          tax_id_type: T.nilable(String)
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # Brand relationship level with TCR (required for TCR)
-        brand_relationship:,
-        # Primary contact name (required)
-        contact_name:,
-        # Business vertical/industry category (required for TCR)
-        vertical:,
-        # Brand name for KYC submission
-        brand_name: nil,
-        # Legal business name
-        business_legal_name: nil,
-        # Business/brand name
-        business_name: nil,
-        # Contact's role in the business
-        business_role: nil,
-        # Business website URL
-        business_url: nil,
-        # City
-        city: nil,
-        # Contact email address
-        contact_email: nil,
-        # Contact phone number in E.164 format
-        contact_phone: nil,
-        # Contact phone country code (e.g., "1" for US)
-        contact_phone_country_code: nil,
-        # Country code (e.g., US, CA)
-        country: nil,
-        # Country where the business is registered
-        country_of_registration: nil,
-        # List of destination countries for messaging
-        destination_countries: nil,
-        # Business entity type
-        entity_type: 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
-        notes: nil,
-        # Phone number prefix for messaging (e.g., "+1")
-        phone_number_prefix: nil,
-        # Postal/ZIP code
-        postal_code: nil,
-        # Primary messaging use case description
-        primary_use_case: 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
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            brand_relationship: Sentdm::TcrBrandRelationship::OrSymbol,
-            contact_name: String,
-            vertical: Sentdm::TcrVertical::OrSymbol,
-            brand_name: T.nilable(String),
-            business_legal_name: T.nilable(String),
-            business_name: T.nilable(String),
-            business_role: T.nilable(String),
-            business_url: T.nilable(String),
-            city: T.nilable(String),
-            contact_email: T.nilable(String),
-            contact_phone: T.nilable(String),
-            contact_phone_country_code: T.nilable(String),
-            country: T.nilable(String),
-            country_of_registration: T.nilable(String),
-            destination_countries:
-              T.nilable(T::Array[Sentdm::DestinationCountry]),
-            entity_type: T.nilable(Sentdm::BrandData::EntityType::OrSymbol),
-            expected_messaging_volume: T.nilable(String),
-            is_tcr_application: T.nilable(T::Boolean),
-            notes: T.nilable(String),
-            phone_number_prefix: T.nilable(String),
-            postal_code: T.nilable(String),
-            primary_use_case: T.nilable(String),
-            state: T.nilable(String),
-            street: T.nilable(String),
-            tax_id: T.nilable(String),
-            tax_id_type: T.nilable(String)
-          }
-        )
-      end
-      def to_hash
-      end
-
-      # Business entity type
-      module EntityType
-        extend Sentdm::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias { T.all(Symbol, Sentdm::BrandData::EntityType) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        PRIVATE_PROFIT =
-          T.let(:PRIVATE_PROFIT, Sentdm::BrandData::EntityType::TaggedSymbol)
-        PUBLIC_PROFIT =
-          T.let(:PUBLIC_PROFIT, Sentdm::BrandData::EntityType::TaggedSymbol)
-        NON_PROFIT =
-          T.let(:NON_PROFIT, Sentdm::BrandData::EntityType::TaggedSymbol)
-        SOLE_PROPRIETOR =
-          T.let(:SOLE_PROPRIETOR, Sentdm::BrandData::EntityType::TaggedSymbol)
-        GOVERNMENT =
-          T.let(:GOVERNMENT, Sentdm::BrandData::EntityType::TaggedSymbol)
-
-        sig do
-          override.returns(
-            T::Array[Sentdm::BrandData::EntityType::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-    end
-  end
-end

data/rbi/sentdm/models/brand_delete_params.rbi

@@ -1,68 +0,0 @@
-# typed: strong
-
-module Sentdm
-  module Models
-    class BrandDeleteParams < Sentdm::Internal::Type::BaseModel
-      extend Sentdm::Internal::Type::RequestParameters::Converter
-      include Sentdm::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(Sentdm::BrandDeleteParams, Sentdm::Internal::AnyHash)
-        end
-
-      sig { returns(String) }
-      attr_accessor :brand_id
-
-      # Request to delete a brand
-      sig { returns(Sentdm::BrandDeleteParams::Body) }
-      attr_reader :body
-
-      sig { params(body: Sentdm::BrandDeleteParams::Body::OrHash).void }
-      attr_writer :body
-
-      sig do
-        params(
-          brand_id: String,
-          body: Sentdm::BrandDeleteParams::Body::OrHash,
-          request_options: Sentdm::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        brand_id:,
-        # Request to delete a brand
-        body:,
-        request_options: {}
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            brand_id: String,
-            body: Sentdm::BrandDeleteParams::Body,
-            request_options: Sentdm::RequestOptions
-          }
-        )
-      end
-      def to_hash
-      end
-
-      class Body < Sentdm::Models::MutationRequest
-        OrHash =
-          T.type_alias do
-            T.any(Sentdm::BrandDeleteParams::Body, Sentdm::Internal::AnyHash)
-          end
-
-        # Request to delete a brand
-        sig { returns(T.attached_class) }
-        def self.new
-        end
-
-        sig { override.returns({}) }
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/rbi/sentdm/models/brand_list_params.rbi

@@ -1,27 +0,0 @@
-# typed: strong
-
-module Sentdm
-  module Models
-    class BrandListParams < Sentdm::Internal::Type::BaseModel
-      extend Sentdm::Internal::Type::RequestParameters::Converter
-      include Sentdm::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(Sentdm::BrandListParams, Sentdm::Internal::AnyHash)
-        end
-
-      sig do
-        params(request_options: Sentdm::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
-      end
-      def self.new(request_options: {})
-      end
-
-      sig { override.returns({ request_options: Sentdm::RequestOptions }) }
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/sentdm/models/brand_list_response.rbi

@@ -1,71 +0,0 @@
-# typed: strong
-
-module Sentdm
-  module Models
-    class BrandListResponse < Sentdm::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(Sentdm::Models::BrandListResponse, Sentdm::Internal::AnyHash)
-        end
-
-      # The response data (null if error)
-      sig { returns(T.nilable(T::Array[Sentdm::BrandWithKYC])) }
-      attr_accessor :data
-
-      # Error details (null if successful)
-      sig { returns(T.nilable(Sentdm::APIError)) }
-      attr_reader :error
-
-      sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
-      attr_writer :error
-
-      # Metadata about the request and response
-      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(T::Array[Sentdm::BrandWithKYC::OrHash]),
-          error: T.nilable(Sentdm::APIError::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 details (null if successful)
-        error: nil,
-        # Metadata about the request and response
-        meta: nil,
-        # Indicates whether the request was successful
-        success: nil
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            data: T.nilable(T::Array[Sentdm::BrandWithKYC]),
-            error: T.nilable(Sentdm::APIError),
-            meta: Sentdm::APIMeta,
-            success: T::Boolean
-          }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/sentdm/models/brand_update_params.rbi

@@ -1,74 +0,0 @@
-# typed: strong
-
-module Sentdm
-  module Models
-    class BrandUpdateParams < Sentdm::Internal::Type::BaseModel
-      extend Sentdm::Internal::Type::RequestParameters::Converter
-      include Sentdm::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(Sentdm::BrandUpdateParams, Sentdm::Internal::AnyHash)
-        end
-
-      sig { returns(String) }
-      attr_accessor :brand_id
-
-      # Brand and KYC information
-      sig { returns(Sentdm::BrandData) }
-      attr_reader :brand
-
-      sig { params(brand: Sentdm::BrandData::OrHash).void }
-      attr_writer :brand
-
-      # Test mode 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 :test_mode
-
-      sig { params(test_mode: T::Boolean).void }
-      attr_writer :test_mode
-
-      sig { returns(T.nilable(String)) }
-      attr_reader :idempotency_key
-
-      sig { params(idempotency_key: String).void }
-      attr_writer :idempotency_key
-
-      sig do
-        params(
-          brand_id: String,
-          brand: Sentdm::BrandData::OrHash,
-          test_mode: T::Boolean,
-          idempotency_key: String,
-          request_options: Sentdm::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        brand_id:,
-        # Brand and KYC information
-        brand:,
-        # Test mode flag - when true, the operation is simulated without side effects
-        # Useful for testing integrations without actual execution
-        test_mode: nil,
-        idempotency_key: nil,
-        request_options: {}
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            brand_id: String,
-            brand: Sentdm::BrandData,
-            test_mode: T::Boolean,
-            idempotency_key: String,
-            request_options: Sentdm::RequestOptions
-          }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end