sentdm 0.26.0 → 0.28.0

data/lib/sentdm.rb

@@ -52,37 +52,29 @@ require_relative "sentdm/errors"
 require_relative "sentdm/internal/transport/base_client"
 require_relative "sentdm/internal/transport/pooled_net_requester"
 require_relative "sentdm/client"
-require_relative "sentdm/models/mutation_request"
-require_relative "sentdm/models/api_meta"
-require_relative "sentdm/models/api_response_of_contact"
-require_relative "sentdm/models/api_response_of_contact_message_summary"
-require_relative "sentdm/models/api_response_of_conversation_messages_list"
-require_relative "sentdm/models/api_response_of_profile_detail"
-require_relative "sentdm/models/api_response_of_user"
-require_relative "sentdm/models/api_response_template"
-require_relative "sentdm/models/api_response_webhook"
 require_relative "sentdm/models/authentication_config"
-require_relative "sentdm/models/billing_contact_info"
-require_relative "sentdm/models/brand_business_info"
-require_relative "sentdm/models/brand_compliance_info"
-require_relative "sentdm/models/brand_contact_info"
-require_relative "sentdm/models/brands_brand_data"
 require_relative "sentdm/models/contact_create_params"
+require_relative "sentdm/models/contact_create_response"
 require_relative "sentdm/models/contact_delete_params"
 require_relative "sentdm/models/contact_list_params"
 require_relative "sentdm/models/contact_list_response"
-require_relative "sentdm/models/contact_message_summary"
-require_relative "sentdm/models/contact_response"
 require_relative "sentdm/models/contact_retrieve_message_summary_params"
+require_relative "sentdm/models/contact_retrieve_message_summary_response"
 require_relative "sentdm/models/contact_retrieve_params"
+require_relative "sentdm/models/contact_retrieve_response"
 require_relative "sentdm/models/contact_update_params"
+require_relative "sentdm/models/contact_update_response"
 require_relative "sentdm/models/conversation_list_messages_params"
+require_relative "sentdm/models/conversation_list_messages_response"
 require_relative "sentdm/models/conversation_list_params"
-require_relative "sentdm/models/conversation_messages_list"
+require_relative "sentdm/models/conversation_list_response"
 require_relative "sentdm/models/destination_country"
-require_relative "sentdm/models/error_detail"
+require_relative "sentdm/models/inbound_message_event"
+require_relative "sentdm/models/inbound_message_event_payload"
 require_relative "sentdm/models/me_retrieve_params"
 require_relative "sentdm/models/me_retrieve_response"
+require_relative "sentdm/models/message_event"
+require_relative "sentdm/models/message_event_payload"
 require_relative "sentdm/models/message_retrieve_activities_params"
 require_relative "sentdm/models/message_retrieve_activities_response"
 require_relative "sentdm/models/message_retrieve_status_params"
@@ -91,70 +83,74 @@ require_relative "sentdm/models/message_send_params"
 require_relative "sentdm/models/message_send_response"
 require_relative "sentdm/models/number_lookup_params"
 require_relative "sentdm/models/number_lookup_response"
-require_relative "sentdm/models/pagination_meta"
-require_relative "sentdm/models/payment_details"
 require_relative "sentdm/models/profile_complete_params"
 require_relative "sentdm/models/profile_complete_response"
 require_relative "sentdm/models/profile_create_params"
+require_relative "sentdm/models/profile_create_response"
 require_relative "sentdm/models/profile_delete_params"
-require_relative "sentdm/models/profile_detail"
 require_relative "sentdm/models/profile_list_params"
 require_relative "sentdm/models/profile_list_response"
 require_relative "sentdm/models/profile_retrieve_params"
-require_relative "sentdm/models/profiles/api_response_of_brand_campaign"
-require_relative "sentdm/models/profiles/api_response_of_list_of_brand_campaign"
-require_relative "sentdm/models/profiles/brand_campaign"
+require_relative "sentdm/models/profile_retrieve_response"
 require_relative "sentdm/models/profiles/campaign_create_params"
-require_relative "sentdm/models/profiles/campaign_data"
+require_relative "sentdm/models/profiles/campaign_create_response"
 require_relative "sentdm/models/profiles/campaign_delete_params"
 require_relative "sentdm/models/profiles/campaign_list_params"
+require_relative "sentdm/models/profiles/campaign_list_response"
 require_relative "sentdm/models/profiles/campaign_update_params"
-require_relative "sentdm/models/profiles/campaign_use_case"
-require_relative "sentdm/models/profiles/campaign_use_case_data"
+require_relative "sentdm/models/profiles/campaign_update_response"
 require_relative "sentdm/models/profiles/messaging_use_case_us"
-require_relative "sentdm/models/profile_settings"
 require_relative "sentdm/models/profile_update_params"
+require_relative "sentdm/models/profile_update_response"
 require_relative "sentdm/models/tcr_brand_relationship"
 require_relative "sentdm/models/tcr_vertical"
-require_relative "sentdm/models/template"
 require_relative "sentdm/models/template_body"
 require_relative "sentdm/models/template_body_content"
 require_relative "sentdm/models/template_button"
 require_relative "sentdm/models/template_button_props"
 require_relative "sentdm/models/template_create_params"
+require_relative "sentdm/models/template_create_response"
 require_relative "sentdm/models/template_definition"
 require_relative "sentdm/models/template_delete_params"
+require_relative "sentdm/models/template_event"
+require_relative "sentdm/models/template_event_payload"
 require_relative "sentdm/models/template_footer"
 require_relative "sentdm/models/template_header"
 require_relative "sentdm/models/template_list_params"
 require_relative "sentdm/models/template_list_response"
 require_relative "sentdm/models/template_retrieve_params"
+require_relative "sentdm/models/template_retrieve_response"
 require_relative "sentdm/models/template_update_params"
+require_relative "sentdm/models/template_update_response"
 require_relative "sentdm/models/template_variable"
 require_relative "sentdm/models/user_invite_params"
+require_relative "sentdm/models/user_invite_response"
 require_relative "sentdm/models/user_list_params"
 require_relative "sentdm/models/user_list_response"
 require_relative "sentdm/models/user_remove_params"
-require_relative "sentdm/models/user_response"
 require_relative "sentdm/models/user_retrieve_params"
+require_relative "sentdm/models/user_retrieve_response"
 require_relative "sentdm/models/user_update_role_params"
+require_relative "sentdm/models/user_update_role_response"
 require_relative "sentdm/models/webhook_create_params"
+require_relative "sentdm/models/webhook_create_response"
 require_relative "sentdm/models/webhook_delete_params"
-require_relative "sentdm/models/webhook_event_type"
 require_relative "sentdm/models/webhook_list_events_params"
 require_relative "sentdm/models/webhook_list_events_response"
 require_relative "sentdm/models/webhook_list_event_types_params"
 require_relative "sentdm/models/webhook_list_event_types_response"
 require_relative "sentdm/models/webhook_list_params"
 require_relative "sentdm/models/webhook_list_response"
-require_relative "sentdm/models/webhook_response"
 require_relative "sentdm/models/webhook_retrieve_params"
+require_relative "sentdm/models/webhook_retrieve_response"
 require_relative "sentdm/models/webhook_rotate_secret_params"
 require_relative "sentdm/models/webhook_rotate_secret_response"
 require_relative "sentdm/models/webhook_test_params"
 require_relative "sentdm/models/webhook_test_response"
 require_relative "sentdm/models/webhook_toggle_status_params"
+require_relative "sentdm/models/webhook_toggle_status_response"
 require_relative "sentdm/models/webhook_update_params"
+require_relative "sentdm/models/webhook_update_response"
 require_relative "sentdm/models"
 require_relative "sentdm/resources/contacts"
 require_relative "sentdm/resources/conversations"

data/rbi/sentdm/client.rbi

@@ -15,38 +15,101 @@ module Sentdm
     sig { returns(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.
     sig { returns(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.
     sig { returns(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.
     sig { returns(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.
     sig { returns(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.
     sig { returns(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.
     sig { returns(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.
     sig { returns(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.
     sig { returns(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.
     sig { returns(Sentdm::Resources::Me) }
     attr_reader :me
 

data/rbi/sentdm/models/contact_create_response.rbi

@@ -0,0 +1,407 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ContactCreateResponse < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::Models::ContactCreateResponse,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      # Contact response for v3 API Uses snake_case for JSON property names
+      sig { returns(T.nilable(Sentdm::Models::ContactCreateResponse::Data)) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: T.nilable(Sentdm::Models::ContactCreateResponse::Data::OrHash)
+        ).void
+      end
+      attr_writer :data
+
+      # Error information
+      sig { returns(T.nilable(Sentdm::Models::ContactCreateResponse::Error)) }
+      attr_reader :error
+
+      sig do
+        params(
+          error: T.nilable(Sentdm::Models::ContactCreateResponse::Error::OrHash)
+        ).void
+      end
+      attr_writer :error
+
+      # Request and response metadata
+      sig { returns(T.nilable(Sentdm::Models::ContactCreateResponse::Meta)) }
+      attr_reader :meta
+
+      sig do
+        params(meta: Sentdm::Models::ContactCreateResponse::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::ContactCreateResponse::Data::OrHash),
+          error:
+            T.nilable(Sentdm::Models::ContactCreateResponse::Error::OrHash),
+          meta: Sentdm::Models::ContactCreateResponse::Meta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Contact response for v3 API Uses snake_case for JSON property names
+        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::ContactCreateResponse::Data),
+            error: T.nilable(Sentdm::Models::ContactCreateResponse::Error),
+            meta: Sentdm::Models::ContactCreateResponse::Meta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::ContactCreateResponse::Data,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Unique identifier for the contact
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
+        sig { returns(T.nilable(String)) }
+        attr_reader :available_channels
+
+        sig { params(available_channels: String).void }
+        attr_writer :available_channels
+
+        # Country calling code (e.g., 1 for US/Canada)
+        sig { returns(T.nilable(String)) }
+        attr_reader :country_code
+
+        sig { params(country_code: String).void }
+        attr_writer :country_code
+
+        # When the contact was created
+        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
+
+        # Default messaging channel to use (e.g., "sms" or "whatsapp")
+        sig { returns(T.nilable(String)) }
+        attr_reader :default_channel
+
+        sig { params(default_channel: String).void }
+        attr_writer :default_channel
+
+        # Phone number in E.164 format (e.g., +1234567890)
+        sig { returns(T.nilable(String)) }
+        attr_reader :format_e164
+
+        sig { params(format_e164: String).void }
+        attr_writer :format_e164
+
+        # Phone number in international format (e.g., +1 234-567-890)
+        sig { returns(T.nilable(String)) }
+        attr_reader :format_international
+
+        sig { params(format_international: String).void }
+        attr_writer :format_international
+
+        # Phone number in national format (e.g., (234) 567-890)
+        sig { returns(T.nilable(String)) }
+        attr_reader :format_national
+
+        sig { params(format_national: String).void }
+        attr_writer :format_national
+
+        # Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
+        sig { returns(T.nilable(String)) }
+        attr_reader :format_rfc
+
+        sig { params(format_rfc: String).void }
+        attr_writer :format_rfc
+
+        # 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.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_inherited
+
+        sig { params(is_inherited: T::Boolean).void }
+        attr_writer :is_inherited
+
+        # Whether the contact has opted out of messaging. Single source of truth — opt-out
+        # is per-contact, not per-channel.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :opt_out
+
+        sig { params(opt_out: T::Boolean).void }
+        attr_writer :opt_out
+
+        # Phone number in original format
+        sig { returns(T.nilable(String)) }
+        attr_reader :phone_number
+
+        sig { params(phone_number: String).void }
+        attr_writer :phone_number
+
+        # ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+        sig { returns(T.nilable(String)) }
+        attr_reader :region_code
+
+        sig { params(region_code: String).void }
+        attr_writer :region_code
+
+        # When the contact was last updated
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :updated_at
+
+        # Contact response for v3 API Uses snake_case for JSON property names
+        sig do
+          params(
+            id: String,
+            available_channels: String,
+            country_code: String,
+            created_at: Time,
+            customer_id: String,
+            default_channel: String,
+            format_e164: String,
+            format_international: String,
+            format_national: String,
+            format_rfc: String,
+            is_inherited: T::Boolean,
+            opt_out: T::Boolean,
+            phone_number: String,
+            region_code: String,
+            updated_at: T.nilable(Time)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique identifier for the contact
+          id: nil,
+          # Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
+          available_channels: nil,
+          # Country calling code (e.g., 1 for US/Canada)
+          country_code: nil,
+          # When the contact was created
+          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,
+          # Default messaging channel to use (e.g., "sms" or "whatsapp")
+          default_channel: nil,
+          # Phone number in E.164 format (e.g., +1234567890)
+          format_e164: nil,
+          # Phone number in international format (e.g., +1 234-567-890)
+          format_international: nil,
+          # Phone number in national format (e.g., (234) 567-890)
+          format_national: nil,
+          # Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
+          format_rfc: nil,
+          # 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.
+          is_inherited: nil,
+          # Whether the contact has opted out of messaging. Single source of truth — opt-out
+          # is per-contact, not per-channel.
+          opt_out: nil,
+          # Phone number in original format
+          phone_number: nil,
+          # ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+          region_code: nil,
+          # When the contact was last updated
+          updated_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              available_channels: String,
+              country_code: String,
+              created_at: Time,
+              customer_id: String,
+              default_channel: String,
+              format_e164: String,
+              format_international: String,
+              format_national: String,
+              format_rfc: String,
+              is_inherited: T::Boolean,
+              opt_out: T::Boolean,
+              phone_number: String,
+              region_code: String,
+              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::ContactCreateResponse::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::ContactCreateResponse::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