sentdm 0.26.0 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebdb5fd6a174b30850e1b33607c0c7acaa61fecae6564e0567d1f5ef1e957cc8
-  data.tar.gz: 830ae5cb38a33f35ff78031b19d31dac59f280a5fd48275e660d93fa4f54a457
+  metadata.gz: 41507ba04354a1aa51dc2607fe1e8d1af2ea3f4ec4e09616790d25b8ae139c43
+  data.tar.gz: 7da6d30368292aaad6c06df6f997c1d5f9e5aac623bad956b818b8670e4b105d
 SHA512:
-  metadata.gz: 37b4f50c8af9746b8c2c1cd498715ce6f7dce3d765a60926a6cfcff9a43952045cb8c2938d0880968d803709f19751eb4f25baf5c8df83f949b1e56f9222d54e
-  data.tar.gz: 616928315abcb21dfcb69ba3011d1a61b0583982c552d8102d5a0812a0482e6ed75fcd0073586a666ff95fbfd4bba8ad86895766b21c5f2a68208b0b3d37a26a
+  metadata.gz: ea59af208b6faa26d5134072b12e743313712f294506d3d76c465e1a7b76898c75da9144051f8ec5f902cecf7b94950d8c7f73ed067aca29c2489277ac0251c4
+  data.tar.gz: 37ea3a43dfb7ce5b482fd5972772a3d1b482d4e7085c99dba8d258f68b0023b7ba8fab94857f0bc02c105b9718967b78348e63c8e0f54569350c76b69eaf2cdb

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 # Changelog
 
+## [0.28.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.27.0...v0.28.0) (2026-08-31)
+
+
+### Features
+
+* **api:** sync OpenAPI spec from production ([d1e44c2](https://github.com/sentdm/sent-dm-ruby/commit/d1e44c2f20f5397cc0d868af4ac0216f2c78baa8))
+* **api:** sync OpenAPI spec from production ([f6354b3](https://github.com/sentdm/sent-dm-ruby/commit/f6354b3dc2a88c39d886349558b605b37a97db3e))
+
+
+### Bug Fixes
+
+* sync the package version in Gemfile.lock to 0.27.0 ([d6f29cc](https://github.com/sentdm/sent-dm-ruby/commit/d6f29cc70c3d1b1786ed6e31c08dd6c9321552b0))
+
+## [0.27.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.26.0...v0.27.0) (2026-08-17)
+
+
+### Highlights
+
+Webhook payloads are now typed. The events Sent POSTs to your endpoint — `MessageEvent`, `InboundMessageEvent` and `TemplateEvent`, each with its own payload type — are generated types you can deserialize into, instead of a shape you had to hand-write from the docs.
+
+The webhook delivery log is typed too. `event_data` on `GET /v3/webhooks/{id}/events` returns the exact envelope that was delivered, and now describes itself as one of those three rather than an opaque object.
+
+Also in this release:
+
+- `csp_id` on the brand object is deprecated and will be removed in a later release. It identifies the Campaign Service Provider that registered the brand, which is Sent, so the value is the same for every account. There is no replacement. Your own TCR identifiers, `tcr_brand_id` and `universal_ein`, are unaffected.
+- Corrected descriptions for blocked sends, which now name the cases that gate a send before any delivery attempt: insufficient balance, a template not approved for sending, and free-form content with no open conversation.
+- `campaign.volume` documents what an omitted value does. Leave it out and the campaign registers as standard, the higher-fee tier, with no error.
+
+### Features
+
+* **api:** sync OpenAPI spec from production ([3913d60](https://github.com/sentdm/sent-dm-ruby/commit/3913d6099298feaa278b76ac8a44f7809e13e815))
+* **api:** sync OpenAPI spec from production ([cb9fb87](https://github.com/sentdm/sent-dm-ruby/commit/cb9fb87ae298bc8c33adcc9f3960102215502d47))
+* **api:** sync OpenAPI spec from production ([8690f90](https://github.com/sentdm/sent-dm-ruby/commit/8690f905c974d5c45da6f6b1c9b0883b550c871f))
+* **sdk:** expose the delivered webhook payloads as models ([4b43f3f](https://github.com/sentdm/sent-dm-ruby/commit/4b43f3f16729ec3ee3736149308ffc7ada08480a))
+
+
+### Chores
+
+* add eager seal-dispatch workflow ([c005db3](https://github.com/sentdm/sent-dm-ruby/commit/c005db35357a408367f76e964e00912f5fc83116))
+
 ## [0.26.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.25.0...v0.26.0) (2026-08-08)
 
 

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.26.0"
+gem "sentdm", "~> 0.28.0"
 ```
 
 <!-- x-release-please-end -->
@@ -256,32 +256,6 @@ params = Sentdm::MessageSendParams.new(
 sent.messages.send_(**params)
 ```
 
-### Enums
-
-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)
-
-# Revealed type: `T.all(Sentdm::BrandBusinessInfo::EntityType, Symbol)`
-T.reveal_type(Sentdm::BrandBusinessInfo::EntityType::PRIVATE_PROFIT)
-```
-
-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,
-  # …
-)
-
-Sentdm::BrandBusinessInfo.new(
-  entity_type: :PRIVATE_PROFIT,
-  # …
-)
-```
-
 ## Versioning
 
 This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.

data/lib/sentdm/client.rb

@@ -20,38 +20,101 @@ module Sentdm
     # @return [String]
     attr_reader :api_key
 
-    # Configure webhook endpoints for real-time event delivery
+    # Delivery reports and inbound messages, pushed to you.
+    #
+    # Subscribe an endpoint to the event types you care about —
+    # `GET /v3/webhooks/event-types` lists them — and we POST each one as it happens,
+    # retrying on failure. Polling `GET /v3/messages/{id}` works and does not scale.
+    #
+    # **Verify the signature.** Every delivery is signed with your endpoint's secret;
+    # an unverified endpoint is one anybody can post to. `rotate-secret` replaces it,
+    # `test` sends a specimen event, and `GET /v3/webhooks/{id}/events` shows what we
+    # tried to deliver and what your endpoint answered — which is the first place to
+    # look when something appears to be missing.
     # @return [Sentdm::Resources::Webhooks]
     attr_reader :webhooks
 
-    # Invite, update, and manage organization users and roles
+    # The people who can sign in to your organization, and what each may do.
+    #
+    # Users are dashboard access and nothing else — they do not send, and removing one
+    # does not affect traffic. An API key is not a user: it belongs to the
+    # organization or to a sender profile, so revoking a person's access leaves your
+    # integration running.
     # @return [Sentdm::Resources::Users]
     attr_reader :users
 
-    # Manage message templates with variable substitution
+    # Reusable message bodies with named variables.
+    #
+    # A template is substituted at send time from the values you pass, so the copy
+    # lives here rather than in your application. WhatsApp templates additionally need
+    # Meta's approval before they can be sent, and a template's channel status reports
+    # where that stands — an approved SMS template and an unapproved WhatsApp one are
+    # the same template in two states.
     # @return [Sentdm::Resources::Templates]
     attr_reader :templates
 
-    # Manage organization profiles
+    # **Deprecated — use Sender Profiles.**
+    #
+    # The original profile resource, kept because it has live callers. It still works,
+    # and its replacement is `/v3/sender-profiles`, which takes the identity and the
+    # campaign in one call instead of across three.
+    #
+    # New integrations should not start here.
     # @return [Sentdm::Resources::Profiles]
     attr_reader :profiles
 
-    # Manage and lookup phone numbers
+    # What a phone number actually is, before you send to it.
+    #
+    # A lookup returns the number's country, line type and carrier, which is what
+    # decides whether it is reachable on a channel and what it costs. Worth doing on
+    # import rather than on send: a landline in a contact list is a message that can
+    # never be delivered.
     # @return [Sentdm::Resources::Numbers]
     attr_reader :numbers
 
-    # Send and track SMS and WhatsApp messages
+    # Send a message and follow what happened to it.
+    #
+    # One endpoint sends on any channel: pass `channel: "sent"` and we pick between
+    # SMS, WhatsApp and RCS per recipient using your routing rules, or name a channel
+    # to pin it. A send is accepted asynchronously — `POST /v3/messages` returns an
+    # id, and delivery is reported through `GET /v3/messages/{id}`, its activities, or
+    # a webhook.
+    #
+    # **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.
     # @return [Sentdm::Resources::Messages]
     attr_reader :messages
 
-    # Create, update, and manage customer contact lists
+    # The people you message, and their channel identities.
+    #
+    # A contact holds one identity per channel — a phone number, a WhatsApp number —
+    # so routing can choose between them for the same person. Opt-out is recorded
+    # against the contact and honoured on every send, whichever channel it came
+    # through.
+    #
+    # `GET /v3/contacts/{id}/message-summary` is the per-contact view of what you have
+    # sent and what happened to it.
     # @return [Sentdm::Resources::Contacts]
     attr_reader :contacts
 
+    # Inbound and outbound messages, grouped by the person they are with.
+    #
+    # A conversation is the thread for one contact across every channel — a reply by
+    # SMS and one by WhatsApp belong to the same conversation, because they are the
+    # same person talking to you.
+    #
+    # Read-only. Sending is **Messages**; a reply arrives here and through your
+    # webhooks.
     # @return [Sentdm::Resources::Conversations]
     attr_reader :conversations
 
-    # Retrieve account details
+    # Who the current key is.
+    #
+    # `GET /v3/me` answers with the account the key authenticates as, which is the
+    # quickest way to tell a live key from a test one, an organization key from a
+    # sender profile's, and to confirm `x-profile-id` resolved to the profile you
+    # meant.
     # @return [Sentdm::Resources::Me]
     attr_reader :me
 

data/lib/sentdm/internal/type/base_model.rb

@@ -438,11 +438,11 @@ module Sentdm
         # @return [Hash{Symbol=>Object}]
         #
         # @example
-        #   # `api_meta` is a `Sentdm::APIMeta`
-        #   api_meta => {
-        #     request_id: request_id,
-        #     timestamp: timestamp,
-        #     version: version
+        #   # `inbound_message_event` is a `Sentdm::InboundMessageEvent`
+        #   inbound_message_event => {
+        #     event: event,
+        #     field: field,
+        #     payload: payload
         #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)

data/lib/sentdm/models/contact_create_response.rb

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Contacts#create
+    class ContactCreateResponse < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   Contact response for v3 API Uses snake_case for JSON property names
+      #
+      #   @return [Sentdm::Models::ContactCreateResponse::Data, nil]
+      optional :data, -> { Sentdm::Models::ContactCreateResponse::Data }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ContactCreateResponse::Error, nil]
+      optional :error, -> { Sentdm::Models::ContactCreateResponse::Error }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @return [Sentdm::Models::ContactCreateResponse::Meta, nil]
+      optional :meta, -> { Sentdm::Models::ContactCreateResponse::Meta }
+
+      # @!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)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::ContactCreateResponse} for more details.
+      #
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::ContactCreateResponse::Data, nil] Contact response for v3 API
+      #
+      #   @param error [Sentdm::Models::ContactCreateResponse::Error, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::ContactCreateResponse::Meta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+
+      # @see Sentdm::Models::ContactCreateResponse#data
+      class Data < Sentdm::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for the contact
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute available_channels
+        #   Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
+        #
+        #   @return [String, nil]
+        optional :available_channels, String
+
+        # @!attribute country_code
+        #   Country calling code (e.g., 1 for US/Canada)
+        #
+        #   @return [String, nil]
+        optional :country_code, String
+
+        # @!attribute created_at
+        #   When the contact was created
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute customer_id
+        #   Which customer owns this — the key's own, or the profile named in x-profile-id.
+        #   Says whose resource this is, which the resource's own id does not.
+        #
+        #   @return [String, nil]
+        optional :customer_id, String
+
+        # @!attribute default_channel
+        #   Default messaging channel to use (e.g., "sms" or "whatsapp")
+        #
+        #   @return [String, nil]
+        optional :default_channel, String
+
+        # @!attribute format_e164
+        #   Phone number in E.164 format (e.g., +1234567890)
+        #
+        #   @return [String, nil]
+        optional :format_e164, String
+
+        # @!attribute format_international
+        #   Phone number in international format (e.g., +1 234-567-890)
+        #
+        #   @return [String, nil]
+        optional :format_international, String
+
+        # @!attribute format_national
+        #   Phone number in national format (e.g., (234) 567-890)
+        #
+        #   @return [String, nil]
+        optional :format_national, String
+
+        # @!attribute format_rfc
+        #   Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
+        #
+        #   @return [String, nil]
+        optional :format_rfc, String
+
+        # @!attribute is_inherited
+        #   @deprecated
+        #
+        #   Always false. Contacts are no longer shared or inherited between sender profiles
+        #   — a profile sees only the contacts it owns. Retained so existing v3 clients
+        #   reading is_inherited keep deserializing; it carries no information.
+        #
+        #   @return [Boolean, nil]
+        optional :is_inherited, Sentdm::Internal::Type::Boolean
+
+        # @!attribute opt_out
+        #   Whether the contact has opted out of messaging. Single source of truth — opt-out
+        #   is per-contact, not per-channel.
+        #
+        #   @return [Boolean, nil]
+        optional :opt_out, Sentdm::Internal::Type::Boolean
+
+        # @!attribute phone_number
+        #   Phone number in original format
+        #
+        #   @return [String, nil]
+        optional :phone_number, String
+
+        # @!attribute region_code
+        #   ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+        #
+        #   @return [String, nil]
+        optional :region_code, String
+
+        # @!attribute updated_at
+        #   When the contact was last updated
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time, nil?: true
+
+        # @!method initialize(id: nil, available_channels: nil, country_code: nil, created_at: nil, customer_id: nil, default_channel: nil, format_e164: nil, format_international: nil, format_national: nil, format_rfc: nil, is_inherited: nil, opt_out: nil, phone_number: nil, region_code: nil, updated_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::ContactCreateResponse::Data} for more details.
+        #
+        #   Contact response for v3 API Uses snake_case for JSON property names
+        #
+        #   @param id [String] Unique identifier for the contact
+        #
+        #   @param available_channels [String] Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
+        #
+        #   @param country_code [String] Country calling code (e.g., 1 for US/Canada)
+        #
+        #   @param created_at [Time] When the contact was created
+        #
+        #   @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
+        #
+        #   @param default_channel [String] Default messaging channel to use (e.g., "sms" or "whatsapp")
+        #
+        #   @param format_e164 [String] Phone number in E.164 format (e.g., +1234567890)
+        #
+        #   @param format_international [String] Phone number in international format (e.g., +1 234-567-890)
+        #
+        #   @param format_national [String] Phone number in national format (e.g., (234) 567-890)
+        #
+        #   @param format_rfc [String] Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
+        #
+        #   @param is_inherited [Boolean] Always false. Contacts are no longer shared or inherited between sender profiles
+        #
+        #   @param opt_out [Boolean] Whether the contact has opted out of messaging. Single source of truth — opt-out
+        #
+        #   @param phone_number [String] Phone number in original format
+        #
+        #   @param region_code [String] ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+        #
+        #   @param updated_at [Time, nil] When the contact was last updated
+      end
+
+      # @see Sentdm::Models::ContactCreateResponse#error
+      class Error < Sentdm::Internal::Type::BaseModel
+        # @!attribute code
+        #   Machine-readable error code (e.g., "RESOURCE_001")
+        #
+        #   @return [String, nil]
+        optional :code, String
+
+        # @!attribute details
+        #   Additional validation error details (field-level errors)
+        #
+        #   @return [Hash{Symbol=>Array<String>}, nil]
+        optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
+
+        # @!attribute doc_url
+        #   URL to documentation about this error
+        #
+        #   @return [String, nil]
+        optional :doc_url, String, nil?: true
+
+        # @!attribute message
+        #   Human-readable error message
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
+        #   Error information
+        #
+        #   @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
+        #
+        #   @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
+        #
+        #   @param doc_url [String, nil] URL to documentation about this error
+        #
+        #   @param message [String] Human-readable error message
+      end
+
+      # @see Sentdm::Models::ContactCreateResponse#meta
+      class Meta < Sentdm::Internal::Type::BaseModel
+        # @!attribute request_id
+        #   Unique identifier for this request (for tracing and support)
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!attribute timestamp
+        #   Server timestamp when the response was generated
+        #
+        #   @return [Time, nil]
+        optional :timestamp, Time
+
+        # @!attribute version
+        #   API version used for this request
+        #
+        #   @return [String, nil]
+        optional :version, String
+
+        # @!method initialize(request_id: nil, timestamp: nil, version: nil)
+        #   Request and response metadata
+        #
+        #   @param request_id [String] Unique identifier for this request (for tracing and support)
+        #
+        #   @param timestamp [Time] Server timestamp when the response was generated
+        #
+        #   @param version [String] API version used for this request
+      end
+    end
+  end
+end

data/lib/sentdm/models/contact_delete_params.rb

@@ -3,7 +3,7 @@
 module Sentdm
   module Models
     # @see Sentdm::Resources::Contacts#delete
-    class ContactDeleteParams < Sentdm::Models::MutationRequest
+    class ContactDeleteParams < Sentdm::Internal::Type::BaseModel
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
@@ -12,14 +12,28 @@ module Sentdm
       #   @return [String]
       required :id, String
 
+      # @!attribute sandbox
+      #   Sandbox flag - when true, the operation is simulated without side effects Useful
+      #   for testing integrations without actual execution
+      #
+      #   @return [Boolean, nil]
+      optional :sandbox, Sentdm::Internal::Type::Boolean
+
       # @!attribute x_profile_id
       #
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(id:, x_profile_id: nil, request_options: {})
+      # @!method initialize(id:, sandbox: nil, x_profile_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::ContactDeleteParams} for more details.
+      #
       #   @param id [String]
+      #
+      #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+      #
       #   @param x_profile_id [String]
+      #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
     end
   end