sentdm 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7eca3b33e0d8588930acf2d6e33fdd60c964f8a781d922f8e7040a75792d2bbe
-  data.tar.gz: 3d483a3c8d7a96d3c25fdacadde93c28529e9268a99821ea821d4f372659d8af
+  metadata.gz: 634c8f9c1711011e0280ebcdb4419b93193a9288622adb1768d327646fa29ebf
+  data.tar.gz: 15eaaa4dad36cb8d03f11ce33e9793ba2cbad249634a335ba85fa1804e33dba9
 SHA512:
-  metadata.gz: 3db448f0f36ba6f215c885c9b10d8dd81f71566e16428e594dbaceeab4987cb5b16bfc91f79a43ab74dca4c178cc3bdbe358e88ce9ef567a3f4b00798928120f
-  data.tar.gz: bc1915cc1dc751c470ef10b5c149a0aad88d3b847a506750d6d1759d8d9ed29e08255050e7682e83bcce06a3c65018359673ee9420642e16c14d519470f3cf71
+  metadata.gz: 41450d9f5fe9ae3f85709cce0d67b299a2c88a10aae4758f72587a4880e6bcddf4923e594f9041118f29a485a6aae4b11e8aebdc88eeeba5416eebe7b539d606
+  data.tar.gz: ac4c7fa1687d70569edccb8e8084c9f438f2f9f1785a3ab2fb5681a8a6b9116ef69b1e5a2b3739d77ffcee7c8dc76b1bf9f28cb861387588fcdf7d1d1b3e9fbd

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.20.0 (2026-05-14)
+
+Full Changelog: [v0.19.0...v0.20.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.19.0...v0.20.0)
+
+### Features
+
+* **api:** manual updates ([f9d7ba9](https://github.com/sentdm/sent-dm-ruby/commit/f9d7ba98c6a8a0fc22eff4d019b3ce4a319ff8c4))
+
 ## 0.19.0 (2026-05-14)
 
 Full Changelog: [v0.18.0...v0.19.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.18.0...v0.19.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.19.0"
+gem "sentdm", "~> 0.20.0"
 ```
 
 <!-- x-release-please-end -->
@@ -265,6 +265,36 @@ params = Sentdm::MessageSendParams.new(
 sent.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
+# :PRIVATE_PROFIT
+puts(
+  Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType::PRIVATE_PROFIT
+)
+
+# Revealed type: `T.all(Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType, Symbol)`
+T.reveal_type(
+  Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType::PRIVATE_PROFIT
+)
+```
+
+Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
+
+```ruby
+Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo.new(
+  entity_type: Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType::PRIVATE_PROFIT,
+  # …
+)
+
+Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo.new(
+  entity_type: :PRIVATE_PROFIT,
+  # …
+)
+```
+
 ## 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/internal/type/base_model.rb

@@ -438,11 +438,11 @@ module Sentdm
         # @return [Hash{Symbol=>Object}]
         #
         # @example
-        #   # `webhook_create_response` is a `Sentdm::Models::WebhookCreateResponse`
-        #   webhook_create_response => {
-        #     data: data,
-        #     error: error,
-        #     meta: meta
+        #   # `api_meta` is a `Sentdm::APIMeta`
+        #   api_meta => {
+        #     request_id: request_id,
+        #     timestamp: timestamp,
+        #     version: version
         #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)

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

@@ -15,6 +15,31 @@ module Sentdm
       #
       # We can therefore convert string values to Symbols, but can't convert other
       # values safely.
+      #
+      # @example
+      #   # `tcr_brand_relationship` is a `Sentdm::TcrBrandRelationship`
+      #   case tcr_brand_relationship
+      #   when Sentdm::TcrBrandRelationship::BASIC_ACCOUNT
+      #     # ...
+      #   when Sentdm::TcrBrandRelationship::MEDIUM_ACCOUNT
+      #     # ...
+      #   when Sentdm::TcrBrandRelationship::LARGE_ACCOUNT
+      #     # ...
+      #   else
+      #     puts(tcr_brand_relationship)
+      #   end
+      #
+      # @example
+      #   case tcr_brand_relationship
+      #   in :BASIC_ACCOUNT
+      #     # ...
+      #   in :MEDIUM_ACCOUNT
+      #     # ...
+      #   in :LARGE_ACCOUNT
+      #     # ...
+      #   else
+      #     puts(tcr_brand_relationship)
+      #   end
       module Enum
         include Sentdm::Internal::Type::Converter
         include Sentdm::Internal::Util::SorbetRuntimeSupport

data/lib/sentdm/models/api_meta.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class APIMeta < Sentdm::Internal::Type::BaseModel
+      # @!attribute request_id
+      #   Unique identifier for this request (for tracing and support)
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!attribute timestamp
+      #   Server timestamp when the response was generated
+      #
+      #   @return [Time, nil]
+      optional :timestamp, Time
+
+      # @!attribute version
+      #   API version used for this request
+      #
+      #   @return [String, nil]
+      optional :version, String
+
+      # @!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 timestamp [Time] Server timestamp when the response was generated
+      #
+      #   @param version [String] API version used for this request
+    end
+  end
+end

data/lib/sentdm/models/api_response_of_contact.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Contacts#create
+    class APIResponseOfContact < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   Contact response for v3 API Uses snake_case for JSON property names
+      #
+      #   @return [Sentdm::Models::ContactResponse, nil]
+      optional :data, -> { Sentdm::ContactResponse }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @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)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::APIResponseOfContact} for more details.
+      #
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::ContactResponse, nil] Contact response for v3 API
+      #
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end

data/lib/sentdm/models/api_response_of_profile_detail.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Profiles#create
+    class APIResponseOfProfileDetail < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   Detailed profile response for v3 API
+      #
+      #   @return [Sentdm::Models::ProfileDetail, nil]
+      optional :data, -> { Sentdm::ProfileDetail }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @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::ProfileDetail, nil] Detailed profile response for v3 API
+      #
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end

data/lib/sentdm/models/api_response_of_user.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Users#retrieve
+    class APIResponseOfUser < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   User response for v3 API
+      #
+      #   @return [Sentdm::Models::UserResponse, nil]
+      optional :data, -> { Sentdm::UserResponse }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @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::UserResponse, nil] User response for v3 API
+      #
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end

data/lib/sentdm/models/api_response_template.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Templates#create
+    class APIResponseTemplate < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   Template response for v3 API
+      #
+      #   @return [Sentdm::Models::Template, nil]
+      optional :data, -> { Sentdm::Template }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @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::Template, nil] Template response for v3 API
+      #
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end

data/lib/sentdm/models/api_response_webhook.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Webhooks#create
+    class APIResponseWebhook < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The response data (null if error)
+      #
+      #   @return [Sentdm::Models::WebhookResponse, nil]
+      optional :data, -> { Sentdm::WebhookResponse }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @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::WebhookResponse, nil] The response data (null if error)
+      #
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    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/brands_brand_data.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class BrandsBrandData < Sentdm::Internal::Type::BaseModel
+      # @!attribute compliance
+      #   Compliance and TCR information for brand registration
+      #
+      #   @return [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo]
+      required :compliance,
+               -> { Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo }
+
+      # @!attribute contact
+      #   Contact information for brand KYC
+      #
+      #   @return [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo]
+      required :contact,
+               -> { Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo }
+
+      # @!attribute business
+      #   Business details and address for brand KYC
+      #
+      #   @return [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo, nil]
+      optional :business,
+               -> { Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo },
+               nil?: true
+
+      # @!method initialize(compliance:, contact:, business: nil)
+      #   Brand and KYC data grouped into contact, business, and compliance sections
+      #
+      #   @param compliance [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo] Compliance and TCR information for brand registration
+      #
+      #   @param contact [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo] Contact information for brand KYC
+      #
+      #   @param business [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo, nil] Business details and address for brand KYC
+    end
+  end
+end

data/lib/sentdm/models/contact_delete_params.rb

@@ -3,7 +3,7 @@
 module Sentdm
   module Models
     # @see Sentdm::Resources::Contacts#delete
-    class ContactDeleteParams < Sentdm::Internal::Type::BaseModel
+    class ContactDeleteParams < Sentdm::Models::MutationRequest
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
@@ -12,28 +12,14 @@ module Sentdm
       #   @return [String]
       required :id, String
 
-      # @!attribute sandbox
-      #   Sandbox flag - when true, the operation is simulated without side effects Useful
-      #   for testing integrations without actual execution
-      #
-      #   @return [Boolean, nil]
-      optional :sandbox, Sentdm::Internal::Type::Boolean
-
       # @!attribute x_profile_id
       #
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(id:, sandbox: nil, x_profile_id: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::ContactDeleteParams} for more details.
-      #
+      # @!method initialize(id:, x_profile_id: nil, request_options: {})
       #   @param id [String]
-      #
-      #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
-      #
       #   @param x_profile_id [String]
-      #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
     end
   end