sentdm 0.4.0 → 0.5.0

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

@@ -2,13 +2,14 @@
 
 module Sentdm
   module Models
-    module Brands
-      class APIResponseTcrCampaignWithUseCases < Sentdm::Internal::Type::BaseModel
+    module Profiles
+      # @see Sentdm::Resources::Profiles::Campaigns#create
+      class APIResponseOfTcrCampaignWithUseCases < Sentdm::Internal::Type::BaseModel
         # @!attribute data
         #   The response data (null if error)
         #
-        #   @return [Sentdm::Models::Brands::TcrCampaignWithUseCases, nil]
-        optional :data, -> { Sentdm::Brands::TcrCampaignWithUseCases }, nil?: true
+        #   @return [Sentdm::Models::Profiles::TcrCampaignWithUseCases, nil]
+        optional :data, -> { Sentdm::Profiles::TcrCampaignWithUseCases }, nil?: true
 
         # @!attribute error
         #   Error details (null if successful)
@@ -31,7 +32,7 @@ module Sentdm
         # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
         #   Standard API response envelope for all v3 endpoints
         #
-        #   @param data [Sentdm::Models::Brands::TcrCampaignWithUseCases, nil] The response data (null if error)
+        #   @param data [Sentdm::Models::Profiles::TcrCampaignWithUseCases, nil] The response data (null if error)
         #
         #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
         #

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Profiles
+      # @see Sentdm::Resources::Profiles::Campaigns#create
+      class CampaignCreateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute profile_id
+        #
+        #   @return [String]
+        required :profile_id, String
+
+        # @!attribute campaign
+        #   Campaign data
+        #
+        #   @return [Sentdm::Models::Profiles::CampaignData]
+        required :campaign, -> { Sentdm::Profiles::CampaignData }
+
+        # @!attribute sandbox
+        #   Sandbox flag - when true, the operation is simulated without side effects Useful
+        #   for testing integrations without actual execution
+        #
+        #   @return [Boolean, nil]
+        optional :sandbox, Sentdm::Internal::Type::Boolean
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_profile_id
+        #
+        #   @return [String, nil]
+        optional :x_profile_id, String
+
+        # @!method initialize(profile_id:, campaign:, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Profiles::CampaignCreateParams} for more details.
+        #
+        #   @param profile_id [String]
+        #
+        #   @param campaign [Sentdm::Models::Profiles::CampaignData] Campaign data
+        #
+        #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param x_profile_id [String]
+        #
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/{brands → profiles}/campaign_data.rb

@@ -2,7 +2,7 @@
 
 module Sentdm
   module Models
-    module Brands
+    module Profiles
       class CampaignData < Sentdm::Internal::Type::BaseModel
         # @!attribute description
         #   Campaign description
@@ -25,11 +25,9 @@ module Sentdm
         # @!attribute use_cases
         #   List of use cases with sample messages
         #
-        #   @return [Array<Sentdm::Models::Brands::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData>]
+        #   @return [Array<Sentdm::Models::Profiles::CampaignData::UseCase>]
         required :use_cases,
-                 -> {
-                   Sentdm::Internal::Type::ArrayOf[Sentdm::Brands::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData]
-                 },
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Profiles::CampaignData::UseCase] },
                  api_name: :useCases
 
         # @!attribute help_keywords
@@ -88,7 +86,7 @@ module Sentdm
 
         # @!method initialize(description:, name:, type:, use_cases:, help_keywords: nil, help_message: nil, message_flow: nil, optin_keywords: nil, optin_message: nil, optout_keywords: nil, optout_message: nil, privacy_policy_link: nil, terms_and_conditions_link: nil)
         #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::Brands::CampaignData} for more details.
+        #   {Sentdm::Models::Profiles::CampaignData} for more details.
         #
         #   Campaign data for create or update operation
         #
@@ -98,7 +96,7 @@ module Sentdm
         #
         #   @param type [String] Campaign type (e.g., "KYC", "App")
         #
-        #   @param use_cases [Array<Sentdm::Models::Brands::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData>] List of use cases with sample messages
+        #   @param use_cases [Array<Sentdm::Models::Profiles::CampaignData::UseCase>] List of use cases with sample messages
         #
         #   @param help_keywords [String, nil] Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
         #
@@ -117,6 +115,29 @@ module Sentdm
         #   @param privacy_policy_link [String, nil] URL to privacy policy
         #
         #   @param terms_and_conditions_link [String, nil] URL to terms and conditions
+
+        class UseCase < Sentdm::Internal::Type::BaseModel
+          # @!attribute messaging_use_case_us
+          #   US messaging use case category
+          #
+          #   @return [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs]
+          required :messaging_use_case_us,
+                   enum: -> { Sentdm::Profiles::MessagingUseCaseUs },
+                   api_name: :messagingUseCaseUs
+
+          # @!attribute sample_messages
+          #   Sample messages for this use case (1-5 messages, max 1024 characters each)
+          #
+          #   @return [Array<String>]
+          required :sample_messages, Sentdm::Internal::Type::ArrayOf[String], api_name: :sampleMessages
+
+          # @!method initialize(messaging_use_case_us:, sample_messages:)
+          #   Campaign use case with sample messages
+          #
+          #   @param messaging_use_case_us [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs] US messaging use case category
+          #
+          #   @param sample_messages [Array<String>] Sample messages for this use case (1-5 messages, max 1024 characters each)
+        end
       end
     end
   end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Profiles
+      # @see Sentdm::Resources::Profiles::Campaigns#delete
+      class CampaignDeleteParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute profile_id
+        #
+        #   @return [String]
+        required :profile_id, String
+
+        # @!attribute campaign_id
+        #
+        #   @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: {})
+        #   @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::MutationRequestBase
+          # @!method initialize
+          #   Request to delete a campaign from a brand
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Profiles
+      # @see Sentdm::Resources::Profiles::Campaigns#list
+      class CampaignListParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute profile_id
+        #
+        #   @return [String]
+        required :profile_id, String
+
+        # @!attribute x_profile_id
+        #
+        #   @return [String, nil]
+        optional :x_profile_id, String
+
+        # @!method initialize(profile_id:, x_profile_id: nil, request_options: {})
+        #   @param profile_id [String]
+        #   @param x_profile_id [String]
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Profiles
+      # @see Sentdm::Resources::Profiles::Campaigns#list
+      class CampaignListResponse < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   The response data (null if error)
+        #
+        #   @return [Array<Sentdm::Models::Profiles::TcrCampaignWithUseCases>, nil]
+        optional :data,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Profiles::TcrCampaignWithUseCases] },
+                 nil?: true
+
+        # @!attribute error
+        #   Error details (null if successful)
+        #
+        #   @return [Sentdm::Models::APIError, nil]
+        optional :error, -> { Sentdm::APIError }, nil?: true
+
+        # @!attribute meta
+        #   Metadata about the request and response
+        #
+        #   @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)
+        #   Standard API response envelope for all v3 endpoints
+        #
+        #   @param data [Array<Sentdm::Models::Profiles::TcrCampaignWithUseCases>, nil] The response data (null if error)
+        #
+        #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+        #
+        #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+        #
+        #   @param success [Boolean] Indicates whether the request was successful
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Profiles
+      # @see Sentdm::Resources::Profiles::Campaigns#update
+      class CampaignUpdateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute profile_id
+        #
+        #   @return [String]
+        required :profile_id, String
+
+        # @!attribute campaign_id
+        #
+        #   @return [String]
+        required :campaign_id, String
+
+        # @!attribute campaign
+        #   Campaign data
+        #
+        #   @return [Sentdm::Models::Profiles::CampaignData]
+        required :campaign, -> { Sentdm::Profiles::CampaignData }
+
+        # @!attribute sandbox
+        #   Sandbox flag - when true, the operation is simulated without side effects Useful
+        #   for testing integrations without actual execution
+        #
+        #   @return [Boolean, nil]
+        optional :sandbox, Sentdm::Internal::Type::Boolean
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_profile_id
+        #
+        #   @return [String, nil]
+        optional :x_profile_id, String
+
+        # @!method initialize(profile_id:, campaign_id:, campaign:, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Profiles::CampaignUpdateParams} for more details.
+        #
+        #   @param profile_id [String]
+        #
+        #   @param campaign_id [String]
+        #
+        #   @param campaign [Sentdm::Models::Profiles::CampaignData] Campaign data
+        #
+        #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param x_profile_id [String]
+        #
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/{brands → profiles}/messaging_use_case_us.rb

@@ -2,7 +2,7 @@
 
 module Sentdm
   module Models
-    module Brands
+    module Profiles
       module MessagingUseCaseUs
         extend Sentdm::Internal::Type::Enum
 

data/lib/sentdm/models/{brands → profiles}/tcr_campaign_with_use_cases.rb

@@ -2,8 +2,8 @@
 
 module Sentdm
   module Models
-    module Brands
-      class TcrCampaignWithUseCases < Sentdm::Models::Brands::BaseDto
+    module Profiles
+      class TcrCampaignWithUseCases < Sentdm::Models::BaseDto
         # @!attribute billed_date
         #
         #   @return [Time, nil]
@@ -91,16 +91,16 @@ module Sentdm
 
         # @!attribute sharing_status
         #
-        #   @return [Symbol, Sentdm::Models::Brands::TcrCampaignWithUseCases::SharingStatus, nil]
+        #   @return [Symbol, Sentdm::Models::Profiles::TcrCampaignWithUseCases::SharingStatus, nil]
         optional :sharing_status,
-                 enum: -> { Sentdm::Brands::TcrCampaignWithUseCases::SharingStatus },
+                 enum: -> { Sentdm::Profiles::TcrCampaignWithUseCases::SharingStatus },
                  api_name: :sharingStatus,
                  nil?: true
 
         # @!attribute status
         #
-        #   @return [Symbol, Sentdm::Models::Brands::TcrCampaignWithUseCases::Status, nil]
-        optional :status, enum: -> { Sentdm::Brands::TcrCampaignWithUseCases::Status }, nil?: true
+        #   @return [Symbol, Sentdm::Models::Profiles::TcrCampaignWithUseCases::Status, nil]
+        optional :status, enum: -> { Sentdm::Profiles::TcrCampaignWithUseCases::Status }, nil?: true
 
         # @!attribute submitted_at
         #
@@ -144,9 +144,9 @@ module Sentdm
 
         # @!attribute use_cases
         #
-        #   @return [Array<Sentdm::Models::Brands::TcrCampaignWithUseCases::UseCase>, nil]
+        #   @return [Array<Sentdm::Models::Profiles::TcrCampaignWithUseCases::UseCase>, nil]
         optional :use_cases,
-                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Brands::TcrCampaignWithUseCases::UseCase] },
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Profiles::TcrCampaignWithUseCases::UseCase] },
                  api_name: :useCases
 
         # @!method initialize(billed_date: nil, brand_id: nil, cost: nil, csp_id: nil, customer_id: nil, description: nil, help_keywords: nil, help_message: nil, kyc_submission_form_id: nil, message_flow: nil, name: nil, optin_keywords: nil, optin_message: nil, optout_keywords: nil, optout_message: nil, privacy_policy_link: nil, reseller_id: nil, sharing_status: nil, status: nil, submitted_at: nil, submitted_to_tcr: nil, tcr_campaign_id: nil, tcr_sync_error: nil, telnyx_campaign_id: nil, terms_and_conditions_link: nil, type: nil, upstream_cnp_id: nil, use_cases: nil)
@@ -167,8 +167,8 @@ module Sentdm
         #   @param optout_message [String, nil]
         #   @param privacy_policy_link [String, nil]
         #   @param reseller_id [String, nil]
-        #   @param sharing_status [Symbol, Sentdm::Models::Brands::TcrCampaignWithUseCases::SharingStatus, nil]
-        #   @param status [Symbol, Sentdm::Models::Brands::TcrCampaignWithUseCases::Status, nil]
+        #   @param sharing_status [Symbol, Sentdm::Models::Profiles::TcrCampaignWithUseCases::SharingStatus, nil]
+        #   @param status [Symbol, Sentdm::Models::Profiles::TcrCampaignWithUseCases::Status, nil]
         #   @param submitted_at [Time, nil]
         #   @param submitted_to_tcr [Boolean]
         #   @param tcr_campaign_id [String, nil]
@@ -177,7 +177,7 @@ module Sentdm
         #   @param terms_and_conditions_link [String, nil]
         #   @param type [String]
         #   @param upstream_cnp_id [String, nil]
-        #   @param use_cases [Array<Sentdm::Models::Brands::TcrCampaignWithUseCases::UseCase>]
+        #   @param use_cases [Array<Sentdm::Models::Profiles::TcrCampaignWithUseCases::UseCase>]
 
         module SharingStatus
           extend Sentdm::Internal::Type::Enum
@@ -201,7 +201,7 @@ module Sentdm
           #   @return [Array<Symbol>]
         end
 
-        class UseCase < Sentdm::Models::Brands::BaseDto
+        class UseCase < Sentdm::Models::BaseDto
           # @!attribute campaign_id
           #
           #   @return [String, nil]
@@ -214,9 +214,9 @@ module Sentdm
 
           # @!attribute messaging_use_case_us
           #
-          #   @return [Symbol, Sentdm::Models::Brands::MessagingUseCaseUs, nil]
+          #   @return [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs, nil]
           optional :messaging_use_case_us,
-                   enum: -> { Sentdm::Brands::MessagingUseCaseUs },
+                   enum: -> { Sentdm::Profiles::MessagingUseCaseUs },
                    api_name: :messagingUseCaseUs
 
           # @!attribute sample_messages
@@ -227,7 +227,7 @@ module Sentdm
           # @!method initialize(campaign_id: nil, customer_id: nil, messaging_use_case_us: nil, sample_messages: nil)
           #   @param campaign_id [String]
           #   @param customer_id [String]
-          #   @param messaging_use_case_us [Symbol, Sentdm::Models::Brands::MessagingUseCaseUs]
+          #   @param messaging_use_case_us [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs]
           #   @param sample_messages [Array<String>]
         end
       end