sentdm 0.35.0 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb2a3192ac350b8b789c39c41c5c98b4dcd1df0b714d0d3f0540e88205a0b57d
-  data.tar.gz: 5d97dab3605f998f583ea137599413f498de456598e57d257591df8afb173e14
+  metadata.gz: f1d07878fe77b406e3665345f7f6d2c733edfd36e5d9885919ca6a480bd448d4
+  data.tar.gz: a71ce847b04363a6718b2d5bcd04e99502518d77d9eaa7b07ecc7fcc44b735d9
 SHA512:
-  metadata.gz: 65df0bbbe671b490469b171d4b241b1d4fc5d088b271390c3a727227f046fddb138c61be3bee853f2a8b26a8e910aae0a41c0f0b46ef01ffedee44e5fc1002b6
-  data.tar.gz: 0fc42b03c73246deaf5cb6711e0431a4469b6eb172c6d1a3cf2a8d7f63621aa4cda7708d7054d61afa042d571d07377b9e1b94437cc2e65aed7099a16eadd77c
+  metadata.gz: e510f27198098e2f73c9d0d1eb86578b395a2222cb1e291631fa7d18682b0d334b6827165df73440e06667e876d53d2675aeee460753d4006c2e162fcb6294da
+  data.tar.gz: d9239a9ef793bae4801adc25f099db5dfa77a1c65bc4798e01b41521cbc482e506a0ec8c573a9933da38d0af981a8056442f9bc2264c7c7f60c75115a77d7633

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [0.36.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.35.0...v0.36.0) (2026-10-06)
+
+
+### Features
+
+* **api:** sync generated SDKs from the committed spec ([fc29692](https://github.com/sentdm/sent-dm-ruby/commit/fc29692de765a72b716a46c4920c603e2b617a95))
+* **api:** sync OpenAPI spec from production ([989362a](https://github.com/sentdm/sent-dm-ruby/commit/989362a3142f3d926e68793f163d21e85d3cf346))
+
 ## [0.35.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.34.0...v0.35.0) (2026-10-01)
 
 

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "sentdm", "~> 0.35.0"
+gem "sentdm", "~> 0.36.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/sentdm/client.rb

@@ -89,6 +89,11 @@ module Sentdm
     # the send pipeline. It is a new attempt, not a free retry: every policy runs
     # again, the message is billed again, and its status webhooks fire again. A
     # FILTERED message is never resendable.
+    #
+    # **A scheduled message can be called off.** `POST /v3/messages/{id}/cancel`
+    # cancels a send you scheduled with `scheduled_at`, as long as it has not been
+    # released yet. Cancelling is free, fires `message.cancelled`, and is final — a
+    # cancelled message cannot be resent.
     # @return [Sentdm::Resources::Messages]
     attr_reader :messages
 

data/lib/sentdm/models/call.rb

@@ -39,8 +39,9 @@ module Sentdm
 
       # @!attribute failure_reason
       #   Why the call did not complete: callback_timeout, invalid_answer,
-      #   insufficient_balance, destination_blocked, rejected or no_answer. Null while the
-      #   call is live, when it completed, and when it failed without a recorded reason
+      #   insufficient_balance, destination_blocked, callback_not_configured, rejected or
+      #   no_answer. Null while the call is live, when it completed, and when it failed
+      #   without a recorded reason
       #
       #   @return [String, nil]
       optional :failure_reason, String, nil?: true
@@ -77,7 +78,7 @@ module Sentdm
       optional :started_at, Time
 
       # @!attribute status
-      #   initiated, ringing, answered, completed, failed, no_answer or rejected
+      #   INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED
       #
       #   @return [String, nil]
       optional :status, String
@@ -123,7 +124,7 @@ module Sentdm
       #
       #   @param started_at [Time] When the call was placed (UTC)
       #
-      #   @param status [String] initiated, ringing, answered, completed, failed, no_answer or rejected
+      #   @param status [String] INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED
       #
       #   @param timeline [Array<Sentdm::Models::CallTimelineEntry>, nil] When the call entered each status, oldest first. Only returned when reading one
       #

data/lib/sentdm/models/call_timeline_entry.rb

@@ -4,7 +4,7 @@ module Sentdm
   module Models
     class CallTimelineEntry < Sentdm::Internal::Type::BaseModel
       # @!attribute status
-      #   initiated, ringing, answered, completed, failed, no_answer or rejected
+      #   INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED
       #
       #   @return [String, nil]
       optional :status, String
@@ -18,7 +18,7 @@ module Sentdm
       # @!method initialize(status: nil, timestamp: nil)
       #   When a call entered a status
       #
-      #   @param status [String] initiated, ringing, answered, completed, failed, no_answer or rejected
+      #   @param status [String] INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED
       #
       #   @param timestamp [Time] When the call entered this status (UTC)
     end

data/lib/sentdm/models/message_event_payload.rb

@@ -72,14 +72,19 @@ module Sentdm
       # @!attribute schedule_reason
       #   message.scheduled only: why the message is held, either because you scheduled it
       #   or because the recipient is inside a protected quiet-hours window. Omitted on
-      #   every other event.
+      #   every other event, including message.cancelled — that is a property of the hold,
+      #   not of the cancellation, and repeating it there would read as "why was this
+      #   cancelled", which it does not answer.
       #
       #   @return [String, nil]
       optional :schedule_reason, String, nil?: true
 
       # @!attribute scheduled_at
-      #   message.scheduled only: when the held message will be released for delivery, in
-      #   UTC (yyyy-MM-ddTHH:mm:ssZ). Omitted on every other event.
+      #   message.scheduled and message.cancelled only, in UTC (yyyy-MM-ddTHH:mm:ssZ): on
+      #   message.scheduled it is when the held message will be released for delivery, on
+      #   message.cancelled the release instant that was called off — the same instant,
+      #   before and after. A consumer that recorded a future send from the first event
+      #   has what it needs to un-record it from the second. Omitted on every other event.
       #
       #   @return [String, nil]
       optional :scheduled_at, String, nil?: true
@@ -131,7 +136,7 @@ module Sentdm
       #
       #   @param schedule_reason [String, nil] message.scheduled only: why the message is held, either because you scheduled it
       #
-      #   @param scheduled_at [String, nil] message.scheduled only: when the held message will be released for delivery, in
+      #   @param scheduled_at [String, nil] message.scheduled and message.cancelled only, in UTC (yyyy-MM-ddTHH:mm:ssZ): on
       #
       #   @param template_id [String, nil] The template the message was sent from, when it was sent from one.
       #

data/lib/sentdm/models/message_retrieve_activities_response.rb

@@ -116,10 +116,12 @@ module Sentdm
           optional :reason_code, String, nil?: true
 
           # @!attribute scheduled_at
-          #   SCHEDULED activities only: when the held message will be released for delivery,
-          #   in UTC. Same wire name as on the send response, the message and the webhook.
-          #   Omitted on every other activity. A message that quiet hours moved at release has
-          #   two SCHEDULED entries, each carrying the instant as it stood at that moment.
+          #   SCHEDULED and CANCELLED activities only, in UTC: on a SCHEDULED entry, when the
+          #   held message will be released for delivery; on a CANCELLED entry, the instant
+          #   that was called off. Same wire name as on the send response, the message and the
+          #   webhook. Omitted on every other activity. A message that quiet hours moved at
+          #   release has two SCHEDULED entries, each carrying the instant as it stood at that
+          #   moment.
           #
           #   @return [Time, nil]
           optional :scheduled_at, Time, nil?: true
@@ -161,7 +163,7 @@ module Sentdm
           #   @param reason_code [String, nil] Why the message reached this status, as a stable platform code such as
           #   DELIVERY\_
           #
-          #   @param scheduled_at [Time, nil] SCHEDULED activities only: when the held message will be released for delivery,
+          #   @param scheduled_at [Time, nil] SCHEDULED and CANCELLED activities only, in UTC: on a SCHEDULED entry, when the
           #
           #   @param status [String] Activity status. Outbound: QUEUED, PROCESSED, ROUTED, SCHEDULED, SENT, DELIVERED
           #

data/lib/sentdm/resources/calls/participants.rb

@@ -106,11 +106,11 @@ module Sentdm
         # conference room, and answers with the participant's own call record. The
         # participant is a call of their own: it has its own id, can be looked up and hung
         # up, and is billed and reported through call.completed and call.failed like any
-        # other call. A phone participant is called from caller_id, which must be one of
-        # your numbers, or from the call's owning number when omitted, and needs a
-        # destination you may call and a positive balance. Only a call your answer
-        # connected to a conference can take participants: a call connected to a user or a
-        # number answers 409.
+        # other call. Every participant needs a positive balance. A phone participant is
+        # called from caller_id, which must be one of your numbers, or from the call's
+        # owning number when omitted, and needs a destination you may call. Only a call
+        # your answer connected to a conference can take participants: a call connected to
+        # a user or a number answers 409.
         #
         # @overload add(id, caller_id: nil, sandbox: nil, to: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
         #

data/lib/sentdm/resources/calls.rb

@@ -118,10 +118,11 @@ module Sentdm
       # Some parameter documentations has been truncated, see
       # {Sentdm::Models::CallHangupParams} for more details.
       #
-      # Ends one of your live calls. The call then ends the way any other call does: its
-      # status moves to completed and call.completed is sent once the disconnect is
-      # reported. A call that has already ended answers 409, and so does a call with no
-      # phone leg, such as one between two app users.
+      # Ends one of your live calls. The call then ends the way any other call does once
+      # the disconnect is reported: an answered call as COMPLETED with call.completed, a
+      # call still ringing as NO_ANSWER, REJECTED or FAILED with call.failed. A call
+      # that has already ended answers 409, and so does a call with no phone leg, such
+      # as one between two app users.
       #
       # @overload hangup(id, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #

data/lib/sentdm/resources/messages.rb

@@ -19,6 +19,11 @@ module Sentdm
     # the send pipeline. It is a new attempt, not a free retry: every policy runs
     # again, the message is billed again, and its status webhooks fire again. A
     # FILTERED message is never resendable.
+    #
+    # **A scheduled message can be called off.** `POST /v3/messages/{id}/cancel`
+    # cancels a send you scheduled with `scheduled_at`, as long as it has not been
+    # released yet. Cancelling is free, fires `message.cancelled`, and is final — a
+    # cancelled message cannot be resent.
     class Messages
       # Some parameter documentations has been truncated, see
       # {Sentdm::Models::MessageRetrieveActivitiesParams} for more details.
@@ -55,10 +60,11 @@ module Sentdm
       #
       # Retrieves the current status and details of a message by ID. Includes delivery
       # status, timestamps, and error information if applicable. A message that is or
-      # was held for a later time (a send you scheduled with scheduled_at, or a
-      # quiet-hours hold) is returned as a ScheduledMessageResponse: the same fields
-      # plus scheduled_at, the release instant in UTC. A message sent immediately has no
-      # scheduled_at key.
+      # was held for a later time (a send you scheduled with scheduled_at, a quiet-hours
+      # hold, or a message you cancelled while it was held) is returned as a
+      # ScheduledMessageResponse: the same fields plus scheduled_at, the instant it is
+      # held for in UTC — or, on a CANCELLED message, the instant that was called off. A
+      # message sent immediately has no scheduled_at key.
       #
       # @overload retrieve_status(id, x_profile_id: nil, request_options: {})
       #

data/lib/sentdm/version.rb

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

data/rbi/sentdm/client.rbi

@@ -84,6 +84,11 @@ module Sentdm
     # the send pipeline. It is a new attempt, not a free retry: every policy runs
     # again, the message is billed again, and its status webhooks fire again. A
     # FILTERED message is never resendable.
+    #
+    # **A scheduled message can be called off.** `POST /v3/messages/{id}/cancel`
+    # cancels a send you scheduled with `scheduled_at`, as long as it has not been
+    # released yet. Cancelling is free, fires `message.cancelled`, and is final — a
+    # cancelled message cannot be resent.
     sig { returns(Sentdm::Resources::Messages) }
     attr_reader :messages
 

data/rbi/sentdm/models/call.rbi

@@ -35,8 +35,9 @@ module Sentdm
       attr_accessor :ended_at
 
       # Why the call did not complete: callback_timeout, invalid_answer,
-      # insufficient_balance, destination_blocked, rejected or no_answer. Null while the
-      # call is live, when it completed, and when it failed without a recorded reason
+      # insufficient_balance, destination_blocked, callback_not_configured, rejected or
+      # no_answer. Null while the call is live, when it completed, and when it failed
+      # without a recorded reason
       sig { returns(T.nilable(String)) }
       attr_accessor :failure_reason
 
@@ -73,7 +74,7 @@ module Sentdm
       sig { params(started_at: Time).void }
       attr_writer :started_at
 
-      # initiated, ringing, answered, completed, failed, no_answer or rejected
+      # INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED
       sig { returns(T.nilable(String)) }
       attr_reader :status
 
@@ -126,8 +127,9 @@ module Sentdm
         # When the call ended (UTC). Null while the call is live
         ended_at: nil,
         # Why the call did not complete: callback_timeout, invalid_answer,
-        # insufficient_balance, destination_blocked, rejected or no_answer. Null while the
-        # call is live, when it completed, and when it failed without a recorded reason
+        # insufficient_balance, destination_blocked, callback_not_configured, rejected or
+        # no_answer. Null while the call is live, when it completed, and when it failed
+        # without a recorded reason
         failure_reason: nil,
         # One end of a call
         from: nil,
@@ -140,7 +142,7 @@ module Sentdm
         recording_available: nil,
         # When the call was placed (UTC)
         started_at: nil,
-        # initiated, ringing, answered, completed, failed, no_answer or rejected
+        # INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED
         status: nil,
         # When the call entered each status, oldest first. Only returned when reading one
         # call

data/rbi/sentdm/models/call_timeline_entry.rbi

@@ -8,7 +8,7 @@ module Sentdm
           T.any(Sentdm::CallTimelineEntry, Sentdm::Internal::AnyHash)
         end
 
-      # initiated, ringing, answered, completed, failed, no_answer or rejected
+      # INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED
       sig { returns(T.nilable(String)) }
       attr_reader :status
 
@@ -25,7 +25,7 @@ module Sentdm
       # When a call entered a status
       sig { params(status: String, timestamp: Time).returns(T.attached_class) }
       def self.new(
-        # initiated, ringing, answered, completed, failed, no_answer or rejected
+        # INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED
         status: nil,
         # When the call entered this status (UTC)
         timestamp: nil

data/rbi/sentdm/models/message_event_payload.rbi

@@ -70,12 +70,17 @@ module Sentdm
 
       # message.scheduled only: why the message is held, either because you scheduled it
       # or because the recipient is inside a protected quiet-hours window. Omitted on
-      # every other event.
+      # every other event, including message.cancelled — that is a property of the hold,
+      # not of the cancellation, and repeating it there would read as "why was this
+      # cancelled", which it does not answer.
       sig { returns(T.nilable(String)) }
       attr_accessor :schedule_reason
 
-      # message.scheduled only: when the held message will be released for delivery, in
-      # UTC (yyyy-MM-ddTHH:mm:ssZ). Omitted on every other event.
+      # message.scheduled and message.cancelled only, in UTC (yyyy-MM-ddTHH:mm:ssZ): on
+      # message.scheduled it is when the held message will be released for delivery, on
+      # message.cancelled the release instant that was called off — the same instant,
+      # before and after. A consumer that recorded a future send from the first event
+      # has what it needs to un-record it from the second. Omitted on every other event.
       sig { returns(T.nilable(String)) }
       attr_accessor :scheduled_at
 
@@ -149,10 +154,15 @@ module Sentdm
         reason_code: nil,
         # message.scheduled only: why the message is held, either because you scheduled it
         # or because the recipient is inside a protected quiet-hours window. Omitted on
-        # every other event.
+        # every other event, including message.cancelled — that is a property of the hold,
+        # not of the cancellation, and repeating it there would read as "why was this
+        # cancelled", which it does not answer.
         schedule_reason: nil,
-        # message.scheduled only: when the held message will be released for delivery, in
-        # UTC (yyyy-MM-ddTHH:mm:ssZ). Omitted on every other event.
+        # message.scheduled and message.cancelled only, in UTC (yyyy-MM-ddTHH:mm:ssZ): on
+        # message.scheduled it is when the held message will be released for delivery, on
+        # message.cancelled the release instant that was called off — the same instant,
+        # before and after. A consumer that recorded a future send from the first event
+        # has what it needs to un-record it from the second. Omitted on every other event.
         scheduled_at: nil,
         # The template the message was sent from, when it was sent from one.
         template_id: nil,

data/rbi/sentdm/models/message_retrieve_activities_response.rbi

@@ -216,10 +216,12 @@ module Sentdm
           sig { returns(T.nilable(String)) }
           attr_accessor :reason_code
 
-          # SCHEDULED activities only: when the held message will be released for delivery,
-          # in UTC. Same wire name as on the send response, the message and the webhook.
-          # Omitted on every other activity. A message that quiet hours moved at release has
-          # two SCHEDULED entries, each carrying the instant as it stood at that moment.
+          # SCHEDULED and CANCELLED activities only, in UTC: on a SCHEDULED entry, when the
+          # held message will be released for delivery; on a CANCELLED entry, the instant
+          # that was called off. Same wire name as on the send response, the message and the
+          # webhook. Omitted on every other activity. A message that quiet hours moved at
+          # release has two SCHEDULED entries, each carrying the instant as it stood at that
+          # moment.
           sig { returns(T.nilable(Time)) }
           attr_accessor :scheduled_at
 
@@ -278,10 +280,12 @@ module Sentdm
             # rather than on reason: the code is stable, the wording may be improved. Same
             # wire name and vocabulary as on the message and the webhook.
             reason_code: nil,
-            # SCHEDULED activities only: when the held message will be released for delivery,
-            # in UTC. Same wire name as on the send response, the message and the webhook.
-            # Omitted on every other activity. A message that quiet hours moved at release has
-            # two SCHEDULED entries, each carrying the instant as it stood at that moment.
+            # SCHEDULED and CANCELLED activities only, in UTC: on a SCHEDULED entry, when the
+            # held message will be released for delivery; on a CANCELLED entry, the instant
+            # that was called off. Same wire name as on the send response, the message and the
+            # webhook. Omitted on every other activity. A message that quiet hours moved at
+            # release has two SCHEDULED entries, each carrying the instant as it stood at that
+            # moment.
             scheduled_at: nil,
             # Activity status. Outbound: QUEUED, PROCESSED, ROUTED, SCHEDULED, SENT,
             # DELIVERED, READ, FAILED. Inbound (from contact): RECEIVED (terminal).

data/rbi/sentdm/resources/calls/participants.rbi

@@ -90,11 +90,11 @@ module Sentdm
         # conference room, and answers with the participant's own call record. The
         # participant is a call of their own: it has its own id, can be looked up and hung
         # up, and is billed and reported through call.completed and call.failed like any
-        # other call. A phone participant is called from caller_id, which must be one of
-        # your numbers, or from the call's owning number when omitted, and needs a
-        # destination you may call and a positive balance. Only a call your answer
-        # connected to a conference can take participants: a call connected to a user or a
-        # number answers 409.
+        # other call. Every participant needs a positive balance. A phone participant is
+        # called from caller_id, which must be one of your numbers, or from the call's
+        # owning number when omitted, and needs a destination you may call. Only a call
+        # your answer connected to a conference can take participants: a call connected to
+        # a user or a number answers 409.
         sig do
           params(
             id: String,

data/rbi/sentdm/resources/calls.rbi

@@ -104,10 +104,11 @@ module Sentdm
       )
       end
 
-      # Ends one of your live calls. The call then ends the way any other call does: its
-      # status moves to completed and call.completed is sent once the disconnect is
-      # reported. A call that has already ended answers 409, and so does a call with no
-      # phone leg, such as one between two app users.
+      # Ends one of your live calls. The call then ends the way any other call does once
+      # the disconnect is reported: an answered call as COMPLETED with call.completed, a
+      # call still ringing as NO_ANSWER, REJECTED or FAILED with call.failed. A call
+      # that has already ended answers 409, and so does a call with no phone leg, such
+      # as one between two app users.
       sig do
         params(
           id: String,

data/rbi/sentdm/resources/messages.rbi

@@ -19,6 +19,11 @@ module Sentdm
     # the send pipeline. It is a new attempt, not a free retry: every policy runs
     # again, the message is billed again, and its status webhooks fire again. A
     # FILTERED message is never resendable.
+    #
+    # **A scheduled message can be called off.** `POST /v3/messages/{id}/cancel`
+    # cancels a send you scheduled with `scheduled_at`, as long as it has not been
+    # released yet. Cancelling is free, fires `message.cancelled`, and is final — a
+    # cancelled message cannot be resent.
     class Messages
       # Retrieves the activity log for a specific message. Activities track the message
       # lifecycle including acceptance, processing, sending, delivery, and any errors. A
@@ -43,10 +48,11 @@ module Sentdm
 
       # Retrieves the current status and details of a message by ID. Includes delivery
       # status, timestamps, and error information if applicable. A message that is or
-      # was held for a later time (a send you scheduled with scheduled_at, or a
-      # quiet-hours hold) is returned as a ScheduledMessageResponse: the same fields
-      # plus scheduled_at, the release instant in UTC. A message sent immediately has no
-      # scheduled_at key.
+      # was held for a later time (a send you scheduled with scheduled_at, a quiet-hours
+      # hold, or a message you cancelled while it was held) is returned as a
+      # ScheduledMessageResponse: the same fields plus scheduled_at, the instant it is
+      # held for in UTC — or, on a CANCELLED message, the instant that was called off. A
+      # message sent immediately has no scheduled_at key.
       sig do
         params(
           id: String,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentdm
 version: !ruby/object:Gem::Version
-  version: 0.35.0
+  version: 0.36.0
 platform: ruby
 authors:
 - Sent
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-01 00:00:00.000000000 Z
+date: 2026-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi