sentdm 0.27.0 → 0.28.0

data/rbi/sentdm/models/webhook_update_response.rbi

@@ -0,0 +1,361 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class WebhookUpdateResponse < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::Models::WebhookUpdateResponse,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      # The response data (null if error)
+      sig { returns(T.nilable(Sentdm::Models::WebhookUpdateResponse::Data)) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: T.nilable(Sentdm::Models::WebhookUpdateResponse::Data::OrHash)
+        ).void
+      end
+      attr_writer :data
+
+      # Error information
+      sig { returns(T.nilable(Sentdm::Models::WebhookUpdateResponse::Error)) }
+      attr_reader :error
+
+      sig do
+        params(
+          error: T.nilable(Sentdm::Models::WebhookUpdateResponse::Error::OrHash)
+        ).void
+      end
+      attr_writer :error
+
+      # Request and response metadata
+      sig { returns(T.nilable(Sentdm::Models::WebhookUpdateResponse::Meta)) }
+      attr_reader :meta
+
+      sig do
+        params(meta: Sentdm::Models::WebhookUpdateResponse::Meta::OrHash).void
+      end
+      attr_writer :meta
+
+      # Indicates whether the request was successful
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :success
+
+      sig { params(success: T::Boolean).void }
+      attr_writer :success
+
+      # Standard API response envelope for all v3 endpoints
+      sig do
+        params(
+          data: T.nilable(Sentdm::Models::WebhookUpdateResponse::Data::OrHash),
+          error:
+            T.nilable(Sentdm::Models::WebhookUpdateResponse::Error::OrHash),
+          meta: Sentdm::Models::WebhookUpdateResponse::Meta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The response data (null if error)
+        data: nil,
+        # Error information
+        error: nil,
+        # Request and response metadata
+        meta: nil,
+        # Indicates whether the request was successful
+        success: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T.nilable(Sentdm::Models::WebhookUpdateResponse::Data),
+            error: T.nilable(Sentdm::Models::WebhookUpdateResponse::Error),
+            meta: Sentdm::Models::WebhookUpdateResponse::Meta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::WebhookUpdateResponse::Data,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :consecutive_failures
+
+        sig { params(consecutive_failures: Integer).void }
+        attr_writer :consecutive_failures
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        # 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.
+        sig { returns(T.nilable(String)) }
+        attr_reader :customer_id
+
+        sig { params(customer_id: String).void }
+        attr_writer :customer_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :display_name
+
+        sig { params(display_name: String).void }
+        attr_writer :display_name
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :endpoint_url
+
+        sig { params(endpoint_url: String).void }
+        attr_writer :endpoint_url
+
+        sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
+        attr_accessor :event_filters
+
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :event_types
+
+        sig { params(event_types: T::Array[String]).void }
+        attr_writer :event_types
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_active
+
+        sig { params(is_active: T::Boolean).void }
+        attr_writer :is_active
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :last_delivery_attempt_at
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :last_successful_delivery_at
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :retry_count
+
+        sig { params(retry_count: Integer).void }
+        attr_writer :retry_count
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :signing_secret
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :timeout_seconds
+
+        sig { params(timeout_seconds: Integer).void }
+        attr_writer :timeout_seconds
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :updated_at
+
+        # The response data (null if error)
+        sig do
+          params(
+            id: String,
+            consecutive_failures: Integer,
+            created_at: Time,
+            customer_id: String,
+            display_name: String,
+            endpoint_url: String,
+            event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
+            event_types: T::Array[String],
+            is_active: T::Boolean,
+            last_delivery_attempt_at: T.nilable(Time),
+            last_successful_delivery_at: T.nilable(Time),
+            retry_count: Integer,
+            signing_secret: T.nilable(String),
+            timeout_seconds: Integer,
+            updated_at: T.nilable(Time)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id: nil,
+          consecutive_failures: nil,
+          created_at: nil,
+          # 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.
+          customer_id: nil,
+          display_name: nil,
+          endpoint_url: nil,
+          event_filters: nil,
+          event_types: nil,
+          is_active: nil,
+          last_delivery_attempt_at: nil,
+          last_successful_delivery_at: nil,
+          retry_count: nil,
+          signing_secret: nil,
+          timeout_seconds: nil,
+          updated_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              consecutive_failures: Integer,
+              created_at: Time,
+              customer_id: String,
+              display_name: String,
+              endpoint_url: String,
+              event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
+              event_types: T::Array[String],
+              is_active: T::Boolean,
+              last_delivery_attempt_at: T.nilable(Time),
+              last_successful_delivery_at: T.nilable(Time),
+              retry_count: Integer,
+              signing_secret: T.nilable(String),
+              timeout_seconds: Integer,
+              updated_at: T.nilable(Time)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Error < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::WebhookUpdateResponse::Error,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Machine-readable error code (e.g., "RESOURCE_001")
+        sig { returns(T.nilable(String)) }
+        attr_reader :code
+
+        sig { params(code: String).void }
+        attr_writer :code
+
+        # Additional validation error details (field-level errors)
+        sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
+        attr_accessor :details
+
+        # URL to documentation about this error
+        sig { returns(T.nilable(String)) }
+        attr_accessor :doc_url
+
+        # Human-readable error message
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        # Error information
+        sig do
+          params(
+            code: String,
+            details: T.nilable(T::Hash[Symbol, T::Array[String]]),
+            doc_url: T.nilable(String),
+            message: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Machine-readable error code (e.g., "RESOURCE_001")
+          code: nil,
+          # Additional validation error details (field-level errors)
+          details: nil,
+          # URL to documentation about this error
+          doc_url: nil,
+          # Human-readable error message
+          message: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              code: String,
+              details: T.nilable(T::Hash[Symbol, T::Array[String]]),
+              doc_url: T.nilable(String),
+              message: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Meta < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::WebhookUpdateResponse::Meta,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Unique identifier for this request (for tracing and support)
+        sig { returns(T.nilable(String)) }
+        attr_reader :request_id
+
+        sig { params(request_id: String).void }
+        attr_writer :request_id
+
+        # Server timestamp when the response was generated
+        sig { returns(T.nilable(Time)) }
+        attr_reader :timestamp
+
+        sig { params(timestamp: Time).void }
+        attr_writer :timestamp
+
+        # API version used for this request
+        sig { returns(T.nilable(String)) }
+        attr_reader :version
+
+        sig { params(version: String).void }
+        attr_writer :version
+
+        # Request and response metadata
+        sig do
+          params(request_id: String, timestamp: Time, version: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Unique identifier for this request (for tracing and support)
+          request_id: nil,
+          # Server timestamp when the response was generated
+          timestamp: nil,
+          # API version used for this request
+          version: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { request_id: String, timestamp: Time, version: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models.rbi

@@ -1,46 +1,14 @@
 # typed: strong
 
 module Sentdm
-  APIMeta = Sentdm::Models::APIMeta
-
-  APIResponseOfContact = Sentdm::Models::APIResponseOfContact
-
-  APIResponseOfContactMessageSummary =
-    Sentdm::Models::APIResponseOfContactMessageSummary
-
-  APIResponseOfConversationMessagesList =
-    Sentdm::Models::APIResponseOfConversationMessagesList
-
-  APIResponseOfProfileDetail = Sentdm::Models::APIResponseOfProfileDetail
-
-  APIResponseOfUser = Sentdm::Models::APIResponseOfUser
-
-  APIResponseTemplate = Sentdm::Models::APIResponseTemplate
-
-  APIResponseWebhook = Sentdm::Models::APIResponseWebhook
-
   AuthenticationConfig = Sentdm::Models::AuthenticationConfig
 
-  BillingContactInfo = Sentdm::Models::BillingContactInfo
-
-  BrandBusinessInfo = Sentdm::Models::BrandBusinessInfo
-
-  BrandComplianceInfo = Sentdm::Models::BrandComplianceInfo
-
-  BrandContactInfo = Sentdm::Models::BrandContactInfo
-
-  BrandsBrandData = Sentdm::Models::BrandsBrandData
-
   ContactCreateParams = Sentdm::Models::ContactCreateParams
 
   ContactDeleteParams = Sentdm::Models::ContactDeleteParams
 
   ContactListParams = Sentdm::Models::ContactListParams
 
-  ContactMessageSummary = Sentdm::Models::ContactMessageSummary
-
-  ContactResponse = Sentdm::Models::ContactResponse
-
   ContactRetrieveMessageSummaryParams =
     Sentdm::Models::ContactRetrieveMessageSummaryParams
 
@@ -53,12 +21,8 @@ module Sentdm
 
   ConversationListParams = Sentdm::Models::ConversationListParams
 
-  ConversationMessagesList = Sentdm::Models::ConversationMessagesList
-
   DestinationCountry = Sentdm::Models::DestinationCountry
 
-  ErrorDetail = Sentdm::Models::ErrorDetail
-
   InboundMessageEvent = Sentdm::Models::InboundMessageEvent
 
   InboundMessageEventPayload = Sentdm::Models::InboundMessageEventPayload
@@ -76,38 +40,26 @@ module Sentdm
 
   MessageSendParams = Sentdm::Models::MessageSendParams
 
-  MutationRequest = Sentdm::Models::MutationRequest
-
   NumberLookupParams = Sentdm::Models::NumberLookupParams
 
-  PaginationMeta = Sentdm::Models::PaginationMeta
-
-  PaymentDetails = Sentdm::Models::PaymentDetails
-
   ProfileCompleteParams = Sentdm::Models::ProfileCompleteParams
 
   ProfileCreateParams = Sentdm::Models::ProfileCreateParams
 
   ProfileDeleteParams = Sentdm::Models::ProfileDeleteParams
 
-  ProfileDetail = Sentdm::Models::ProfileDetail
-
   ProfileListParams = Sentdm::Models::ProfileListParams
 
   ProfileRetrieveParams = Sentdm::Models::ProfileRetrieveParams
 
   Profiles = Sentdm::Models::Profiles
 
-  ProfileSettings = Sentdm::Models::ProfileSettings
-
   ProfileUpdateParams = Sentdm::Models::ProfileUpdateParams
 
   TcrBrandRelationship = Sentdm::Models::TcrBrandRelationship
 
   TcrVertical = Sentdm::Models::TcrVertical
 
-  Template = Sentdm::Models::Template
-
   TemplateBody = Sentdm::Models::TemplateBody
 
   TemplateBodyContent = Sentdm::Models::TemplateBodyContent
@@ -144,8 +96,6 @@ module Sentdm
 
   UserRemoveParams = Sentdm::Models::UserRemoveParams
 
-  UserResponse = Sentdm::Models::UserResponse
-
   UserRetrieveParams = Sentdm::Models::UserRetrieveParams
 
   UserUpdateRoleParams = Sentdm::Models::UserUpdateRoleParams
@@ -154,16 +104,12 @@ module Sentdm
 
   WebhookDeleteParams = Sentdm::Models::WebhookDeleteParams
 
-  WebhookEventType = Sentdm::Models::WebhookEventType
-
   WebhookListEventsParams = Sentdm::Models::WebhookListEventsParams
 
   WebhookListEventTypesParams = Sentdm::Models::WebhookListEventTypesParams
 
   WebhookListParams = Sentdm::Models::WebhookListParams
 
-  WebhookResponse = Sentdm::Models::WebhookResponse
-
   WebhookRetrieveParams = Sentdm::Models::WebhookRetrieveParams
 
   WebhookRotateSecretParams = Sentdm::Models::WebhookRotateSecretParams

data/rbi/sentdm/resources/contacts.rbi

@@ -2,7 +2,15 @@
 
 module Sentdm
   module Resources
-    # 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.
     class Contacts
       # Creates a new contact by phone number and associates it with the authenticated
       # customer.
@@ -13,7 +21,7 @@ module Sentdm
           idempotency_key: String,
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::APIResponseOfContact)
+        ).returns(Sentdm::Models::ContactCreateResponse)
       end
       def create(
         # Body param: Phone number of the contact to create
@@ -41,7 +49,7 @@ module Sentdm
           id: String,
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::APIResponseOfContact)
+        ).returns(Sentdm::Models::ContactRetrieveResponse)
       end
       def retrieve(
         # Contact ID from route parameter
@@ -53,8 +61,7 @@ module Sentdm
       )
       end
 
-      # Updates a contact's default channel and/or opt-out status. Inherited contacts
-      # cannot be updated.
+      # Updates a contact's default channel and/or opt-out status.
       sig do
         params(
           id: String,
@@ -64,7 +71,7 @@ module Sentdm
           idempotency_key: String,
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::APIResponseOfContact)
+        ).returns(Sentdm::Models::ContactUpdateResponse)
       end
       def update(
         # Path param: Contact ID from route parameter
@@ -121,8 +128,16 @@ module Sentdm
       )
       end
 
-      # Dissociates a contact from the authenticated customer. Inherited contacts cannot
-      # be deleted.
+      # **Deprecated.** Use `PATCH /v3/contacts/{id}` with `{"opt_out": true}` instead,
+      # and expect this to be removed in a future release. It still behaves exactly as
+      # before, so nothing needs to change today.
+      #
+      # Opting a contact out stops every send to them, which is what deleting one was
+      # mostly used for — and it keeps the record of who they were and that they asked.
+      # A delete discards the consent history along with the contact, which is the part
+      # you need if anyone ever asks why you stopped, or why you started again.
+      #
+      # Dissociates a contact from the authenticated customer.
       sig do
         params(
           id: String,
@@ -154,7 +169,7 @@ module Sentdm
           contact_id: String,
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::APIResponseOfContactMessageSummary)
+        ).returns(Sentdm::Models::ContactRetrieveMessageSummaryResponse)
       end
       def retrieve_message_summary(
         contact_id,

data/rbi/sentdm/resources/conversations.rbi

@@ -2,6 +2,14 @@
 
 module Sentdm
   module Resources
+    # 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.
     class Conversations
       # Retrieves a paginated list of the authenticated customer's messages across all
       # conversations, ordered by created date (most recent first).
@@ -11,7 +19,7 @@ module Sentdm
           page_size: Integer,
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::APIResponseOfConversationMessagesList)
+        ).returns(Sentdm::Models::ConversationListResponse)
       end
       def list(
         # Query param
@@ -35,7 +43,7 @@ module Sentdm
           page_size: Integer,
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::APIResponseOfConversationMessagesList)
+        ).returns(Sentdm::Models::ConversationListMessagesResponse)
       end
       def list_messages(
         # Path param: Conversation id from the route.

data/rbi/sentdm/resources/me.rbi

@@ -2,7 +2,12 @@
 
 module Sentdm
   module Resources
-    # 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.
     class Me
       # Returns the account associated with the provided API key. The response includes
       # account identity, contact information, messaging channel configuration, and —

data/rbi/sentdm/resources/messages.rbi

@@ -2,7 +2,17 @@
 
 module Sentdm
   module Resources
-    # 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.
     class Messages
       # Retrieves the activity log for a specific message. Activities track the message
       # lifecycle including acceptance, processing, sending, delivery, and any errors.

data/rbi/sentdm/resources/numbers.rbi

@@ -2,7 +2,12 @@
 
 module Sentdm
   module Resources
-    # 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.
     class Numbers
       # Retrieves detailed information about a phone number including carrier, line
       # type, porting status, and VoIP detection. Uses the customer's messaging provider