sentdm 0.33.0 → 0.34.0

data/lib/sentdm/models/template_create_params.rb

@@ -7,6 +7,14 @@ module Sentdm
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
+      # @!attribute auto_create_for_sp
+      #   Create this template automatically on every sender profile of the organization,
+      #   now and in future (default: false). Accepted only from an organization that has
+      #   been enabled for it, and only at creation — it cannot be changed afterwards.
+      #
+      #   @return [Boolean, nil]
+      optional :auto_create_for_sp, Sentdm::Internal::Type::Boolean
+
       # @!attribute category
       #   Template category: MARKETING, UTILITY, AUTHENTICATION (optional, auto-detected
       #   if not provided)
@@ -56,10 +64,12 @@ module Sentdm
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(category: nil, creation_source: nil, definition: nil, language: nil, sandbox: nil, submit_for_review: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+      # @!method initialize(auto_create_for_sp: nil, category: nil, creation_source: nil, definition: nil, language: nil, sandbox: nil, submit_for_review: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::TemplateCreateParams} for more details.
       #
+      #   @param auto_create_for_sp [Boolean] Create this template automatically on every sender profile of the organization,
+      #
       #   @param category [String, nil] Template category: MARKETING, UTILITY, AUTHENTICATION (optional, auto-detected i
       #
       #   @param creation_source [String, nil] Source of template creation (default: from-api)

data/lib/sentdm/models/webhook_create_params.rb

@@ -41,6 +41,13 @@ module Sentdm
       #   @return [Boolean, nil]
       optional :sandbox, Sentdm::Internal::Type::Boolean
 
+      # @!attribute sender_profile
+      #   Request-only: the events an organization webhook's sender profile clones
+      #   receive, one clone per existing and future profile. Responses never return it.
+      #
+      #   @return [Sentdm::Models::WebhookCreateParams::SenderProfile, nil]
+      optional :sender_profile, -> { Sentdm::WebhookCreateParams::SenderProfile }, nil?: true
+
       # @!attribute timeout_seconds
       #
       #   @return [Integer, nil]
@@ -56,7 +63,7 @@ module Sentdm
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(display_name: nil, endpoint_url: nil, event_filters: nil, event_types: nil, retry_count: nil, sandbox: nil, timeout_seconds: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+      # @!method initialize(display_name: nil, endpoint_url: nil, event_filters: nil, event_types: nil, retry_count: nil, sandbox: nil, sender_profile: nil, timeout_seconds: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::WebhookCreateParams} for more details.
       #
@@ -72,6 +79,8 @@ module Sentdm
       #
       #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
       #
+      #   @param sender_profile [Sentdm::Models::WebhookCreateParams::SenderProfile, nil] Request-only: the events an organization webhook's sender profile clones receive
+      #
       #   @param timeout_seconds [Integer]
       #
       #   @param idempotency_key [String]
@@ -79,6 +88,27 @@ module Sentdm
       #   @param x_profile_id [String]
       #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+
+      class SenderProfile < Sentdm::Internal::Type::BaseModel
+        # @!attribute event_filters
+        #
+        #   @return [Hash{Symbol=>Array<String>}, nil]
+        optional :event_filters,
+                 Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]],
+                 nil?: true
+
+        # @!attribute event_types
+        #
+        #   @return [Array<String>, nil]
+        optional :event_types, Sentdm::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(event_filters: nil, event_types: nil)
+        #   Request-only: the events an organization webhook's sender profile clones
+        #   receive, one clone per existing and future profile. Responses never return it.
+        #
+        #   @param event_filters [Hash{Symbol=>Array<String>}, nil]
+        #   @param event_types [Array<String>]
+      end
     end
   end
 end

data/lib/sentdm/models/webhook_list_events_response.rb

@@ -48,7 +48,7 @@ module Sentdm
       #   handler that rejects an envelope it does not recognise will break on the next
       #   addition rather than ignore it.
       #
-      #   @return [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, Sentdm::Models::ChannelEvent, Sentdm::Models::ContactEvent, Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload, nil]
+      #   @return [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, Sentdm::Models::ChannelEvent, Sentdm::Models::ContactEvent, Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload, Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload, nil]
       optional :event_data, union: -> { Sentdm::Models::WebhookListEventsResponse::EventData }
 
       # @!attribute event_type
@@ -90,7 +90,7 @@ module Sentdm
       #
       #   @param error_message [String, nil]
       #
-      #   @param event_data [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, Sentdm::Models::ChannelEvent, Sentdm::Models::ContactEvent, Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload] The exact event body that was delivered, or attempted, for this record. One of t
+      #   @param event_data [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, Sentdm::Models::ChannelEvent, Sentdm::Models::ContactEvent, Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload, Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload] The exact event body that was delivered, or attempted, for this record. One of t
       #
       #   @param event_type [String]
       #
@@ -148,6 +148,10 @@ module Sentdm
         # varies only in Payload.
         variant -> { Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload }
 
+        # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
+        # varies only in Payload.
+        variant -> { Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload }
+
         class SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload < Sentdm::Internal::Type::BaseModel
           # @!attribute event
           #   The specific event within the family, for example message.delivered,
@@ -433,8 +437,177 @@ module Sentdm
           end
         end
 
+        class SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload < 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::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload::Payload, nil]
+          optional :payload,
+                   -> { Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload::Payload },
+                   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::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload}
+          #   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::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload::Payload, 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
+
+          # @see Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload#payload
+          class Payload < 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::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload::Payload}
+            #   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
+
         # @!method self.variants
-        #   @return [Array(Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, Sentdm::Models::ChannelEvent, Sentdm::Models::ContactEvent, Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload)]
+        #   @return [Array(Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, Sentdm::Models::ChannelEvent, Sentdm::Models::ContactEvent, Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload, Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload)]
       end
     end
   end

data/lib/sentdm/models/webhook_update_params.rb

@@ -46,6 +46,13 @@ module Sentdm
       #   @return [Boolean, nil]
       optional :sandbox, Sentdm::Internal::Type::Boolean
 
+      # @!attribute sender_profile
+      #   Request-only: the events an organization webhook's sender profile clones
+      #   receive, one clone per existing and future profile. Responses never return it.
+      #
+      #   @return [Sentdm::Models::WebhookUpdateParams::SenderProfile, nil]
+      optional :sender_profile, -> { Sentdm::WebhookUpdateParams::SenderProfile }, nil?: true
+
       # @!attribute timeout_seconds
       #
       #   @return [Integer, nil]
@@ -61,7 +68,7 @@ module Sentdm
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(id:, display_name: nil, endpoint_url: nil, event_filters: nil, event_types: nil, retry_count: nil, sandbox: nil, timeout_seconds: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+      # @!method initialize(id:, display_name: nil, endpoint_url: nil, event_filters: nil, event_types: nil, retry_count: nil, sandbox: nil, sender_profile: nil, timeout_seconds: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::WebhookUpdateParams} for more details.
       #
@@ -79,6 +86,8 @@ module Sentdm
       #
       #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
       #
+      #   @param sender_profile [Sentdm::Models::WebhookUpdateParams::SenderProfile, nil] Request-only: the events an organization webhook's sender profile clones receive
+      #
       #   @param timeout_seconds [Integer]
       #
       #   @param idempotency_key [String]
@@ -86,6 +95,27 @@ module Sentdm
       #   @param x_profile_id [String]
       #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+
+      class SenderProfile < Sentdm::Internal::Type::BaseModel
+        # @!attribute event_filters
+        #
+        #   @return [Hash{Symbol=>Array<String>}, nil]
+        optional :event_filters,
+                 Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]],
+                 nil?: true
+
+        # @!attribute event_types
+        #
+        #   @return [Array<String>, nil]
+        optional :event_types, Sentdm::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(event_filters: nil, event_types: nil)
+        #   Request-only: the events an organization webhook's sender profile clones
+        #   receive, one clone per existing and future profile. Responses never return it.
+        #
+        #   @param event_filters [Hash{Symbol=>Array<String>}, nil]
+        #   @param event_types [Array<String>]
+      end
     end
   end
 end

data/lib/sentdm/resources/me.rb

@@ -39,6 +39,11 @@ module Sentdm
       # inventory — normally this account, and a different one where a number is shared.
       # Both are `null` when the account has no US SMS sender.
       #
+      # **Template auto-creation:** `enable_template_auto_creation_for_sp` reports
+      # whether this account may mark a template for automatic creation on its sender
+      # profiles. It is granted by Sent and off by default. A `profile` reports `false`,
+      # having no sender profiles of its own to create anything on.
+      #
       # @overload retrieve(x_profile_id: nil, request_options: {})
       #
       # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys

data/lib/sentdm/resources/templates.rb

@@ -19,7 +19,9 @@ module Sentdm
       # from the template's content and can be changed afterwards with
       # `PUT /v3/templates/{id}`.
       #
-      # @overload create(category: nil, creation_source: nil, definition: nil, language: nil, sandbox: nil, submit_for_review: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+      # @overload create(auto_create_for_sp: nil, category: nil, creation_source: nil, definition: nil, language: nil, sandbox: nil, submit_for_review: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+      #
+      # @param auto_create_for_sp [Boolean] Body param: Create this template automatically on every sender profile of the or
       #
       # @param category [String, nil] Body param: Template category: MARKETING, UTILITY, AUTHENTICATION (optional, aut
       #

data/lib/sentdm/resources/webhooks.rb

@@ -19,7 +19,7 @@ module Sentdm
       #
       # Creates a new webhook endpoint for the authenticated customer.
       #
-      # @overload create(display_name: nil, endpoint_url: nil, event_filters: nil, event_types: nil, retry_count: nil, sandbox: nil, timeout_seconds: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+      # @overload create(display_name: nil, endpoint_url: nil, event_filters: nil, event_types: nil, retry_count: nil, sandbox: nil, sender_profile: nil, timeout_seconds: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
       # @param display_name [String] Body param
       #
@@ -33,6 +33,8 @@ module Sentdm
       #
       # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
+      # @param sender_profile [Sentdm::Models::WebhookCreateParams::SenderProfile, nil] Body param: Request-only: the events an organization webhook's sender profile cl
+      #
       # @param timeout_seconds [Integer] Body param
       #
       # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
@@ -89,7 +91,7 @@ module Sentdm
       #
       # Updates an existing webhook for the authenticated customer.
       #
-      # @overload update(id, display_name: nil, endpoint_url: nil, event_filters: nil, event_types: nil, retry_count: nil, sandbox: nil, timeout_seconds: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+      # @overload update(id, display_name: nil, endpoint_url: nil, event_filters: nil, event_types: nil, retry_count: nil, sandbox: nil, sender_profile: nil, timeout_seconds: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
       # @param id [String] Path param
       #
@@ -105,6 +107,8 @@ module Sentdm
       #
       # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
+      # @param sender_profile [Sentdm::Models::WebhookUpdateParams::SenderProfile, nil] Body param: Request-only: the events an organization webhook's sender profile cl
+      #
       # @param timeout_seconds [Integer] Body param
       #
       # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
@@ -221,7 +225,9 @@ module Sentdm
       # Some parameter documentations has been truncated, see
       # {Sentdm::Models::WebhookListEventsParams} for more details.
       #
-      # Retrieves a paginated list of delivery events for the specified webhook.
+      # Retrieves a paginated list of delivery events for the specified webhook. If the
+      # webhook is cloned onto your sender profiles, the list includes what those clones
+      # received; read payload.account_id to tell whose event it is.
       #
       # @overload list_events(id, page: nil, page_size: nil, search: nil, x_profile_id: nil, request_options: {})
       #

data/lib/sentdm/version.rb

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

data/rbi/sentdm/models/channel_event_payload.rbi

@@ -68,13 +68,19 @@ module Sentdm
       sig { returns(T.nilable(String)) }
       attr_accessor :number_type
 
-      # Why the market reached this state, when a reason was given — a correction
-      # explained, or a campaign lapse. Free text, passed through from the registry or
-      # carrier that wrote it, so treat it as a message to show a human rather than a
-      # value to branch on.
+      # Why the market reached this state, as a sentence to show a person: the specific
+      # explanation when one was given (a correction explained, a campaign lapse),
+      # otherwise what reason_code means for this market. Not a value to branch on.
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
 
+      # Why the market is not ACTIVE, as a stable code: an ErrorCodes CHANNEL_xxx value
+      # such as CHANNEL_001 (something you owe) or CHANNEL_002 (a correction was
+      # requested). The same code the channels resource reports for the market. Switch
+      # on this rather than on reason. Omitted while ACTIVE.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :reason_code
+
       # The sender itself — a number in E.164, or an alphanumeric sender ID.
       #
       # Always present, and null until a sender exists. The key is on every delivery so
@@ -142,6 +148,7 @@ module Sentdm
             T.nilable(Sentdm::ChannelEventPayload::Compliance::OrHash),
           number_type: T.nilable(String),
           reason: T.nilable(String),
+          reason_code: T.nilable(String),
           sender_value: T.nilable(String),
           status: String,
           updated_at: String
@@ -185,11 +192,15 @@ module Sentdm
         # The kind of sender the market uses, for example TEN_DLC, LOCAL, or ALPHANUMERIC.
         # Omitted when the subject has no sender type of its own.
         number_type: nil,
-        # Why the market reached this state, when a reason was given — a correction
-        # explained, or a campaign lapse. Free text, passed through from the registry or
-        # carrier that wrote it, so treat it as a message to show a human rather than a
-        # value to branch on.
+        # Why the market reached this state, as a sentence to show a person: the specific
+        # explanation when one was given (a correction explained, a campaign lapse),
+        # otherwise what reason_code means for this market. Not a value to branch on.
         reason: nil,
+        # Why the market is not ACTIVE, as a stable code: an ErrorCodes CHANNEL_xxx value
+        # such as CHANNEL_001 (something you owe) or CHANNEL_002 (a correction was
+        # requested). The same code the channels resource reports for the market. Switch
+        # on this rather than on reason. Omitted while ACTIVE.
+        reason_code: nil,
         # The sender itself — a number in E.164, or an alphanumeric sender ID.
         #
         # Always present, and null until a sender exists. The key is on every delivery so
@@ -228,6 +239,7 @@ module Sentdm
             compliance: T.nilable(Sentdm::ChannelEventPayload::Compliance),
             number_type: T.nilable(String),
             reason: T.nilable(String),
+            reason_code: T.nilable(String),
             sender_value: T.nilable(String),
             status: String,
             updated_at: String