sentdm 0.19.0 → 0.20.0

data/lib/sentdm/resources/webhooks.rb

@@ -31,7 +31,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::WebhookCreateResponse]
+      # @return [Sentdm::Models::APIResponseWebhook]
       #
       # @see Sentdm::Models::WebhookCreateParams
       def create(params = {})
@@ -42,7 +42,7 @@ module Sentdm
           path: "v3/webhooks",
           headers: parsed.slice(*header_params.keys).transform_keys(header_params),
           body: parsed.except(*header_params.keys),
-          model: Sentdm::Models::WebhookCreateResponse,
+          model: Sentdm::APIResponseWebhook,
           options: options
         )
       end
@@ -60,7 +60,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::WebhookRetrieveResponse]
+      # @return [Sentdm::Models::APIResponseWebhook]
       #
       # @see Sentdm::Models::WebhookRetrieveParams
       def retrieve(id, params = {})
@@ -69,7 +69,7 @@ module Sentdm
           method: :get,
           path: ["v3/webhooks/%1$s", id],
           headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
-          model: Sentdm::Models::WebhookRetrieveResponse,
+          model: Sentdm::APIResponseWebhook,
           options: options
         )
       end
@@ -103,7 +103,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::WebhookUpdateResponse]
+      # @return [Sentdm::Models::APIResponseWebhook]
       #
       # @see Sentdm::Models::WebhookUpdateParams
       def update(id, params = {})
@@ -114,7 +114,7 @@ module Sentdm
           path: ["v3/webhooks/%1$s", id],
           headers: parsed.slice(*header_params.keys).transform_keys(header_params),
           body: parsed.except(*header_params.keys),
-          model: Sentdm::Models::WebhookUpdateResponse,
+          model: Sentdm::APIResponseWebhook,
           options: options
         )
       end
@@ -331,7 +331,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::WebhookToggleStatusResponse]
+      # @return [Sentdm::Models::APIResponseWebhook]
       #
       # @see Sentdm::Models::WebhookToggleStatusParams
       def toggle_status(id, params = {})
@@ -342,7 +342,7 @@ module Sentdm
           path: ["v3/webhooks/%1$s/toggle-status", id],
           headers: parsed.slice(*header_params.keys).transform_keys(header_params),
           body: parsed.except(*header_params.keys),
-          model: Sentdm::Models::WebhookToggleStatusResponse,
+          model: Sentdm::APIResponseWebhook,
           options: options
         )
       end

data/lib/sentdm/version.rb

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

data/lib/sentdm.rb

@@ -52,15 +52,25 @@ 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/profiles/base_dto"
+require_relative "sentdm/models/api_meta"
+require_relative "sentdm/models/api_response_of_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/billing_contact_info"
+require_relative "sentdm/models/brands_brand_data"
 require_relative "sentdm/models/contact_create_params"
-require_relative "sentdm/models/contact_create_response"
 require_relative "sentdm/models/contact_delete_params"
 require_relative "sentdm/models/contact_list_params"
 require_relative "sentdm/models/contact_list_response"
+require_relative "sentdm/models/contact_response"
 require_relative "sentdm/models/contact_retrieve_params"
-require_relative "sentdm/models/contact_retrieve_response"
 require_relative "sentdm/models/contact_update_params"
-require_relative "sentdm/models/contact_update_response"
+require_relative "sentdm/models/destination_country"
+require_relative "sentdm/models/error_detail"
 require_relative "sentdm/models/me_retrieve_params"
 require_relative "sentdm/models/me_retrieve_response"
 require_relative "sentdm/models/message_retrieve_activities_params"
@@ -71,61 +81,73 @@ require_relative "sentdm/models/message_send_params"
 require_relative "sentdm/models/message_send_response"
 require_relative "sentdm/models/number_lookup_params"
 require_relative "sentdm/models/number_lookup_response"
+require_relative "sentdm/models/pagination_meta"
+require_relative "sentdm/models/payment_details"
 require_relative "sentdm/models/profile_complete_params"
 require_relative "sentdm/models/profile_complete_response"
 require_relative "sentdm/models/profile_create_params"
-require_relative "sentdm/models/profile_create_response"
 require_relative "sentdm/models/profile_delete_params"
+require_relative "sentdm/models/profile_detail"
 require_relative "sentdm/models/profile_list_params"
 require_relative "sentdm/models/profile_list_response"
 require_relative "sentdm/models/profile_retrieve_params"
-require_relative "sentdm/models/profile_retrieve_response"
+require_relative "sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases"
 require_relative "sentdm/models/profiles/campaign_create_params"
-require_relative "sentdm/models/profiles/campaign_create_response"
+require_relative "sentdm/models/profiles/campaign_data"
 require_relative "sentdm/models/profiles/campaign_delete_params"
 require_relative "sentdm/models/profiles/campaign_list_params"
 require_relative "sentdm/models/profiles/campaign_list_response"
 require_relative "sentdm/models/profiles/campaign_update_params"
-require_relative "sentdm/models/profiles/campaign_update_response"
+require_relative "sentdm/models/profiles/messaging_use_case_us"
+require_relative "sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data"
+require_relative "sentdm/models/profiles/tcr_campaign_with_use_cases"
+require_relative "sentdm/models/profile_settings"
 require_relative "sentdm/models/profile_update_params"
-require_relative "sentdm/models/profile_update_response"
+require_relative "sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config"
+require_relative "sentdm/models/sent_dm_services_common_contracts_poc_os_template_body"
+require_relative "sentdm/models/sent_dm_services_common_contracts_poc_os_template_button"
+require_relative "sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props"
+require_relative "sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer"
+require_relative "sentdm/models/sent_dm_services_common_contracts_poc_os_template_header"
+require_relative "sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info"
+require_relative "sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info"
+require_relative "sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info"
+require_relative "sentdm/models/tcr_brand_relationship"
+require_relative "sentdm/models/tcr_vertical"
+require_relative "sentdm/models/template"
+require_relative "sentdm/models/template_body_content"
 require_relative "sentdm/models/template_create_params"
-require_relative "sentdm/models/template_create_response"
+require_relative "sentdm/models/template_definition"
 require_relative "sentdm/models/template_delete_params"
 require_relative "sentdm/models/template_list_params"
 require_relative "sentdm/models/template_list_response"
 require_relative "sentdm/models/template_retrieve_params"
-require_relative "sentdm/models/template_retrieve_response"
 require_relative "sentdm/models/template_update_params"
-require_relative "sentdm/models/template_update_response"
+require_relative "sentdm/models/template_variable"
 require_relative "sentdm/models/user_invite_params"
-require_relative "sentdm/models/user_invite_response"
 require_relative "sentdm/models/user_list_params"
 require_relative "sentdm/models/user_list_response"
 require_relative "sentdm/models/user_remove_params"
+require_relative "sentdm/models/user_response"
 require_relative "sentdm/models/user_retrieve_params"
-require_relative "sentdm/models/user_retrieve_response"
 require_relative "sentdm/models/user_update_role_params"
-require_relative "sentdm/models/user_update_role_response"
 require_relative "sentdm/models/webhook_create_params"
-require_relative "sentdm/models/webhook_create_response"
 require_relative "sentdm/models/webhook_delete_params"
+require_relative "sentdm/models/webhook_event_type"
 require_relative "sentdm/models/webhook_list_events_params"
 require_relative "sentdm/models/webhook_list_events_response"
 require_relative "sentdm/models/webhook_list_event_types_params"
 require_relative "sentdm/models/webhook_list_event_types_response"
 require_relative "sentdm/models/webhook_list_params"
 require_relative "sentdm/models/webhook_list_response"
+require_relative "sentdm/models/webhook_response"
 require_relative "sentdm/models/webhook_retrieve_params"
-require_relative "sentdm/models/webhook_retrieve_response"
 require_relative "sentdm/models/webhook_rotate_secret_params"
 require_relative "sentdm/models/webhook_rotate_secret_response"
 require_relative "sentdm/models/webhook_test_params"
 require_relative "sentdm/models/webhook_test_response"
 require_relative "sentdm/models/webhook_toggle_status_params"
-require_relative "sentdm/models/webhook_toggle_status_response"
 require_relative "sentdm/models/webhook_update_params"
-require_relative "sentdm/models/webhook_update_response"
 require_relative "sentdm/models"
 require_relative "sentdm/resources/contacts"
 require_relative "sentdm/resources/me"

data/rbi/sentdm/models/api_meta.rbi

@@ -0,0 +1,55 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIMeta < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::APIMeta, Sentdm::Internal::AnyHash) }
+
+      # Unique identifier for this request (for tracing and support)
+      sig { returns(T.nilable(String)) }
+      attr_reader :request_id
+
+      sig { params(request_id: String).void }
+      attr_writer :request_id
+
+      # Server timestamp when the response was generated
+      sig { returns(T.nilable(Time)) }
+      attr_reader :timestamp
+
+      sig { params(timestamp: Time).void }
+      attr_writer :timestamp
+
+      # API version used for this request
+      sig { returns(T.nilable(String)) }
+      attr_reader :version
+
+      sig { params(version: String).void }
+      attr_writer :version
+
+      # Request and response metadata
+      sig do
+        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,
+        # Server timestamp when the response was generated
+        timestamp: nil,
+        # API version used for this request
+        version: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          { request_id: String, timestamp: Time, version: String }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/api_response_of_contact.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseOfContact < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::APIResponseOfContact, Sentdm::Internal::AnyHash)
+        end
+
+      # Contact response for v3 API Uses snake_case for JSON property names
+      sig { returns(T.nilable(Sentdm::ContactResponse)) }
+      attr_reader :data
+
+      sig { params(data: T.nilable(Sentdm::ContactResponse::OrHash)).void }
+      attr_writer :data
+
+      # Error information
+      sig { returns(T.nilable(Sentdm::ErrorDetail)) }
+      attr_reader :error
+
+      sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
+      attr_writer :error
+
+      # Request and response metadata
+      sig { returns(T.nilable(Sentdm::APIMeta)) }
+      attr_reader :meta
+
+      sig { params(meta: Sentdm::APIMeta::OrHash).void }
+      attr_writer :meta
+
+      # Indicates whether the request was successful
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :success
+
+      sig { params(success: T::Boolean).void }
+      attr_writer :success
+
+      # Standard API response envelope for all v3 endpoints
+      sig do
+        params(
+          data: T.nilable(Sentdm::ContactResponse::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Contact response for v3 API Uses snake_case for JSON property names
+        data: nil,
+        # Error information
+        error: nil,
+        # Request and response metadata
+        meta: nil,
+        # Indicates whether the request was successful
+        success: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T.nilable(Sentdm::ContactResponse),
+            error: T.nilable(Sentdm::ErrorDetail),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/api_response_of_profile_detail.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseOfProfileDetail < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::APIResponseOfProfileDetail, Sentdm::Internal::AnyHash)
+        end
+
+      # Detailed profile response for v3 API
+      sig { returns(T.nilable(Sentdm::ProfileDetail)) }
+      attr_reader :data
+
+      sig { params(data: T.nilable(Sentdm::ProfileDetail::OrHash)).void }
+      attr_writer :data
+
+      # Error information
+      sig { returns(T.nilable(Sentdm::ErrorDetail)) }
+      attr_reader :error
+
+      sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
+      attr_writer :error
+
+      # Request and response metadata
+      sig { returns(T.nilable(Sentdm::APIMeta)) }
+      attr_reader :meta
+
+      sig { params(meta: Sentdm::APIMeta::OrHash).void }
+      attr_writer :meta
+
+      # Indicates whether the request was successful
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :success
+
+      sig { params(success: T::Boolean).void }
+      attr_writer :success
+
+      # Standard API response envelope for all v3 endpoints
+      sig do
+        params(
+          data: T.nilable(Sentdm::ProfileDetail::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Detailed profile response for v3 API
+        data: nil,
+        # Error information
+        error: nil,
+        # Request and response metadata
+        meta: nil,
+        # Indicates whether the request was successful
+        success: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T.nilable(Sentdm::ProfileDetail),
+            error: T.nilable(Sentdm::ErrorDetail),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/api_response_of_user.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseOfUser < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::APIResponseOfUser, Sentdm::Internal::AnyHash)
+        end
+
+      # User response for v3 API
+      sig { returns(T.nilable(Sentdm::UserResponse)) }
+      attr_reader :data
+
+      sig { params(data: T.nilable(Sentdm::UserResponse::OrHash)).void }
+      attr_writer :data
+
+      # Error information
+      sig { returns(T.nilable(Sentdm::ErrorDetail)) }
+      attr_reader :error
+
+      sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
+      attr_writer :error
+
+      # Request and response metadata
+      sig { returns(T.nilable(Sentdm::APIMeta)) }
+      attr_reader :meta
+
+      sig { params(meta: Sentdm::APIMeta::OrHash).void }
+      attr_writer :meta
+
+      # Indicates whether the request was successful
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :success
+
+      sig { params(success: T::Boolean).void }
+      attr_writer :success
+
+      # Standard API response envelope for all v3 endpoints
+      sig do
+        params(
+          data: T.nilable(Sentdm::UserResponse::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # User response for v3 API
+        data: nil,
+        # Error information
+        error: nil,
+        # Request and response metadata
+        meta: nil,
+        # Indicates whether the request was successful
+        success: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T.nilable(Sentdm::UserResponse),
+            error: T.nilable(Sentdm::ErrorDetail),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/api_response_template.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseTemplate < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::APIResponseTemplate, Sentdm::Internal::AnyHash)
+        end
+
+      # Template response for v3 API
+      sig { returns(T.nilable(Sentdm::Template)) }
+      attr_reader :data
+
+      sig { params(data: T.nilable(Sentdm::Template::OrHash)).void }
+      attr_writer :data
+
+      # Error information
+      sig { returns(T.nilable(Sentdm::ErrorDetail)) }
+      attr_reader :error
+
+      sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
+      attr_writer :error
+
+      # Request and response metadata
+      sig { returns(T.nilable(Sentdm::APIMeta)) }
+      attr_reader :meta
+
+      sig { params(meta: Sentdm::APIMeta::OrHash).void }
+      attr_writer :meta
+
+      # Indicates whether the request was successful
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :success
+
+      sig { params(success: T::Boolean).void }
+      attr_writer :success
+
+      # Standard API response envelope for all v3 endpoints
+      sig do
+        params(
+          data: T.nilable(Sentdm::Template::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Template response for v3 API
+        data: nil,
+        # Error information
+        error: nil,
+        # Request and response metadata
+        meta: nil,
+        # Indicates whether the request was successful
+        success: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T.nilable(Sentdm::Template),
+            error: T.nilable(Sentdm::ErrorDetail),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/api_response_webhook.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class APIResponseWebhook < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::APIResponseWebhook, Sentdm::Internal::AnyHash)
+        end
+
+      # The response data (null if error)
+      sig { returns(T.nilable(Sentdm::WebhookResponse)) }
+      attr_reader :data
+
+      sig { params(data: T.nilable(Sentdm::WebhookResponse::OrHash)).void }
+      attr_writer :data
+
+      # Error information
+      sig { returns(T.nilable(Sentdm::ErrorDetail)) }
+      attr_reader :error
+
+      sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
+      attr_writer :error
+
+      # Request and response metadata
+      sig { returns(T.nilable(Sentdm::APIMeta)) }
+      attr_reader :meta
+
+      sig { params(meta: Sentdm::APIMeta::OrHash).void }
+      attr_writer :meta
+
+      # Indicates whether the request was successful
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :success
+
+      sig { params(success: T::Boolean).void }
+      attr_writer :success
+
+      # Standard API response envelope for all v3 endpoints
+      sig do
+        params(
+          data: T.nilable(Sentdm::WebhookResponse::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
+          meta: Sentdm::APIMeta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The response data (null if error)
+        data: nil,
+        # Error information
+        error: nil,
+        # Request and response metadata
+        meta: nil,
+        # Indicates whether the request was successful
+        success: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T.nilable(Sentdm::WebhookResponse),
+            error: T.nilable(Sentdm::ErrorDetail),
+            meta: Sentdm::APIMeta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/billing_contact_info.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class BillingContactInfo < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::BillingContactInfo, Sentdm::Internal::AnyHash)
+        end
+
+      # Email address where invoices will be sent (required)
+      sig { returns(String) }
+      attr_accessor :email
+
+      # Full name of the billing contact or company (required)
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Billing address (optional). Free-form text including street, city, state, postal
+      # code, and country.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :address
+
+      # Phone number for the billing contact (optional)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone
+
+      # Billing contact information for a profile. Required when billing_model is
+      # "profile" or "profile_and_organization".
+      sig do
+        params(
+          email: String,
+          name: String,
+          address: T.nilable(String),
+          phone: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Email address where invoices will be sent (required)
+        email:,
+        # Full name of the billing contact or company (required)
+        name:,
+        # Billing address (optional). Free-form text including street, city, state, postal
+        # code, and country.
+        address: nil,
+        # Phone number for the billing contact (optional)
+        phone: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            email: String,
+            name: String,
+            address: T.nilable(String),
+            phone: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end