sentdm 0.0.2

data/rbi/sentdm/models/template_response.rbi

@@ -0,0 +1,149 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class TemplateResponse < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::TemplateResponse, Sentdm::Internal::AnyHash)
+        end
+
+      # The unique identifier of the template
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # The template category (e.g., MARKETING, UTILITY, AUTHENTICATION)
+      sig { returns(T.nilable(String)) }
+      attr_reader :category
+
+      sig { params(category: String).void }
+      attr_writer :category
+
+      # The date and time when the template was created
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at
+
+      sig { params(created_at: Time).void }
+      attr_writer :created_at
+
+      # The complete template definition including header, body, footer, and buttons
+      sig { returns(T.nilable(Sentdm::TemplateDefinition)) }
+      attr_reader :definition
+
+      sig { params(definition: Sentdm::TemplateDefinition::OrHash).void }
+      attr_writer :definition
+
+      # The display name of the template (auto-generated if not provided)
+      sig { returns(T.nilable(String)) }
+      attr_reader :display_name
+
+      sig { params(display_name: String).void }
+      attr_writer :display_name
+
+      # Indicates whether the template is published and available for use
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :is_published
+
+      sig { params(is_published: T::Boolean).void }
+      attr_writer :is_published
+
+      # The template language code (e.g., en_US, es_ES)
+      sig { returns(T.nilable(String)) }
+      attr_reader :language
+
+      sig { params(language: String).void }
+      attr_writer :language
+
+      # The approval status of the template (e.g., APPROVED, PENDING, REJECTED, DRAFT)
+      sig { returns(T.nilable(String)) }
+      attr_reader :status
+
+      sig { params(status: String).void }
+      attr_writer :status
+
+      # The date and time when the template was last updated
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :updated_at
+
+      # The WhatsApp Business API template ID from Meta
+      sig { returns(T.nilable(String)) }
+      attr_reader :whatsapp_template_id
+
+      sig { params(whatsapp_template_id: String).void }
+      attr_writer :whatsapp_template_id
+
+      # The WhatsApp template name as registered with Meta
+      sig { returns(T.nilable(String)) }
+      attr_reader :whatsapp_template_name
+
+      sig { params(whatsapp_template_name: String).void }
+      attr_writer :whatsapp_template_name
+
+      # Represents a message template with comprehensive metadata including definition
+      # structure
+      sig do
+        params(
+          id: String,
+          category: String,
+          created_at: Time,
+          definition: Sentdm::TemplateDefinition::OrHash,
+          display_name: String,
+          is_published: T::Boolean,
+          language: String,
+          status: String,
+          updated_at: T.nilable(Time),
+          whatsapp_template_id: String,
+          whatsapp_template_name: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier of the template
+        id: nil,
+        # The template category (e.g., MARKETING, UTILITY, AUTHENTICATION)
+        category: nil,
+        # The date and time when the template was created
+        created_at: nil,
+        # The complete template definition including header, body, footer, and buttons
+        definition: nil,
+        # The display name of the template (auto-generated if not provided)
+        display_name: nil,
+        # Indicates whether the template is published and available for use
+        is_published: nil,
+        # The template language code (e.g., en_US, es_ES)
+        language: nil,
+        # The approval status of the template (e.g., APPROVED, PENDING, REJECTED, DRAFT)
+        status: nil,
+        # The date and time when the template was last updated
+        updated_at: nil,
+        # The WhatsApp Business API template ID from Meta
+        whatsapp_template_id: nil,
+        # The WhatsApp template name as registered with Meta
+        whatsapp_template_name: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            category: String,
+            created_at: Time,
+            definition: Sentdm::TemplateDefinition,
+            display_name: String,
+            is_published: T::Boolean,
+            language: String,
+            status: String,
+            updated_at: T.nilable(Time),
+            whatsapp_template_id: String,
+            whatsapp_template_name: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/template_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class TemplateRetrieveParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::TemplateRetrieveParams, 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/template_variable.rbi

@@ -0,0 +1,120 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class TemplateVariable < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::TemplateVariable, Sentdm::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :id
+
+      sig { params(id: Integer).void }
+      attr_writer :id
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      sig { returns(T.nilable(Sentdm::TemplateVariable::Props)) }
+      attr_reader :props
+
+      sig { params(props: Sentdm::TemplateVariable::Props::OrHash).void }
+      attr_writer :props
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :type
+
+      sig { params(type: String).void }
+      attr_writer :type
+
+      sig do
+        params(
+          id: Integer,
+          name: String,
+          props: Sentdm::TemplateVariable::Props::OrHash,
+          type: String
+        ).returns(T.attached_class)
+      end
+      def self.new(id: nil, name: nil, props: nil, type: nil)
+      end
+
+      sig do
+        override.returns(
+          {
+            id: Integer,
+            name: String,
+            props: Sentdm::TemplateVariable::Props,
+            type: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Props < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::TemplateVariable::Props, Sentdm::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :alt
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :media_type
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :sample
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :short_url
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :url
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :variable_type
+
+        sig do
+          params(
+            alt: T.nilable(String),
+            media_type: T.nilable(String),
+            sample: T.nilable(String),
+            short_url: T.nilable(String),
+            url: T.nilable(String),
+            variable_type: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          alt: nil,
+          media_type: nil,
+          sample: nil,
+          short_url: nil,
+          url: nil,
+          variable_type: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              alt: T.nilable(String),
+              media_type: T.nilable(String),
+              sample: T.nilable(String),
+              short_url: T.nilable(String),
+              url: T.nilable(String),
+              variable_type: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Sentdm
+  ContactListItem = Sentdm::Models::ContactListItem
+
+  ContactListParams = Sentdm::Models::ContactListParams
+
+  ContactRetrieveByPhoneParams = Sentdm::Models::ContactRetrieveByPhoneParams
+
+  ContactRetrieveIDParams = Sentdm::Models::ContactRetrieveIDParams
+
+  MessageRetrieveParams = Sentdm::Models::MessageRetrieveParams
+
+  MessageSendQuickMessageParams = Sentdm::Models::MessageSendQuickMessageParams
+
+  MessageSendToContactParams = Sentdm::Models::MessageSendToContactParams
+
+  MessageSendToPhoneParams = Sentdm::Models::MessageSendToPhoneParams
+
+  NumberLookupRetrieveParams = Sentdm::Models::NumberLookupRetrieveParams
+
+  OrganizationListParams = Sentdm::Models::OrganizationListParams
+
+  OrganizationRetrieveProfilesParams =
+    Sentdm::Models::OrganizationRetrieveProfilesParams
+
+  Organizations = Sentdm::Models::Organizations
+
+  ProfileSummary = Sentdm::Models::ProfileSummary
+
+  TemplateBodyContent = Sentdm::Models::TemplateBodyContent
+
+  TemplateCreateParams = Sentdm::Models::TemplateCreateParams
+
+  TemplateDefinition = Sentdm::Models::TemplateDefinition
+
+  TemplateDeleteParams = Sentdm::Models::TemplateDeleteParams
+
+  TemplateListParams = Sentdm::Models::TemplateListParams
+
+  TemplateResponse = Sentdm::Models::TemplateResponse
+
+  TemplateRetrieveParams = Sentdm::Models::TemplateRetrieveParams
+
+  TemplateVariable = Sentdm::Models::TemplateVariable
+end

data/rbi/sentdm/request_options.rbi

@@ -0,0 +1,55 @@
+# typed: strong
+
+module Sentdm
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < Sentdm::Internal::Type::BaseModel
+    OrHash =
+      T.type_alias { T.any(Sentdm::RequestOptions, Sentdm::Internal::AnyHash) }
+
+    # @api private
+    sig { params(opts: Sentdm::RequestOptions::OrHash).void }
+    def self.validate!(opts)
+    end
+
+    # Idempotency key to send with request and all associated retries. Will only be
+    # sent for write requests.
+    sig { returns(T.nilable(String)) }
+    attr_accessor :idempotency_key
+
+    # Extra query params to send with the request. These are `.merge`’d into any
+    # `query` given at the client level.
+    sig do
+      returns(
+        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
+      )
+    end
+    attr_accessor :extra_query
+
+    # Extra headers to send with the request. These are `.merged`’d into any
+    # `extra_headers` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+    attr_accessor :extra_headers
+
+    # Extra data to send with the request. These are deep merged into any data
+    # generated as part of the normal request.
+    sig { returns(T.nilable(T.anything)) }
+    attr_accessor :extra_body
+
+    # Maximum number of retries to attempt after a failed initial request.
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_retries
+
+    # Request timeout in seconds.
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    # Returns a new instance of RequestOptions.
+    sig { params(values: Sentdm::Internal::AnyHash).returns(T.attached_class) }
+    def self.new(values = {})
+    end
+  end
+end

data/rbi/sentdm/resources/contacts.rbi

@@ -0,0 +1,63 @@
+# typed: strong
+
+module Sentdm
+  module Resources
+    class Contacts
+      # Retrieves a paginated list of contacts for the authenticated customer. Supports
+      # server-side pagination with configurable page size. The customer ID is extracted
+      # from the authentication token.
+      sig do
+        params(
+          page: Integer,
+          page_size: Integer,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::Models::ContactListResponse)
+      end
+      def list(
+        # The page number (zero-indexed). Default is 0.
+        page:,
+        # The number of items per page. Default is 20.
+        page_size:,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a contact by their phone number for the authenticated customer. Phone
+      # number should be in international format (e.g., +1234567890). The customer ID is
+      # extracted from the authentication token.
+      sig do
+        params(
+          phone_number: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::ContactListItem)
+      end
+      def retrieve_by_phone(
+        # The phone number in international format (e.g., +1234567890)
+        phone_number:,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a specific contact by their unique identifier for the authenticated
+      # customer. The customer ID is extracted from the authentication token. Returns
+      # detailed contact information including phone number and creation timestamp.
+      sig do
+        params(
+          id: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::ContactListItem)
+      end
+      def retrieve_id(
+        # The unique identifier (GUID) of the resource to retrieve
+        id:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Sentdm::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/sentdm/resources/messages.rbi

@@ -0,0 +1,97 @@
+# typed: strong
+
+module Sentdm
+  module Resources
+    class Messages
+      # Retrieves comprehensive details about a specific message using the message ID.
+      # Returns complete message data including delivery status, channel information,
+      # template details, contact information, and pricing. The customer ID is extracted
+      # from the authentication token to ensure the message belongs to the authenticated
+      # customer.
+      sig do
+        params(
+          id: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::Models::MessageRetrieveResponse)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Sends a message to a phone number using the default template. This endpoint is
+      # rate limited to 5 messages per customer per day. The customer ID is extracted
+      # from the authentication token.
+      sig do
+        params(
+          custom_message: String,
+          phone_number: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).void
+      end
+      def send_quick_message(
+        # The custom message content to include in the template
+        custom_message:,
+        # The phone number to send the message to, in international format (e.g.,
+        # +1234567890)
+        phone_number:,
+        request_options: {}
+      )
+      end
+
+      # Sends a message to a specific contact using a template. The message can be sent
+      # via SMS or WhatsApp depending on the contact's capabilities. Optionally specify
+      # a webhook URL to receive delivery status updates. The customer ID is extracted
+      # from the authentication token.
+      sig do
+        params(
+          contact_id: String,
+          template_id: String,
+          template_variables: T.nilable(T::Hash[Symbol, String]),
+          request_options: Sentdm::RequestOptions::OrHash
+        ).void
+      end
+      def send_to_contact(
+        # The unique identifier of the contact to send the message to
+        contact_id:,
+        # The unique identifier of the template to use for the message
+        template_id:,
+        # Optional key-value pairs of template variables to replace in the template body.
+        # For example, if your template contains "Hello {{name}}", you would provide {
+        # "name": "John Doe" }
+        template_variables: nil,
+        request_options: {}
+      )
+      end
+
+      # Sends a message to a phone number using a template. The phone number doesn't
+      # need to be a pre-existing contact. The message can be sent via SMS or WhatsApp.
+      # Optionally specify a webhook URL to receive delivery status updates. The
+      # customer ID is extracted from the authentication token.
+      sig do
+        params(
+          phone_number: String,
+          template_id: String,
+          template_variables: T.nilable(T::Hash[Symbol, String]),
+          request_options: Sentdm::RequestOptions::OrHash
+        ).void
+      end
+      def send_to_phone(
+        # The phone number to send the message to, in international format (e.g.,
+        # +1234567890)
+        phone_number:,
+        # The unique identifier of the template to use for the message
+        template_id:,
+        # Optional key-value pairs of template variables to replace in the template body.
+        # For example, if your template contains "Hello {{name}}", you would provide {
+        # "name": "John Doe" }
+        template_variables: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Sentdm::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/sentdm/resources/number_lookup.rbi

@@ -0,0 +1,24 @@
+# typed: strong
+
+module Sentdm
+  module Resources
+    class NumberLookup
+      # Retrieves detailed information about a phone number including validation,
+      # formatting, country information, and available messaging channels. The customer
+      # ID is extracted from the authentication token.
+      sig do
+        params(
+          phone_number: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::Models::NumberLookupRetrieveResponse)
+      end
+      def retrieve(phone_number:, request_options: {})
+      end
+
+      # @api private
+      sig { params(client: Sentdm::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/sentdm/resources/organizations/users.rbi

@@ -0,0 +1,95 @@
+# typed: strong
+
+module Sentdm
+  module Resources
+    class Organizations
+      class Users
+        # Retrieves a specific user by their ID. Requires appropriate permissions. The
+        # customerId can be either an organization ID or a profile ID.
+        sig do
+          params(
+            user_id: String,
+            customer_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(Sentdm::Organizations::CustomerUser)
+        end
+        def retrieve(user_id, customer_id:, request_options: {})
+        end
+
+        # Retrieves all users associated with an organization or sender profile. Requires
+        # appropriate permissions. Supports pagination.
+        sig do
+          params(
+            customer_id: String,
+            page: Integer,
+            page_size: Integer,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(Sentdm::Models::Organizations::UserListResponse)
+        end
+        def list(customer_id, page:, page_size:, request_options: {})
+        end
+
+        # Removes a user from an organization or sender profile. Requires admin
+        # permissions. This action permanently deletes the user association.
+        sig do
+          params(
+            user_id: String,
+            customer_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).void
+        end
+        def delete(user_id, customer_id:, request_options: {})
+        end
+
+        # Invites a user to an organization or sender profile with a specified role.
+        # Requires appropriate permissions. The customerId can be either an organization
+        # ID or a profile ID.
+        sig do
+          params(
+            customer_id: String,
+            email: String,
+            invited_by: T.nilable(String),
+            name: String,
+            role: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(Sentdm::Organizations::CustomerUser)
+        end
+        def invite(
+          customer_id,
+          email: nil,
+          invited_by: nil,
+          name: nil,
+          role: nil,
+          request_options: {}
+        )
+        end
+
+        # Updates a user's role within an organization or sender profile. Requires admin
+        # permissions. Valid roles are: admin, billing, developer.
+        sig do
+          params(
+            user_id: String,
+            customer_id: String,
+            role: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(Sentdm::Organizations::CustomerUser)
+        end
+        def update_role(
+          # Path param
+          user_id,
+          # Path param
+          customer_id:,
+          # Body param
+          role: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Sentdm::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end