sentdm 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55daa4cbbfa67e7eab52f43a902db3dfa1e12804f514a6fed126a2adb84e9cb5
-  data.tar.gz: 20bca2938be488c2018679a9c26a4799c0e82c16dbc7c9fa69cf6adb4bcf59df
+  metadata.gz: 05c854c79f1208c28d3ecacb5111648f56c2d850f1b2a353462a19ef9559f70f
+  data.tar.gz: 07d88b86954305d084b1dcd5a54785349979e08d66dc68b292be60845f44e05a
 SHA512:
-  metadata.gz: 95fe7e54513a8dfd92833d88a4a954933caeeb5d9ec3af775f851fb718713c4d1450728c048782fb86aa7337a26703934c54d0cf229242df69f2cf12ac15272c
-  data.tar.gz: 7f0972a458476b6482b7158dd7c5ab721191761943df7081e1226af7d10523ac27eb36b7257d1906e18d8fcf84e3af345c3b6134de0e0da9ec8987856c036186
+  metadata.gz: d464e1edb179e1b3ef4b76c017417016ff67f4d16d02345985c1177493cdb286285cf00eb4a6a9347a1361aa03a3783f8b2646d889d1fc16ef7b0a6782cde06a
+  data.tar.gz: 8bc5abf3c6429faa22188eef6711467142b6b9623fbd208ae5b6171d65f7f44beb7b9b13fad99ab9ba6c29f9d652234e1776bce5b61397f09dd24e4ba1ba89e1

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.4.0 (2026-03-11)
+
+Full Changelog: [v0.3.1...v0.4.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.3.1...v0.4.0)
+
+### Features
+
+* **api:** api update ([bd1c867](https://github.com/sentdm/sent-dm-ruby/commit/bd1c86786ab541d177d0dab68b56a584becadafd))
+
 ## 0.3.1 (2026-03-11)
 
 Full Changelog: [v0.3.0...v0.3.1](https://github.com/sentdm/sent-dm-ruby/compare/v0.3.0...v0.3.1)

data/README.md

@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "sentdm", "~> 0.3.1"
+gem "sentdm", "~> 0.4.0"
 ```
 
 <!-- x-release-please-end -->
@@ -270,23 +270,23 @@ sent_dm.messages.send_(**params)
 Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
 
 ```ruby
-# :BASIC_ACCOUNT
-puts(Sentdm::TcrBrandRelationship::BASIC_ACCOUNT)
+# :SELF_DECLARED
+puts(Sentdm::BrandWithKYC::IdentityStatus::SELF_DECLARED)
 
-# Revealed type: `T.all(Sentdm::TcrBrandRelationship, Symbol)`
-T.reveal_type(Sentdm::TcrBrandRelationship::BASIC_ACCOUNT)
+# Revealed type: `T.all(Sentdm::BrandWithKYC::IdentityStatus, Symbol)`
+T.reveal_type(Sentdm::BrandWithKYC::IdentityStatus::SELF_DECLARED)
 ```
 
 Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
 
 ```ruby
-Sentdm::BrandData.new(
-  brand_relationship: Sentdm::TcrBrandRelationship::BASIC_ACCOUNT,
+Sentdm::BrandWithKYC.new(
+  identity_status: Sentdm::BrandWithKYC::IdentityStatus::SELF_DECLARED,
   # …
 )
 
-Sentdm::BrandData.new(
-  brand_relationship: :BASIC_ACCOUNT,
+Sentdm::BrandWithKYC.new(
+  identity_status: :SELF_DECLARED,
   # …
 )
 ```

data/lib/sentdm/client.rb

@@ -47,7 +47,6 @@ module Sentdm
     # @return [Sentdm::Resources::Contacts]
     attr_reader :contacts
 
-    # Register and manage 10DLC brands for SMS compliance
     # @return [Sentdm::Resources::Brands]
     attr_reader :brands
 

data/lib/sentdm/models/api_meta.rb

@@ -9,12 +9,6 @@ module Sentdm
       #   @return [String, nil]
       optional :request_id, String
 
-      # @!attribute response_time_ms
-      #   Response time in milliseconds (optional)
-      #
-      #   @return [Integer, nil]
-      optional :response_time_ms, Integer, nil?: true
-
       # @!attribute timestamp
       #   Server timestamp when the response was generated
       #
@@ -27,13 +21,11 @@ module Sentdm
       #   @return [String, nil]
       optional :version, String
 
-      # @!method initialize(request_id: nil, response_time_ms: nil, timestamp: nil, version: nil)
+      # @!method initialize(request_id: nil, timestamp: nil, version: nil)
       #   Request and response metadata
       #
       #   @param request_id [String] Unique identifier for this request (for tracing and support)
       #
-      #   @param response_time_ms [Integer, nil] Response time in milliseconds (optional)
-      #
       #   @param timestamp [Time] Server timestamp when the response was generated
       #
       #   @param version [String] API version used for this request

data/lib/sentdm/models/brand_data.rb

@@ -3,234 +3,271 @@
 module Sentdm
   module Models
     class BrandData < Sentdm::Internal::Type::BaseModel
-      # @!attribute brand_relationship
-      #   Brand relationship level with TCR (required for TCR)
+      # @!attribute compliance
+      #   Compliance and TCR-related information
       #
-      #   @return [Symbol, Sentdm::Models::TcrBrandRelationship]
-      required :brand_relationship, enum: -> { Sentdm::TcrBrandRelationship }, api_name: :brandRelationship
+      #   @return [Sentdm::Models::BrandData::Compliance]
+      required :compliance, -> { Sentdm::BrandData::Compliance }
 
-      # @!attribute contact_name
-      #   Primary contact name (required)
+      # @!attribute contact
+      #   Contact information for the brand
       #
-      #   @return [String]
-      required :contact_name, String, api_name: :contactName
+      #   @return [Sentdm::Models::BrandData::Contact]
+      required :contact, -> { Sentdm::BrandData::Contact }
 
-      # @!attribute vertical
-      #   Business vertical/industry category (required for TCR)
+      # @!attribute business
+      #   Business details and address information
       #
-      #   @return [Symbol, Sentdm::Models::TcrVertical]
-      required :vertical, enum: -> { Sentdm::TcrVertical }
+      #   @return [Sentdm::Models::BrandData::Business, nil]
+      optional :business, -> { Sentdm::BrandData::Business }, nil?: true
 
-      # @!attribute brand_name
-      #   Brand name for KYC submission
+      # @!method initialize(compliance:, contact:, business: nil)
+      #   Brand and KYC data grouped into contact, business, and compliance sections
       #
-      #   @return [String, nil]
-      optional :brand_name, String, api_name: :brandName, nil?: true
-
-      # @!attribute business_legal_name
-      #   Legal business name
+      #   @param compliance [Sentdm::Models::BrandData::Compliance] Compliance and TCR-related information
       #
-      #   @return [String, nil]
-      optional :business_legal_name, String, api_name: :businessLegalName, nil?: true
-
-      # @!attribute business_name
-      #   Business/brand name
+      #   @param contact [Sentdm::Models::BrandData::Contact] Contact information for the brand
       #
-      #   @return [String, nil]
-      optional :business_name, String, api_name: :businessName, nil?: true
+      #   @param business [Sentdm::Models::BrandData::Business, nil] Business details and address information
 
-      # @!attribute business_role
-      #   Contact's role in the business
-      #
-      #   @return [String, nil]
-      optional :business_role, String, api_name: :businessRole, nil?: true
+      # @see Sentdm::Models::BrandData#compliance
+      class Compliance < Sentdm::Internal::Type::BaseModel
+        # @!attribute brand_relationship
+        #   Brand relationship level with TCR (required for TCR)
+        #
+        #   @return [Symbol, Sentdm::Models::TcrBrandRelationship]
+        required :brand_relationship, enum: -> { Sentdm::TcrBrandRelationship }, api_name: :brandRelationship
 
-      # @!attribute business_url
-      #   Business website URL
-      #
-      #   @return [String, nil]
-      optional :business_url, String, api_name: :businessUrl, nil?: true
+        # @!attribute vertical
+        #   Business vertical/industry category (required for TCR)
+        #
+        #   @return [Symbol, Sentdm::Models::TcrVertical]
+        required :vertical, enum: -> { Sentdm::TcrVertical }
 
-      # @!attribute city
-      #   City
-      #
-      #   @return [String, nil]
-      optional :city, String, nil?: true
+        # @!attribute destination_countries
+        #   List of destination countries for messaging
+        #
+        #   @return [Array<Sentdm::Models::DestinationCountry>, nil]
+        optional :destination_countries,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::DestinationCountry] },
+                 api_name: :destinationCountries,
+                 nil?: true
 
-      # @!attribute contact_email
-      #   Contact email address
-      #
-      #   @return [String, nil]
-      optional :contact_email, String, api_name: :contactEmail, nil?: true
+        # @!attribute expected_messaging_volume
+        #   Expected daily messaging volume
+        #
+        #   @return [String, nil]
+        optional :expected_messaging_volume, String, api_name: :expectedMessagingVolume, nil?: true
 
-      # @!attribute contact_phone
-      #   Contact phone number in E.164 format
-      #
-      #   @return [String, nil]
-      optional :contact_phone, String, api_name: :contactPhone, nil?: true
+        # @!attribute is_tcr_application
+        #   Whether this is a TCR (Campaign Registry) application
+        #
+        #   @return [Boolean, nil]
+        optional :is_tcr_application, Sentdm::Internal::Type::Boolean, api_name: :isTcrApplication, nil?: true
 
-      # @!attribute contact_phone_country_code
-      #   Contact phone country code (e.g., "1" for US)
-      #
-      #   @return [String, nil]
-      optional :contact_phone_country_code, String, api_name: :contactPhoneCountryCode, nil?: true
+        # @!attribute notes
+        #   Additional notes about the business or use case
+        #
+        #   @return [String, nil]
+        optional :notes, String, nil?: true
 
-      # @!attribute country
-      #   Country code (e.g., US, CA)
-      #
-      #   @return [String, nil]
-      optional :country, String, nil?: true
+        # @!attribute phone_number_prefix
+        #   Phone number prefix for messaging (e.g., "+1")
+        #
+        #   @return [String, nil]
+        optional :phone_number_prefix, String, api_name: :phoneNumberPrefix, nil?: true
 
-      # @!attribute country_of_registration
-      #   Country where the business is registered
-      #
-      #   @return [String, nil]
-      optional :country_of_registration, String, api_name: :countryOfRegistration, nil?: true
+        # @!attribute primary_use_case
+        #   Primary messaging use case description
+        #
+        #   @return [String, nil]
+        optional :primary_use_case, String, api_name: :primaryUseCase, nil?: true
 
-      # @!attribute destination_countries
-      #   List of destination countries for messaging
-      #
-      #   @return [Array<Sentdm::Models::DestinationCountry>, nil]
-      optional :destination_countries,
-               -> { Sentdm::Internal::Type::ArrayOf[Sentdm::DestinationCountry] },
-               api_name: :destinationCountries,
-               nil?: true
-
-      # @!attribute entity_type
-      #   Business entity type
-      #
-      #   @return [Symbol, Sentdm::Models::BrandData::EntityType, nil]
-      optional :entity_type, enum: -> { Sentdm::BrandData::EntityType }, api_name: :entityType, nil?: true
+        # @!method initialize(brand_relationship:, vertical:, destination_countries: nil, expected_messaging_volume: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, primary_use_case: nil)
+        #   Compliance and TCR-related information
+        #
+        #   @param brand_relationship [Symbol, Sentdm::Models::TcrBrandRelationship] Brand relationship level with TCR (required for TCR)
+        #
+        #   @param vertical [Symbol, Sentdm::Models::TcrVertical] Business vertical/industry category (required for TCR)
+        #
+        #   @param destination_countries [Array<Sentdm::Models::DestinationCountry>, nil] List of destination countries for messaging
+        #
+        #   @param expected_messaging_volume [String, nil] Expected daily messaging volume
+        #
+        #   @param is_tcr_application [Boolean, nil] Whether this is a TCR (Campaign Registry) application
+        #
+        #   @param notes [String, nil] Additional notes about the business or use case
+        #
+        #   @param phone_number_prefix [String, nil] Phone number prefix for messaging (e.g., "+1")
+        #
+        #   @param primary_use_case [String, nil] Primary messaging use case description
+      end
 
-      # @!attribute expected_messaging_volume
-      #   Expected daily messaging volume
-      #
-      #   @return [String, nil]
-      optional :expected_messaging_volume, String, api_name: :expectedMessagingVolume, nil?: true
+      # @see Sentdm::Models::BrandData#contact
+      class Contact < Sentdm::Internal::Type::BaseModel
+        # @!attribute name
+        #   Primary contact name (required)
+        #
+        #   @return [String]
+        required :name, String
 
-      # @!attribute is_tcr_application
-      #   Whether this is a TCR (Campaign Registry) application
-      #
-      #   @return [Boolean, nil]
-      optional :is_tcr_application, Sentdm::Internal::Type::Boolean, api_name: :isTcrApplication, nil?: true
+        # @!attribute business_name
+        #   Business/brand name
+        #
+        #   @return [String, nil]
+        optional :business_name, String, api_name: :businessName, nil?: true
 
-      # @!attribute notes
-      #   Additional notes about the business or use case
-      #
-      #   @return [String, nil]
-      optional :notes, String, nil?: true
+        # @!attribute email
+        #   Contact email address
+        #
+        #   @return [String, nil]
+        optional :email, String, nil?: true
 
-      # @!attribute phone_number_prefix
-      #   Phone number prefix for messaging (e.g., "+1")
-      #
-      #   @return [String, nil]
-      optional :phone_number_prefix, String, api_name: :phoneNumberPrefix, nil?: true
+        # @!attribute phone
+        #   Contact phone number in E.164 format
+        #
+        #   @return [String, nil]
+        optional :phone, String, nil?: true
 
-      # @!attribute postal_code
-      #   Postal/ZIP code
-      #
-      #   @return [String, nil]
-      optional :postal_code, String, api_name: :postalCode, nil?: true
+        # @!attribute phone_country_code
+        #   Contact phone country code (e.g., "1" for US)
+        #
+        #   @return [String, nil]
+        optional :phone_country_code, String, api_name: :phoneCountryCode, nil?: true
 
-      # @!attribute primary_use_case
-      #   Primary messaging use case description
-      #
-      #   @return [String, nil]
-      optional :primary_use_case, String, api_name: :primaryUseCase, nil?: true
+        # @!attribute role
+        #   Contact's role in the business
+        #
+        #   @return [String, nil]
+        optional :role, String, nil?: true
 
-      # @!attribute state
-      #   State/province code
-      #
-      #   @return [String, nil]
-      optional :state, String, nil?: true
+        # @!method initialize(name:, business_name: nil, email: nil, phone: nil, phone_country_code: nil, role: nil)
+        #   Contact information for the brand
+        #
+        #   @param name [String] Primary contact name (required)
+        #
+        #   @param business_name [String, nil] Business/brand name
+        #
+        #   @param email [String, nil] Contact email address
+        #
+        #   @param phone [String, nil] Contact phone number in E.164 format
+        #
+        #   @param phone_country_code [String, nil] Contact phone country code (e.g., "1" for US)
+        #
+        #   @param role [String, nil] Contact's role in the business
+      end
 
-      # @!attribute street
-      #   Street address
-      #
-      #   @return [String, nil]
-      optional :street, String, nil?: true
+      # @see Sentdm::Models::BrandData#business
+      class Business < Sentdm::Internal::Type::BaseModel
+        # @!attribute city
+        #   City
+        #
+        #   @return [String, nil]
+        optional :city, String, nil?: true
 
-      # @!attribute tax_id
-      #   Tax ID/EIN number
-      #
-      #   @return [String, nil]
-      optional :tax_id, String, api_name: :taxId, nil?: true
+        # @!attribute country
+        #   Country code (e.g., US, CA)
+        #
+        #   @return [String, nil]
+        optional :country, String, nil?: true
 
-      # @!attribute tax_id_type
-      #   Type of tax ID (e.g., us_ein, ca_bn)
-      #
-      #   @return [String, nil]
-      optional :tax_id_type, String, api_name: :taxIdType, nil?: true
+        # @!attribute country_of_registration
+        #   Country where the business is registered
+        #
+        #   @return [String, nil]
+        optional :country_of_registration, String, api_name: :countryOfRegistration, nil?: true
 
-      # @!method initialize(brand_relationship:, contact_name:, vertical:, brand_name: nil, business_legal_name: nil, business_name: nil, business_role: nil, business_url: nil, city: nil, contact_email: nil, contact_phone: nil, contact_phone_country_code: nil, country: nil, country_of_registration: nil, destination_countries: nil, entity_type: nil, expected_messaging_volume: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, postal_code: nil, primary_use_case: nil, state: nil, street: nil, tax_id: nil, tax_id_type: nil)
-      #   Brand and KYC data
-      #
-      #   @param brand_relationship [Symbol, Sentdm::Models::TcrBrandRelationship] Brand relationship level with TCR (required for TCR)
-      #
-      #   @param contact_name [String] Primary contact name (required)
-      #
-      #   @param vertical [Symbol, Sentdm::Models::TcrVertical] Business vertical/industry category (required for TCR)
-      #
-      #   @param brand_name [String, nil] Brand name for KYC submission
-      #
-      #   @param business_legal_name [String, nil] Legal business name
-      #
-      #   @param business_name [String, nil] Business/brand name
-      #
-      #   @param business_role [String, nil] Contact's role in the business
-      #
-      #   @param business_url [String, nil] Business website URL
-      #
-      #   @param city [String, nil] City
-      #
-      #   @param contact_email [String, nil] Contact email address
-      #
-      #   @param contact_phone [String, nil] Contact phone number in E.164 format
-      #
-      #   @param contact_phone_country_code [String, nil] Contact phone country code (e.g., "1" for US)
-      #
-      #   @param country [String, nil] Country code (e.g., US, CA)
-      #
-      #   @param country_of_registration [String, nil] Country where the business is registered
-      #
-      #   @param destination_countries [Array<Sentdm::Models::DestinationCountry>, nil] List of destination countries for messaging
-      #
-      #   @param entity_type [Symbol, Sentdm::Models::BrandData::EntityType, nil] Business entity type
-      #
-      #   @param expected_messaging_volume [String, nil] Expected daily messaging volume
-      #
-      #   @param is_tcr_application [Boolean, nil] Whether this is a TCR (Campaign Registry) application
-      #
-      #   @param notes [String, nil] Additional notes about the business or use case
-      #
-      #   @param phone_number_prefix [String, nil] Phone number prefix for messaging (e.g., "+1")
-      #
-      #   @param postal_code [String, nil] Postal/ZIP code
-      #
-      #   @param primary_use_case [String, nil] Primary messaging use case description
-      #
-      #   @param state [String, nil] State/province code
-      #
-      #   @param street [String, nil] Street address
-      #
-      #   @param tax_id [String, nil] Tax ID/EIN number
-      #
-      #   @param tax_id_type [String, nil] Type of tax ID (e.g., us_ein, ca_bn)
+        # @!attribute entity_type
+        #   Business entity type
+        #
+        #   @return [Symbol, Sentdm::Models::BrandData::Business::EntityType, nil]
+        optional :entity_type,
+                 enum: -> { Sentdm::BrandData::Business::EntityType },
+                 api_name: :entityType,
+                 nil?: true
 
-      # Business entity type
-      #
-      # @see Sentdm::Models::BrandData#entity_type
-      module EntityType
-        extend Sentdm::Internal::Type::Enum
-
-        PRIVATE_PROFIT = :PRIVATE_PROFIT
-        PUBLIC_PROFIT = :PUBLIC_PROFIT
-        NON_PROFIT = :NON_PROFIT
-        SOLE_PROPRIETOR = :SOLE_PROPRIETOR
-        GOVERNMENT = :GOVERNMENT
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
+        # @!attribute legal_name
+        #   Legal business name
+        #
+        #   @return [String, nil]
+        optional :legal_name, String, api_name: :legalName, nil?: true
+
+        # @!attribute postal_code
+        #   Postal/ZIP code
+        #
+        #   @return [String, nil]
+        optional :postal_code, String, api_name: :postalCode, nil?: true
+
+        # @!attribute state
+        #   State/province code
+        #
+        #   @return [String, nil]
+        optional :state, String, nil?: true
+
+        # @!attribute street
+        #   Street address
+        #
+        #   @return [String, nil]
+        optional :street, String, nil?: true
+
+        # @!attribute tax_id
+        #   Tax ID/EIN number
+        #
+        #   @return [String, nil]
+        optional :tax_id, String, api_name: :taxId, nil?: true
+
+        # @!attribute tax_id_type
+        #   Type of tax ID (e.g., us_ein, ca_bn)
+        #
+        #   @return [String, nil]
+        optional :tax_id_type, String, api_name: :taxIdType, nil?: true
+
+        # @!attribute url
+        #   Business website URL
+        #
+        #   @return [String, nil]
+        optional :url, String, nil?: true
+
+        # @!method initialize(city: nil, country: nil, country_of_registration: nil, entity_type: nil, legal_name: nil, postal_code: nil, state: nil, street: nil, tax_id: nil, tax_id_type: nil, url: nil)
+        #   Business details and address information
+        #
+        #   @param city [String, nil] City
+        #
+        #   @param country [String, nil] Country code (e.g., US, CA)
+        #
+        #   @param country_of_registration [String, nil] Country where the business is registered
+        #
+        #   @param entity_type [Symbol, Sentdm::Models::BrandData::Business::EntityType, nil] Business entity type
+        #
+        #   @param legal_name [String, nil] Legal business name
+        #
+        #   @param postal_code [String, nil] Postal/ZIP code
+        #
+        #   @param state [String, nil] State/province code
+        #
+        #   @param street [String, nil] Street address
+        #
+        #   @param tax_id [String, nil] Tax ID/EIN number
+        #
+        #   @param tax_id_type [String, nil] Type of tax ID (e.g., us_ein, ca_bn)
+        #
+        #   @param url [String, nil] Business website URL
+
+        # Business entity type
+        #
+        # @see Sentdm::Models::BrandData::Business#entity_type
+        module EntityType
+          extend Sentdm::Internal::Type::Enum
+
+          PRIVATE_PROFIT = :PRIVATE_PROFIT
+          PUBLIC_PROFIT = :PUBLIC_PROFIT
+          NON_PROFIT = :NON_PROFIT
+          SOLE_PROPRIETOR = :SOLE_PROPRIETOR
+          GOVERNMENT = :GOVERNMENT
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end