sentdm 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05c854c79f1208c28d3ecacb5111648f56c2d850f1b2a353462a19ef9559f70f
-  data.tar.gz: 07d88b86954305d084b1dcd5a54785349979e08d66dc68b292be60845f44e05a
+  metadata.gz: b04e02de625816b5c8b0b5a02ecedc198dc33f346277ebaebca6e26e8df61844
+  data.tar.gz: cb8626c2a126335a92cea456679fdb2d5865fbecbb391e6634d00b932cde65d4
 SHA512:
-  metadata.gz: d464e1edb179e1b3ef4b76c017417016ff67f4d16d02345985c1177493cdb286285cf00eb4a6a9347a1361aa03a3783f8b2646d889d1fc16ef7b0a6782cde06a
-  data.tar.gz: 8bc5abf3c6429faa22188eef6711467142b6b9623fbd208ae5b6171d65f7f44beb7b9b13fad99ab9ba6c29f9d652234e1776bce5b61397f09dd24e4ba1ba89e1
+  metadata.gz: 7a1eec1d9dfd462eefddb941989e06e7af9ed1e2a3fd9a84fca256af193711b0443c7dbbca66db20963722c630e34854207489842f21d8ab4fd4f174118a6178
+  data.tar.gz: d291e1ace6701e0ef970dc044aa629847472273a9ec1b422456eba805db7f4b45358ea0b71fba71f166392f20c0e4b37a20d4c23b5339ed9d55c29980defd60a

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.5.0 (2026-03-11)
+
+Full Changelog: [v0.4.0...v0.5.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.4.0...v0.5.0)
+
+### Features
+
+* **api:** manual updates ([bdd5b4e](https://github.com/sentdm/sent-dm-ruby/commit/bdd5b4efe70096707888663254558a55d1a3c03b))
+
 ## 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)

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.4.0"
+gem "sentdm", "~> 0.5.0"
 ```
 
 <!-- x-release-please-end -->
@@ -265,32 +265,6 @@ params = Sentdm::MessageSendParams.new(
 sent_dm.messages.send_(**params)
 ```
 
-### Enums
-
-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
-# :SELF_DECLARED
-puts(Sentdm::BrandWithKYC::IdentityStatus::SELF_DECLARED)
-
-# 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::BrandWithKYC.new(
-  identity_status: Sentdm::BrandWithKYC::IdentityStatus::SELF_DECLARED,
-  # …
-)
-
-Sentdm::BrandWithKYC.new(
-  identity_status: :SELF_DECLARED,
-  # …
-)
-```
-
 ## Versioning
 
 This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.

data/lib/sentdm/client.rb

@@ -36,20 +36,18 @@ module Sentdm
     # @return [Sentdm::Resources::Profiles]
     attr_reader :profiles
 
+    # Manage and lookup phone numbers
+    # @return [Sentdm::Resources::Numbers]
+    attr_reader :numbers
+
     # Send and track SMS and WhatsApp messages
     # @return [Sentdm::Resources::Messages]
     attr_reader :messages
 
-    # @return [Sentdm::Resources::Lookup]
-    attr_reader :lookup
-
     # Create, update, and manage customer contact lists
     # @return [Sentdm::Resources::Contacts]
     attr_reader :contacts
 
-    # @return [Sentdm::Resources::Brands]
-    attr_reader :brands
-
     # Retrieve account details
     # @return [Sentdm::Resources::Me]
     attr_reader :me
@@ -105,10 +103,9 @@ module Sentdm
       @users = Sentdm::Resources::Users.new(client: self)
       @templates = Sentdm::Resources::Templates.new(client: self)
       @profiles = Sentdm::Resources::Profiles.new(client: self)
+      @numbers = Sentdm::Resources::Numbers.new(client: self)
       @messages = Sentdm::Resources::Messages.new(client: self)
-      @lookup = Sentdm::Resources::Lookup.new(client: self)
       @contacts = Sentdm::Resources::Contacts.new(client: self)
-      @brands = Sentdm::Resources::Brands.new(client: self)
       @me = Sentdm::Resources::Me.new(client: self)
     end
   end

data/lib/sentdm/internal/type/base_model.rb

@@ -438,11 +438,11 @@ module Sentdm
         # @return [Hash{Symbol=>Object}]
         #
         # @example
-        #   # `api_error` is a `Sentdm::APIError`
-        #   api_error => {
-        #     code: code,
-        #     details: details,
-        #     doc_url: doc_url
+        #   # `base_dto` is a `Sentdm::BaseDto`
+        #   base_dto => {
+        #     id: id,
+        #     created_at: created_at,
+        #     updated_at: updated_at
         #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)

data/lib/sentdm/models/{api_response_contact.rb → api_response_of_contact.rb}

@@ -3,12 +3,12 @@
 module Sentdm
   module Models
     # @see Sentdm::Resources::Contacts#create
-    class APIResponseContact < Sentdm::Internal::Type::BaseModel
+    class APIResponseOfContact < Sentdm::Internal::Type::BaseModel
       # @!attribute data
       #   The response data (null if error)
       #
-      #   @return [Sentdm::Models::Contact, nil]
-      optional :data, -> { Sentdm::Contact }, nil?: true
+      #   @return [Sentdm::Models::ContactResponse, nil]
+      optional :data, -> { Sentdm::ContactResponse }, nil?: true
 
       # @!attribute error
       #   Error details (null if successful)
@@ -31,7 +31,7 @@ module Sentdm
       # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
       #   Standard API response envelope for all v3 endpoints
       #
-      #   @param data [Sentdm::Models::Contact, nil] The response data (null if error)
+      #   @param data [Sentdm::Models::ContactResponse, nil] The response data (null if error)
       #
       #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
       #

data/lib/sentdm/models/base_dto.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class BaseDto < Sentdm::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time, api_name: :createdAt
+
+      # @!attribute updated_at
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, api_name: :updatedAt, nil?: true
+
+      # @!method initialize(id: nil, created_at: nil, updated_at: nil)
+      #   @param id [String] Unique identifier
+      #
+      #   @param created_at [Time]
+      #
+      #   @param updated_at [Time, nil]
+    end
+  end
+end

data/lib/sentdm/models/billing_contact_info.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class BillingContactInfo < Sentdm::Internal::Type::BaseModel
+      # @!attribute email
+      #   Email address where invoices will be sent (required)
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute name
+      #   Full name of the billing contact or company (required)
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute address
+      #   Billing address (optional). Free-form text including street, city, state, postal
+      #   code, and country.
+      #
+      #   @return [String, nil]
+      optional :address, String, nil?: true
+
+      # @!attribute phone
+      #   Phone number for the billing contact (optional)
+      #
+      #   @return [String, nil]
+      optional :phone, String, nil?: true
+
+      # @!method initialize(email:, name:, address: nil, phone: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::BillingContactInfo} for more details.
+      #
+      #   Billing contact information for a profile. Required when billing_model is
+      #   "profile" or "profile_and_organization".
+      #
+      #   @param email [String] Email address where invoices will be sent (required)
+      #
+      #   @param name [String] Full name of the billing contact or company (required)
+      #
+      #   @param address [String, nil] Billing address (optional). Free-form text including street, city, state, postal
+      #
+      #   @param phone [String, nil] Phone number for the billing contact (optional)
+    end
+  end
+end

data/lib/sentdm/models/{brand_data.rb → brands_brand_data.rb}

@@ -2,35 +2,35 @@
 
 module Sentdm
   module Models
-    class BrandData < Sentdm::Internal::Type::BaseModel
+    class BrandsBrandData < Sentdm::Internal::Type::BaseModel
       # @!attribute compliance
       #   Compliance and TCR-related information
       #
-      #   @return [Sentdm::Models::BrandData::Compliance]
-      required :compliance, -> { Sentdm::BrandData::Compliance }
+      #   @return [Sentdm::Models::BrandsBrandData::Compliance]
+      required :compliance, -> { Sentdm::BrandsBrandData::Compliance }
 
       # @!attribute contact
       #   Contact information for the brand
       #
-      #   @return [Sentdm::Models::BrandData::Contact]
-      required :contact, -> { Sentdm::BrandData::Contact }
+      #   @return [Sentdm::Models::BrandsBrandData::Contact]
+      required :contact, -> { Sentdm::BrandsBrandData::Contact }
 
       # @!attribute business
       #   Business details and address information
       #
-      #   @return [Sentdm::Models::BrandData::Business, nil]
-      optional :business, -> { Sentdm::BrandData::Business }, nil?: true
+      #   @return [Sentdm::Models::BrandsBrandData::Business, nil]
+      optional :business, -> { Sentdm::BrandsBrandData::Business }, nil?: true
 
       # @!method initialize(compliance:, contact:, business: nil)
       #   Brand and KYC data grouped into contact, business, and compliance sections
       #
-      #   @param compliance [Sentdm::Models::BrandData::Compliance] Compliance and TCR-related information
+      #   @param compliance [Sentdm::Models::BrandsBrandData::Compliance] Compliance and TCR-related information
       #
-      #   @param contact [Sentdm::Models::BrandData::Contact] Contact information for the brand
+      #   @param contact [Sentdm::Models::BrandsBrandData::Contact] Contact information for the brand
       #
-      #   @param business [Sentdm::Models::BrandData::Business, nil] Business details and address information
+      #   @param business [Sentdm::Models::BrandsBrandData::Business, nil] Business details and address information
 
-      # @see Sentdm::Models::BrandData#compliance
+      # @see Sentdm::Models::BrandsBrandData#compliance
       class Compliance < Sentdm::Internal::Type::BaseModel
         # @!attribute brand_relationship
         #   Brand relationship level with TCR (required for TCR)
@@ -103,7 +103,7 @@ module Sentdm
         #   @param primary_use_case [String, nil] Primary messaging use case description
       end
 
-      # @see Sentdm::Models::BrandData#contact
+      # @see Sentdm::Models::BrandsBrandData#contact
       class Contact < Sentdm::Internal::Type::BaseModel
         # @!attribute name
         #   Primary contact name (required)
@@ -157,7 +157,7 @@ module Sentdm
         #   @param role [String, nil] Contact's role in the business
       end
 
-      # @see Sentdm::Models::BrandData#business
+      # @see Sentdm::Models::BrandsBrandData#business
       class Business < Sentdm::Internal::Type::BaseModel
         # @!attribute city
         #   City
@@ -180,9 +180,9 @@ module Sentdm
         # @!attribute entity_type
         #   Business entity type
         #
-        #   @return [Symbol, Sentdm::Models::BrandData::Business::EntityType, nil]
+        #   @return [Symbol, Sentdm::Models::BrandsBrandData::Business::EntityType, nil]
         optional :entity_type,
-                 enum: -> { Sentdm::BrandData::Business::EntityType },
+                 enum: -> { Sentdm::BrandsBrandData::Business::EntityType },
                  api_name: :entityType,
                  nil?: true
 
@@ -237,7 +237,7 @@ module Sentdm
         #
         #   @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 entity_type [Symbol, Sentdm::Models::BrandsBrandData::Business::EntityType, nil] Business entity type
         #
         #   @param legal_name [String, nil] Legal business name
         #
@@ -255,7 +255,7 @@ module Sentdm
 
         # Business entity type
         #
-        # @see Sentdm::Models::BrandData::Business#entity_type
+        # @see Sentdm::Models::BrandsBrandData::Business#entity_type
         module EntityType
           extend Sentdm::Internal::Type::Enum
 

data/lib/sentdm/models/contact_delete_params.rb

@@ -32,7 +32,7 @@ module Sentdm
       #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
 
-      class Body < Sentdm::Models::MutationRequest
+      class Body < Sentdm::Models::MutationRequestBase
         # @!method initialize
         #   Request to delete/dissociate a contact
       end

data/lib/sentdm/models/contact_list_response.rb

@@ -44,8 +44,8 @@ module Sentdm
         # @!attribute contacts
         #   List of contacts
         #
-        #   @return [Array<Sentdm::Models::Contact>, nil]
-        optional :contacts, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Contact] }
+        #   @return [Array<Sentdm::Models::ContactResponse>, nil]
+        optional :contacts, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ContactResponse] }
 
         # @!attribute pagination
         #   Pagination metadata
@@ -56,7 +56,7 @@ module Sentdm
         # @!method initialize(contacts: nil, pagination: nil)
         #   The response data (null if error)
         #
-        #   @param contacts [Array<Sentdm::Models::Contact>] List of contacts
+        #   @param contacts [Array<Sentdm::Models::ContactResponse>] List of contacts
         #
         #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata
       end

data/lib/sentdm/models/{contact.rb → contact_response.rb}

@@ -2,7 +2,7 @@
 
 module Sentdm
   module Models
-    class Contact < Sentdm::Internal::Type::BaseModel
+    class ContactResponse < Sentdm::Internal::Type::BaseModel
       # @!attribute id
       #   Unique identifier for the contact
       #

data/lib/sentdm/models/{mutation_request.rb → mutation_request_base.rb}

@@ -2,7 +2,7 @@
 
 module Sentdm
   module Models
-    class MutationRequest < Sentdm::Internal::Type::BaseModel
+    class MutationRequestBase < Sentdm::Internal::Type::BaseModel
       # @!attribute sandbox
       #   Sandbox flag - when true, the operation is simulated without side effects Useful
       #   for testing integrations without actual execution
@@ -12,7 +12,7 @@ module Sentdm
 
       # @!method initialize(sandbox: nil)
       #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::MutationRequest} for more details.
+      #   {Sentdm::Models::MutationRequestBase} for more details.
       #
       #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
     end

data/lib/sentdm/models/number_lookup_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Numbers#lookup
+    class NumberLookupParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute phone_number
+      #
+      #   @return [String]
+      required :phone_number, String
+
+      # @!attribute x_profile_id
+      #
+      #   @return [String, nil]
+      optional :x_profile_id, String
+
+      # @!method initialize(phone_number:, x_profile_id: nil, request_options: {})
+      #   @param phone_number [String]
+      #   @param x_profile_id [String]
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/number_lookup_response.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Numbers#lookup
+    class NumberLookupResponse < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The response data (null if error)
+      #
+      #   @return [Sentdm::Models::NumberLookupResponse::Data, nil]
+      optional :data, -> { Sentdm::Models::NumberLookupResponse::Data }, nil?: true
+
+      # @!attribute error
+      #   Error details (null if successful)
+      #
+      #   @return [Sentdm::Models::APIError, nil]
+      optional :error, -> { Sentdm::APIError }, nil?: true
+
+      # @!attribute meta
+      #   Metadata about the request and response
+      #
+      #   @return [Sentdm::Models::APIMeta, nil]
+      optional :meta, -> { Sentdm::APIMeta }
+
+      # @!attribute success
+      #   Indicates whether the request was successful
+      #
+      #   @return [Boolean, nil]
+      optional :success, Sentdm::Internal::Type::Boolean
+
+      # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::NumberLookupResponse::Data, nil] The response data (null if error)
+      #
+      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+
+      # @see Sentdm::Models::NumberLookupResponse#data
+      class Data < Sentdm::Internal::Type::BaseModel
+        # @!attribute carrier_name
+        #
+        #   @return [String, nil]
+        optional :carrier_name, String, nil?: true
+
+        # @!attribute country_code
+        #
+        #   @return [String, nil]
+        optional :country_code, String, nil?: true
+
+        # @!attribute is_ported
+        #
+        #   @return [Boolean, nil]
+        optional :is_ported, Sentdm::Internal::Type::Boolean, nil?: true
+
+        # @!attribute is_valid
+        #
+        #   @return [Boolean, nil]
+        optional :is_valid, Sentdm::Internal::Type::Boolean
+
+        # @!attribute is_voip
+        #
+        #   @return [Boolean, nil]
+        optional :is_voip, Sentdm::Internal::Type::Boolean, nil?: true
+
+        # @!attribute line_type
+        #
+        #   @return [String, nil]
+        optional :line_type, String, nil?: true
+
+        # @!attribute mobile_country_code
+        #
+        #   @return [String, nil]
+        optional :mobile_country_code, String, nil?: true
+
+        # @!attribute mobile_network_code
+        #
+        #   @return [String, nil]
+        optional :mobile_network_code, String, nil?: true
+
+        # @!attribute phone_number
+        #
+        #   @return [String, nil]
+        optional :phone_number, String
+
+        # @!method initialize(carrier_name: nil, country_code: nil, is_ported: nil, is_valid: nil, is_voip: nil, line_type: nil, mobile_country_code: nil, mobile_network_code: nil, phone_number: nil)
+        #   The response data (null if error)
+        #
+        #   @param carrier_name [String, nil]
+        #   @param country_code [String, nil]
+        #   @param is_ported [Boolean, nil]
+        #   @param is_valid [Boolean]
+        #   @param is_voip [Boolean, nil]
+        #   @param line_type [String, nil]
+        #   @param mobile_country_code [String, nil]
+        #   @param mobile_network_code [String, nil]
+        #   @param phone_number [String]
+      end
+    end
+  end
+end

data/lib/sentdm/models/payment_details.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class PaymentDetails < Sentdm::Internal::Type::BaseModel
+      # @!attribute card_number
+      #   Card number (digits only, 13–19 characters)
+      #
+      #   @return [String]
+      required :card_number, String
+
+      # @!attribute cvc
+      #   Card security code (3–4 digits)
+      #
+      #   @return [String]
+      required :cvc, String
+
+      # @!attribute expiry
+      #   Card expiry date in MM/YY format (e.g. "09/27")
+      #
+      #   @return [String]
+      required :expiry, String
+
+      # @!attribute zip_code
+      #   Billing ZIP / postal code associated with the card
+      #
+      #   @return [String]
+      required :zip_code, String
+
+      # @!method initialize(card_number:, cvc:, expiry:, zip_code:)
+      #   Payment card details for a profile. Accepted when billing_model is "profile" or
+      #   "profile_and_organization". These details are not stored on our servers and will
+      #   be forwarded to the payment processor.
+      #
+      #   @param card_number [String] Card number (digits only, 13–19 characters)
+      #
+      #   @param cvc [String] Card security code (3–4 digits)
+      #
+      #   @param expiry [String] Card expiry date in MM/YY format (e.g. "09/27")
+      #
+      #   @param zip_code [String] Billing ZIP / postal code associated with the card
+    end
+  end
+end

data/lib/sentdm/models/{profile_complete_params.rb → profile_complete_setup_params.rb}

@@ -2,8 +2,8 @@
 
 module Sentdm
   module Models
-    # @see Sentdm::Resources::Profiles#complete
-    class ProfileCompleteParams < Sentdm::Internal::Type::BaseModel
+    # @see Sentdm::Resources::Profiles#complete_setup
+    class ProfileCompleteSetupParams < Sentdm::Internal::Type::BaseModel
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
@@ -37,7 +37,7 @@ module Sentdm
 
       # @!method initialize(profile_id:, web_hook_url:, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::ProfileCompleteParams} for more details.
+      #   {Sentdm::Models::ProfileCompleteSetupParams} for more details.
       #
       #   @param profile_id [String]
       #

data/lib/sentdm/models/{profile_complete_response.rb → profile_complete_setup_response.rb}

@@ -3,6 +3,6 @@
 module Sentdm
   module Models
     # @type [Sentdm::Internal::Type::Converter]
-    ProfileCompleteResponse = Sentdm::Internal::Type::Unknown
+    ProfileCompleteSetupResponse = Sentdm::Internal::Type::Unknown
   end
 end