sentdm 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a156f615bcb0c3a315688ef1b00ec81cfa032750d749642a0365e20d7ae4c9df
-  data.tar.gz: 0e1ef565451ca40155a468de7154f9faa663a6229b52e27ecc04e1160cb7acf9
+  metadata.gz: 197216990e5fbfd233a96fe398d63ae6e8bf0666fe5dae76e66da1f9396db36f
+  data.tar.gz: 8787403ba8b32810d77c97652e3d6c6386dc8e2941eb02e2fcb0854e9601f302
 SHA512:
-  metadata.gz: 2b0c996f6f0b65632fce6f0867021a06740f3db0b91cab4f451bd2ddac122e2f797fa124c942b9cce33fde78de2ccc053724d96ce1fb5017b5ecf285a7d7e010
-  data.tar.gz: 406bb232a1d48f76b18f0b4b0b55112c7c2cb5c31bf05bb258f52a8dd7e08279c54e59be388ba47420534f59d40cf9a897a1a799707f0e3fbf640b63f87732f6
+  metadata.gz: 950c0205f1cc3ae2e6da794c1e13df4e9c51ddf7f0dd12f0e33c73d2eec23dc25e24aca483c7cad15548948aabd49065ac1a597b26f994c9c52202df39ea2a39
+  data.tar.gz: 6eed0efde25a0400b67af7b15c38ea05064ebeb3df63d3dab82065495b3b72774fa60c71df2975e30e0260ba8bef83d25fe8bba9ade46e4f17c3102137c400b6

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.18.0 (2026-04-29)
+
+Full Changelog: [v0.17.0...v0.18.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.17.0...v0.18.0)
+
+### Features
+
+* **api:** api update ([144871d](https://github.com/sentdm/sent-dm-ruby/commit/144871d5fdd3214a7467a468519b392d759a6ada))
+
 ## 0.17.0 (2026-04-29)
 
 Full Changelog: [v0.16.0...v0.17.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.16.0...v0.17.0)

data/README.md

@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "sentdm", "~> 0.17.0"
+gem "sentdm", "~> 0.18.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/sentdm/models/contact_delete_params.rb

@@ -3,7 +3,7 @@
 module Sentdm
   module Models
     # @see Sentdm::Resources::Contacts#delete
-    class ContactDeleteParams < Sentdm::Internal::Type::BaseModel
+    class ContactDeleteParams < Sentdm::Models::MutationRequest
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
@@ -12,30 +12,15 @@ module Sentdm
       #   @return [String]
       required :id, String
 
-      # @!attribute body
-      #   Request to delete/dissociate a contact
-      #
-      #   @return [Sentdm::Models::ContactDeleteParams::Body]
-      required :body, -> { Sentdm::ContactDeleteParams::Body }
-
       # @!attribute x_profile_id
       #
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(id:, body:, x_profile_id: nil, request_options: {})
+      # @!method initialize(id:, x_profile_id: nil, request_options: {})
       #   @param id [String]
-      #
-      #   @param body [Sentdm::Models::ContactDeleteParams::Body] Request to delete/dissociate a contact
-      #
       #   @param x_profile_id [String]
-      #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
-
-      class Body < Sentdm::Models::MutationRequest
-        # @!method initialize
-        #   Request to delete/dissociate a contact
-      end
     end
   end
 end

data/lib/sentdm/models/profile_complete_response.rb

@@ -2,7 +2,73 @@
 
 module Sentdm
   module Models
-    # @type [Sentdm::Internal::Type::Converter]
-    ProfileCompleteResponse = Sentdm::Internal::Type::Unknown
+    # @see Sentdm::Resources::Profiles#complete
+    class ProfileCompleteResponse < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   Response when a profile is already in the completed state and no further action
+      #   is taken.
+      #
+      #   @return [Sentdm::Models::ProfileCompleteResponse::Data, nil]
+      optional :data, -> { Sentdm::Models::ProfileCompleteResponse::Data }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @return [Sentdm::Models::APIMeta, nil]
+      optional :meta, -> { Sentdm::APIMeta }
+
+      # @!attribute success
+      #   Indicates whether the request was successful
+      #
+      #   @return [Boolean, nil]
+      optional :success, Sentdm::Internal::Type::Boolean
+
+      # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::ProfileCompleteResponse} for more details.
+      #
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::ProfileCompleteResponse::Data, nil] Response when a profile is already in the completed state and no further action
+      #
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+
+      # @see Sentdm::Models::ProfileCompleteResponse#data
+      class Data < Sentdm::Internal::Type::BaseModel
+        # @!attribute message
+        #   Human-readable message describing the result.
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!attribute status
+        #   Current process status of the profile (e.g., "completed", "submitted",
+        #   "in_progress").
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!method initialize(message: nil, status: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::ProfileCompleteResponse::Data} for more details.
+        #
+        #   Response when a profile is already in the completed state and no further action
+        #   is taken.
+        #
+        #   @param message [String] Human-readable message describing the result.
+        #
+        #   @param status [String] Current process status of the profile (e.g., "completed", "submitted", "in_progr
+      end
+    end
   end
 end

data/lib/sentdm/models/profile_delete_params.rb

@@ -3,7 +3,7 @@
 module Sentdm
   module Models
     # @see Sentdm::Resources::Profiles#delete
-    class ProfileDeleteParams < Sentdm::Internal::Type::BaseModel
+    class ProfileDeleteParams < Sentdm::Models::MutationRequest
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
@@ -12,30 +12,15 @@ module Sentdm
       #   @return [String]
       required :profile_id, String
 
-      # @!attribute body
-      #   Request to delete a profile
-      #
-      #   @return [Sentdm::Models::ProfileDeleteParams::Body]
-      required :body, -> { Sentdm::ProfileDeleteParams::Body }
-
       # @!attribute x_profile_id
       #
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(profile_id:, body:, x_profile_id: nil, request_options: {})
+      # @!method initialize(profile_id:, x_profile_id: nil, request_options: {})
       #   @param profile_id [String]
-      #
-      #   @param body [Sentdm::Models::ProfileDeleteParams::Body] Request to delete a profile
-      #
       #   @param x_profile_id [String]
-      #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
-
-      class Body < Sentdm::Models::MutationRequest
-        # @!method initialize
-        #   Request to delete a profile
-      end
     end
   end
 end

data/lib/sentdm/models/profiles/campaign_delete_params.rb

@@ -4,7 +4,7 @@ module Sentdm
   module Models
     module Profiles
       # @see Sentdm::Resources::Profiles::Campaigns#delete
-      class CampaignDeleteParams < Sentdm::Internal::Type::BaseModel
+      class CampaignDeleteParams < Sentdm::Models::MutationRequest
         extend Sentdm::Internal::Type::RequestParameters::Converter
         include Sentdm::Internal::Type::RequestParameters
 
@@ -18,32 +18,16 @@ module Sentdm
         #   @return [String]
         required :campaign_id, String
 
-        # @!attribute body
-        #   Request to delete a campaign from a brand
-        #
-        #   @return [Sentdm::Models::Profiles::CampaignDeleteParams::Body]
-        required :body, -> { Sentdm::Profiles::CampaignDeleteParams::Body }
-
         # @!attribute x_profile_id
         #
         #   @return [String, nil]
         optional :x_profile_id, String
 
-        # @!method initialize(profile_id:, campaign_id:, body:, x_profile_id: nil, request_options: {})
+        # @!method initialize(profile_id:, campaign_id:, x_profile_id: nil, request_options: {})
         #   @param profile_id [String]
-        #
         #   @param campaign_id [String]
-        #
-        #   @param body [Sentdm::Models::Profiles::CampaignDeleteParams::Body] Request to delete a campaign from a brand
-        #
         #   @param x_profile_id [String]
-        #
         #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
-
-        class Body < Sentdm::Models::MutationRequest
-          # @!method initialize
-          #   Request to delete a campaign from a brand
-        end
       end
     end
   end

data/lib/sentdm/models/user_remove_params.rb

@@ -3,7 +3,7 @@
 module Sentdm
   module Models
     # @see Sentdm::Resources::Users#remove
-    class UserRemoveParams < Sentdm::Internal::Type::BaseModel
+    class UserRemoveParams < Sentdm::Models::MutationRequest
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
@@ -12,30 +12,15 @@ module Sentdm
       #   @return [String]
       required :user_id, String
 
-      # @!attribute body
-      #   Request to remove a user from an organization
-      #
-      #   @return [Sentdm::Models::UserRemoveParams::Body]
-      required :body, -> { Sentdm::UserRemoveParams::Body }
-
       # @!attribute x_profile_id
       #
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(user_id:, body:, x_profile_id: nil, request_options: {})
+      # @!method initialize(user_id:, x_profile_id: nil, request_options: {})
       #   @param user_id [String]
-      #
-      #   @param body [Sentdm::Models::UserRemoveParams::Body] Request to remove a user from an organization
-      #
       #   @param x_profile_id [String]
-      #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
-
-      class Body < Sentdm::Models::MutationRequest
-        # @!method initialize
-        #   Request to remove a user from an organization
-      end
     end
   end
 end

data/lib/sentdm/models/webhook_rotate_secret_params.rb

@@ -3,7 +3,7 @@
 module Sentdm
   module Models
     # @see Sentdm::Resources::Webhooks#rotate_secret
-    class WebhookRotateSecretParams < Sentdm::Internal::Type::BaseModel
+    class WebhookRotateSecretParams < Sentdm::Models::MutationRequest
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
@@ -12,11 +12,6 @@ module Sentdm
       #   @return [String]
       required :id, String
 
-      # @!attribute body
-      #
-      #   @return [Sentdm::Models::WebhookRotateSecretParams::Body]
-      required :body, -> { Sentdm::WebhookRotateSecretParams::Body }
-
       # @!attribute idempotency_key
       #
       #   @return [String, nil]
@@ -27,16 +22,11 @@ module Sentdm
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(id:, body:, idempotency_key: nil, x_profile_id: nil, request_options: {})
+      # @!method initialize(id:, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #   @param id [String]
-      #   @param body [Sentdm::Models::WebhookRotateSecretParams::Body]
       #   @param idempotency_key [String]
       #   @param x_profile_id [String]
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
-
-      class Body < Sentdm::Models::MutationRequest
-        # @!method initialize
-      end
     end
   end
 end

data/lib/sentdm/resources/contacts.rb

@@ -152,11 +152,11 @@ module Sentdm
       # Dissociates a contact from the authenticated customer. Inherited contacts cannot
       # be deleted.
       #
-      # @overload delete(id, body:, x_profile_id: nil, request_options: {})
+      # @overload delete(id, sandbox: nil, x_profile_id: nil, request_options: {})
       #
       # @param id [String] Path param: Contact ID from route parameter
       #
-      # @param body [Sentdm::Models::ContactDeleteParams::Body] Body param: Request to delete/dissociate a contact
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
       # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
       #
@@ -165,13 +165,14 @@ module Sentdm
       # @return [nil]
       #
       # @see Sentdm::Models::ContactDeleteParams
-      def delete(id, params)
+      def delete(id, params = {})
         parsed, options = Sentdm::ContactDeleteParams.dump_request(params)
+        header_params = {x_profile_id: "x-profile-id"}
         @client.request(
           method: :delete,
           path: ["v3/contacts/%1$s", id],
-          headers: parsed.except(:body).transform_keys(x_profile_id: "x-profile-id"),
-          body: parsed[:body],
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
           model: NilClass,
           options: options
         )

data/lib/sentdm/resources/profiles/campaigns.rb

@@ -117,13 +117,13 @@ module Sentdm
         # Deletes a campaign by ID from the brand of the specified profile. The profile
         # must belong to the authenticated organization.
         #
-        # @overload delete(campaign_id, profile_id:, body:, x_profile_id: nil, request_options: {})
+        # @overload delete(campaign_id, profile_id:, sandbox: nil, x_profile_id: nil, request_options: {})
         #
         # @param campaign_id [String] Path param: Campaign ID from route parameter
         #
         # @param profile_id [String] Path param: Profile ID from route parameter
         #
-        # @param body [Sentdm::Models::Profiles::CampaignDeleteParams::Body] Body param: Request to delete a campaign from a brand
+        # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
         #
         # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
         #
@@ -138,11 +138,12 @@ module Sentdm
             parsed.delete(:profile_id) do
               raise ArgumentError.new("missing required path argument #{_1}")
             end
+          header_params = {x_profile_id: "x-profile-id"}
           @client.request(
             method: :delete,
             path: ["v3/profiles/%1$s/campaigns/%2$s", profile_id, campaign_id],
-            headers: parsed.except(:body).transform_keys(x_profile_id: "x-profile-id"),
-            body: parsed[:body],
+            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+            body: parsed.except(*header_params.keys),
             model: NilClass,
             options: options
           )

data/lib/sentdm/resources/profiles.rb

@@ -255,11 +255,11 @@ module Sentdm
       # Soft deletes a sender profile. The profile will be marked as deleted but data is
       # retained. Requires admin role in the organization.
       #
-      # @overload delete(profile_id, body:, x_profile_id: nil, request_options: {})
+      # @overload delete(profile_id, sandbox: nil, x_profile_id: nil, request_options: {})
       #
       # @param profile_id [String] Path param
       #
-      # @param body [Sentdm::Models::ProfileDeleteParams::Body] Body param: Request to delete a profile
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
       # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
       #
@@ -268,13 +268,14 @@ module Sentdm
       # @return [nil]
       #
       # @see Sentdm::Models::ProfileDeleteParams
-      def delete(profile_id, params)
+      def delete(profile_id, params = {})
         parsed, options = Sentdm::ProfileDeleteParams.dump_request(params)
+        header_params = {x_profile_id: "x-profile-id"}
         @client.request(
           method: :delete,
           path: ["v3/profiles/%1$s", profile_id],
-          headers: parsed.except(:body).transform_keys(x_profile_id: "x-profile-id"),
-          body: parsed[:body],
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
           model: NilClass,
           options: options
         )
@@ -316,7 +317,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Object]
+      # @return [Sentdm::Models::ProfileCompleteResponse]
       #
       # @see Sentdm::Models::ProfileCompleteParams
       def complete(profile_id, params)
@@ -327,7 +328,7 @@ module Sentdm
           path: ["v3/profiles/%1$s/complete", profile_id],
           headers: parsed.slice(*header_params.keys).transform_keys(header_params),
           body: parsed.except(*header_params.keys),
-          model: Sentdm::Internal::Type::Unknown,
+          model: Sentdm::Models::ProfileCompleteResponse,
           options: options
         )
       end

data/lib/sentdm/resources/users.rb

@@ -104,11 +104,11 @@ module Sentdm
       # Removes a user's access to an organization or profile. Requires admin role. You
       # cannot remove yourself or remove the last admin.
       #
-      # @overload remove(user_id, body:, x_profile_id: nil, request_options: {})
+      # @overload remove(user_id, sandbox: nil, x_profile_id: nil, request_options: {})
       #
       # @param user_id [String] Path param
       #
-      # @param body [Sentdm::Models::UserRemoveParams::Body] Body param: Request to remove a user from an organization
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
       # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
       #
@@ -117,13 +117,14 @@ module Sentdm
       # @return [nil]
       #
       # @see Sentdm::Models::UserRemoveParams
-      def remove(user_id, params)
+      def remove(user_id, params = {})
         parsed, options = Sentdm::UserRemoveParams.dump_request(params)
+        header_params = {x_profile_id: "x-profile-id"}
         @client.request(
           method: :delete,
           path: ["v3/users/%1$s", user_id],
-          headers: parsed.except(:body).transform_keys(x_profile_id: "x-profile-id"),
-          body: parsed[:body],
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
           model: NilClass,
           options: options
         )

data/lib/sentdm/resources/webhooks.rb

@@ -249,11 +249,11 @@ 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, x_profile_id: nil, request_options: {})
+      # @overload rotate_secret(id, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
       # @param id [String] Path param
       #
-      # @param body [Sentdm::Models::WebhookRotateSecretParams::Body] Body param
+      # @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
       #
@@ -264,16 +264,14 @@ module Sentdm
       # @return [Sentdm::Models::WebhookRotateSecretResponse]
       #
       # @see Sentdm::Models::WebhookRotateSecretParams
-      def rotate_secret(id, params)
+      def rotate_secret(id, params = {})
         parsed, options = Sentdm::WebhookRotateSecretParams.dump_request(params)
+        header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
         @client.request(
           method: :post,
           path: ["v3/webhooks/%1$s/rotate-secret", id],
-          headers: parsed.except(:body).transform_keys(
-            idempotency_key: "idempotency-key",
-            x_profile_id: "x-profile-id"
-          ),
-          body: parsed[:body],
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
           model: Sentdm::Models::WebhookRotateSecretResponse,
           options: options
         )

data/lib/sentdm/version.rb

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

data/rbi/sentdm/models/contact_delete_params.rbi

@@ -2,7 +2,7 @@
 
 module Sentdm
   module Models
-    class ContactDeleteParams < Sentdm::Internal::Type::BaseModel
+    class ContactDeleteParams < Sentdm::Models::MutationRequest
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
@@ -14,13 +14,6 @@ module Sentdm
       sig { returns(String) }
       attr_accessor :id
 
-      # Request to delete/dissociate a contact
-      sig { returns(Sentdm::ContactDeleteParams::Body) }
-      attr_reader :body
-
-      sig { params(body: Sentdm::ContactDeleteParams::Body::OrHash).void }
-      attr_writer :body
-
       sig { returns(T.nilable(String)) }
       attr_reader :x_profile_id
 
@@ -30,25 +23,17 @@ module Sentdm
       sig do
         params(
           id: String,
-          body: Sentdm::ContactDeleteParams::Body::OrHash,
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        id:,
-        # Request to delete/dissociate a contact
-        body:,
-        x_profile_id: nil,
-        request_options: {}
-      )
+      def self.new(id:, x_profile_id: nil, request_options: {})
       end
 
       sig do
         override.returns(
           {
             id: String,
-            body: Sentdm::ContactDeleteParams::Body,
             x_profile_id: String,
             request_options: Sentdm::RequestOptions
           }
@@ -56,22 +41,6 @@ module Sentdm
       end
       def to_hash
       end
-
-      class Body < Sentdm::Models::MutationRequest
-        OrHash =
-          T.type_alias do
-            T.any(Sentdm::ContactDeleteParams::Body, Sentdm::Internal::AnyHash)
-          end
-
-        # Request to delete/dissociate a contact
-        sig { returns(T.attached_class) }
-        def self.new
-        end
-
-        sig { override.returns({}) }
-        def to_hash
-        end
-      end
     end
   end
 end