sentdm 0.30.0 → 0.32.0

data/rbi/sentdm/resources/contacts.rbi

@@ -100,22 +100,22 @@ module Sentdm
       # filtering by search term, channel, or phone number.
       sig do
         params(
+          channel: T.nilable(String),
           page: Integer,
           page_size: Integer,
-          channel: T.nilable(String),
           phone: T.nilable(String),
           search: T.nilable(String),
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::Models::ContactListResponse)
+        ).returns(Sentdm::Internal::ContactsPage[Sentdm::ContactResponse])
       end
       def list(
-        # Query param: Page number (1-indexed)
-        page:,
-        # Query param: Number of items per page
-        page_size:,
         # Query param: Optional channel filter (sms, whatsapp)
         channel: nil,
+        # Query param: Page number (1-indexed)
+        page: nil,
+        # Query param: Number of items per page
+        page_size: nil,
         # Query param: Optional phone number filter (alternative to list view)
         phone: nil,
         # Query param: Optional search term for filtering contacts

data/rbi/sentdm/resources/conversations.rbi

@@ -19,13 +19,17 @@ module Sentdm
           page_size: Integer,
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::APIResponseOfConversationMessagesList)
+        ).returns(
+          Sentdm::Internal::ConversationsPage[
+            Sentdm::ConversationMessagesList::Message
+          ]
+        )
       end
       def list(
         # Query param
-        page:,
+        page: nil,
         # Query param
-        page_size:,
+        page_size: nil,
         # Header param: Profile UUID to scope the request to a child profile. Only
         # organization API keys can use this header. The profile must belong to the
         # calling organization.
@@ -43,15 +47,19 @@ module Sentdm
           page_size: Integer,
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::APIResponseOfConversationMessagesList)
+        ).returns(
+          Sentdm::Internal::ConversationsPage[
+            Sentdm::ConversationMessagesList::Message
+          ]
+        )
       end
       def list_messages(
         # Path param: Conversation id from the route.
         id,
         # Query param
-        page:,
+        page: nil,
         # Query param
-        page_size:,
+        page_size: nil,
         # Header param: Profile UUID to scope the request to a child profile. Only
         # organization API keys can use this header. The profile must belong to the
         # calling organization.

data/rbi/sentdm/resources/templates.rbi

@@ -12,7 +12,9 @@ module Sentdm
     class Templates
       # Creates a new message template with header, body, footer, and buttons. The
       # template can be submitted for review immediately or saved as draft for later
-      # submission.
+      # submission. There is no `name` field on create — the display name is derived
+      # from the template's content and can be changed afterwards with
+      # `PUT /v3/templates/{id}`.
       sig do
         params(
           category: T.nilable(String),
@@ -76,7 +78,31 @@ module Sentdm
       end
 
       # Updates an existing template's name, category, language, definition, or submits
-      # it for review.
+      # it for review. While the template is in review (status PENDING, or any channel
+      # awaiting a verdict) its definition, category and language are frozen and a
+      # resubmission is refused — those requests answer 409 CONFLICT_006. The display
+      # name stays editable throughout.
+      #
+      # `definition`, `category` and `language` are editable only from status DRAFT,
+      # REJECTED or APPROVED. An edit to any of them on a template in another state
+      # (PAUSED, DISABLED or REVOKED) is refused with 400 VALIDATION_001 and the detail
+      # "Template (except display name) cannot be updated unless it is in draft or
+      # rejected status"; `name` stays editable in every state. `submit_for_review` on a
+      # PAUSED, DISABLED or REVOKED template is accepted and answers 200, but opens no
+      # review and does not move the status — only the reviewer can reinstate it.
+      #
+      # Editing an APPROVED template is a live edit: the new content is stored
+      # immediately, and sending `submit_for_review: true` re-opens review, which
+      # returns the affected channels to PENDING so they stop sending until they are
+      # approved again. The previously approved content is never sent during re-review.
+      # Watch the per-channel `templates` webhook events rather than assuming the
+      # template-level status.
+      #
+      # Templates provisioned by Sent (light-onboarding templates, whose names carry the
+      # reserved `sent_` prefix) are read-only: every field is refused with 400
+      # VALIDATION*001 and the detail "This template is read-only. Only 'submit for
+      # review' is allowed.", and only `submit_for_review` is accepted. A `name`
+      # starting with `sent*` is refused for the same reason — the prefix is reserved.
       sig do
         params(
           id: String,
@@ -125,21 +151,17 @@ module Sentdm
       # Supports filtering by status, category, and search term.
       sig do
         params(
-          page: Integer,
-          page_size: Integer,
           category: T.nilable(String),
           is_welcome_playground: T.nilable(T::Boolean),
+          page: Integer,
+          page_size: Integer,
           search: T.nilable(String),
           status: T.nilable(String),
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::Models::TemplateListResponse)
+        ).returns(Sentdm::Internal::TemplatesPage[Sentdm::Template])
       end
       def list(
-        # Query param: Page number (1-indexed)
-        page:,
-        # Query param: Number of items per page
-        page_size:,
         # Query param: Optional category filter: MARKETING, UTILITY, AUTHENTICATION
         category: nil,
         # Query param: Accepted and ignored. It used to filter on the welcome-playground
@@ -148,6 +170,10 @@ module Sentdm
         # so a client still passing is_welcome_playground keeps binding instead of the
         # request shape changing under it.
         is_welcome_playground: nil,
+        # Query param: Page number (1-indexed)
+        page: nil,
+        # Query param: Number of items per page
+        page_size: nil,
         # Query param: Optional search term for filtering templates
         search: nil,
         # Query param: Optional status filter: APPROVED, PENDING, REJECTED

data/rbi/sentdm/resources/webhooks.rbi

@@ -123,21 +123,21 @@ module Sentdm
       # Retrieves a paginated list of webhooks for the authenticated customer.
       sig do
         params(
+          is_active: T.nilable(T::Boolean),
           page: Integer,
           page_size: Integer,
-          is_active: T.nilable(T::Boolean),
           search: T.nilable(String),
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::Models::WebhookListResponse)
+        ).returns(Sentdm::Internal::WebhooksPage[Sentdm::WebhookResponse])
       end
       def list(
         # Query param
-        page:,
+        is_active: nil,
         # Query param
-        page_size:,
+        page: nil,
         # Query param
-        is_active: nil,
+        page_size: nil,
         # Query param
         search: nil,
         # Header param: Profile UUID to scope the request to a child profile. Only
@@ -189,15 +189,19 @@ module Sentdm
           search: T.nilable(String),
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::Models::WebhookListEventsResponse)
+        ).returns(
+          Sentdm::Internal::WebhookEventsPage[
+            Sentdm::Models::WebhookListEventsResponse
+          ]
+        )
       end
       def list_events(
         # Path param
         id,
         # Query param
-        page:,
+        page: nil,
         # Query param
-        page_size:,
+        page_size: nil,
         # Query param
         search: nil,
         # Header param: Profile UUID to scope the request to a child profile. Only

data/sig/sentdm/internal/contacts_page.rbs

@@ -0,0 +1,41 @@
+module Sentdm
+  module Internal
+    class ContactsPage[Elem]
+      include Sentdm::Internal::Type::BasePage[Elem]
+
+      attr_accessor data: Data
+
+      def inspect: -> String
+
+      type data = { contacts: ::Array[top], pagination: Data::Pagination }
+      class Data < Sentdm::Internal::Type::BaseModel
+        attr_reader contacts: ::Array[top]?
+
+        def contacts=: (::Array[top]) -> ::Array[top]
+
+        attr_reader pagination: Data::Pagination?
+
+        def pagination=: (Data::Pagination) -> Data::Pagination
+
+        def initialize: (
+          ?contacts: ::Array[top],
+          ?pagination: Data::Pagination
+        ) -> void
+
+        def to_hash: -> { contacts: ::Array[top], pagination: Data::Pagination }
+
+        type pagination = { has_more: bool }
+
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          attr_reader has_more: bool?
+
+          def has_more=: (bool) -> bool
+
+          def initialize: (?has_more: bool) -> void
+
+          def to_hash: -> { has_more: bool }
+        end
+      end
+    end
+  end
+end

data/sig/sentdm/internal/conversations_page.rbs

@@ -0,0 +1,41 @@
+module Sentdm
+  module Internal
+    class ConversationsPage[Elem]
+      include Sentdm::Internal::Type::BasePage[Elem]
+
+      attr_accessor data: Data
+
+      def inspect: -> String
+
+      type data = { messages: ::Array[top], pagination: Data::Pagination }
+      class Data < Sentdm::Internal::Type::BaseModel
+        attr_reader messages: ::Array[top]?
+
+        def messages=: (::Array[top]) -> ::Array[top]
+
+        attr_reader pagination: Data::Pagination?
+
+        def pagination=: (Data::Pagination) -> Data::Pagination
+
+        def initialize: (
+          ?messages: ::Array[top],
+          ?pagination: Data::Pagination
+        ) -> void
+
+        def to_hash: -> { messages: ::Array[top], pagination: Data::Pagination }
+
+        type pagination = { has_more: bool }
+
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          attr_reader has_more: bool?
+
+          def has_more=: (bool) -> bool
+
+          def initialize: (?has_more: bool) -> void
+
+          def to_hash: -> { has_more: bool }
+        end
+      end
+    end
+  end
+end

data/sig/sentdm/internal/templates_page.rbs

@@ -0,0 +1,44 @@
+module Sentdm
+  module Internal
+    class TemplatesPage[Elem]
+      include Sentdm::Internal::Type::BasePage[Elem]
+
+      attr_accessor data: Data
+
+      def inspect: -> String
+
+      type data = { pagination: Data::Pagination, templates: ::Array[top] }
+      class Data < Sentdm::Internal::Type::BaseModel
+        attr_reader pagination: Data::Pagination?
+
+        def pagination=: (Data::Pagination) -> Data::Pagination
+
+        attr_reader templates: ::Array[top]?
+
+        def templates=: (::Array[top]) -> ::Array[top]
+
+        def initialize: (
+          ?pagination: Data::Pagination,
+          ?templates: ::Array[top]
+        ) -> void
+
+        def to_hash: -> {
+          pagination: Data::Pagination,
+          templates: ::Array[top]
+        }
+
+        type pagination = { has_more: bool }
+
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          attr_reader has_more: bool?
+
+          def has_more=: (bool) -> bool
+
+          def initialize: (?has_more: bool) -> void
+
+          def to_hash: -> { has_more: bool }
+        end
+      end
+    end
+  end
+end

data/sig/sentdm/internal/webhook_events_page.rbs

@@ -0,0 +1,41 @@
+module Sentdm
+  module Internal
+    class WebhookEventsPage[Elem]
+      include Sentdm::Internal::Type::BasePage[Elem]
+
+      attr_accessor data: Data
+
+      def inspect: -> String
+
+      type data = { events: ::Array[top], pagination: Data::Pagination }
+      class Data < Sentdm::Internal::Type::BaseModel
+        attr_reader events: ::Array[top]?
+
+        def events=: (::Array[top]) -> ::Array[top]
+
+        attr_reader pagination: Data::Pagination?
+
+        def pagination=: (Data::Pagination) -> Data::Pagination
+
+        def initialize: (
+          ?events: ::Array[top],
+          ?pagination: Data::Pagination
+        ) -> void
+
+        def to_hash: -> { events: ::Array[top], pagination: Data::Pagination }
+
+        type pagination = { has_more: bool }
+
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          attr_reader has_more: bool?
+
+          def has_more=: (bool) -> bool
+
+          def initialize: (?has_more: bool) -> void
+
+          def to_hash: -> { has_more: bool }
+        end
+      end
+    end
+  end
+end

data/sig/sentdm/internal/webhooks_page.rbs

@@ -0,0 +1,41 @@
+module Sentdm
+  module Internal
+    class WebhooksPage[Elem]
+      include Sentdm::Internal::Type::BasePage[Elem]
+
+      attr_accessor data: Data
+
+      def inspect: -> String
+
+      type data = { pagination: Data::Pagination, webhooks: ::Array[top] }
+      class Data < Sentdm::Internal::Type::BaseModel
+        attr_reader pagination: Data::Pagination?
+
+        def pagination=: (Data::Pagination) -> Data::Pagination
+
+        attr_reader webhooks: ::Array[top]?
+
+        def webhooks=: (::Array[top]) -> ::Array[top]
+
+        def initialize: (
+          ?pagination: Data::Pagination,
+          ?webhooks: ::Array[top]
+        ) -> void
+
+        def to_hash: -> { pagination: Data::Pagination, webhooks: ::Array[top] }
+
+        type pagination = { has_more: bool }
+
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          attr_reader has_more: bool?
+
+          def has_more=: (bool) -> bool
+
+          def initialize: (?has_more: bool) -> void
+
+          def to_hash: -> { has_more: bool }
+        end
+      end
+    end
+  end
+end

data/sig/sentdm/models/channel_event.rbs

@@ -0,0 +1,44 @@
+module Sentdm
+  module Models
+    type channel_event =
+      {
+        event: String?,
+        field: String,
+        payload: Sentdm::ChannelEventPayload?,
+        request_id: String?,
+        timestamp: String
+      }
+
+    class ChannelEvent < Sentdm::Internal::Type::BaseModel
+      attr_accessor event: String?
+
+      attr_reader field: String?
+
+      def field=: (String) -> String
+
+      attr_accessor payload: Sentdm::ChannelEventPayload?
+
+      attr_accessor request_id: String?
+
+      attr_reader timestamp: String?
+
+      def timestamp=: (String) -> String
+
+      def initialize: (
+        ?event: String?,
+        ?field: String,
+        ?payload: Sentdm::ChannelEventPayload?,
+        ?request_id: String?,
+        ?timestamp: String
+      ) -> void
+
+      def to_hash: -> {
+        event: String?,
+        field: String,
+        payload: Sentdm::ChannelEventPayload?,
+        request_id: String?,
+        timestamp: String
+      }
+    end
+  end
+end

data/sig/sentdm/models/channel_event_payload.rbs

@@ -0,0 +1,63 @@
+module Sentdm
+  module Models
+    type channel_event_payload =
+      {
+        country: String,
+        account_id: String,
+        channel: String,
+        number_type: String?,
+        reason: String?,
+        sender_value: String?,
+        status: String,
+        updated_at: String
+      }
+
+    class ChannelEventPayload < Sentdm::Internal::Type::BaseModel
+      attr_accessor country: String
+
+      attr_reader account_id: String?
+
+      def account_id=: (String) -> String
+
+      attr_reader channel: String?
+
+      def channel=: (String) -> String
+
+      attr_accessor number_type: String?
+
+      attr_accessor reason: String?
+
+      attr_accessor sender_value: String?
+
+      attr_reader status: String?
+
+      def status=: (String) -> String
+
+      attr_reader updated_at: String?
+
+      def updated_at=: (String) -> String
+
+      def initialize: (
+        country: String,
+        ?account_id: String,
+        ?channel: String,
+        ?number_type: String?,
+        ?reason: String?,
+        ?sender_value: String?,
+        ?status: String,
+        ?updated_at: String
+      ) -> void
+
+      def to_hash: -> {
+        country: String,
+        account_id: String,
+        channel: String,
+        number_type: String?,
+        reason: String?,
+        sender_value: String?,
+        status: String,
+        updated_at: String
+      }
+    end
+  end
+end

data/sig/sentdm/models/contact_event.rbs

@@ -0,0 +1,44 @@
+module Sentdm
+  module Models
+    type contact_event =
+      {
+        event: String?,
+        field: String,
+        payload: Sentdm::ContactEventPayload?,
+        request_id: String?,
+        timestamp: String
+      }
+
+    class ContactEvent < Sentdm::Internal::Type::BaseModel
+      attr_accessor event: String?
+
+      attr_reader field: String?
+
+      def field=: (String) -> String
+
+      attr_accessor payload: Sentdm::ContactEventPayload?
+
+      attr_accessor request_id: String?
+
+      attr_reader timestamp: String?
+
+      def timestamp=: (String) -> String
+
+      def initialize: (
+        ?event: String?,
+        ?field: String,
+        ?payload: Sentdm::ContactEventPayload?,
+        ?request_id: String?,
+        ?timestamp: String
+      ) -> void
+
+      def to_hash: -> {
+        event: String?,
+        field: String,
+        payload: Sentdm::ContactEventPayload?,
+        request_id: String?,
+        timestamp: String
+      }
+    end
+  end
+end

data/sig/sentdm/models/contact_event_payload.rbs

@@ -0,0 +1,63 @@
+module Sentdm
+  module Models
+    type contact_event_payload =
+      {
+        opt_out: bool,
+        source: String,
+        account_id: String,
+        channel: String,
+        contact_id: String,
+        message_id: String?,
+        phone_number: String,
+        text: String?
+      }
+
+    class ContactEventPayload < Sentdm::Internal::Type::BaseModel
+      attr_accessor opt_out: bool
+
+      attr_accessor source: String
+
+      attr_reader account_id: String?
+
+      def account_id=: (String) -> String
+
+      attr_reader channel: String?
+
+      def channel=: (String) -> String
+
+      attr_reader contact_id: String?
+
+      def contact_id=: (String) -> String
+
+      attr_accessor message_id: String?
+
+      attr_reader phone_number: String?
+
+      def phone_number=: (String) -> String
+
+      attr_accessor text: String?
+
+      def initialize: (
+        opt_out: bool,
+        source: String,
+        ?account_id: String,
+        ?channel: String,
+        ?contact_id: String,
+        ?message_id: String?,
+        ?phone_number: String,
+        ?text: String?
+      ) -> void
+
+      def to_hash: -> {
+        opt_out: bool,
+        source: String,
+        account_id: String,
+        channel: String,
+        contact_id: String,
+        message_id: String?,
+        phone_number: String,
+        text: String?
+      }
+    end
+  end
+end

data/sig/sentdm/models/contact_list_params.rbs

@@ -2,9 +2,9 @@ module Sentdm
   module Models
     type contact_list_params =
       {
+        channel: String?,
         page: Integer,
         page_size: Integer,
-        channel: String?,
         phone: String?,
         search: String?,
         x_profile_id: String
@@ -15,11 +15,15 @@ module Sentdm
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
-      attr_accessor page: Integer
+      attr_accessor channel: String?
 
-      attr_accessor page_size: Integer
+      attr_reader page: Integer?
 
-      attr_accessor channel: String?
+      def page=: (Integer) -> Integer
+
+      attr_reader page_size: Integer?
+
+      def page_size=: (Integer) -> Integer
 
       attr_accessor phone: String?
 
@@ -30,9 +34,9 @@ module Sentdm
       def x_profile_id=: (String) -> String
 
       def initialize: (
-        page: Integer,
-        page_size: Integer,
         ?channel: String?,
+        ?page: Integer,
+        ?page_size: Integer,
         ?phone: String?,
         ?search: String?,
         ?x_profile_id: String,
@@ -40,9 +44,9 @@ module Sentdm
       ) -> void
 
       def to_hash: -> {
+        channel: String?,
         page: Integer,
         page_size: Integer,
-        channel: String?,
         phone: String?,
         search: String?,
         x_profile_id: String,