sentdm 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6deb093a9f2c5d24bcdb01a4931610ac5a20888cd2a55cb2b6b716b11b6cd54a
-  data.tar.gz: 213dc9cedf353c9c1eafa2cd7463415ad1cdad1e8d9438fa037672eebfe48912
+  metadata.gz: 4d991654f4a9e02eb0875ca96e4721e3442dae7bbec0ff4078333628cca5f7a1
+  data.tar.gz: 4d57c9c5beaa57188637bf293742f4d1575a7b43b7f28f54ffc694b661fc3a92
 SHA512:
-  metadata.gz: 1d486ff5a4f521ad385c10fac04f27d1d55e94bc107b9639a3abae6ba9040d0b59b53f6a9e938198ab311df84c553ed0cf0721b2f832075a0dcc08a4df77b8f8
-  data.tar.gz: dc5717d0ef6304ad6ce20564f5317a046f8c25274519fdb63d656abb2c736e87e5ce7539306aaa98a7e14fa2fa7486f2c3259d9514c226f17a475cf58fa3d8c9
+  metadata.gz: 95f4ddee5e276312271679177dcc209b42ce6c0270dacdf01f6eb5c6bf422b960f6df824e5dd313e67f176ab07a7612b05795ed4641dc3217f87916a931d8b53
+  data.tar.gz: 1d074dc2fd83b3cc8f9fe0e7c6f355248b3926d752d930482e3121174a401f720973c627ad0242d92c6ae6435695b799dc22726335cebc8c10ae8eadec2e8601

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.15.0 (2026-04-21)
+
+Full Changelog: [v0.14.0...v0.15.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.14.0...v0.15.0)
+
+### Features
+
+* **api:** api update ([766fd2a](https://github.com/sentdm/sent-dm-ruby/commit/766fd2ab76879a691e35141696b5ea2d2acbb3fc))
+
 ## 0.14.0 (2026-04-20)
 
 Full Changelog: [v0.13.1...v0.14.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.13.1...v0.14.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.14.0"
+gem "sentdm", "~> 0.15.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/sentdm/models/contact_response.rb

@@ -15,6 +15,15 @@ module Sentdm
       #   @return [String, nil]
       optional :available_channels, String
 
+      # @!attribute channel_consent
+      #   Consent status by channel. Keys: "sms", "whatsapp". Values: "opted_in",
+      #   "opted_out". All channels will have the same status because consent is global
+      #   across channels. A STOP on any channel opts out of all channels; a START opts in
+      #   to all.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :channel_consent, Sentdm::Internal::Type::HashOf[String], nil?: true
+
       # @!attribute country_code
       #   Country calling code (e.g., 1 for US/Canada)
       #
@@ -87,13 +96,18 @@ module Sentdm
       #   @return [Time, nil]
       optional :updated_at, Time, nil?: true
 
-      # @!method initialize(id: nil, available_channels: nil, country_code: nil, created_at: nil, default_channel: nil, format_e164: nil, format_international: nil, format_national: nil, format_rfc: nil, is_inherited: nil, opt_out: nil, phone_number: nil, region_code: nil, updated_at: nil)
+      # @!method initialize(id: nil, available_channels: nil, channel_consent: nil, country_code: nil, created_at: nil, default_channel: nil, format_e164: nil, format_international: nil, format_national: nil, format_rfc: nil, is_inherited: nil, opt_out: nil, phone_number: nil, region_code: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::ContactResponse} for more details.
+      #
       #   Contact response for v3 API Uses snake_case for JSON property names
       #
       #   @param id [String] Unique identifier for the contact
       #
       #   @param available_channels [String] Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
       #
+      #   @param channel_consent [Hash{Symbol=>String}, nil] Consent status by channel. Keys: "sms", "whatsapp". Values: "opted_in", "opted_o
+      #
       #   @param country_code [String] Country calling code (e.g., 1 for US/Canada)
       #
       #   @param created_at [Time] When the contact was created

data/lib/sentdm/models/contact_update_params.rb

@@ -12,6 +12,17 @@ module Sentdm
       #   @return [String]
       required :id, String
 
+      # @!attribute channel_consent
+      #   Consent status by channel. Keys: "sms", "whatsapp". Values: "opted_in",
+      #   "opted_out". All entries must have the same status — mixed values (e.g., sms:
+      #   opted_out + whatsapp: opted_in) are rejected with 400. The provided status is
+      #   applied to ALL channels regardless of which keys are specified, because consent
+      #   is global across channels. When provided, takes precedence over the opt_out
+      #   field.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :channel_consent, Sentdm::Internal::Type::HashOf[String], nil?: true
+
       # @!attribute default_channel
       #   Default messaging channel: "sms" or "whatsapp"
       #
@@ -41,12 +52,14 @@ module Sentdm
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(id:, default_channel: nil, opt_out: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+      # @!method initialize(id:, channel_consent: nil, default_channel: nil, opt_out: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::ContactUpdateParams} for more details.
       #
       #   @param id [String]
       #
+      #   @param channel_consent [Hash{Symbol=>String}, nil] Consent status by channel. Keys: "sms", "whatsapp". Values: "opted_in", "opted_o
+      #
       #   @param default_channel [String, nil] Default messaging channel: "sms" or "whatsapp"
       #
       #   @param opt_out [Boolean, nil] Whether the contact has opted out of messaging

data/lib/sentdm/models/message_retrieve_status_response.rb

@@ -71,6 +71,11 @@ module Sentdm
         #   @return [String, nil]
         optional :customer_id, String
 
+        # @!attribute direction
+        #
+        #   @return [String, nil]
+        optional :direction, String
+
         # @!attribute events
         #
         #   @return [Array<Sentdm::Models::MessageRetrieveStatusResponse::Data::Event>, nil]
@@ -115,7 +120,7 @@ module Sentdm
         # @!attribute template_category
         #
         #   @return [String, nil]
-        optional :template_category, String
+        optional :template_category, String, nil?: true
 
         # @!attribute template_id
         #
@@ -125,9 +130,9 @@ module Sentdm
         # @!attribute template_name
         #
         #   @return [String, nil]
-        optional :template_name, String
+        optional :template_name, String, nil?: true
 
-        # @!method initialize(id: nil, active_contact_price: nil, channel: nil, contact_id: nil, created_at: nil, customer_id: nil, events: nil, message_body: nil, phone: nil, phone_international: nil, price: nil, region_code: nil, status: nil, template_category: nil, template_id: nil, template_name: nil)
+        # @!method initialize(id: nil, active_contact_price: nil, channel: nil, contact_id: nil, created_at: nil, customer_id: nil, direction: nil, events: nil, message_body: nil, phone: nil, phone_international: nil, price: nil, region_code: nil, status: nil, template_category: nil, template_id: nil, template_name: nil)
         #   Some parameter documentations has been truncated, see
         #   {Sentdm::Models::MessageRetrieveStatusResponse::Data} for more details.
         #
@@ -145,6 +150,8 @@ module Sentdm
         #
         #   @param customer_id [String]
         #
+        #   @param direction [String]
+        #
         #   @param events [Array<Sentdm::Models::MessageRetrieveStatusResponse::Data::Event>, nil]
         #
         #   @param message_body [Sentdm::Models::MessageRetrieveStatusResponse::Data::MessageBody, nil] Structured message body format for database storage.
@@ -159,11 +166,11 @@ module Sentdm
         #
         #   @param status [String]
         #
-        #   @param template_category [String]
+        #   @param template_category [String, nil]
         #
         #   @param template_id [String, nil]
         #
-        #   @param template_name [String]
+        #   @param template_name [String, nil]
 
         class Event < Sentdm::Internal::Type::BaseModel
           # @!attribute description

data/lib/sentdm/resources/contacts.rb

@@ -73,10 +73,12 @@ module Sentdm
       # Updates a contact's default channel and/or opt-out status. Inherited contacts
       # cannot be updated.
       #
-      # @overload update(id, default_channel: nil, opt_out: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+      # @overload update(id, channel_consent: nil, default_channel: nil, opt_out: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
       # @param id [String] Path param: Contact ID from route parameter
       #
+      # @param channel_consent [Hash{Symbol=>String}, nil] Body param: Consent status by channel. Keys: "sms", "whatsapp". Values: "opted_i
+      #
       # @param default_channel [String, nil] Body param: Default messaging channel: "sms" or "whatsapp"
       #
       # @param opt_out [Boolean, nil] Body param: Whether the contact has opted out of messaging

data/lib/sentdm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sentdm
-  VERSION = "0.14.0"
+  VERSION = "0.15.0"
 end

data/rbi/sentdm/models/contact_response.rbi

@@ -22,6 +22,13 @@ module Sentdm
       sig { params(available_channels: String).void }
       attr_writer :available_channels
 
+      # Consent status by channel. Keys: "sms", "whatsapp". Values: "opted_in",
+      # "opted_out". All channels will have the same status because consent is global
+      # across channels. A STOP on any channel opts out of all channels; a START opts in
+      # to all.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :channel_consent
+
       # Country calling code (e.g., 1 for US/Canada)
       sig { returns(T.nilable(String)) }
       attr_reader :country_code
@@ -108,6 +115,7 @@ module Sentdm
         params(
           id: String,
           available_channels: String,
+          channel_consent: T.nilable(T::Hash[Symbol, String]),
           country_code: String,
           created_at: Time,
           default_channel: String,
@@ -127,6 +135,11 @@ module Sentdm
         id: nil,
         # Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
         available_channels: nil,
+        # Consent status by channel. Keys: "sms", "whatsapp". Values: "opted_in",
+        # "opted_out". All channels will have the same status because consent is global
+        # across channels. A STOP on any channel opts out of all channels; a START opts in
+        # to all.
+        channel_consent: nil,
         # Country calling code (e.g., 1 for US/Canada)
         country_code: nil,
         # When the contact was created
@@ -159,6 +172,7 @@ module Sentdm
           {
             id: String,
             available_channels: String,
+            channel_consent: T.nilable(T::Hash[Symbol, String]),
             country_code: String,
             created_at: Time,
             default_channel: String,

data/rbi/sentdm/models/contact_update_params.rbi

@@ -14,6 +14,15 @@ module Sentdm
       sig { returns(String) }
       attr_accessor :id
 
+      # Consent status by channel. Keys: "sms", "whatsapp". Values: "opted_in",
+      # "opted_out". All entries must have the same status — mixed values (e.g., sms:
+      # opted_out + whatsapp: opted_in) are rejected with 400. The provided status is
+      # applied to ALL channels regardless of which keys are specified, because consent
+      # is global across channels. When provided, takes precedence over the opt_out
+      # field.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :channel_consent
+
       # Default messaging channel: "sms" or "whatsapp"
       sig { returns(T.nilable(String)) }
       attr_accessor :default_channel
@@ -45,6 +54,7 @@ module Sentdm
       sig do
         params(
           id: String,
+          channel_consent: T.nilable(T::Hash[Symbol, String]),
           default_channel: T.nilable(String),
           opt_out: T.nilable(T::Boolean),
           sandbox: T::Boolean,
@@ -55,6 +65,13 @@ module Sentdm
       end
       def self.new(
         id:,
+        # Consent status by channel. Keys: "sms", "whatsapp". Values: "opted_in",
+        # "opted_out". All entries must have the same status — mixed values (e.g., sms:
+        # opted_out + whatsapp: opted_in) are rejected with 400. The provided status is
+        # applied to ALL channels regardless of which keys are specified, because consent
+        # is global across channels. When provided, takes precedence over the opt_out
+        # field.
+        channel_consent: nil,
         # Default messaging channel: "sms" or "whatsapp"
         default_channel: nil,
         # Whether the contact has opted out of messaging
@@ -72,6 +89,7 @@ module Sentdm
         override.returns(
           {
             id: String,
+            channel_consent: T.nilable(T::Hash[Symbol, String]),
             default_channel: T.nilable(String),
             opt_out: T.nilable(T::Boolean),
             sandbox: T::Boolean,

data/rbi/sentdm/models/message_retrieve_status_response.rbi

@@ -128,6 +128,12 @@ module Sentdm
         sig { params(customer_id: String).void }
         attr_writer :customer_id
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :direction
+
+        sig { params(direction: String).void }
+        attr_writer :direction
+
         sig do
           returns(
             T.nilable(
@@ -188,19 +194,13 @@ module Sentdm
         attr_writer :status
 
         sig { returns(T.nilable(String)) }
-        attr_reader :template_category
-
-        sig { params(template_category: String).void }
-        attr_writer :template_category
+        attr_accessor :template_category
 
         sig { returns(T.nilable(String)) }
         attr_accessor :template_id
 
         sig { returns(T.nilable(String)) }
-        attr_reader :template_name
-
-        sig { params(template_name: String).void }
-        attr_writer :template_name
+        attr_accessor :template_name
 
         # Message response for v3 API — same shape as v2 with snake_case JSON conventions
         sig do
@@ -211,6 +211,7 @@ module Sentdm
             contact_id: String,
             created_at: Time,
             customer_id: String,
+            direction: String,
             events:
               T.nilable(
                 T::Array[
@@ -226,9 +227,9 @@ module Sentdm
             price: T.nilable(Float),
             region_code: String,
             status: String,
-            template_category: String,
+            template_category: T.nilable(String),
             template_id: T.nilable(String),
-            template_name: String
+            template_name: T.nilable(String)
           ).returns(T.attached_class)
         end
         def self.new(
@@ -238,6 +239,7 @@ module Sentdm
           contact_id: nil,
           created_at: nil,
           customer_id: nil,
+          direction: nil,
           events: nil,
           # Structured message body format for database storage. Preserves channel-specific
           # components (header, body, footer, buttons).
@@ -262,6 +264,7 @@ module Sentdm
               contact_id: String,
               created_at: Time,
               customer_id: String,
+              direction: String,
               events:
                 T.nilable(
                   T::Array[
@@ -277,9 +280,9 @@ module Sentdm
               price: T.nilable(Float),
               region_code: String,
               status: String,
-              template_category: String,
+              template_category: T.nilable(String),
               template_id: T.nilable(String),
-              template_name: String
+              template_name: T.nilable(String)
             }
           )
         end

data/rbi/sentdm/resources/contacts.rbi

@@ -58,6 +58,7 @@ module Sentdm
       sig do
         params(
           id: String,
+          channel_consent: T.nilable(T::Hash[Symbol, String]),
           default_channel: T.nilable(String),
           opt_out: T.nilable(T::Boolean),
           sandbox: T::Boolean,
@@ -69,6 +70,13 @@ module Sentdm
       def update(
         # Path param: Contact ID from route parameter
         id,
+        # Body param: Consent status by channel. Keys: "sms", "whatsapp". Values:
+        # "opted_in", "opted_out". All entries must have the same status — mixed values
+        # (e.g., sms: opted_out + whatsapp: opted_in) are rejected with 400. The provided
+        # status is applied to ALL channels regardless of which keys are specified,
+        # because consent is global across channels. When provided, takes precedence over
+        # the opt_out field.
+        channel_consent: nil,
         # Body param: Default messaging channel: "sms" or "whatsapp"
         default_channel: nil,
         # Body param: Whether the contact has opted out of messaging

data/sig/sentdm/models/contact_response.rbs

@@ -4,6 +4,7 @@ module Sentdm
       {
         id: String,
         available_channels: String,
+        channel_consent: ::Hash[Symbol, String]?,
         country_code: String,
         created_at: Time,
         default_channel: String,
@@ -27,6 +28,8 @@ module Sentdm
 
       def available_channels=: (String) -> String
 
+      attr_accessor channel_consent: ::Hash[Symbol, String]?
+
       attr_reader country_code: String?
 
       def country_code=: (String) -> String
@@ -76,6 +79,7 @@ module Sentdm
       def initialize: (
         ?id: String,
         ?available_channels: String,
+        ?channel_consent: ::Hash[Symbol, String]?,
         ?country_code: String,
         ?created_at: Time,
         ?default_channel: String,
@@ -93,6 +97,7 @@ module Sentdm
       def to_hash: -> {
         id: String,
         available_channels: String,
+        channel_consent: ::Hash[Symbol, String]?,
         country_code: String,
         created_at: Time,
         default_channel: String,

data/sig/sentdm/models/contact_update_params.rbs

@@ -3,6 +3,7 @@ module Sentdm
     type contact_update_params =
       {
         id: String,
+        channel_consent: ::Hash[Symbol, String]?,
         default_channel: String?,
         opt_out: bool?,
         sandbox: bool,
@@ -17,6 +18,8 @@ module Sentdm
 
       attr_accessor id: String
 
+      attr_accessor channel_consent: ::Hash[Symbol, String]?
+
       attr_accessor default_channel: String?
 
       attr_accessor opt_out: bool?
@@ -35,6 +38,7 @@ module Sentdm
 
       def initialize: (
         id: String,
+        ?channel_consent: ::Hash[Symbol, String]?,
         ?default_channel: String?,
         ?opt_out: bool?,
         ?sandbox: bool,
@@ -45,6 +49,7 @@ module Sentdm
 
       def to_hash: -> {
         id: String,
+        channel_consent: ::Hash[Symbol, String]?,
         default_channel: String?,
         opt_out: bool?,
         sandbox: bool,

data/sig/sentdm/models/message_retrieve_status_response.rbs

@@ -43,6 +43,7 @@ module Sentdm
           contact_id: String,
           created_at: Time,
           customer_id: String,
+          direction: String,
           events: ::Array[Sentdm::Models::MessageRetrieveStatusResponse::Data::Event]?,
           message_body: Sentdm::Models::MessageRetrieveStatusResponse::Data::MessageBody?,
           phone: String,
@@ -50,9 +51,9 @@ module Sentdm
           price: Float?,
           region_code: String,
           status: String,
-          template_category: String,
+          template_category: String?,
           template_id: String?,
-          template_name: String
+          template_name: String?
         }
 
       class Data < Sentdm::Internal::Type::BaseModel
@@ -78,6 +79,10 @@ module Sentdm
 
         def customer_id=: (String) -> String
 
+        attr_reader direction: String?
+
+        def direction=: (String) -> String
+
         attr_accessor events: ::Array[Sentdm::Models::MessageRetrieveStatusResponse::Data::Event]?
 
         attr_accessor message_body: Sentdm::Models::MessageRetrieveStatusResponse::Data::MessageBody?
@@ -100,15 +105,11 @@ module Sentdm
 
         def status=: (String) -> String
 
-        attr_reader template_category: String?
-
-        def template_category=: (String) -> String
+        attr_accessor template_category: String?
 
         attr_accessor template_id: String?
 
-        attr_reader template_name: String?
-
-        def template_name=: (String) -> String
+        attr_accessor template_name: String?
 
         def initialize: (
           ?id: String,
@@ -117,6 +118,7 @@ module Sentdm
           ?contact_id: String,
           ?created_at: Time,
           ?customer_id: String,
+          ?direction: String,
           ?events: ::Array[Sentdm::Models::MessageRetrieveStatusResponse::Data::Event]?,
           ?message_body: Sentdm::Models::MessageRetrieveStatusResponse::Data::MessageBody?,
           ?phone: String,
@@ -124,9 +126,9 @@ module Sentdm
           ?price: Float?,
           ?region_code: String,
           ?status: String,
-          ?template_category: String,
+          ?template_category: String?,
           ?template_id: String?,
-          ?template_name: String
+          ?template_name: String?
         ) -> void
 
         def to_hash: -> {
@@ -136,6 +138,7 @@ module Sentdm
           contact_id: String,
           created_at: Time,
           customer_id: String,
+          direction: String,
           events: ::Array[Sentdm::Models::MessageRetrieveStatusResponse::Data::Event]?,
           message_body: Sentdm::Models::MessageRetrieveStatusResponse::Data::MessageBody?,
           phone: String,
@@ -143,9 +146,9 @@ module Sentdm
           price: Float?,
           region_code: String,
           status: String,
-          template_category: String,
+          template_category: String?,
           template_id: String?,
-          template_name: String
+          template_name: String?
         }
 
         type event = { description: String?, status: String, timestamp: Time }

data/sig/sentdm/resources/contacts.rbs

@@ -17,6 +17,7 @@ module Sentdm
 
       def update: (
         String id,
+        ?channel_consent: ::Hash[Symbol, String]?,
         ?default_channel: String?,
         ?opt_out: bool?,
         ?sandbox: bool,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentdm
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Sent
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-20 00:00:00.000000000 Z
+date: 2026-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi