sentdm 0.30.0 → 0.31.0

data/lib/sentdm/resources/templates.rb

@@ -131,16 +131,16 @@ module Sentdm
       # Retrieves a paginated list of message templates for the authenticated customer.
       # Supports filtering by status, category, and search term.
       #
-      # @overload list(page:, page_size:, category: nil, is_welcome_playground: nil, search: nil, status: nil, x_profile_id: nil, request_options: {})
-      #
-      # @param page [Integer] Query param: Page number (1-indexed)
-      #
-      # @param page_size [Integer] Query param: Number of items per page
+      # @overload list(category: nil, is_welcome_playground: nil, page: nil, page_size: nil, search: nil, status: nil, x_profile_id: nil, request_options: {})
       #
       # @param category [String, nil] Query param: Optional category filter: MARKETING, UTILITY, AUTHENTICATION
       #
       # @param is_welcome_playground [Boolean, nil] Query param: Accepted and ignored. It used to filter on the welcome-playground m
       #
+      # @param page [Integer] Query param: Page number (1-indexed)
+      #
+      # @param page_size [Integer] Query param: Number of items per page
+      #
       # @param search [String, nil] Query param: Optional search term for filtering templates
       #
       # @param status [String, nil] Query param: Optional status filter: APPROVED, PENDING, REJECTED
@@ -149,11 +149,11 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::TemplateListResponse]
+      # @return [Sentdm::Internal::TemplatesPage<Sentdm::Models::Template>]
       #
       # @see Sentdm::Models::TemplateListParams
-      def list(params)
-        query_params = [:page, :page_size, :category, :is_welcome_playground, :search, :status]
+      def list(params = {})
+        query_params = [:category, :is_welcome_playground, :page, :page_size, :search, :status]
         parsed, options = Sentdm::TemplateListParams.dump_request(params)
         query = Sentdm::Internal::Util.encode_query_params(parsed.slice(*query_params))
         @client.request(
@@ -161,7 +161,8 @@ module Sentdm
           path: "v3/templates",
           query: query,
           headers: parsed.except(*query_params).transform_keys(x_profile_id: "x-profile-id"),
-          model: Sentdm::Models::TemplateListResponse,
+          page: Sentdm::Internal::TemplatesPage,
+          model: Sentdm::Template,
           options: options
         )
       end

data/lib/sentdm/resources/webhooks.rb

@@ -134,25 +134,25 @@ module Sentdm
       #
       # Retrieves a paginated list of webhooks for the authenticated customer.
       #
-      # @overload list(page:, page_size:, is_active: nil, search: nil, x_profile_id: nil, request_options: {})
+      # @overload list(is_active: nil, page: nil, page_size: nil, search: nil, x_profile_id: nil, request_options: {})
+      #
+      # @param is_active [Boolean, nil] Query param
       #
       # @param page [Integer] Query param
       #
       # @param page_size [Integer] Query param
       #
-      # @param is_active [Boolean, nil] Query param
-      #
       # @param search [String, nil] Query param
       #
       # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::WebhookListResponse]
+      # @return [Sentdm::Internal::WebhooksPage<Sentdm::Models::WebhookResponse>]
       #
       # @see Sentdm::Models::WebhookListParams
-      def list(params)
-        query_params = [:page, :page_size, :is_active, :search]
+      def list(params = {})
+        query_params = [:is_active, :page, :page_size, :search]
         parsed, options = Sentdm::WebhookListParams.dump_request(params)
         query = Sentdm::Internal::Util.encode_query_params(parsed.slice(*query_params))
         @client.request(
@@ -160,7 +160,8 @@ module Sentdm
           path: "v3/webhooks",
           query: query,
           headers: parsed.except(*query_params).transform_keys(x_profile_id: "x-profile-id"),
-          model: Sentdm::Models::WebhookListResponse,
+          page: Sentdm::Internal::WebhooksPage,
+          model: Sentdm::WebhookResponse,
           options: options
         )
       end
@@ -222,7 +223,7 @@ module Sentdm
       #
       # Retrieves a paginated list of delivery events for the specified webhook.
       #
-      # @overload list_events(id, page:, page_size:, search: nil, x_profile_id: nil, request_options: {})
+      # @overload list_events(id, page: nil, page_size: nil, search: nil, x_profile_id: nil, request_options: {})
       #
       # @param id [String] Path param
       #
@@ -236,10 +237,10 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::WebhookListEventsResponse]
+      # @return [Sentdm::Internal::WebhookEventsPage<Sentdm::Models::WebhookListEventsResponse>]
       #
       # @see Sentdm::Models::WebhookListEventsParams
-      def list_events(id, params)
+      def list_events(id, params = {})
         query_params = [:page, :page_size, :search]
         parsed, options = Sentdm::WebhookListEventsParams.dump_request(params)
         query = Sentdm::Internal::Util.encode_query_params(parsed.slice(*query_params))
@@ -248,6 +249,7 @@ module Sentdm
           path: ["v3/webhooks/%1$s/events", id],
           query: query,
           headers: parsed.except(*query_params).transform_keys(x_profile_id: "x-profile-id"),
+          page: Sentdm::Internal::WebhookEventsPage,
           model: Sentdm::Models::WebhookListEventsResponse,
           options: options
         )

data/lib/sentdm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sentdm
-  VERSION = "0.30.0"
+  VERSION = "0.31.0"
 end

data/lib/sentdm.rb

@@ -52,6 +52,11 @@ 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/internal/contacts_page"
+require_relative "sentdm/internal/conversations_page"
+require_relative "sentdm/internal/templates_page"
+require_relative "sentdm/internal/webhook_events_page"
+require_relative "sentdm/internal/webhooks_page"
 require_relative "sentdm/models/mutation_request"
 require_relative "sentdm/models/api_meta"
 require_relative "sentdm/models/api_response_of_contact"
@@ -70,7 +75,6 @@ require_relative "sentdm/models/brands_brand_data"
 require_relative "sentdm/models/contact_create_params"
 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"
@@ -133,7 +137,6 @@ 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_update_params"
 require_relative "sentdm/models/template_variable"
@@ -152,7 +155,6 @@ 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_rotate_secret_params"

data/rbi/sentdm/internal/contacts_page.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Sentdm
+  module Internal
+    class ContactsPage
+      include Sentdm::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(Data) }
+      attr_accessor :data
+
+      # @api private
+      sig { returns(String) }
+      def inspect
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(Data, Sentdm::Internal::AnyHash) }
+
+        sig { returns(T.nilable(T::Array[T.anything])) }
+        attr_reader :contacts
+
+        sig { params(contacts: T::Array[T.anything]).void }
+        attr_writer :contacts
+
+        sig { returns(T.nilable(Data::Pagination)) }
+        attr_reader :pagination
+
+        sig { params(pagination: Data::Pagination::OrHash).void }
+        attr_writer :pagination
+
+        sig do
+          params(
+            contacts: T::Array[T.anything],
+            pagination: Data::Pagination::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(contacts: nil, pagination: nil)
+        end
+
+        sig do
+          override.returns(
+            { contacts: T::Array[T.anything], pagination: Data::Pagination }
+          )
+        end
+        def to_hash
+        end
+
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(Data::Pagination, Sentdm::Internal::AnyHash) }
+
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :has_more
+
+          sig { params(has_more: T::Boolean).void }
+          attr_writer :has_more
+
+          sig { params(has_more: T::Boolean).returns(T.attached_class) }
+          def self.new(has_more: nil)
+          end
+
+          sig { override.returns({ has_more: T::Boolean }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/internal/conversations_page.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Sentdm
+  module Internal
+    class ConversationsPage
+      include Sentdm::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(Data) }
+      attr_accessor :data
+
+      # @api private
+      sig { returns(String) }
+      def inspect
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(Data, Sentdm::Internal::AnyHash) }
+
+        sig { returns(T.nilable(T::Array[T.anything])) }
+        attr_reader :messages
+
+        sig { params(messages: T::Array[T.anything]).void }
+        attr_writer :messages
+
+        sig { returns(T.nilable(Data::Pagination)) }
+        attr_reader :pagination
+
+        sig { params(pagination: Data::Pagination::OrHash).void }
+        attr_writer :pagination
+
+        sig do
+          params(
+            messages: T::Array[T.anything],
+            pagination: Data::Pagination::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(messages: nil, pagination: nil)
+        end
+
+        sig do
+          override.returns(
+            { messages: T::Array[T.anything], pagination: Data::Pagination }
+          )
+        end
+        def to_hash
+        end
+
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(Data::Pagination, Sentdm::Internal::AnyHash) }
+
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :has_more
+
+          sig { params(has_more: T::Boolean).void }
+          attr_writer :has_more
+
+          sig { params(has_more: T::Boolean).returns(T.attached_class) }
+          def self.new(has_more: nil)
+          end
+
+          sig { override.returns({ has_more: T::Boolean }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/internal/templates_page.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Sentdm
+  module Internal
+    class TemplatesPage
+      include Sentdm::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(Data) }
+      attr_accessor :data
+
+      # @api private
+      sig { returns(String) }
+      def inspect
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(Data, Sentdm::Internal::AnyHash) }
+
+        sig { returns(T.nilable(Data::Pagination)) }
+        attr_reader :pagination
+
+        sig { params(pagination: Data::Pagination::OrHash).void }
+        attr_writer :pagination
+
+        sig { returns(T.nilable(T::Array[T.anything])) }
+        attr_reader :templates
+
+        sig { params(templates: T::Array[T.anything]).void }
+        attr_writer :templates
+
+        sig do
+          params(
+            pagination: Data::Pagination::OrHash,
+            templates: T::Array[T.anything]
+          ).returns(T.attached_class)
+        end
+        def self.new(pagination: nil, templates: nil)
+        end
+
+        sig do
+          override.returns(
+            { pagination: Data::Pagination, templates: T::Array[T.anything] }
+          )
+        end
+        def to_hash
+        end
+
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(Data::Pagination, Sentdm::Internal::AnyHash) }
+
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :has_more
+
+          sig { params(has_more: T::Boolean).void }
+          attr_writer :has_more
+
+          sig { params(has_more: T::Boolean).returns(T.attached_class) }
+          def self.new(has_more: nil)
+          end
+
+          sig { override.returns({ has_more: T::Boolean }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/internal/webhook_events_page.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Sentdm
+  module Internal
+    class WebhookEventsPage
+      include Sentdm::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(Data) }
+      attr_accessor :data
+
+      # @api private
+      sig { returns(String) }
+      def inspect
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(Data, Sentdm::Internal::AnyHash) }
+
+        sig { returns(T.nilable(T::Array[T.anything])) }
+        attr_reader :events
+
+        sig { params(events: T::Array[T.anything]).void }
+        attr_writer :events
+
+        sig { returns(T.nilable(Data::Pagination)) }
+        attr_reader :pagination
+
+        sig { params(pagination: Data::Pagination::OrHash).void }
+        attr_writer :pagination
+
+        sig do
+          params(
+            events: T::Array[T.anything],
+            pagination: Data::Pagination::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(events: nil, pagination: nil)
+        end
+
+        sig do
+          override.returns(
+            { events: T::Array[T.anything], pagination: Data::Pagination }
+          )
+        end
+        def to_hash
+        end
+
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(Data::Pagination, Sentdm::Internal::AnyHash) }
+
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :has_more
+
+          sig { params(has_more: T::Boolean).void }
+          attr_writer :has_more
+
+          sig { params(has_more: T::Boolean).returns(T.attached_class) }
+          def self.new(has_more: nil)
+          end
+
+          sig { override.returns({ has_more: T::Boolean }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/internal/webhooks_page.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Sentdm
+  module Internal
+    class WebhooksPage
+      include Sentdm::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(Data) }
+      attr_accessor :data
+
+      # @api private
+      sig { returns(String) }
+      def inspect
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(Data, Sentdm::Internal::AnyHash) }
+
+        sig { returns(T.nilable(Data::Pagination)) }
+        attr_reader :pagination
+
+        sig { params(pagination: Data::Pagination::OrHash).void }
+        attr_writer :pagination
+
+        sig { returns(T.nilable(T::Array[T.anything])) }
+        attr_reader :webhooks
+
+        sig { params(webhooks: T::Array[T.anything]).void }
+        attr_writer :webhooks
+
+        sig do
+          params(
+            pagination: Data::Pagination::OrHash,
+            webhooks: T::Array[T.anything]
+          ).returns(T.attached_class)
+        end
+        def self.new(pagination: nil, webhooks: nil)
+        end
+
+        sig do
+          override.returns(
+            { pagination: Data::Pagination, webhooks: T::Array[T.anything] }
+          )
+        end
+        def to_hash
+        end
+
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(Data::Pagination, Sentdm::Internal::AnyHash) }
+
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :has_more
+
+          sig { params(has_more: T::Boolean).void }
+          attr_writer :has_more
+
+          sig { params(has_more: T::Boolean).returns(T.attached_class) }
+          def self.new(has_more: nil)
+          end
+
+          sig { override.returns({ has_more: T::Boolean }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/contact_list_params.rbi

@@ -11,17 +11,23 @@ module Sentdm
           T.any(Sentdm::ContactListParams, Sentdm::Internal::AnyHash)
         end
 
+      # Optional channel filter (sms, whatsapp)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :channel
+
       # Page number (1-indexed)
-      sig { returns(Integer) }
-      attr_accessor :page
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page
+
+      sig { params(page: Integer).void }
+      attr_writer :page
 
       # Number of items per page
-      sig { returns(Integer) }
-      attr_accessor :page_size
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
 
-      # Optional channel filter (sms, whatsapp)
-      sig { returns(T.nilable(String)) }
-      attr_accessor :channel
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
 
       # Optional phone number filter (alternative to list view)
       sig { returns(T.nilable(String)) }
@@ -39,9 +45,9 @@ module Sentdm
 
       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,
@@ -49,12 +55,12 @@ module Sentdm
         ).returns(T.attached_class)
       end
       def self.new(
-        # Page number (1-indexed)
-        page:,
-        # Number of items per page
-        page_size:,
         # Optional channel filter (sms, whatsapp)
         channel: nil,
+        # Page number (1-indexed)
+        page: nil,
+        # Number of items per page
+        page_size: nil,
         # Optional phone number filter (alternative to list view)
         phone: nil,
         # Optional search term for filtering contacts
@@ -67,9 +73,9 @@ module Sentdm
       sig do
         override.returns(
           {
+            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,

data/rbi/sentdm/models/conversation_list_messages_params.rbi

@@ -17,11 +17,17 @@ module Sentdm
       sig { returns(String) }
       attr_accessor :id
 
-      sig { returns(Integer) }
-      attr_accessor :page
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page
 
-      sig { returns(Integer) }
-      attr_accessor :page_size
+      sig { params(page: Integer).void }
+      attr_writer :page
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
 
       sig { returns(T.nilable(String)) }
       attr_reader :x_profile_id
@@ -40,8 +46,8 @@ module Sentdm
       end
       def self.new(
         id:,
-        page:,
-        page_size:,
+        page: nil,
+        page_size: nil,
         x_profile_id: nil,
         request_options: {}
       )

data/rbi/sentdm/models/conversation_list_params.rbi

@@ -11,11 +11,17 @@ module Sentdm
           T.any(Sentdm::ConversationListParams, Sentdm::Internal::AnyHash)
         end
 
-      sig { returns(Integer) }
-      attr_accessor :page
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page
 
-      sig { returns(Integer) }
-      attr_accessor :page_size
+      sig { params(page: Integer).void }
+      attr_writer :page
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
 
       sig { returns(T.nilable(String)) }
       attr_reader :x_profile_id
@@ -31,7 +37,12 @@ module Sentdm
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(page:, page_size:, x_profile_id: nil, request_options: {})
+      def self.new(
+        page: nil,
+        page_size: nil,
+        x_profile_id: nil,
+        request_options: {}
+      )
       end
 
       sig do