sentdm 0.1.0 → 0.3.0

data/rbi/sentdm/resources/profiles.rbi

@@ -0,0 +1,238 @@
+# typed: strong
+
+module Sentdm
+  module Resources
+    class Profiles
+      # Creates a new sender profile within an organization. Profiles represent
+      # different brands, departments, or use cases, each with their own messaging
+      # configuration and settings. Requires admin role in the organization.
+      sig do
+        params(
+          allow_contact_sharing: T::Boolean,
+          allow_template_sharing: T::Boolean,
+          billing_model: T.nilable(String),
+          description: T.nilable(String),
+          icon: T.nilable(String),
+          inherit_contacts: T.nilable(T::Boolean),
+          inherit_tcr_brand: T.nilable(T::Boolean),
+          inherit_tcr_campaign: T.nilable(T::Boolean),
+          inherit_templates: T.nilable(T::Boolean),
+          name: String,
+          short_name: T.nilable(String),
+          test_mode: T::Boolean,
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::APIResponseOfProfileDetail)
+      end
+      def create(
+        # Body param: Whether contacts are shared across profiles (default: false)
+        allow_contact_sharing: nil,
+        # Body param: Whether templates are shared across profiles (default: false)
+        allow_template_sharing: nil,
+        # Body param: Billing model: profile, organization, or profile_and_organization
+        # (default: profile)
+        billing_model: nil,
+        # Body param: Profile description (optional)
+        description: nil,
+        # Body param: Profile icon URL (optional)
+        icon: nil,
+        # Body param: Whether this profile inherits contacts from organization (default:
+        # true)
+        inherit_contacts: nil,
+        # Body param: Whether this profile inherits TCR brand from organization (default:
+        # true)
+        inherit_tcr_brand: nil,
+        # Body param: Whether this profile inherits TCR campaign from organization
+        # (default: true)
+        inherit_tcr_campaign: nil,
+        # Body param: Whether this profile inherits templates from organization (default:
+        # true)
+        inherit_templates: nil,
+        # Body param: Profile name (required)
+        name: nil,
+        # Body param: Profile short name/abbreviation (optional)
+        short_name: 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 detailed information about a specific sender profile within an
+      # organization.
+      sig do
+        params(
+          profile_id: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::APIResponseOfProfileDetail)
+      end
+      def retrieve(profile_id, request_options: {})
+      end
+
+      # Updates a profile's configuration and settings. Requires admin role in the
+      # organization. Only provided fields will be updated (partial update).
+      sig do
+        params(
+          path_profile_id: String,
+          allow_contact_sharing: T.nilable(T::Boolean),
+          allow_number_change_during_onboarding: T.nilable(T::Boolean),
+          allow_template_sharing: T.nilable(T::Boolean),
+          billing_model: T.nilable(String),
+          description: T.nilable(String),
+          icon: T.nilable(String),
+          inherit_contacts: T.nilable(T::Boolean),
+          inherit_tcr_brand: T.nilable(T::Boolean),
+          inherit_tcr_campaign: T.nilable(T::Boolean),
+          inherit_templates: T.nilable(T::Boolean),
+          name: T.nilable(String),
+          body_profile_id: String,
+          sending_phone_number: T.nilable(String),
+          sending_phone_number_profile_id: T.nilable(String),
+          sending_whatsapp_number_profile_id: T.nilable(String),
+          short_name: T.nilable(String),
+          test_mode: T::Boolean,
+          whatsapp_phone_number: T.nilable(String),
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::APIResponseOfProfileDetail)
+      end
+      def update(
+        # Path param
+        path_profile_id,
+        # Body param: Whether contacts are shared across profiles (optional)
+        allow_contact_sharing: nil,
+        # Body param: Whether number changes are allowed during onboarding (optional)
+        allow_number_change_during_onboarding: nil,
+        # Body param: Whether templates are shared across profiles (optional)
+        allow_template_sharing: nil,
+        # Body param: Billing model: profile, organization, or profile_and_organization
+        # (optional)
+        billing_model: nil,
+        # Body param: Profile description (optional)
+        description: nil,
+        # Body param: Profile icon URL (optional)
+        icon: nil,
+        # Body param: Whether this profile inherits contacts from organization (optional)
+        inherit_contacts: nil,
+        # Body param: Whether this profile inherits TCR brand from organization (optional)
+        inherit_tcr_brand: nil,
+        # Body param: Whether this profile inherits TCR campaign from organization
+        # (optional)
+        inherit_tcr_campaign: nil,
+        # Body param: Whether this profile inherits templates from organization (optional)
+        inherit_templates: nil,
+        # Body param: Profile name (optional)
+        name: nil,
+        # Body param: Profile ID from route parameter
+        body_profile_id: nil,
+        # Body param: Direct phone number for SMS sending (optional)
+        sending_phone_number: nil,
+        # Body param: Reference to another profile to use for SMS/Telnyx configuration
+        # (optional)
+        sending_phone_number_profile_id: nil,
+        # Body param: Reference to another profile to use for WhatsApp configuration
+        # (optional)
+        sending_whatsapp_number_profile_id: nil,
+        # Body param: Profile short name/abbreviation (optional)
+        short_name: 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: Direct phone number for WhatsApp sending (optional)
+        whatsapp_phone_number: 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 sender profiles within an organization. Profiles represent
+      # different brands, departments, or use cases within an organization, each with
+      # their own messaging configuration.
+      sig do
+        params(request_options: Sentdm::RequestOptions::OrHash).returns(
+          Sentdm::Models::ProfileListResponse
+        )
+      end
+      def list(request_options: {})
+      end
+
+      # Soft deletes a sender profile. The profile will be marked as deleted but data is
+      # retained. Requires admin role in the organization.
+      sig do
+        params(
+          path_profile_id: String,
+          body_profile_id: String,
+          test_mode: T::Boolean,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        path_profile_id,
+        # Profile ID from route parameter
+        body_profile_id: nil,
+        # Test mode flag - when true, the operation is simulated without side effects
+        # Useful for testing integrations without actual execution
+        test_mode: nil,
+        request_options: {}
+      )
+      end
+
+      # Final step in profile compliance workflow. Validates all prerequisites (general
+      # data, brand, campaigns), connects profile to Telnyx/WhatsApp, and sets status
+      # based on configuration. The process runs in the background and calls the
+      # provided webhook URL when finished.
+      #
+      #                 Prerequisites:
+      #                 - Profile must be completed
+      #                 - If inheritTcrBrand=false: Profile must have existing brand
+      #                 - If inheritTcrBrand=true: Parent must have existing brand
+      #                 - If TCR application: Must have at least one campaign (own or inherited)
+      #                 - If inheritTcrCampaign=false: Profile should have campaigns
+      #                 - If inheritTcrCampaign=true: Parent must have campaigns
+      #
+      #                 Status Logic:
+      #                 - If both SMS and WhatsApp channels are missing → SUBMITTED
+      #                 - If TCR application and not inheriting brand/campaigns → SUBMITTED
+      #                 - If non-TCR with destination country (IsMain=true) → SUBMITTED
+      #                 - Otherwise → COMPLETED
+      sig do
+        params(
+          profile_id: String,
+          web_hook_url: String,
+          test_mode: T::Boolean,
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(T.anything)
+      end
+      def complete(
+        # Path param: Profile ID from route
+        profile_id,
+        # Body param: Webhook URL to call when profile completion finishes (success or
+        # failure)
+        web_hook_url:,
+        # 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
+
+      # @api private
+      sig { params(client: Sentdm::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/sentdm/resources/templates.rbi

@@ -3,55 +3,103 @@
 module Sentdm
   module Resources
     class Templates
-      # Creates a new message template for the authenticated customer with comprehensive
-      # template definitions including headers, body, footer, and interactive buttons.
-      # Supports automatic metadata generation using AI (display name, language,
-      # category). Optionally submits the template for WhatsApp review. The customer ID
-      # is extracted from the authentication token.
+      # 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.
       sig do
         params(
-          definition: Sentdm::TemplateDefinition::OrHash,
           category: T.nilable(String),
+          creation_source: T.nilable(String),
+          definition: Sentdm::TemplateDefinition::OrHash,
           language: T.nilable(String),
           submit_for_review: T::Boolean,
+          test_mode: T::Boolean,
+          idempotency_key: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::TemplateResponse)
+        ).returns(Sentdm::APIResponseTemplate)
       end
       def create(
-        # Template definition containing header, body, footer, and buttons
-        definition:,
-        # The template category (e.g., MARKETING, UTILITY, AUTHENTICATION). Can only be
-        # set when creating a new template. If not provided, will be auto-generated using
-        # AI.
+        # Body param: Template category: MARKETING, UTILITY, AUTHENTICATION (optional,
+        # auto-detected if not provided)
         category: nil,
-        # The template language code (e.g., en_US, es_ES). Can only be set when creating a
-        # new template. If not provided, will be auto-detected using AI.
+        # Body param: Source of template creation (default: from-api)
+        creation_source: nil,
+        # Body param: Template definition including header, body, footer, and buttons
+        definition: nil,
+        # Body param: Template language code (e.g., en_US) (optional, auto-detected if not
+        # provided)
         language: nil,
-        # When false, the template will be saved as draft. When true, the template will be
-        # submitted for review.
+        # Body param: Whether to submit the template for review after creation (default:
+        # false)
         submit_for_review: 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 specific template by its ID. Returns template details including
+      # name, category, language, status, and definition.
+      sig do
+        params(
+          id: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::APIResponseTemplate)
+      end
+      def retrieve(
+        # Template ID from route parameter
+        id,
         request_options: {}
       )
       end
 
-      # Retrieves a specific message template by its unique identifier for the
-      # authenticated customer with comprehensive template definitions including
-      # headers, body, footer, and interactive buttons. The customer ID is extracted
-      # from the authentication token.
+      # Updates an existing template's name, category, language, definition, or submits
+      # it for review.
       sig do
         params(
           id: String,
+          category: T.nilable(String),
+          definition: T.nilable(Sentdm::TemplateDefinition::OrHash),
+          language: T.nilable(String),
+          name: T.nilable(String),
+          submit_for_review: T::Boolean,
+          test_mode: T::Boolean,
+          idempotency_key: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::TemplateResponse)
+        ).returns(Sentdm::APIResponseTemplate)
       end
-      def retrieve(id, request_options: {})
+      def update(
+        # Path param: Template ID from route parameter
+        id,
+        # Body param: Template category: MARKETING, UTILITY, AUTHENTICATION
+        category: nil,
+        # Body param: Template definition including header, body, footer, and buttons
+        definition: nil,
+        # Body param: Template language code (e.g., en_US)
+        language: nil,
+        # Body param: Template display name
+        name: nil,
+        # Body param: Whether to submit the template for review after updating (default:
+        # false)
+        submit_for_review: 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 all message templates available for the authenticated customer with
-      # comprehensive template definitions including headers, body, footer, and
-      # interactive buttons. Supports advanced filtering by search term, status, and
-      # category, plus pagination. The customer ID is extracted from the authentication
-      # token.
+      # Retrieves a paginated list of message templates for the authenticated customer.
+      # Supports filtering by status, category, and search term.
       sig do
         params(
           page: Integer,
@@ -63,33 +111,38 @@ module Sentdm
         ).returns(Sentdm::Models::TemplateListResponse)
       end
       def list(
-        # The page number (zero-indexed). Default is 0.
+        # Page number (1-indexed)
         page:,
-        # The number of items per page (1-1000). Default is 100.
         page_size:,
-        # Optional filter by template category (e.g., MARKETING, UTILITY, AUTHENTICATION)
+        # Optional category filter: MARKETING, UTILITY, AUTHENTICATION
         category: nil,
-        # Optional search term to filter templates by name or content
+        # Optional search term for filtering templates
         search: nil,
-        # Optional filter by template status (e.g., APPROVED, PENDING, REJECTED, DRAFT)
+        # Optional status filter: APPROVED, PENDING, REJECTED
         status: nil,
         request_options: {}
       )
       end
 
-      # Deletes a specific message template by its unique identifier for the
-      # authenticated customer with smart deletion strategy. Deletion behavior: - If
-      # template has NO messages: Permanently deleted from database (hard delete). - If
-      # template has messages: Marked as deleted but preserved for message history (soft
-      # delete with snapshot). The template must exist and belong to the authenticated
-      # customer to be deleted successfully. The customer ID is extracted from the
-      # authentication token.
+      # Deletes a template by ID. Optionally, you can also delete the template from
+      # WhatsApp/Meta by setting delete_from_meta=true.
       sig do
-        params(id: String, request_options: Sentdm::RequestOptions::OrHash).void
+        params(
+          id: String,
+          delete_from_meta: T.nilable(T::Boolean),
+          test_mode: T::Boolean,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).void
       end
       def delete(
-        # The unique identifier (GUID) of the resource to retrieve
+        # Template ID from route parameter
         id,
+        # Whether to also delete the template from WhatsApp/Meta (optional, defaults to
+        # false)
+        delete_from_meta: nil,
+        # Test mode flag - when true, the operation is simulated without side effects
+        # Useful for testing integrations without actual execution
+        test_mode: nil,
         request_options: {}
       )
       end

data/rbi/sentdm/resources/users.rbi

@@ -0,0 +1,116 @@
+# typed: strong
+
+module Sentdm
+  module Resources
+    class Users
+      # Retrieves detailed information about a specific user in an organization or
+      # profile. Requires developer role or higher.
+      sig do
+        params(
+          user_id: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::APIResponseOfUser)
+      end
+      def retrieve(user_id, request_options: {})
+      end
+
+      # Retrieves all users who have access to the organization or profile identified by
+      # the API key, including their roles and status. Shows invited users (pending
+      # acceptance) and active users. Requires developer role or higher.
+      sig do
+        params(request_options: Sentdm::RequestOptions::OrHash).returns(
+          Sentdm::Models::UserListResponse
+        )
+      end
+      def list(request_options: {})
+      end
+
+      # Sends an invitation to a user to join the organization or profile with a
+      # specific role. Requires admin role. The user will receive an invitation email
+      # with a token to accept. Invitation tokens expire after 7 days.
+      sig do
+        params(
+          email: String,
+          name: String,
+          role: String,
+          test_mode: T::Boolean,
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::APIResponseOfUser)
+      end
+      def invite(
+        # Body param: User email address (required)
+        email: nil,
+        # Body param: User full name (required)
+        name: nil,
+        # Body param: User role: admin, billing, or developer (required)
+        role: 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
+
+      # Removes a user's access to an organization or profile. Requires admin role. You
+      # cannot remove yourself or remove the last admin.
+      sig do
+        params(
+          path_user_id: String,
+          test_mode: T::Boolean,
+          body_user_id: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).void
+      end
+      def remove(
+        path_user_id,
+        # Test mode flag - when true, the operation is simulated without side effects
+        # Useful for testing integrations without actual execution
+        test_mode: nil,
+        # User ID from route parameter
+        body_user_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Updates a user's role in the organization or profile. Requires admin role. You
+      # cannot change your own role or demote the last admin.
+      sig do
+        params(
+          path_user_id: String,
+          role: String,
+          test_mode: T::Boolean,
+          body_user_id: String,
+          idempotency_key: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::APIResponseOfUser)
+      end
+      def update_role(
+        # Path param
+        path_user_id,
+        # Body param: User role: admin, billing, or developer (required)
+        role: 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: User ID from route parameter
+        body_user_id: 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
+
+      # @api private
+      sig { params(client: Sentdm::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end