sentdm 0.1.0 → 0.3.0

data/rbi/sentdm/models/contact_list_params.rbi

@@ -11,26 +11,45 @@ module Sentdm
           T.any(Sentdm::ContactListParams, Sentdm::Internal::AnyHash)
         end
 
-      # The page number (zero-indexed). Default is 0.
+      # Page number (1-indexed)
       sig { returns(Integer) }
       attr_accessor :page
 
-      # The number of items per page. Default is 20.
       sig { returns(Integer) }
       attr_accessor :page_size
 
+      # Optional channel filter (sms, whatsapp)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :channel
+
+      # Optional phone number filter (alternative to list view)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone
+
+      # Optional search term for filtering contacts
+      sig { returns(T.nilable(String)) }
+      attr_accessor :search
+
       sig do
         params(
           page: Integer,
           page_size: Integer,
+          channel: T.nilable(String),
+          phone: T.nilable(String),
+          search: T.nilable(String),
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # The page number (zero-indexed). Default is 0.
+        # Page number (1-indexed)
         page:,
-        # The number of items per page. Default is 20.
         page_size:,
+        # Optional channel filter (sms, whatsapp)
+        channel: nil,
+        # Optional phone number filter (alternative to list view)
+        phone: nil,
+        # Optional search term for filtering contacts
+        search: nil,
         request_options: {}
       )
       end
@@ -40,6 +59,9 @@ module Sentdm
           {
             page: Integer,
             page_size: Integer,
+            channel: T.nilable(String),
+            phone: T.nilable(String),
+            search: T.nilable(String),
             request_options: Sentdm::RequestOptions
           }
         )

data/rbi/sentdm/models/contact_list_response.rbi

@@ -8,67 +8,121 @@ module Sentdm
           T.any(Sentdm::Models::ContactListResponse, Sentdm::Internal::AnyHash)
         end
 
-      sig { returns(T.nilable(T::Array[Sentdm::ContactListItem])) }
-      attr_reader :items
+      # The response data (null if error)
+      sig { returns(T.nilable(Sentdm::Models::ContactListResponse::Data)) }
+      attr_reader :data
 
-      sig { params(items: T::Array[Sentdm::ContactListItem::OrHash]).void }
-      attr_writer :items
-
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :page
-
-      sig { params(page: Integer).void }
-      attr_writer :page
+      sig do
+        params(
+          data: T.nilable(Sentdm::Models::ContactListResponse::Data::OrHash)
+        ).void
+      end
+      attr_writer :data
 
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :page_size
+      # Error details (null if successful)
+      sig { returns(T.nilable(Sentdm::APIError)) }
+      attr_reader :error
 
-      sig { params(page_size: Integer).void }
-      attr_writer :page_size
+      sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
+      attr_writer :error
 
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :total_count
+      # Metadata about the request and response
+      sig { returns(T.nilable(Sentdm::APIMeta)) }
+      attr_reader :meta
 
-      sig { params(total_count: Integer).void }
-      attr_writer :total_count
+      sig { params(meta: Sentdm::APIMeta::OrHash).void }
+      attr_writer :meta
 
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :total_pages
+      # Indicates whether the request was successful
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :success
 
-      sig { params(total_pages: Integer).void }
-      attr_writer :total_pages
+      sig { params(success: T::Boolean).void }
+      attr_writer :success
 
+      # Standard API response envelope for all v3 endpoints
       sig do
         params(
-          items: T::Array[Sentdm::ContactListItem::OrHash],
-          page: Integer,
-          page_size: Integer,
-          total_count: Integer,
-          total_pages: Integer
+          data: T.nilable(Sentdm::Models::ContactListResponse::Data::OrHash),
+          error: T.nilable(Sentdm::APIError::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
-        items: nil,
-        page: nil,
-        page_size: nil,
-        total_count: nil,
-        total_pages: nil
+        # The response data (null if error)
+        data: nil,
+        # Error details (null if successful)
+        error: nil,
+        # Metadata about the request and response
+        meta: nil,
+        # Indicates whether the request was successful
+        success: nil
       )
       end
 
       sig do
         override.returns(
           {
-            items: T::Array[Sentdm::ContactListItem],
-            page: Integer,
-            page_size: Integer,
-            total_count: Integer,
-            total_pages: Integer
+            data: T.nilable(Sentdm::Models::ContactListResponse::Data),
+            error: T.nilable(Sentdm::APIError),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
           }
         )
       end
       def to_hash
       end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::ContactListResponse::Data,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # List of contacts
+        sig { returns(T.nilable(T::Array[Sentdm::Contact])) }
+        attr_reader :contacts
+
+        sig { params(contacts: T::Array[Sentdm::Contact::OrHash]).void }
+        attr_writer :contacts
+
+        # Pagination metadata
+        sig { returns(T.nilable(Sentdm::PaginationMeta)) }
+        attr_reader :pagination
+
+        sig { params(pagination: Sentdm::PaginationMeta::OrHash).void }
+        attr_writer :pagination
+
+        # The response data (null if error)
+        sig do
+          params(
+            contacts: T::Array[Sentdm::Contact::OrHash],
+            pagination: Sentdm::PaginationMeta::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # List of contacts
+          contacts: nil,
+          # Pagination metadata
+          pagination: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              contacts: T::Array[Sentdm::Contact],
+              pagination: Sentdm::PaginationMeta
+            }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/sentdm/models/{message_retrieve_params.rbi → contact_retrieve_params.rbi}

@@ -2,13 +2,13 @@
 
 module Sentdm
   module Models
-    class MessageRetrieveParams < Sentdm::Internal::Type::BaseModel
+    class ContactRetrieveParams < Sentdm::Internal::Type::BaseModel
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
-          T.any(Sentdm::MessageRetrieveParams, Sentdm::Internal::AnyHash)
+          T.any(Sentdm::ContactRetrieveParams, Sentdm::Internal::AnyHash)
         end
 
       sig do

data/rbi/sentdm/models/contact_update_params.rbi

@@ -0,0 +1,73 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ContactUpdateParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::ContactUpdateParams, Sentdm::Internal::AnyHash)
+        end
+
+      # Default messaging channel: "sms" or "whatsapp"
+      sig { returns(T.nilable(String)) }
+      attr_accessor :default_channel
+
+      # Whether the contact has opted out of messaging
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :opt_out
+
+      # Test mode flag - when true, the operation is simulated without side effects
+      # Useful for testing integrations without actual execution
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :test_mode
+
+      sig { params(test_mode: T::Boolean).void }
+      attr_writer :test_mode
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig do
+        params(
+          default_channel: T.nilable(String),
+          opt_out: T.nilable(T::Boolean),
+          test_mode: T::Boolean,
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Default messaging channel: "sms" or "whatsapp"
+        default_channel: nil,
+        # Whether the contact has opted out of messaging
+        opt_out: nil,
+        # Test mode flag - when true, the operation is simulated without side effects
+        # Useful for testing integrations without actual execution
+        test_mode: nil,
+        idempotency_key: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            default_channel: T.nilable(String),
+            opt_out: T.nilable(T::Boolean),
+            test_mode: T::Boolean,
+            idempotency_key: String,
+            request_options: Sentdm::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/destination_country.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class DestinationCountry < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::DestinationCountry, Sentdm::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :is_main
+
+      sig { params(is_main: T::Boolean).void }
+      attr_writer :is_main
+
+      sig { params(id: String, is_main: T::Boolean).returns(T.attached_class) }
+      def self.new(id: nil, is_main: nil)
+      end
+
+      sig { override.returns({ id: String, is_main: T::Boolean }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/lookup_retrieve_phone_info_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class LookupRetrievePhoneInfoParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::LookupRetrievePhoneInfoParams,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: Sentdm::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Sentdm::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/lookup_retrieve_phone_info_response.rbi

@@ -0,0 +1,183 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class LookupRetrievePhoneInfoResponse < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::Models::LookupRetrievePhoneInfoResponse,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      # The response data (null if error)
+      sig do
+        returns(
+          T.nilable(Sentdm::Models::LookupRetrievePhoneInfoResponse::Data)
+        )
+      end
+      attr_reader :data
+
+      sig do
+        params(
+          data:
+            T.nilable(
+              Sentdm::Models::LookupRetrievePhoneInfoResponse::Data::OrHash
+            )
+        ).void
+      end
+      attr_writer :data
+
+      # Error details (null if successful)
+      sig { returns(T.nilable(Sentdm::APIError)) }
+      attr_reader :error
+
+      sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
+      attr_writer :error
+
+      # Metadata about the request and response
+      sig { returns(T.nilable(Sentdm::APIMeta)) }
+      attr_reader :meta
+
+      sig { params(meta: Sentdm::APIMeta::OrHash).void }
+      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::LookupRetrievePhoneInfoResponse::Data::OrHash
+            ),
+          error: T.nilable(Sentdm::APIError::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The response data (null if error)
+        data: nil,
+        # Error details (null if successful)
+        error: nil,
+        # Metadata about the request and response
+        meta: nil,
+        # Indicates whether the request was successful
+        success: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data:
+              T.nilable(Sentdm::Models::LookupRetrievePhoneInfoResponse::Data),
+            error: T.nilable(Sentdm::APIError),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::LookupRetrievePhoneInfoResponse::Data,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :carrier_name
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :is_ported
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_valid
+
+        sig { params(is_valid: T::Boolean).void }
+        attr_writer :is_valid
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :is_voip
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :line_type
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :mobile_country_code
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :mobile_network_code
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :phone_number
+
+        sig { params(phone_number: String).void }
+        attr_writer :phone_number
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :provider
+
+        sig { params(provider: String).void }
+        attr_writer :provider
+
+        # The response data (null if error)
+        sig do
+          params(
+            carrier_name: T.nilable(String),
+            is_ported: T.nilable(T::Boolean),
+            is_valid: T::Boolean,
+            is_voip: T.nilable(T::Boolean),
+            line_type: T.nilable(String),
+            mobile_country_code: T.nilable(String),
+            mobile_network_code: T.nilable(String),
+            phone_number: String,
+            provider: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          carrier_name: nil,
+          is_ported: nil,
+          is_valid: nil,
+          is_voip: nil,
+          line_type: nil,
+          mobile_country_code: nil,
+          mobile_network_code: nil,
+          phone_number: nil,
+          provider: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              carrier_name: T.nilable(String),
+              is_ported: T.nilable(T::Boolean),
+              is_valid: T::Boolean,
+              is_voip: T.nilable(T::Boolean),
+              line_type: T.nilable(String),
+              mobile_country_code: T.nilable(String),
+              mobile_network_code: T.nilable(String),
+              phone_number: String,
+              provider: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/me_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class MeRetrieveParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::MeRetrieveParams, Sentdm::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Sentdm::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Sentdm::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end