sentdm 0.32.0 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dab566c65206bbd97b0e29e8660f25932a22d58359db63e20c4d4ba9cbd8dec
-  data.tar.gz: 5e097f125343b76d26132686ff963dcfba40c316b6e9a8a4b13dc0fd493014aa
+  metadata.gz: 8b4444164d11b8913195b89a66ba9d140e5edaca680199f80156774e39f3f893
+  data.tar.gz: 38b18a67c9dc58ed79f990686d0363fbab3138b66c9a2e3b20eb76ba0d4d4988
 SHA512:
-  metadata.gz: a47bec3101129a85381094c226cf6be44786562b5a882683bcc6c40dbeeb40d6da8ef8dd4a47254a7f6dc09cefea91655170baa7495755a54d922d127f0d6e56
-  data.tar.gz: a5239a8ae31862ca952d547205f9fd35b909f3bf43320f45afbed14f881110de646b5697a2f247b43bc91861ef5df95f43b5f6353becce01a133086bf844bb6b
+  metadata.gz: bd38b5407cb704af0bf1cfecccb4f4bdcc2b5b173ac638d7c3f4c8e5a6039a019637d46114d6c082ebc420f7ad3532cfd128493f56d7bff51c62abc62cf34461
+  data.tar.gz: 3a79e6d405c70edc8e4479f28dc4955c0e0a3fbfaa59da458848c831e99650d90e87c672316609514fb9d5bd4d2b61d194d3f54a31d6c7ecac9340b12117e887

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [0.34.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.33.0...v0.34.0) (2026-09-30)
+
+
+### Features
+
+* **api:** sync OpenAPI spec from production ([d7d4ecf](https://github.com/sentdm/sent-dm-ruby/commit/d7d4ecf5dd378e69ee6f5148b816554ebbf1a6bf))
+
+## [0.33.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.32.0...v0.33.0) (2026-09-30)
+
+
+### Features
+
+* **api:** sync generated SDKs from the committed spec ([c68607e](https://github.com/sentdm/sent-dm-ruby/commit/c68607ed78d4a03f1c3c03d36440985cd5eedceb))
+* **api:** sync OpenAPI spec from production ([ceb47d9](https://github.com/sentdm/sent-dm-ruby/commit/ceb47d9ddc2d46144e5f81b0ef4bc7693b1f435f))
+* **api:** sync OpenAPI spec from production ([8c92eb5](https://github.com/sentdm/sent-dm-ruby/commit/8c92eb52bff195424d14d09eff8f131edc640918))
+
 ## [0.32.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.31.0...v0.32.0) (2026-09-18)
 
 

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.32.0"
+gem "sentdm", "~> 0.34.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/sentdm/client.rb

@@ -83,6 +83,12 @@ module Sentdm
     # **A message needs a sender.** What you can send, where, and at what cost is
     # decided by the markets under **Channels** — so a recipient in a country you hold
     # no sender for is refused here rather than queued.
+    #
+    # **A message can be resent on its id.** `POST /v3/messages/{id}/resend` puts a
+    # finished message — typically one BLOCKED for insufficient balance — back through
+    # 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.
     # @return [Sentdm::Resources::Messages]
     attr_reader :messages
 

data/lib/sentdm/models/channel_event_payload.rb

@@ -16,7 +16,9 @@ module Sentdm
       #   The account whose market this is, named as on every other family. When an
       #   organization receives an event for one of its sender profiles this is the
       #   profile, so a reseller compares it with its own id and anything different is one
-      #   of its profiles.
+      #   of its profiles. Matches customer_id on GET /v3/channels and the sender
+      #   profile's id. Together with channel, country, and number_type, it identifies the
+      #   market.
       #
       #   @return [String, nil]
       optional :account_id, String
@@ -29,6 +31,28 @@ module Sentdm
       #   @return [String, nil]
       optional :channel, String
 
+      # @!attribute compliance
+      #   What a market has been given: the identity it registers under, its programme,
+      #   and any documents attached.
+      #
+      #   What it does not carry is what the market asks for. That is the subject of GET
+      #   /v3/compliance/requirements, and it is the same answer for every caller — a
+      #   description of what a compliance regime wants, not a record of one customer's
+      #   progress through it. It was reported here as well for a while, which put the
+      #   same array in six response shapes and left a caller deciding which of two
+      #   sources to believe.
+      #
+      #   Present on a list read for markets that register (carrying brand and campaign),
+      #   but with documents absent — documents are not fetched for a list, because a
+      #   catalog lookup and a document read per market would multiply across a page.
+      #   Absent documents is distinct from an empty list: absent says they were not
+      #   fetched; empty says the market has been given none. The parent object is null
+      #   only when the market registers with nobody and compliance was not computed —
+      #   nothing to show at all.
+      #
+      #   @return [Sentdm::Models::ChannelEventPayload::Compliance, nil]
+      optional :compliance, -> { Sentdm::ChannelEventPayload::Compliance }, nil?: true
+
       # @!attribute number_type
       #   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.
@@ -37,14 +61,22 @@ module Sentdm
       optional :number_type, String, nil?: true
 
       # @!attribute reason
-      #   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.
       #
       #   @return [String, nil]
       optional :reason, String, nil?: true
 
+      # @!attribute reason_code
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :reason_code, String, nil?: true
+
       # @!attribute sender_value
       #   The sender itself — a number in E.164, or an alphanumeric sender ID.
       #
@@ -83,7 +115,7 @@ module Sentdm
       #   @return [String, nil]
       optional :updated_at, String
 
-      # @!method initialize(country:, account_id: nil, channel: nil, number_type: nil, reason: nil, sender_value: nil, status: nil, updated_at: nil)
+      # @!method initialize(country:, account_id: nil, channel: nil, compliance: nil, number_type: nil, reason: nil, reason_code: nil, sender_value: nil, status: nil, updated_at: nil)
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::ChannelEventPayload} for more details.
       #
@@ -114,15 +146,130 @@ module Sentdm
       #
       #   @param channel [String] The channel this market belongs to: sms, whatsapp, or rcs. Never
       #
+      #   @param compliance [Sentdm::Models::ChannelEventPayload::Compliance, nil] What a market has been given: the identity it registers under, its programme, an
+      #
       #   @param number_type [String, nil] The kind of sender the market uses, for example TEN_DLC, LOCAL, or
       #
-      #   @param reason [String, nil] Why the market reached this state, when a reason was given — a correction explai
+      #   @param reason [String, nil] Why the market reached this state, as a sentence to show a person: the specific
+      #
+      #   @param reason_code [String, nil] Why the market is not ACTIVE, as a stable code: an ErrorCodes CHANNEL_xxx value
       #
       #   @param sender_value [String, nil] The sender itself — a number in E.164, or an alphanumeric sender ID.
       #
       #   @param status [String] Where the market stands: PENDING_REVIEW, ACTION_NEEDED, PROVISIONING,
       #
       #   @param updated_at [String] When the transition happened, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+
+      # @see Sentdm::Models::ChannelEventPayload#compliance
+      class Compliance < Sentdm::Internal::Type::BaseModel
+        # @!attribute brand
+        #   The identity this market registers under, with inherit saying whose it is.
+        #
+        #   Reported here rather than on the profile because it belongs to the registration
+        #   this market files, and only one market files one. It was a top-level block for a
+        #   while, which put a per-registration value beside a list of markets and left a
+        #   caller to work out which market it belonged to.
+        #
+        #   Absent for a market that registers with nobody — such a market asks for no
+        #   identity, so there is none to report. Absent and null mean different things:
+        #   absent says this market does not ask, null would say it asks and nothing was
+        #   supplied.
+        #
+        #   Untyped, like the request side, because its members are declared by the market's
+        #   own schema rather than by a C# class. A typed pair here would be a second
+        #   definition of what a market wants, free to drift from the one that validates.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :brand, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::Unknown], nil?: true
+
+        # @!attribute campaign
+        #   The programme this market registers, with inherit saying whose it is.
+        #
+        #   One, not a list. TcrCampaigns permits several and an account built on the admin
+        #   side may hold them, but this surface offers one — which is what lets the
+        #   market's PATCH be an upsert rather than a collection with an addressable create
+        #   behind it. An account holding several is reported as its first and refused on
+        #   write, rather than half-edited.
+        #
+        #   Carries no id. Nothing addresses a campaign, and an undeclared key would be
+        #   refused if the caller sent this object back — which it is meant to be able to
+        #   do.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :campaign, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::Unknown], nil?: true
+
+        # @!attribute documents
+        #   What has been supplied for this market.
+        #
+        #   Files, not values — the declared halves above carry the values. A document
+        #   cannot be a JSON value, so it is sent as multipart on the channel call and
+        #   reported here as a reference.
+        #
+        #   Absent on a list read, which fetches identity but does not compute compliance
+        #   documents per market. Absent and empty mean different things: absent says the
+        #   documents were not fetched; empty says the market has been given none.
+        #
+        #   @return [Array<Sentdm::Models::ChannelEventPayload::Compliance::Document>, nil]
+        optional :documents,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ChannelEventPayload::Compliance::Document] },
+                 nil?: true
+
+        # @!method initialize(brand: nil, campaign: nil, documents: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::ChannelEventPayload::Compliance} for more details.
+        #
+        #   What a market has been given: the identity it registers under, its programme,
+        #   and any documents attached.
+        #
+        #   What it does not carry is what the market asks for. That is the subject of GET
+        #   /v3/compliance/requirements, and it is the same answer for every caller — a
+        #   description of what a compliance regime wants, not a record of one customer's
+        #   progress through it. It was reported here as well for a while, which put the
+        #   same array in six response shapes and left a caller deciding which of two
+        #   sources to believe.
+        #
+        #   Present on a list read for markets that register (carrying brand and campaign),
+        #   but with documents absent — documents are not fetched for a list, because a
+        #   catalog lookup and a document read per market would multiply across a page.
+        #   Absent documents is distinct from an empty list: absent says they were not
+        #   fetched; empty says the market has been given none. The parent object is null
+        #   only when the market registers with nobody and compliance was not computed —
+        #   nothing to show at all.
+        #
+        #   @param brand [Hash{Symbol=>Object}, nil] The identity this market registers under, with inherit saying whose it is.
+        #
+        #   @param campaign [Hash{Symbol=>Object}, nil] The programme this market registers, with inherit saying whose it is.
+        #
+        #   @param documents [Array<Sentdm::Models::ChannelEventPayload::Compliance::Document>, nil] What has been supplied for this market.
+
+        class Document < Sentdm::Internal::Type::BaseModel
+          # @!attribute document_id
+          #   Identifier of the upload, for fetching it back through the documents endpoints.
+          #
+          #   @return [String, nil]
+          optional :document_id, String, nil?: true
+
+          # @!attribute file_name
+          #
+          #   @return [String, nil]
+          optional :file_name, String, nil?: true
+
+          # @!attribute key
+          #   The catalog's name for this document, matching the requirement it satisfies.
+          #
+          #   @return [String, nil]
+          optional :key, String
+
+          # @!method initialize(document_id: nil, file_name: nil, key: nil)
+          #   A document a market asked for and has been given.
+          #
+          #   @param document_id [String, nil] Identifier of the upload, for fetching it back through the documents endpoints.
+          #
+          #   @param file_name [String, nil]
+          #
+          #   @param key [String] The catalog's name for this document, matching the requirement it satisfies.
+        end
+      end
     end
   end
 end

data/lib/sentdm/models/contact_event.rb

@@ -19,17 +19,25 @@ module Sentdm
       optional :field, String
 
       # @!attribute payload
-      #   Body of a contact.opt_in, contact.opt_out or contact.help event. Delivered when
-      #   a contact signals a consent change or asks for help.
+      #   Body of a contact.opt_in, contact.opt_out, contact.help or
+      #   contact.custom_keyword event. Delivered when a contact signals a consent change,
+      #   asks for help, or sends one of your own auto-reply keywords.
       #
       #   These events state the signal outright, so you do not have to recognise keywords
       #   in the text of a message.received event. They also cover cases that produce no
       #   inbound message at all, such as a network handling an opt-out on your behalf.
       #
-      #   Fields are ordered identity → resulting state → provenance → join key. Nothing
-      #   here restates the envelope: which of the three signals occurred is the
-      #   envelope's event, and when it was emitted is its timestamp. Retries carry the
-      #   same X-Webhook-Event-ID header, which is what to deduplicate on.
+      #   Two of the four change consent and two do not: contact.help and
+      #   contact.custom_keyword report the state the contact already had. Read opt_out
+      #   for the state and the envelope's event for what happened, rather than inferring
+      #   one from the other.
+      #
+      #   Fields are ordered identity → resulting state → provenance → join keys. The two
+      #   parties are from and to. Note that the message family has not moved to those
+      #   names yet — message.received still calls the same two parties inbound_number and
+      #   outbound_number. Nothing here restates the envelope: which signal occurred is
+      #   the envelope's event, and when it was emitted is its timestamp. Retries carry
+      #   the same X-Webhook-Event-ID header, which is what to deduplicate on.
       #
       #   @return [Sentdm::Models::ContactEventPayload, nil]
       optional :payload, -> { Sentdm::ContactEventPayload }, nil?: true
@@ -59,7 +67,7 @@ module Sentdm
       #
       #   @param field [String] The event family, for example message, templates or contact. Route on
       #
-      #   @param payload [Sentdm::Models::ContactEventPayload, nil] Body of a contact.opt_in, contact.opt_out or contact.help event. Delivered
+      #   @param payload [Sentdm::Models::ContactEventPayload, nil] Body of a contact.opt_in, contact.opt_out, contact.help or
       #
       #   @param request_id [String, nil] The event-specific body.
       #

data/lib/sentdm/models/contact_event_payload.rb

@@ -5,8 +5,9 @@ module Sentdm
     class ContactEventPayload < Sentdm::Internal::Type::BaseModel
       # @!attribute opt_out
       #   Whether the contact is opted out after this signal — the state to write to your
-      #   own record. Same meaning as opt_out on the contact resource. On contact.help
-      #   this reports the contact's existing state, which help does not change.
+      #   own record. Same meaning as opt_out on the contact resource. On contact.help and
+      #   contact.custom_keyword this reports the contact's existing state, which neither
+      #   changes.
       #
       #   Two signals from the same contact can arrive out of order, because each one is
       #   queued on its own rather than against the contact. Compare the envelope's
@@ -33,6 +34,18 @@ module Sentdm
       #   @return [String, nil]
       optional :account_id, String
 
+      # @!attribute agent_id
+      #   The RCS agent the signal reached, when it reached one.
+      #
+      #   Omitted entirely on channels that have no agent, rather than sent as null — an
+      #   SMS or WhatsApp payload does not carry this key at all. On RCS it is the
+      #   counterpart to To: a contact reaches an agent rather than a number, so exactly
+      #   one of the two is populated and never both. If you run more than one agent, this
+      #   is what tells you which of them the contact acted on.
+      #
+      #   @return [String, nil]
+      optional :agent_id, String, nil?: true
+
       # @!attribute channel
       #   The channel the signal arrived on, for example sms or whatsapp.
       #
@@ -41,12 +54,20 @@ module Sentdm
 
       # @!attribute contact_id
       #   The contact who raised the signal. Always populated, including for contact.help
-      #   from a number you have not messaged before — the contact is created if it does
-      #   not exist yet, so this identifier is always resolvable against the contacts API.
+      #   or contact.custom_keyword from a number you have not messaged before — the
+      #   contact is created if it does not exist yet, so this identifier is always
+      #   resolvable against the contacts API.
       #
       #   @return [String, nil]
       optional :contact_id, String
 
+      # @!attribute from
+      #   The contact's number, in E.164 format with the leading + — who raised the
+      #   signal. The same party message.received publishes as inbound_number.
+      #
+      #   @return [String, nil]
+      optional :from, String
+
       # @!attribute message_id
       #   The inbound message that carried the signal, matching message_id on the
       #   corresponding message.received event so the two can be joined.
@@ -60,12 +81,21 @@ module Sentdm
       #   @return [String, nil]
       optional :message_id, String, nil?: true
 
-      # @!attribute phone_number
-      #   The contact's number in E.164 format. Same value as phone_number on the contact
-      #   resource.
+      # @!attribute template_id
+      #   The auto-reply template whose keyword the contact matched, joinable against the
+      #   templates API.
+      #
+      #   This is what identifies which signal arrived on contact.custom_keyword: every
+      #   custom template reports the same event name, so the event alone cannot tell your
+      #   booking keyword from your opening-hours one. One template holds as many keywords
+      #   as you configured, so this is steadier to switch on than text.
+      #
+      #   Populated on the compliance sub-types too, where it names the template that
+      #   replied. Sent as null when no template was involved — a network-reported opt-out
+      #   matches no keyword. The field is always present, so read it and check for null.
       #
       #   @return [String, nil]
-      optional :phone_number, String
+      optional :template_id, String, nil?: true
 
       # @!attribute text
       #   The text the contact sent, for example STOP or UNSUBSCRIBE. Sent as null when
@@ -75,21 +105,46 @@ module Sentdm
       #   @return [String, nil]
       optional :text, String, nil?: true
 
-      # @!method initialize(opt_out:, source:, account_id: nil, channel: nil, contact_id: nil, message_id: nil, phone_number: nil, text: nil)
+      # @!attribute to
+      #   The number of yours that received the signal, in E.164 format with the leading
+      #   +. Tells a multi-number account which of its senders the contact acted on, which
+      #   nothing else on this payload answers.
+      #
+      #   This is your number, not the contact's. That is the opposite of what to means on
+      #   POST /v3/messages, where it is the list of recipients you are sending to. Reply
+      #   to From, not to this field, or the message goes back to yourself.
+      #
+      #   Sent as null when the signal did not arrive at a number of yours — an RCS signal
+      #   terminates at an agent rather than a number, and a provider-reported opt-out may
+      #   name no receiving number at all. The field is always present, so read it and
+      #   check for null rather than checking whether the key exists.
+      #
+      #   @return [String, nil]
+      optional :to, String, nil?: true
+
+      # @!method initialize(opt_out:, source:, account_id: nil, agent_id: nil, channel: nil, contact_id: nil, from: nil, message_id: nil, template_id: nil, text: nil, to: nil)
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::ContactEventPayload} for more details.
       #
-      #   Body of a contact.opt_in, contact.opt_out or contact.help event. Delivered when
-      #   a contact signals a consent change or asks for help.
+      #   Body of a contact.opt_in, contact.opt_out, contact.help or
+      #   contact.custom_keyword event. Delivered when a contact signals a consent change,
+      #   asks for help, or sends one of your own auto-reply keywords.
       #
       #   These events state the signal outright, so you do not have to recognise keywords
       #   in the text of a message.received event. They also cover cases that produce no
       #   inbound message at all, such as a network handling an opt-out on your behalf.
       #
-      #   Fields are ordered identity → resulting state → provenance → join key. Nothing
-      #   here restates the envelope: which of the three signals occurred is the
-      #   envelope's event, and when it was emitted is its timestamp. Retries carry the
-      #   same X-Webhook-Event-ID header, which is what to deduplicate on.
+      #   Two of the four change consent and two do not: contact.help and
+      #   contact.custom_keyword report the state the contact already had. Read opt_out
+      #   for the state and the envelope's event for what happened, rather than inferring
+      #   one from the other.
+      #
+      #   Fields are ordered identity → resulting state → provenance → join keys. The two
+      #   parties are from and to. Note that the message family has not moved to those
+      #   names yet — message.received still calls the same two parties inbound_number and
+      #   outbound_number. Nothing here restates the envelope: which signal occurred is
+      #   the envelope's event, and when it was emitted is its timestamp. Retries carry
+      #   the same X-Webhook-Event-ID header, which is what to deduplicate on.
       #
       #   @param opt_out [Boolean] Whether the contact is opted out after this signal — the state to write to your
       #
@@ -97,15 +152,21 @@ module Sentdm
       #
       #   @param account_id [String] The account the contact belongs to. Present so one endpoint can serve several ac
       #
+      #   @param agent_id [String, nil] The RCS agent the signal reached, when it reached one.
+      #
       #   @param channel [String] The channel the signal arrived on, for example sms or whatsapp.
       #
       #   @param contact_id [String] The contact who raised the signal. Always populated, including for contact.help
       #
+      #   @param from [String] The contact's number, in E.164 format with the leading + — who raised the signal
+      #
       #   @param message_id [String, nil] The inbound message that carried the signal, matching message_id on the
       #
-      #   @param phone_number [String] The contact's number in E.164 format. Same value as phone_number on the contact
+      #   @param template_id [String, nil] The auto-reply template whose keyword the contact matched, joinable against the
       #
       #   @param text [String, nil] The text the contact sent, for example STOP or UNSUBSCRIBE. Sent as
+      #
+      #   @param to [String, nil] The number of yours that received the signal, in E.164 format with the leading +
     end
   end
 end