sentdm 0.2.0 → 0.3.0

data/rbi/sentdm/resources/brands/campaigns.rbi

@@ -0,0 +1,108 @@
+# typed: strong
+
+module Sentdm
+  module Resources
+    class Brands
+      class Campaigns
+        # Creates a new campaign scoped under a specific brand. The campaign is linked to
+        # the specified brand. Each campaign must include at least one use case with
+        # sample messages.
+        sig do
+          params(
+            brand_id: String,
+            campaign: Sentdm::Brands::CampaignData::OrHash,
+            test_mode: T::Boolean,
+            idempotency_key: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(Sentdm::Brands::APIResponseTcrCampaignWithUseCases)
+        end
+        def create(
+          # Path param: Brand ID from route
+          brand_id,
+          # Body param: Campaign data
+          campaign:,
+          # Body param: Test mode flag - when true, the operation is simulated without side
+          # effects Useful for testing integrations without actual execution
+          test_mode: nil,
+          # Header param: Unique key to ensure idempotent request processing. Must be 1-255
+          # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+          # hours per key per customer.
+          idempotency_key: nil,
+          request_options: {}
+        )
+        end
+
+        # Updates an existing campaign scoped under a specific brand. Cannot update
+        # campaigns that have already been submitted to TCR.
+        sig do
+          params(
+            campaign_id: String,
+            brand_id: String,
+            campaign: Sentdm::Brands::CampaignData::OrHash,
+            test_mode: T::Boolean,
+            idempotency_key: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(Sentdm::Brands::APIResponseTcrCampaignWithUseCases)
+        end
+        def update(
+          # Path param: Campaign ID from route
+          campaign_id,
+          # Path param: Brand ID from route
+          brand_id:,
+          # Body param: Campaign data
+          campaign:,
+          # Body param: Test mode flag - when true, the operation is simulated without side
+          # effects Useful for testing integrations without actual execution
+          test_mode: nil,
+          # Header param: Unique key to ensure idempotent request processing. Must be 1-255
+          # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+          # hours per key per customer.
+          idempotency_key: nil,
+          request_options: {}
+        )
+        end
+
+        # Retrieves all campaigns linked to a specific brand, including their use cases
+        # and sample messages.
+        sig do
+          params(
+            brand_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(Sentdm::Models::Brands::CampaignListResponse)
+        end
+        def list(
+          # Brand ID from route
+          brand_id,
+          request_options: {}
+        )
+        end
+
+        # Deletes a campaign by ID within a specific brand. The brand must belong to the
+        # authenticated customer.
+        sig do
+          params(
+            campaign_id: String,
+            brand_id: String,
+            body: Sentdm::Brands::CampaignDeleteParams::Body::OrHash,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # Path param: Campaign ID from route parameter
+          campaign_id,
+          # Path param: Brand ID from route parameter
+          brand_id:,
+          # Body param: Request to delete a campaign from a brand
+          body:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Sentdm::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/resources/brands.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module Sentdm
+  module Resources
+    class Brands
+      sig { returns(Sentdm::Resources::Brands::Campaigns) }
+      attr_reader :campaigns
+
+      # Creates a new brand and associated information. This endpoint automatically sets
+      # inheritTcrBrand=false when a brand is created.
+      sig do
+        params(
+          brand: Sentdm::BrandData::OrHash,
+          test_mode: T::Boolean,
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::APIResponseBrandWithKYC)
+      end
+      def create(
+        # Body param: Brand and KYC information
+        brand:,
+        # Body param: Test mode flag - when true, the operation is simulated without side
+        # effects Useful for testing integrations without actual execution
+        test_mode: nil,
+        # Header param: Unique key to ensure idempotent request processing. Must be 1-255
+        # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+        # hours per key per customer.
+        idempotency_key: nil,
+        request_options: {}
+      )
+      end
+
+      # Updates an existing brand and its associated information. Cannot update brands
+      # that have already been submitted to TCR or inherited brands.
+      sig do
+        params(
+          brand_id: String,
+          brand: Sentdm::BrandData::OrHash,
+          test_mode: T::Boolean,
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::APIResponseBrandWithKYC)
+      end
+      def update(
+        # Path param: Brand ID from route
+        brand_id,
+        # Body param: Brand and KYC information
+        brand:,
+        # Body param: Test mode flag - when true, the operation is simulated without side
+        # effects Useful for testing integrations without actual execution
+        test_mode: nil,
+        # Header param: Unique key to ensure idempotent request processing. Must be 1-255
+        # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+        # hours per key per customer.
+        idempotency_key: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves all brands for the authenticated customer with information in a
+      # flattened structure. Includes inherited brands if inheritTcrBrand=true.
+      sig do
+        params(request_options: Sentdm::RequestOptions::OrHash).returns(
+          Sentdm::Models::BrandListResponse
+        )
+      end
+      def list(request_options: {})
+      end
+
+      # Delete a brand by ID. The brand must belong to the authenticated customer.
+      sig do
+        params(
+          brand_id: String,
+          body: Sentdm::BrandDeleteParams::Body::OrHash,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # Brand ID from route parameter
+        brand_id,
+        # Request to delete a brand
+        body:,
+        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/contacts.rbi

@@ -3,53 +3,116 @@
 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.
+      # Creates a new contact by phone number and associates it with the authenticated
+      # customer.
       sig do
         params(
-          page: Integer,
-          page_size: Integer,
+          phone_number: String,
+          test_mode: T::Boolean,
+          idempotency_key: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::Models::ContactListResponse)
+        ).returns(Sentdm::APIResponseContact)
       end
-      def list(
-        # The page number (zero-indexed). Default is 0.
-        page:,
-        # The number of items per page. Default is 20.
-        page_size:,
+      def create(
+        # Body param: Phone number of the contact to create
+        phone_number: nil,
+        # Body param: Test mode flag - when true, the operation is simulated without side
+        # effects Useful for testing integrations without actual execution
+        test_mode: nil,
+        # Header param: Unique key to ensure idempotent request processing. Must be 1-255
+        # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+        # hours per key per customer.
+        idempotency_key: nil,
         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.
+      # Retrieves a specific contact by their unique identifier. Returns detailed
+      # contact information including phone formats, available channels, and opt-out
+      # status.
       sig do
         params(
-          phone_number: String,
+          id: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::APIResponseContact)
+      end
+      def retrieve(
+        # Contact ID from route parameter
+        id,
+        request_options: {}
+      )
+      end
+
+      # Updates a contact's default channel and/or opt-out status. Inherited contacts
+      # cannot be updated.
+      sig do
+        params(
+          id: String,
+          default_channel: T.nilable(String),
+          opt_out: T.nilable(T::Boolean),
+          test_mode: T::Boolean,
+          idempotency_key: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::ContactListItem)
+        ).returns(Sentdm::APIResponseContact)
+      end
+      def update(
+        # Path param: Contact ID from route parameter
+        id,
+        # Body param: Default messaging channel: "sms" or "whatsapp"
+        default_channel: nil,
+        # Body param: Whether the contact has opted out of messaging
+        opt_out: nil,
+        # Body param: Test mode flag - when true, the operation is simulated without side
+        # effects Useful for testing integrations without actual execution
+        test_mode: nil,
+        # Header param: Unique key to ensure idempotent request processing. Must be 1-255
+        # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+        # hours per key per customer.
+        idempotency_key: nil,
+        request_options: {}
+      )
       end
-      def retrieve_by_phone(
-        # The phone number in international format (e.g., +1234567890)
-        phone_number:,
+
+      # Retrieves a paginated list of contacts for the authenticated customer. Supports
+      # filtering by search term, channel, or phone number.
+      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(Sentdm::Models::ContactListResponse)
+      end
+      def list(
+        # Page number (1-indexed)
+        page:,
+        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
 
-      # 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.
+      # Dissociates a contact from the authenticated customer. Inherited contacts cannot
+      # be deleted.
       sig do
         params(
           id: String,
+          body: Sentdm::ContactDeleteParams::Body::OrHash,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::ContactListItem)
+        ).void
       end
-      def retrieve_id(
-        # The unique identifier (GUID) of the resource to retrieve
-        id:,
+      def delete(
+        # Contact ID from route parameter
+        id,
+        # Request to delete/dissociate a contact
+        body:,
         request_options: {}
       )
       end

data/rbi/sentdm/resources/lookup.rbi

@@ -0,0 +1,24 @@
+# typed: strong
+
+module Sentdm
+  module Resources
+    class Lookup
+      # Validates a phone number and retrieves formatting, country, and timezone
+      # information from the internal index. Provider-agnostic and works for all
+      # customers.
+      sig do
+        params(
+          phone_number: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::Models::LookupRetrievePhoneInfoResponse)
+      end
+      def retrieve_phone_info(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/me.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module Sentdm
+  module Resources
+    class Me
+      # Returns the account associated with the API key. For organization API keys,
+      # returns the organization with its profiles. For profile API keys, returns the
+      # profile with its settings.
+      sig do
+        params(request_options: Sentdm::RequestOptions::OrHash).returns(
+          Sentdm::Models::MeRetrieveResponse
+        )
+      end
+      def retrieve(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

@@ -3,87 +3,68 @@
 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.
+      # Retrieves the activity log for a specific message. Activities track the message
+      # lifecycle including acceptance, processing, sending, delivery, and any errors.
       sig do
         params(
           id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::Models::MessageRetrieveResponse)
+        ).returns(Sentdm::Models::MessageRetrieveActivitiesResponse)
       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:,
+      def retrieve_activities(
+        # Message ID from route parameter
+        id,
         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.
+      # Retrieves the current status and details of a message by ID. Includes delivery
+      # status, timestamps, and error information if applicable.
       sig do
         params(
-          contact_id: String,
-          template_id: String,
-          template_variables: T.nilable(T::Hash[Symbol, String]),
+          id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).void
+        ).returns(Sentdm::Models::MessageRetrieveStatusResponse)
       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,
+      def retrieve_status(
+        # Message ID
+        id,
         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.
+      # Sends a message to one or more recipients using a template. Supports
+      # multi-channel broadcast — when multiple channels are specified (e.g. ["sms",
+      # "whatsapp"]), a separate message is created for each (recipient, channel) pair.
+      # Returns immediately with per-recipient message IDs for async tracking via
+      # webhooks or the GET /messages/{id} endpoint.
       sig do
         params(
-          phone_number: String,
-          template_id: String,
-          template_variables: T.nilable(T::Hash[Symbol, String]),
+          channel: T.nilable(T::Array[String]),
+          template: Sentdm::MessageSendParams::Template::OrHash,
+          test_mode: T::Boolean,
+          to: T::Array[String],
+          idempotency_key: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).void
+        ).returns(Sentdm::Models::MessageSendResponse)
       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,
+      def send_(
+        # Body param: Channels to broadcast on, e.g. ["whatsapp", "sms"]. Each channel
+        # produces a separate message per recipient. "sent" = auto-detect, "rcs" =
+        # reserved (skipped). Defaults to ["sent"] (auto-detect) if omitted.
+        channel: nil,
+        # Body param: Template reference (by id or name, with optional parameters)
+        template: nil,
+        # Body param: Test mode flag - when true, the operation is simulated without side
+        # effects Useful for testing integrations without actual execution
+        test_mode: nil,
+        # Body param: List of recipient phone numbers in E.164 format (multi-recipient
+        # fan-out)
+        to: nil,
+        # Header param: Unique key to ensure idempotent request processing. Must be 1-255
+        # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+        # hours per key per customer.
+        idempotency_key: nil,
         request_options: {}
       )
       end