sentdm 0.3.1 → 0.4.0

data/lib/sentdm/resources/webhooks.rb

@@ -9,7 +9,7 @@ module Sentdm
       #
       # Creates a new webhook endpoint for the authenticated customer.
       #
-      # @overload create(display_name: nil, endpoint_url: nil, event_types: nil, retry_count: nil, test_mode: nil, timeout_seconds: nil, idempotency_key: nil, request_options: {})
+      # @overload create(display_name: nil, endpoint_url: nil, event_types: nil, retry_count: nil, sandbox: nil, timeout_seconds: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
       # @param display_name [String] Body param
       #
@@ -19,12 +19,14 @@ module Sentdm
       #
       # @param retry_count [Integer] Body param
       #
-      # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
       # @param timeout_seconds [Integer] Body param
       #
       # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
       #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::APIResponseWebhook]
@@ -32,7 +34,7 @@ module Sentdm
       # @see Sentdm::Models::WebhookCreateParams
       def create(params = {})
         parsed, options = Sentdm::WebhookCreateParams.dump_request(params)
-        header_params = {idempotency_key: "idempotency-key"}
+        header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
         @client.request(
           method: :post,
           path: "v3/webhooks",
@@ -43,22 +45,30 @@ module Sentdm
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::WebhookRetrieveParams} for more details.
+      #
       # Retrieves a single webhook by ID for the authenticated customer.
       #
-      # @overload retrieve(id, request_options: {})
+      # @overload retrieve(id, x_profile_id: nil, request_options: {})
       #
       # @param id [String]
+      #
+      # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::APIResponseWebhook]
       #
       # @see Sentdm::Models::WebhookRetrieveParams
       def retrieve(id, params = {})
+        parsed, options = Sentdm::WebhookRetrieveParams.dump_request(params)
         @client.request(
           method: :get,
           path: ["v3/webhooks/%1$s", id],
+          headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
           model: Sentdm::APIResponseWebhook,
-          options: params[:request_options]
+          options: options
         )
       end
 
@@ -67,7 +77,7 @@ module Sentdm
       #
       # Updates an existing webhook for the authenticated customer.
       #
-      # @overload update(id, display_name: nil, endpoint_url: nil, event_types: nil, retry_count: nil, test_mode: nil, timeout_seconds: nil, idempotency_key: nil, request_options: {})
+      # @overload update(id, display_name: nil, endpoint_url: nil, event_types: nil, retry_count: nil, sandbox: nil, timeout_seconds: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
       # @param id [String] Path param
       #
@@ -79,12 +89,14 @@ module Sentdm
       #
       # @param retry_count [Integer] Body param
       #
-      # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
       # @param timeout_seconds [Integer] Body param
       #
       # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
       #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::APIResponseWebhook]
@@ -92,7 +104,7 @@ module Sentdm
       # @see Sentdm::Models::WebhookUpdateParams
       def update(id, params = {})
         parsed, options = Sentdm::WebhookUpdateParams.dump_request(params)
-        header_params = {idempotency_key: "idempotency-key"}
+        header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
         @client.request(
           method: :put,
           path: ["v3/webhooks/%1$s", id],
@@ -103,53 +115,77 @@ module Sentdm
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::WebhookListParams} for more details.
+      #
       # Retrieves a paginated list of webhooks for the authenticated customer.
       #
-      # @overload list(page:, page_size:, is_active: nil, search: nil, request_options: {})
+      # @overload list(page:, page_size:, is_active: nil, search: nil, x_profile_id: nil, request_options: {})
+      #
+      # @param page [Integer] Query param
+      #
+      # @param page_size [Integer] Query param
+      #
+      # @param is_active [Boolean, nil] Query param
+      #
+      # @param search [String, nil] Query param
+      #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
       #
-      # @param page [Integer]
-      # @param page_size [Integer]
-      # @param is_active [Boolean, nil]
-      # @param search [String, nil]
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::WebhookListResponse]
       #
       # @see Sentdm::Models::WebhookListParams
       def list(params)
+        query_params = [:page, :page_size, :is_active, :search]
         parsed, options = Sentdm::WebhookListParams.dump_request(params)
-        query = Sentdm::Internal::Util.encode_query_params(parsed)
+        query = Sentdm::Internal::Util.encode_query_params(parsed.slice(*query_params))
         @client.request(
           method: :get,
           path: "v3/webhooks",
-          query: query.transform_keys(page_size: "pageSize", is_active: "isActive"),
+          query: query,
+          headers: parsed.except(*query_params).transform_keys(x_profile_id: "x-profile-id"),
           model: Sentdm::Models::WebhookListResponse,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::WebhookDeleteParams} for more details.
+      #
       # Deletes a webhook for the authenticated customer.
       #
-      # @overload delete(id, request_options: {})
+      # @overload delete(id, x_profile_id: nil, request_options: {})
       #
       # @param id [String]
+      #
+      # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
       #
       # @see Sentdm::Models::WebhookDeleteParams
       def delete(id, params = {})
+        parsed, options = Sentdm::WebhookDeleteParams.dump_request(params)
         @client.request(
           method: :delete,
           path: ["v3/webhooks/%1$s", id],
+          headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
           model: NilClass,
-          options: params[:request_options]
+          options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::WebhookListEventTypesParams} for more details.
+      #
       # Retrieves all available webhook event types that can be subscribed to.
       #
-      # @overload list_event_types(request_options: {})
+      # @overload list_event_types(x_profile_id: nil, request_options: {})
+      #
+      # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -157,34 +193,47 @@ module Sentdm
       #
       # @see Sentdm::Models::WebhookListEventTypesParams
       def list_event_types(params = {})
+        parsed, options = Sentdm::WebhookListEventTypesParams.dump_request(params)
         @client.request(
           method: :get,
           path: "v3/webhooks/event-types",
+          headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
           model: Sentdm::Models::WebhookListEventTypesResponse,
-          options: params[:request_options]
+          options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::WebhookListEventsParams} for more details.
+      #
       # Retrieves a paginated list of delivery events for the specified webhook.
       #
-      # @overload list_events(id, page:, page_size:, search: nil, request_options: {})
+      # @overload list_events(id, page:, page_size:, search: nil, x_profile_id: nil, request_options: {})
+      #
+      # @param id [String] Path param
+      #
+      # @param page [Integer] Query param
+      #
+      # @param page_size [Integer] Query param
+      #
+      # @param search [String, nil] Query param
+      #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
       #
-      # @param id [String]
-      # @param page [Integer]
-      # @param page_size [Integer]
-      # @param search [String, nil]
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::WebhookListEventsResponse]
       #
       # @see Sentdm::Models::WebhookListEventsParams
       def list_events(id, params)
+        query_params = [:page, :page_size, :search]
         parsed, options = Sentdm::WebhookListEventsParams.dump_request(params)
-        query = Sentdm::Internal::Util.encode_query_params(parsed)
+        query = Sentdm::Internal::Util.encode_query_params(parsed.slice(*query_params))
         @client.request(
           method: :get,
           path: ["v3/webhooks/%1$s/events", id],
-          query: query.transform_keys(page_size: "pageSize"),
+          query: query,
+          headers: parsed.except(*query_params).transform_keys(x_profile_id: "x-profile-id"),
           model: Sentdm::Models::WebhookListEventsResponse,
           options: options
         )
@@ -196,7 +245,7 @@ module Sentdm
       # Generates a new signing secret for the specified webhook. The old secret is
       # immediately invalidated.
       #
-      # @overload rotate_secret(id, body:, idempotency_key: nil, request_options: {})
+      # @overload rotate_secret(id, body:, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
       # @param id [String] Path param
       #
@@ -204,6 +253,8 @@ module Sentdm
       #
       # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
       #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::WebhookRotateSecretResponse]
@@ -214,7 +265,10 @@ module Sentdm
         @client.request(
           method: :post,
           path: ["v3/webhooks/%1$s/rotate-secret", id],
-          headers: parsed.except(:body).transform_keys(idempotency_key: "idempotency-key"),
+          headers: parsed.except(:body).transform_keys(
+            idempotency_key: "idempotency-key",
+            x_profile_id: "x-profile-id"
+          ),
           body: parsed[:body],
           model: Sentdm::Models::WebhookRotateSecretResponse,
           options: options
@@ -226,16 +280,18 @@ module Sentdm
       #
       # Sends a test event to the specified webhook endpoint to verify connectivity.
       #
-      # @overload test_(id, event_type: nil, test_mode: nil, idempotency_key: nil, request_options: {})
+      # @overload test_(id, event_type: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
       # @param id [String] Path param
       #
       # @param event_type [String] Body param
       #
-      # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
       # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
       #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::WebhookTestResponse]
@@ -243,7 +299,7 @@ module Sentdm
       # @see Sentdm::Models::WebhookTestParams
       def test_(id, params = {})
         parsed, options = Sentdm::WebhookTestParams.dump_request(params)
-        header_params = {idempotency_key: "idempotency-key"}
+        header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
         @client.request(
           method: :post,
           path: ["v3/webhooks/%1$s/test", id],
@@ -259,16 +315,18 @@ module Sentdm
       #
       # Activates or deactivates a webhook for the authenticated customer.
       #
-      # @overload toggle_status(id, is_active: nil, test_mode: nil, idempotency_key: nil, request_options: {})
+      # @overload toggle_status(id, is_active: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
       # @param id [String] Path param
       #
       # @param is_active [Boolean] Body param
       #
-      # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
       # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
       #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::APIResponseWebhook]
@@ -276,7 +334,7 @@ module Sentdm
       # @see Sentdm::Models::WebhookToggleStatusParams
       def toggle_status(id, params = {})
         parsed, options = Sentdm::WebhookToggleStatusParams.dump_request(params)
-        header_params = {idempotency_key: "idempotency-key"}
+        header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
         @client.request(
           method: :patch,
           path: ["v3/webhooks/%1$s/toggle-status", id],

data/lib/sentdm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sentdm
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/sentdm.rb

@@ -52,32 +52,21 @@ require_relative "sentdm/errors"
 require_relative "sentdm/internal/transport/base_client"
 require_relative "sentdm/internal/transport/pooled_net_requester"
 require_relative "sentdm/client"
-require_relative "sentdm/models/mutation_request"
 require_relative "sentdm/models/brands/base_dto"
+require_relative "sentdm/models/mutation_request"
 require_relative "sentdm/models/api_error"
 require_relative "sentdm/models/api_meta"
-require_relative "sentdm/models/api_response_brand_with_kyc"
 require_relative "sentdm/models/api_response_contact"
 require_relative "sentdm/models/api_response_of_profile_detail"
 require_relative "sentdm/models/api_response_of_user"
 require_relative "sentdm/models/api_response_template"
 require_relative "sentdm/models/api_response_webhook"
-require_relative "sentdm/models/brand_create_params"
 require_relative "sentdm/models/brand_data"
-require_relative "sentdm/models/brand_delete_params"
-require_relative "sentdm/models/brand_list_params"
-require_relative "sentdm/models/brand_list_response"
 require_relative "sentdm/models/brands/api_response_tcr_campaign_with_use_cases"
-require_relative "sentdm/models/brands/campaign_create_params"
 require_relative "sentdm/models/brands/campaign_data"
-require_relative "sentdm/models/brands/campaign_delete_params"
-require_relative "sentdm/models/brands/campaign_list_params"
-require_relative "sentdm/models/brands/campaign_list_response"
-require_relative "sentdm/models/brands/campaign_update_params"
 require_relative "sentdm/models/brands/messaging_use_case_us"
 require_relative "sentdm/models/brands/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data"
 require_relative "sentdm/models/brands/tcr_campaign_with_use_cases"
-require_relative "sentdm/models/brand_update_params"
 require_relative "sentdm/models/brand_with_kyc"
 require_relative "sentdm/models/contact"
 require_relative "sentdm/models/contact_create_params"
@@ -87,8 +76,6 @@ require_relative "sentdm/models/contact_list_response"
 require_relative "sentdm/models/contact_retrieve_params"
 require_relative "sentdm/models/contact_update_params"
 require_relative "sentdm/models/destination_country"
-require_relative "sentdm/models/lookup_retrieve_phone_info_params"
-require_relative "sentdm/models/lookup_retrieve_phone_info_response"
 require_relative "sentdm/models/me_retrieve_params"
 require_relative "sentdm/models/me_retrieve_response"
 require_relative "sentdm/models/message_retrieve_activities_params"

data/rbi/sentdm/client.rbi

@@ -42,7 +42,6 @@ module Sentdm
     sig { returns(Sentdm::Resources::Contacts) }
     attr_reader :contacts
 
-    # Register and manage 10DLC brands for SMS compliance
     sig { returns(Sentdm::Resources::Brands) }
     attr_reader :brands
 

data/rbi/sentdm/models/api_meta.rbi

@@ -13,10 +13,6 @@ module Sentdm
       sig { params(request_id: String).void }
       attr_writer :request_id
 
-      # Response time in milliseconds (optional)
-      sig { returns(T.nilable(Integer)) }
-      attr_accessor :response_time_ms
-
       # Server timestamp when the response was generated
       sig { returns(T.nilable(Time)) }
       attr_reader :timestamp
@@ -33,18 +29,13 @@ module Sentdm
 
       # Request and response metadata
       sig do
-        params(
-          request_id: String,
-          response_time_ms: T.nilable(Integer),
-          timestamp: Time,
-          version: String
-        ).returns(T.attached_class)
+        params(request_id: String, timestamp: Time, version: String).returns(
+          T.attached_class
+        )
       end
       def self.new(
         # Unique identifier for this request (for tracing and support)
         request_id: nil,
-        # Response time in milliseconds (optional)
-        response_time_ms: nil,
         # Server timestamp when the response was generated
         timestamp: nil,
         # API version used for this request
@@ -54,12 +45,7 @@ module Sentdm
 
       sig do
         override.returns(
-          {
-            request_id: String,
-            response_time_ms: T.nilable(Integer),
-            timestamp: Time,
-            version: String
-          }
+          { request_id: String, timestamp: Time, version: String }
         )
       end
       def to_hash