sentdm 0.3.1 → 0.5.0

data/rbi/sentdm/resources/users.rbi

@@ -9,21 +9,34 @@ module Sentdm
       sig do
         params(
           user_id: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(Sentdm::APIResponseOfUser)
       end
-      def retrieve(user_id, request_options: {})
+      def retrieve(
+        user_id,
+        # Profile UUID to scope the request to a child profile. Only organization API keys
+        # can use this header. The profile must belong to the calling organization.
+        x_profile_id: nil,
+        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
-        )
+        params(
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::Models::UserListResponse)
       end
-      def list(request_options: {})
+      def list(
+        # Profile UUID to scope the request to a child profile. Only organization API keys
+        # can use this header. The profile must belong to the calling organization.
+        x_profile_id: nil,
+        request_options: {}
+      )
       end
 
       # Sends an invitation to a user to join the organization or profile with a
@@ -34,8 +47,9 @@ module Sentdm
           email: String,
           name: String,
           role: String,
-          test_mode: T::Boolean,
+          sandbox: T::Boolean,
           idempotency_key: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(Sentdm::APIResponseOfUser)
       end
@@ -46,13 +60,17 @@ module Sentdm
         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
+        # Body param: Sandbox flag - when true, the operation is simulated without side
         # effects Useful for testing integrations without actual execution
-        test_mode: nil,
+        sandbox: 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,
+        # Header param: Profile UUID to scope the request to a child profile. Only
+        # organization API keys can use this header. The profile must belong to the
+        # calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -61,19 +79,21 @@ module Sentdm
       # cannot remove yourself or remove the last admin.
       sig do
         params(
-          path_user_id: String,
-          test_mode: T::Boolean,
-          body_user_id: String,
+          user_id: String,
+          body: Sentdm::UserRemoveParams::Body::OrHash,
+          x_profile_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,
+        # Path param
+        user_id,
+        # Body param: Request to remove a user from an organization
+        body:,
+        # Header param: Profile UUID to scope the request to a child profile. Only
+        # organization API keys can use this header. The profile must belong to the
+        # calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -82,28 +102,30 @@ module Sentdm
       # cannot change your own role or demote the last admin.
       sig do
         params(
-          path_user_id: String,
+          user_id: String,
           role: String,
-          test_mode: T::Boolean,
-          body_user_id: String,
+          sandbox: T::Boolean,
           idempotency_key: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(Sentdm::APIResponseOfUser)
       end
       def update_role(
         # Path param
-        path_user_id,
+        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
+        # Body param: Sandbox 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,
+        sandbox: 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,
+        # Header param: Profile UUID to scope the request to a child profile. Only
+        # organization API keys can use this header. The profile must belong to the
+        # calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end

data/rbi/sentdm/resources/webhooks.rbi

@@ -11,9 +11,10 @@ module Sentdm
           endpoint_url: String,
           event_types: T::Array[String],
           retry_count: Integer,
-          test_mode: T::Boolean,
+          sandbox: T::Boolean,
           timeout_seconds: Integer,
           idempotency_key: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(Sentdm::APIResponseWebhook)
       end
@@ -26,15 +27,19 @@ module Sentdm
         event_types: nil,
         # Body param
         retry_count: nil,
-        # Body param: Test mode flag - when true, the operation is simulated without side
+        # Body param: Sandbox flag - when true, the operation is simulated without side
         # effects Useful for testing integrations without actual execution
-        test_mode: nil,
+        sandbox: nil,
         # Body param
         timeout_seconds: 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,
+        # Header param: Profile UUID to scope the request to a child profile. Only
+        # organization API keys can use this header. The profile must belong to the
+        # calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -43,10 +48,17 @@ module Sentdm
       sig do
         params(
           id: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(Sentdm::APIResponseWebhook)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        id,
+        # Profile UUID to scope the request to a child profile. Only organization API keys
+        # can use this header. The profile must belong to the calling organization.
+        x_profile_id: nil,
+        request_options: {}
+      )
       end
 
       # Updates an existing webhook for the authenticated customer.
@@ -57,9 +69,10 @@ module Sentdm
           endpoint_url: String,
           event_types: T::Array[String],
           retry_count: Integer,
-          test_mode: T::Boolean,
+          sandbox: T::Boolean,
           timeout_seconds: Integer,
           idempotency_key: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(Sentdm::APIResponseWebhook)
       end
@@ -74,15 +87,19 @@ module Sentdm
         event_types: nil,
         # Body param
         retry_count: nil,
-        # Body param: Test mode flag - when true, the operation is simulated without side
+        # Body param: Sandbox flag - when true, the operation is simulated without side
         # effects Useful for testing integrations without actual execution
-        test_mode: nil,
+        sandbox: nil,
         # Body param
         timeout_seconds: 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,
+        # Header param: Profile UUID to scope the request to a child profile. Only
+        # organization API keys can use this header. The profile must belong to the
+        # calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -94,32 +111,57 @@ module Sentdm
           page_size: Integer,
           is_active: T.nilable(T::Boolean),
           search: T.nilable(String),
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(Sentdm::Models::WebhookListResponse)
       end
       def list(
+        # Query param
         page:,
+        # Query param
         page_size:,
+        # Query param
         is_active: nil,
+        # Query param
         search: nil,
+        # Header param: Profile UUID to scope the request to a child profile. Only
+        # organization API keys can use this header. The profile must belong to the
+        # calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end
 
       # Deletes a webhook for the authenticated customer.
       sig do
-        params(id: String, request_options: Sentdm::RequestOptions::OrHash).void
+        params(
+          id: String,
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).void
       end
-      def delete(id, request_options: {})
+      def delete(
+        id,
+        # Profile UUID to scope the request to a child profile. Only organization API keys
+        # can use this header. The profile must belong to the calling organization.
+        x_profile_id: nil,
+        request_options: {}
+      )
       end
 
       # Retrieves all available webhook event types that can be subscribed to.
       sig do
-        params(request_options: Sentdm::RequestOptions::OrHash).returns(
-          Sentdm::Models::WebhookListEventTypesResponse
-        )
+        params(
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::Models::WebhookListEventTypesResponse)
       end
-      def list_event_types(request_options: {})
+      def list_event_types(
+        # Profile UUID to scope the request to a child profile. Only organization API keys
+        # can use this header. The profile must belong to the calling organization.
+        x_profile_id: nil,
+        request_options: {}
+      )
       end
 
       # Retrieves a paginated list of delivery events for the specified webhook.
@@ -129,10 +171,25 @@ module Sentdm
           page: Integer,
           page_size: Integer,
           search: T.nilable(String),
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(Sentdm::Models::WebhookListEventsResponse)
       end
-      def list_events(id, page:, page_size:, search: nil, request_options: {})
+      def list_events(
+        # Path param
+        id,
+        # Query param
+        page:,
+        # Query param
+        page_size:,
+        # Query param
+        search: nil,
+        # Header param: Profile UUID to scope the request to a child profile. Only
+        # organization API keys can use this header. The profile must belong to the
+        # calling organization.
+        x_profile_id: nil,
+        request_options: {}
+      )
       end
 
       # Generates a new signing secret for the specified webhook. The old secret is
@@ -142,6 +199,7 @@ module Sentdm
           id: String,
           body: Sentdm::WebhookRotateSecretParams::Body::OrHash,
           idempotency_key: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(Sentdm::Models::WebhookRotateSecretResponse)
       end
@@ -154,6 +212,10 @@ module Sentdm
         # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
         # hours per key per customer.
         idempotency_key: nil,
+        # Header param: Profile UUID to scope the request to a child profile. Only
+        # organization API keys can use this header. The profile must belong to the
+        # calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -163,8 +225,9 @@ module Sentdm
         params(
           id: String,
           event_type: String,
-          test_mode: T::Boolean,
+          sandbox: T::Boolean,
           idempotency_key: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(Sentdm::Models::WebhookTestResponse)
       end
@@ -173,13 +236,17 @@ module Sentdm
         id,
         # Body param
         event_type: nil,
-        # Body param: Test mode flag - when true, the operation is simulated without side
+        # Body param: Sandbox flag - when true, the operation is simulated without side
         # effects Useful for testing integrations without actual execution
-        test_mode: nil,
+        sandbox: 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,
+        # Header param: Profile UUID to scope the request to a child profile. Only
+        # organization API keys can use this header. The profile must belong to the
+        # calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -189,8 +256,9 @@ module Sentdm
         params(
           id: String,
           is_active: T::Boolean,
-          test_mode: T::Boolean,
+          sandbox: T::Boolean,
           idempotency_key: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(Sentdm::APIResponseWebhook)
       end
@@ -199,13 +267,17 @@ module Sentdm
         id,
         # Body param
         is_active: nil,
-        # Body param: Test mode flag - when true, the operation is simulated without side
+        # Body param: Sandbox flag - when true, the operation is simulated without side
         # effects Useful for testing integrations without actual execution
-        test_mode: nil,
+        sandbox: 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,
+        # Header param: Profile UUID to scope the request to a child profile. Only
+        # organization API keys can use this header. The profile must belong to the
+        # calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end

data/sig/sentdm/client.rbs

@@ -18,14 +18,12 @@ module Sentdm
 
     attr_reader profiles: Sentdm::Resources::Profiles
 
-    attr_reader messages: Sentdm::Resources::Messages
+    attr_reader numbers: Sentdm::Resources::Numbers
 
-    attr_reader lookup: Sentdm::Resources::Lookup
+    attr_reader messages: Sentdm::Resources::Messages
 
     attr_reader contacts: Sentdm::Resources::Contacts
 
-    attr_reader brands: Sentdm::Resources::Brands
-
     attr_reader me: Sentdm::Resources::Me
 
     private def auth_headers: -> ::Hash[String, String]

data/sig/sentdm/models/api_meta.rbs

@@ -1,20 +1,12 @@
 module Sentdm
   module Models
-    type api_meta =
-      {
-        request_id: String,
-        response_time_ms: Integer?,
-        timestamp: Time,
-        version: String
-      }
+    type api_meta = { request_id: String, timestamp: Time, version: String }
 
     class APIMeta < Sentdm::Internal::Type::BaseModel
       attr_reader request_id: String?
 
       def request_id=: (String) -> String
 
-      attr_accessor response_time_ms: Integer?
-
       attr_reader timestamp: Time?
 
       def timestamp=: (Time) -> Time
@@ -25,17 +17,11 @@ module Sentdm
 
       def initialize: (
         ?request_id: String,
-        ?response_time_ms: Integer?,
         ?timestamp: Time,
         ?version: String
       ) -> void
 
-      def to_hash: -> {
-        request_id: String,
-        response_time_ms: Integer?,
-        timestamp: Time,
-        version: String
-      }
+      def to_hash: -> { request_id: String, timestamp: Time, version: String }
     end
   end
 end

data/sig/sentdm/models/{api_response_contact.rbs → api_response_of_contact.rbs}

@@ -1,15 +1,15 @@
 module Sentdm
   module Models
-    type api_response_contact =
+    type api_response_of_contact =
       {
-        data: Sentdm::Contact?,
+        data: Sentdm::ContactResponse?,
         error: Sentdm::APIError?,
         meta: Sentdm::APIMeta,
         success: bool
       }
 
-    class APIResponseContact < Sentdm::Internal::Type::BaseModel
-      attr_accessor data: Sentdm::Contact?
+    class APIResponseOfContact < Sentdm::Internal::Type::BaseModel
+      attr_accessor data: Sentdm::ContactResponse?
 
       attr_accessor error: Sentdm::APIError?
 
@@ -22,14 +22,14 @@ module Sentdm
       def success=: (bool) -> bool
 
       def initialize: (
-        ?data: Sentdm::Contact?,
+        ?data: Sentdm::ContactResponse?,
         ?error: Sentdm::APIError?,
         ?meta: Sentdm::APIMeta,
         ?success: bool
       ) -> void
 
       def to_hash: -> {
-        data: Sentdm::Contact?,
+        data: Sentdm::ContactResponse?,
         error: Sentdm::APIError?,
         meta: Sentdm::APIMeta,
         success: bool

data/sig/sentdm/models/base_dto.rbs

@@ -0,0 +1,25 @@
+module Sentdm
+  module Models
+    type base_dto = { id: String, created_at: Time, updated_at: Time? }
+
+    class BaseDto < Sentdm::Internal::Type::BaseModel
+      attr_reader id: String?
+
+      def id=: (String) -> String
+
+      attr_reader created_at: Time?
+
+      def created_at=: (Time) -> Time
+
+      attr_accessor updated_at: Time?
+
+      def initialize: (
+        ?id: String,
+        ?created_at: Time,
+        ?updated_at: Time?
+      ) -> void
+
+      def to_hash: -> { id: String, created_at: Time, updated_at: Time? }
+    end
+  end
+end

data/sig/sentdm/models/billing_contact_info.rbs

@@ -0,0 +1,30 @@
+module Sentdm
+  module Models
+    type billing_contact_info =
+      { email: String, name: String, address: String?, phone: String? }
+
+    class BillingContactInfo < Sentdm::Internal::Type::BaseModel
+      attr_accessor email: String
+
+      attr_accessor name: String
+
+      attr_accessor address: String?
+
+      attr_accessor phone: String?
+
+      def initialize: (
+        email: String,
+        name: String,
+        ?address: String?,
+        ?phone: String?
+      ) -> void
+
+      def to_hash: -> {
+        email: String,
+        name: String,
+        address: String?,
+        phone: String?
+      }
+    end
+  end
+end