sentdm 0.34.0 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b4444164d11b8913195b89a66ba9d140e5edaca680199f80156774e39f3f893
-  data.tar.gz: 38b18a67c9dc58ed79f990686d0363fbab3138b66c9a2e3b20eb76ba0d4d4988
+  metadata.gz: f1d07878fe77b406e3665345f7f6d2c733edfd36e5d9885919ca6a480bd448d4
+  data.tar.gz: a71ce847b04363a6718b2d5bcd04e99502518d77d9eaa7b07ecc7fcc44b735d9
 SHA512:
-  metadata.gz: bd38b5407cb704af0bf1cfecccb4f4bdcc2b5b173ac638d7c3f4c8e5a6039a019637d46114d6c082ebc420f7ad3532cfd128493f56d7bff51c62abc62cf34461
-  data.tar.gz: 3a79e6d405c70edc8e4479f28dc4955c0e0a3fbfaa59da458848c831e99650d90e87c672316609514fb9d5bd4d2b61d194d3f54a31d6c7ecac9340b12117e887
+  metadata.gz: e510f27198098e2f73c9d0d1eb86578b395a2222cb1e291631fa7d18682b0d334b6827165df73440e06667e876d53d2675aeee460753d4006c2e162fcb6294da
+  data.tar.gz: d9239a9ef793bae4801adc25f099db5dfa77a1c65bc4798e01b41521cbc482e506a0ec8c573a9933da38d0af981a8056442f9bc2264c7c7f60c75115a77d7633

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # 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)
+
+
+### Features
+
+* **api:** add voice and calls endpoints to the SDKs ([53f68a7](https://github.com/sentdm/sent-dm-ruby/commit/53f68a7293095980d2674fd20bbcc6045883554d))
+* **api:** sync generated SDKs from the committed spec ([b6fbc5a](https://github.com/sentdm/sent-dm-ruby/commit/b6fbc5a4e562a8f0354c7e2a9c9a357d1207cb6b))
+
 ## [0.34.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.33.0...v0.34.0) (2026-09-30)
 
 

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.34.0"
+gem "sentdm", "~> 0.36.0"
 ```
 
 <!-- x-release-please-end -->
@@ -289,23 +289,25 @@ sent.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
-# :PRIVATE_PROFIT
-puts(Sentdm::BrandBusinessInfo::EntityType::PRIVATE_PROFIT)
+# :ACTIVE
+puts(Sentdm::Channels::VoiceUpdateParams::Status::ACTIVE)
 
-# Revealed type: `T.all(Sentdm::BrandBusinessInfo::EntityType, Symbol)`
-T.reveal_type(Sentdm::BrandBusinessInfo::EntityType::PRIVATE_PROFIT)
+# Revealed type: `T.all(Sentdm::Channels::VoiceUpdateParams::Status, Symbol)`
+T.reveal_type(Sentdm::Channels::VoiceUpdateParams::Status::ACTIVE)
 ```
 
 Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
 
 ```ruby
-Sentdm::BrandBusinessInfo.new(
-  entity_type: Sentdm::BrandBusinessInfo::EntityType::PRIVATE_PROFIT,
+# Using the enum constants preserves the tagged type information:
+sent.channels.voice.update(
+  status: Sentdm::Channels::VoiceUpdateParams::Status::ACTIVE,
   # …
 )
 
-Sentdm::BrandBusinessInfo.new(
-  entity_type: :PRIVATE_PROFIT,
+# Literal values are also permissible:
+sent.channels.voice.update(
+  status: :ACTIVE,
   # …
 )
 ```

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
 
@@ -115,6 +120,29 @@ module Sentdm
     # @return [Sentdm::Resources::Conversations]
     attr_reader :conversations
 
+    # Phone calls from the numbers you hold, driven by your own callback URL.
+    #
+    # `POST /v3/channels/voice` enables a number for calls, with the callback URL Sent
+    # asks what to do with each call on it, and `POST /v3/channels/voice/tokens` mints
+    # a short-lived token that lets a user of your app place and receive calls as that
+    # number. When a call arrives or a caller presses a key, a signed question is
+    # POSTed to the callback URL and the answer decides the call;
+    # `POST /v3/channels/voice/{number}/test` checks the URL answers the way we need
+    # before a real call reaches it, and
+    # `POST /v3/channels/voice/{number}/rotate-secret` replaces the signing secret.
+    # The call events themselves (`call.completed` and the rest) arrive through your
+    # webhooks.
+    #
+    # Every call is a record under `/v3/calls`: read it, list its recordings once one
+    # is ready, hang it up, start or stop recording, and add, mute or remove
+    # conference participants while it is live. A leg to a phone number runs for at
+    # most what your balance affords at the destination's rate.
+    # @return [Sentdm::Resources::Calls]
+    attr_reader :calls
+
+    # @return [Sentdm::Resources::Channels]
+    attr_reader :channels
+
     # Who the current key is.
     #
     # `GET /v3/me` answers with the account the key authenticates as, which is the
@@ -193,6 +221,8 @@ module Sentdm
       @messages = Sentdm::Resources::Messages.new(client: self)
       @contacts = Sentdm::Resources::Contacts.new(client: self)
       @conversations = Sentdm::Resources::Conversations.new(client: self)
+      @calls = Sentdm::Resources::Calls.new(client: self)
+      @channels = Sentdm::Resources::Channels.new(client: self)
       @me = Sentdm::Resources::Me.new(client: self)
     end
   end

data/lib/sentdm/internal/calls_page.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   if calls_page.has_next?
+    #     calls_page = calls_page.next_page
+    #   end
+    #
+    # @example
+    #   calls_page.auto_paging_each do |call|
+    #     puts(call)
+    #   end
+    class CallsPage
+      include Sentdm::Internal::Type::BasePage
+
+      # @return [Data]
+      attr_accessor :data
+
+      # @return [Boolean]
+      def next_page?
+        data&.pagination&.has_more
+      end
+
+      # @raise [Sentdm::HTTP::Error]
+      # @return [self]
+      def next_page
+        unless next_page?
+          message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+          raise RuntimeError.new(message)
+        end
+
+        req = Sentdm::Internal::Util.deep_merge(
+          @req,
+          {query: {page: @req.fetch(:query).fetch(:page, 1).to_i.succ}}
+        )
+        @client.request(req)
+      end
+
+      # @param blk [Proc]
+      #
+      # @yieldparam [generic<Elem>]
+      def auto_paging_each(&blk)
+        unless block_given?
+          raise ArgumentError.new("A block must be given to ##{__method__}")
+        end
+
+        page = self
+        loop do
+          page.data&.calls&.each(&blk)
+
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @api private
+      #
+      # @param client [Sentdm::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+
+        case page_data
+        in {data: Hash | nil => data}
+          if (calls = data[:calls]).is_a?(Array)
+            data = {**data, calls: calls.map { Sentdm::Internal::Type::Converter.coerce(@model, _1) }}
+          end
+          @data = Sentdm::Internal::Type::Converter.coerce(Sentdm::Internal::CallsPage::Data, data)
+        else
+        end
+      end
+
+      # @api private
+      #
+      # @return [String]
+      def inspect
+        model = Sentdm::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)}>"
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        # @!attribute calls
+        #
+        #   @return [Array<Object>, nil]
+        optional :calls, Sentdm::Internal::Type::ArrayOf[Sentdm::Internal::Type::Unknown]
+
+        # @!attribute pagination
+        #
+        #   @return [Data::Pagination, nil]
+        optional :pagination, -> { Data::Pagination }
+
+        # @!method initialize(calls: nil, pagination: nil)
+        #   @param calls [Array<Object>]
+        #   @param pagination [Data::Pagination]
+
+        # @see Data#pagination
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          # @!attribute has_more
+          #
+          #   @return [Boolean, nil]
+          optional :has_more, Sentdm::Internal::Type::Boolean
+
+          # @!method initialize(has_more: nil)
+          #   @param has_more [Boolean]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/api_response_of_call.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Calls#retrieve
+    class APIResponseOfCall < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   A call record
+      #
+      #   @return [Sentdm::Models::Call, nil]
+      optional :data, -> { Sentdm::Call }, 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::Call, nil] A call record
+      #
+      #   @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_call_recordings.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Calls#list_recordings
+    class APIResponseOfCallRecordings < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The recordings of a call, each as a short-lived download link
+      #
+      #   @return [Sentdm::Models::CallRecordings, nil]
+      optional :data, -> { Sentdm::CallRecordings }, 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::CallRecordings, nil] The recordings of a call, each as a short-lived download link
+      #
+      #   @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_calls_list.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class APIResponseOfCallsList < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   Paginated list of calls
+      #
+      #   @return [Sentdm::Models::CallsList, nil]
+      optional :data, -> { Sentdm::CallsList }, 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::CallsList, nil] Paginated list of calls
+      #
+      #   @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/call.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Calls#list
+    class Call < Sentdm::Internal::Type::BaseModel
+      # @!attribute id
+      #   The call id, the same one carried by the call.request question and every call
+      #   webhook
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute answered_at
+      #   When the call was answered (UTC). Null until then, and always null for a call
+      #   between two of your app users
+      #
+      #   @return [Time, nil]
+      optional :answered_at, Time, nil?: true
+
+      # @!attribute direction
+      #   outbound for a call placed from your app, inbound for a call to one of your
+      #   numbers
+      #
+      #   @return [String, nil]
+      optional :direction, String
+
+      # @!attribute duration_seconds
+      #   Billable duration in seconds. Null while the call is live
+      #
+      #   @return [Integer, nil]
+      optional :duration_seconds, Integer, nil?: true
+
+      # @!attribute ended_at
+      #   When the call ended (UTC). Null while the call is live
+      #
+      #   @return [Time, nil]
+      optional :ended_at, Time, nil?: true
+
+      # @!attribute failure_reason
+      #   Why the call did not complete: callback_timeout, invalid_answer,
+      #   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
+
+      # @!attribute from
+      #   One end of a call
+      #
+      #   @return [Sentdm::Models::CallParty, nil]
+      optional :from, -> { Sentdm::CallParty }
+
+      # @!attribute number
+      #   Your number that owns the call, in E.164 format: the dialed number for an
+      #   inbound call, the caller's bound number for a call placed from your app
+      #
+      #   @return [String, nil]
+      optional :number, String
+
+      # @!attribute price
+      #   What the call cost. Null until it has been priced
+      #
+      #   @return [Float, nil]
+      optional :price, Float, nil?: true
+
+      # @!attribute recording_available
+      #   True once a recording of the call is available
+      #
+      #   @return [Boolean, nil]
+      optional :recording_available, Sentdm::Internal::Type::Boolean
+
+      # @!attribute started_at
+      #   When the call was placed (UTC)
+      #
+      #   @return [Time, nil]
+      optional :started_at, Time
+
+      # @!attribute status
+      #   INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute timeline
+      #   When the call entered each status, oldest first. Only returned when reading one
+      #   call
+      #
+      #   @return [Array<Sentdm::Models::CallTimelineEntry>, nil]
+      optional :timeline, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::CallTimelineEntry] }, nil?: true
+
+      # @!attribute to
+      #   One end of a call
+      #
+      #   @return [Sentdm::Models::CallParty, nil]
+      optional :to, -> { Sentdm::CallParty }
+
+      # @!method initialize(id: nil, answered_at: nil, direction: nil, duration_seconds: nil, ended_at: nil, failure_reason: nil, from: nil, number: nil, price: nil, recording_available: nil, started_at: nil, status: nil, timeline: nil, to: nil)
+      #   Some parameter documentations has been truncated, see {Sentdm::Models::Call} for
+      #   more details.
+      #
+      #   A call record
+      #
+      #   @param id [String] The call id, the same one carried by the call.request question and every call we
+      #
+      #   @param answered_at [Time, nil] When the call was answered (UTC). Null until then, and always null for a call be
+      #
+      #   @param direction [String] outbound for a call placed from your app, inbound for a call to one of your numb
+      #
+      #   @param duration_seconds [Integer, nil] Billable duration in seconds. Null while the call is live
+      #
+      #   @param ended_at [Time, nil] When the call ended (UTC). Null while the call is live
+      #
+      #   @param failure_reason [String, nil] Why the call did not complete: callback_timeout, invalid_answer, insufficient_ba
+      #
+      #   @param from [Sentdm::Models::CallParty] One end of a call
+      #
+      #   @param number [String] Your number that owns the call, in E.164 format: the dialed number for an inboun
+      #
+      #   @param price [Float, nil] What the call cost. Null until it has been priced
+      #
+      #   @param recording_available [Boolean] True once a recording of the call is available
+      #
+      #   @param started_at [Time] When the call was placed (UTC)
+      #
+      #   @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
+      #
+      #   @param to [Sentdm::Models::CallParty] One end of a call
+    end
+  end
+end

data/lib/sentdm/models/call_event.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class CallEvent < Sentdm::Internal::Type::BaseModel
+      # @!attribute event
+      #   The specific event within the family, for example message.delivered,
+      #   message.received or contact.opt_out. Absent on events that have no subtype, so
+      #   treat it as optional.
+      #
+      #   @return [String, nil]
+      optional :event, String, nil?: true
+
+      # @!attribute field
+      #   The event family, for example message, templates or contact. Route on this
+      #   first, then on event for the specific change.
+      #
+      #   @return [String, nil]
+      optional :field, String
+
+      # @!attribute payload
+      #   Body of a call.initiated, call.answered, call.completed, call.failed or
+      #   call.recording_ready event. Which of them occurred is the envelope's event.
+      #
+      #   Shaped like the message, inbound, template and channel payloads: account_id
+      #   names the account the event is about, channel names the channel, and updated_at
+      #   is when the change happened on the call, in the same yyyy-MM-ddTHH:mm:ssZ form.
+      #   duration_seconds and price are added on call.completed, reason on call.failed
+      #   and recording_id on call.recording_ready; each is omitted rather than sent as
+      #   null when it does not apply.
+      #
+      #   Casing is snake_case because these ride the same webhook stream customers
+      #   already parse message_id from; the question/answer contract is a separate
+      #   surface and stays camelCase. Nothing here is provider-shaped: no provider call
+      #   id, no namespaced identity.
+      #
+      #   @return [Sentdm::Models::CallEventPayload, nil]
+      optional :payload, -> { Sentdm::CallEventPayload }, nil?: true
+
+      # @!attribute request_id
+      #   The event-specific body.
+      #
+      #   @return [String, nil]
+      optional :request_id, String, nil?: true
+
+      # @!attribute timestamp
+      #   When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
+      #   time, not the time the underlying change happened. Use the timestamp inside the
+      #   payload for the latter.
+      #
+      #   @return [String, nil]
+      optional :timestamp, String
+
+      # @!method initialize(event: nil, field: nil, payload: nil, request_id: nil, timestamp: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::CallEvent} for more details.
+      #
+      #   The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
+      #   this shape and varies only in Payload.
+      #
+      #   @param event [String, nil] The specific event within the family, for example message.delivered,
+      #
+      #   @param field [String] The event family, for example message, templates or contact. Route on
+      #
+      #   @param payload [Sentdm::Models::CallEventPayload, nil] Body of a call.initiated, call.answered, call.completed, call.failed
+      #
+      #   @param request_id [String, nil] The event-specific body.
+      #
+      #   @param timestamp [String] When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
+    end
+  end
+end

data/lib/sentdm/models/call_event_payload.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class CallEventPayload < Sentdm::Internal::Type::BaseModel
+      # @!attribute call_id
+      #   Sent's call id, the same one the customer saw on the first question.
+      #
+      #   @return [String]
+      required :call_id, String
+
+      # @!attribute account_id
+      #   The account the call belongs to: the key's own customer, or the sender profile
+      #   it acted as.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute channel
+      #   Always voice.
+      #
+      #   @return [String, nil]
+      optional :channel, String
+
+      # @!attribute duration_seconds
+      #   How long the call lasted. Only on call.completed.
+      #
+      #   @return [Integer, nil]
+      optional :duration_seconds, Integer, nil?: true
+
+      # @!attribute number
+      #   The customer number that owns the call, in E.164 format.
+      #
+      #   @return [String, nil]
+      optional :number, String
+
+      # @!attribute price
+      #   What the call was charged. Only on call.completed, and omitted there until
+      #   billing has recorded the charge.
+      #
+      #   @return [Float, nil]
+      optional :price, Float, nil?: true
+
+      # @!attribute reason
+      #   The machine-readable reason the call did not complete. Only on call.failed, and
+      #   omitted when no reason was recorded.
+      #
+      #   @return [String, nil]
+      optional :reason, String, nil?: true
+
+      # @!attribute recording_id
+      #   The recording that became available, the same id GET /v3/calls/{id}/recordings
+      #   lists it under. Only on call.recording_ready, which is sent once per recording.
+      #
+      #   @return [String, nil]
+      optional :recording_id, String, nil?: true
+
+      # @!attribute updated_at
+      #   When the change happened on the call, as opposed to when the event was emitted.
+      #
+      #   @return [String, nil]
+      optional :updated_at, String
+
+      # @!method initialize(call_id:, account_id: nil, channel: nil, duration_seconds: nil, number: nil, price: nil, reason: nil, recording_id: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::CallEventPayload} for more details.
+      #
+      #   Body of a call.initiated, call.answered, call.completed, call.failed or
+      #   call.recording_ready event. Which of them occurred is the envelope's event.
+      #
+      #   Shaped like the message, inbound, template and channel payloads: account_id
+      #   names the account the event is about, channel names the channel, and updated_at
+      #   is when the change happened on the call, in the same yyyy-MM-ddTHH:mm:ssZ form.
+      #   duration_seconds and price are added on call.completed, reason on call.failed
+      #   and recording_id on call.recording_ready; each is omitted rather than sent as
+      #   null when it does not apply.
+      #
+      #   Casing is snake_case because these ride the same webhook stream customers
+      #   already parse message_id from; the question/answer contract is a separate
+      #   surface and stays camelCase. Nothing here is provider-shaped: no provider call
+      #   id, no namespaced identity.
+      #
+      #   @param call_id [String] Sent's call id, the same one the customer saw on the first question.
+      #
+      #   @param account_id [String] The account the call belongs to: the key's own customer, or the sender profile i
+      #
+      #   @param channel [String] Always voice.
+      #
+      #   @param duration_seconds [Integer, nil] How long the call lasted. Only on call.completed.
+      #
+      #   @param number [String] The customer number that owns the call, in E.164 format.
+      #
+      #   @param price [Float, nil] What the call was charged. Only on call.completed, and omitted there until billi
+      #
+      #   @param reason [String, nil] The machine-readable reason the call did not complete. Only on call.failed, and
+      #
+      #   @param recording_id [String, nil] The recording that became available, the same id GET /v3/calls/{id}/recordings l
+      #
+      #   @param updated_at [String] When the change happened on the call, as opposed to when the event was emitted.
+    end
+  end
+end