sentdm 0.4.0 → 0.7.0

data/rbi/sentdm/models/profile_update_params.rbi

@@ -29,13 +29,12 @@ module Sentdm
       # Billing contact for this profile. Required when billing_model is "profile" or
       # "profile_and_organization" and no billing contact has been configured yet.
       # Identifies who receives invoices and who is responsible for payment.
-      sig { returns(T.nilable(Sentdm::ProfileUpdateParams::BillingContact)) }
+      sig { returns(T.nilable(Sentdm::BillingContactInfo)) }
       attr_reader :billing_contact
 
       sig do
         params(
-          billing_contact:
-            T.nilable(Sentdm::ProfileUpdateParams::BillingContact::OrHash)
+          billing_contact: T.nilable(Sentdm::BillingContactInfo::OrHash)
         ).void
       end
       attr_writer :billing_contact
@@ -54,10 +53,10 @@ module Sentdm
       # updates the brand associated with this profile. Cannot be set when
       # inherit_tcr_brand is true. Once a brand has been submitted to TCR it cannot be
       # modified.
-      sig { returns(T.nilable(Sentdm::BrandData)) }
+      sig { returns(T.nilable(Sentdm::BrandsBrandData)) }
       attr_reader :brand
 
-      sig { params(brand: T.nilable(Sentdm::BrandData::OrHash)).void }
+      sig { params(brand: T.nilable(Sentdm::BrandsBrandData::OrHash)).void }
       attr_writer :brand
 
       # Profile description (optional)
@@ -91,14 +90,11 @@ module Sentdm
       # Payment card details for this profile (optional). Accepted when billing_model is
       # "profile" or "profile_and_organization". Not persisted on our servers —
       # forwarded to the payment processor.
-      sig { returns(T.nilable(Sentdm::ProfileUpdateParams::PaymentDetails)) }
+      sig { returns(T.nilable(Sentdm::PaymentDetails)) }
       attr_reader :payment_details
 
       sig do
-        params(
-          payment_details:
-            T.nilable(Sentdm::ProfileUpdateParams::PaymentDetails::OrHash)
-        ).void
+        params(payment_details: T.nilable(Sentdm::PaymentDetails::OrHash)).void
       end
       attr_writer :payment_details
 
@@ -150,10 +146,9 @@ module Sentdm
           allow_contact_sharing: T.nilable(T::Boolean),
           allow_number_change_during_onboarding: T.nilable(T::Boolean),
           allow_template_sharing: T.nilable(T::Boolean),
-          billing_contact:
-            T.nilable(Sentdm::ProfileUpdateParams::BillingContact::OrHash),
+          billing_contact: T.nilable(Sentdm::BillingContactInfo::OrHash),
           billing_model: T.nilable(String),
-          brand: T.nilable(Sentdm::BrandData::OrHash),
+          brand: T.nilable(Sentdm::BrandsBrandData::OrHash),
           description: T.nilable(String),
           icon: T.nilable(String),
           inherit_contacts: T.nilable(T::Boolean),
@@ -161,8 +156,7 @@ module Sentdm
           inherit_tcr_campaign: T.nilable(T::Boolean),
           inherit_templates: T.nilable(T::Boolean),
           name: T.nilable(String),
-          payment_details:
-            T.nilable(Sentdm::ProfileUpdateParams::PaymentDetails::OrHash),
+          payment_details: T.nilable(Sentdm::PaymentDetails::OrHash),
           sandbox: T::Boolean,
           sending_phone_number: T.nilable(String),
           sending_phone_number_profile_id: T.nilable(String),
@@ -245,10 +239,9 @@ module Sentdm
             allow_contact_sharing: T.nilable(T::Boolean),
             allow_number_change_during_onboarding: T.nilable(T::Boolean),
             allow_template_sharing: T.nilable(T::Boolean),
-            billing_contact:
-              T.nilable(Sentdm::ProfileUpdateParams::BillingContact),
+            billing_contact: T.nilable(Sentdm::BillingContactInfo),
             billing_model: T.nilable(String),
-            brand: T.nilable(Sentdm::BrandData),
+            brand: T.nilable(Sentdm::BrandsBrandData),
             description: T.nilable(String),
             icon: T.nilable(String),
             inherit_contacts: T.nilable(T::Boolean),
@@ -256,8 +249,7 @@ module Sentdm
             inherit_tcr_campaign: T.nilable(T::Boolean),
             inherit_templates: T.nilable(T::Boolean),
             name: T.nilable(String),
-            payment_details:
-              T.nilable(Sentdm::ProfileUpdateParams::PaymentDetails),
+            payment_details: T.nilable(Sentdm::PaymentDetails),
             sandbox: T::Boolean,
             sending_phone_number: T.nilable(String),
             sending_phone_number_profile_id: T.nilable(String),
@@ -272,132 +264,6 @@ module Sentdm
       end
       def to_hash
       end
-
-      class BillingContact < Sentdm::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Sentdm::ProfileUpdateParams::BillingContact,
-              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 for this profile. Required when billing_model is "profile" or
-        # "profile_and_organization" and no billing contact has been configured yet.
-        # Identifies who receives invoices and who is responsible for payment.
-        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
-
-      class PaymentDetails < Sentdm::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Sentdm::ProfileUpdateParams::PaymentDetails,
-              Sentdm::Internal::AnyHash
-            )
-          end
-
-        # Card number (digits only, 13–19 characters)
-        sig { returns(String) }
-        attr_accessor :card_number
-
-        # Card security code (3–4 digits)
-        sig { returns(String) }
-        attr_accessor :cvc
-
-        # Card expiry date in MM/YY format (e.g. "09/27")
-        sig { returns(String) }
-        attr_accessor :expiry
-
-        # Billing ZIP / postal code associated with the card
-        sig { returns(String) }
-        attr_accessor :zip_code
-
-        # Payment card details for this profile (optional). Accepted when billing_model is
-        # "profile" or "profile_and_organization". Not persisted on our servers —
-        # forwarded to the payment processor.
-        sig do
-          params(
-            card_number: String,
-            cvc: String,
-            expiry: String,
-            zip_code: String
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Card number (digits only, 13–19 characters)
-          card_number:,
-          # Card security code (3–4 digits)
-          cvc:,
-          # Card expiry date in MM/YY format (e.g. "09/27")
-          expiry:,
-          # Billing ZIP / postal code associated with the card
-          zip_code:
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              card_number: String,
-              cvc: String,
-              expiry: String,
-              zip_code: String
-            }
-          )
-        end
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/sentdm/models/{brands/api_response_tcr_campaign_with_use_cases.rbi → profiles/api_response_of_tcr_campaign_with_use_cases.rbi}

@@ -2,23 +2,23 @@
 
 module Sentdm
   module Models
-    module Brands
-      class APIResponseTcrCampaignWithUseCases < Sentdm::Internal::Type::BaseModel
+    module Profiles
+      class APIResponseOfTcrCampaignWithUseCases < Sentdm::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
             T.any(
-              Sentdm::Brands::APIResponseTcrCampaignWithUseCases,
+              Sentdm::Profiles::APIResponseOfTcrCampaignWithUseCases,
               Sentdm::Internal::AnyHash
             )
           end
 
         # The response data (null if error)
-        sig { returns(T.nilable(Sentdm::Brands::TcrCampaignWithUseCases)) }
+        sig { returns(T.nilable(Sentdm::Profiles::TcrCampaignWithUseCases)) }
         attr_reader :data
 
         sig do
           params(
-            data: T.nilable(Sentdm::Brands::TcrCampaignWithUseCases::OrHash)
+            data: T.nilable(Sentdm::Profiles::TcrCampaignWithUseCases::OrHash)
           ).void
         end
         attr_writer :data
@@ -47,7 +47,7 @@ module Sentdm
         # Standard API response envelope for all v3 endpoints
         sig do
           params(
-            data: T.nilable(Sentdm::Brands::TcrCampaignWithUseCases::OrHash),
+            data: T.nilable(Sentdm::Profiles::TcrCampaignWithUseCases::OrHash),
             error: T.nilable(Sentdm::APIError::OrHash),
             meta: Sentdm::APIMeta::OrHash,
             success: T::Boolean
@@ -68,7 +68,7 @@ module Sentdm
         sig do
           override.returns(
             {
-              data: T.nilable(Sentdm::Brands::TcrCampaignWithUseCases),
+              data: T.nilable(Sentdm::Profiles::TcrCampaignWithUseCases),
               error: T.nilable(Sentdm::APIError),
               meta: Sentdm::APIMeta,
               success: T::Boolean

data/rbi/sentdm/models/profiles/campaign_create_params.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Profiles
+      class CampaignCreateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Profiles::CampaignCreateParams,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :profile_id
+
+        # Campaign data
+        sig { returns(Sentdm::Profiles::CampaignData) }
+        attr_reader :campaign
+
+        sig { params(campaign: Sentdm::Profiles::CampaignData::OrHash).void }
+        attr_writer :campaign
+
+        # Sandbox flag - when true, the operation is simulated without side effects Useful
+        # for testing integrations without actual execution
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :sandbox
+
+        sig { params(sandbox: T::Boolean).void }
+        attr_writer :sandbox
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_profile_id
+
+        sig { params(x_profile_id: String).void }
+        attr_writer :x_profile_id
+
+        sig do
+          params(
+            profile_id: String,
+            campaign: Sentdm::Profiles::CampaignData::OrHash,
+            sandbox: T::Boolean,
+            idempotency_key: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          profile_id:,
+          # Campaign data
+          campaign:,
+          # Sandbox flag - when true, the operation is simulated without side effects Useful
+          # for testing integrations without actual execution
+          sandbox: nil,
+          idempotency_key: nil,
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              profile_id: String,
+              campaign: Sentdm::Profiles::CampaignData,
+              sandbox: T::Boolean,
+              idempotency_key: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/{brands → profiles}/campaign_data.rbi

@@ -2,11 +2,11 @@
 
 module Sentdm
   module Models
-    module Brands
+    module Profiles
       class CampaignData < Sentdm::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
-            T.any(Sentdm::Brands::CampaignData, Sentdm::Internal::AnyHash)
+            T.any(Sentdm::Profiles::CampaignData, Sentdm::Internal::AnyHash)
           end
 
         # Campaign description
@@ -25,7 +25,7 @@ module Sentdm
         sig do
           returns(
             T::Array[
-              Sentdm::Brands::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData
+              Sentdm::Profiles::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData
             ]
           )
         end
@@ -75,7 +75,7 @@ module Sentdm
             type: String,
             use_cases:
               T::Array[
-                Sentdm::Brands::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData::OrHash
+                Sentdm::Profiles::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData::OrHash
               ],
             help_keywords: T.nilable(String),
             help_message: T.nilable(String),
@@ -126,7 +126,7 @@ module Sentdm
               type: String,
               use_cases:
                 T::Array[
-                  Sentdm::Brands::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData
+                  Sentdm::Profiles::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData
                 ],
               help_keywords: T.nilable(String),
               help_message: T.nilable(String),

data/rbi/sentdm/models/profiles/campaign_delete_params.rbi

@@ -0,0 +1,95 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Profiles
+      class CampaignDeleteParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Profiles::CampaignDeleteParams,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :profile_id
+
+        sig { returns(String) }
+        attr_accessor :campaign_id
+
+        # Request to delete a campaign from a brand
+        sig { returns(Sentdm::Profiles::CampaignDeleteParams::Body) }
+        attr_reader :body
+
+        sig do
+          params(
+            body: Sentdm::Profiles::CampaignDeleteParams::Body::OrHash
+          ).void
+        end
+        attr_writer :body
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_profile_id
+
+        sig { params(x_profile_id: String).void }
+        attr_writer :x_profile_id
+
+        sig do
+          params(
+            profile_id: String,
+            campaign_id: String,
+            body: Sentdm::Profiles::CampaignDeleteParams::Body::OrHash,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          profile_id:,
+          campaign_id:,
+          # Request to delete a campaign from a brand
+          body:,
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              profile_id: String,
+              campaign_id: String,
+              body: Sentdm::Profiles::CampaignDeleteParams::Body,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Body < Sentdm::Models::MutationRequestBase
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::Profiles::CampaignDeleteParams::Body,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          # Request to delete a campaign from a brand
+          sig { returns(T.attached_class) }
+          def self.new
+          end
+
+          sig { override.returns({}) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/profiles/campaign_list_params.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Profiles
+      class CampaignListParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Profiles::CampaignListParams,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :profile_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_profile_id
+
+        sig { params(x_profile_id: String).void }
+        attr_writer :x_profile_id
+
+        sig do
+          params(
+            profile_id: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(profile_id:, x_profile_id: nil, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              profile_id: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/profiles/campaign_list_response.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Profiles
+      class CampaignListResponse < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::Profiles::CampaignListResponse,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # The response data (null if error)
+        sig do
+          returns(
+            T.nilable(T::Array[Sentdm::Profiles::TcrCampaignWithUseCases])
+          )
+        end
+        attr_accessor :data
+
+        # Error details (null if successful)
+        sig { returns(T.nilable(Sentdm::APIError)) }
+        attr_reader :error
+
+        sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
+        attr_writer :error
+
+        # Metadata about the request and response
+        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(
+                T::Array[Sentdm::Profiles::TcrCampaignWithUseCases::OrHash]
+              ),
+            error: T.nilable(Sentdm::APIError::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 details (null if successful)
+          error: nil,
+          # Metadata about the request and response
+          meta: nil,
+          # Indicates whether the request was successful
+          success: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              data:
+                T.nilable(T::Array[Sentdm::Profiles::TcrCampaignWithUseCases]),
+              error: T.nilable(Sentdm::APIError),
+              meta: Sentdm::APIMeta,
+              success: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end