sentdm 0.29.0 → 0.31.0

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

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Profiles
+      class BrandCampaign < Sentdm::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute billed_date
+        #
+        #   @return [Time, nil]
+        optional :billed_date, Time, api_name: :billedDate, nil?: true
+
+        # @!attribute brand_id
+        #
+        #   @return [String, nil]
+        optional :brand_id, String, api_name: :brandId, nil?: true
+
+        # @!attribute cost
+        #
+        #   @return [Float, nil]
+        optional :cost, Float, nil?: true
+
+        # @!attribute created_at
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time, api_name: :createdAt
+
+        # @!attribute customer_id
+        #
+        #   @return [String, nil]
+        optional :customer_id, String, api_name: :customerId
+
+        # @!attribute dca_elections_complete
+        #   True once every carrier has completed its DCA election and the campaign is
+        #   operationally ready for traffic.
+        #
+        #   @return [Boolean, nil]
+        optional :dca_elections_complete,
+                 Sentdm::Internal::Type::Boolean,
+                 api_name: :dcaElectionsComplete,
+                 nil?: true
+
+        # @!attribute dca_elections_completed_at
+        #
+        #   @return [Time, nil]
+        optional :dca_elections_completed_at, Time, api_name: :dcaElectionsCompletedAt, nil?: true
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute has_submission_transaction
+        #   True when the one-time campaign submission fee has already been charged.
+        #
+        #   @return [Boolean, nil]
+        optional :has_submission_transaction,
+                 Sentdm::Internal::Type::Boolean,
+                 api_name: :hasSubmissionTransaction
+
+        # @!attribute help_keywords
+        #
+        #   @return [String, nil]
+        optional :help_keywords, String, api_name: :helpKeywords, nil?: true
+
+        # @!attribute help_message
+        #
+        #   @return [String, nil]
+        optional :help_message, String, api_name: :helpMessage, nil?: true
+
+        # @!attribute message_flow
+        #
+        #   @return [String, nil]
+        optional :message_flow, String, api_name: :messageFlow, nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute optin_keywords
+        #
+        #   @return [String, nil]
+        optional :optin_keywords, String, api_name: :optinKeywords, nil?: true
+
+        # @!attribute optin_message
+        #
+        #   @return [String, nil]
+        optional :optin_message, String, api_name: :optinMessage, nil?: true
+
+        # @!attribute optout_keywords
+        #
+        #   @return [String, nil]
+        optional :optout_keywords, String, api_name: :optoutKeywords, nil?: true
+
+        # @!attribute optout_message
+        #
+        #   @return [String, nil]
+        optional :optout_message, String, api_name: :optoutMessage, nil?: true
+
+        # @!attribute privacy_policy_link
+        #
+        #   @return [String, nil]
+        optional :privacy_policy_link, String, api_name: :privacyPolicyLink, nil?: true
+
+        # @!attribute status
+        #
+        #   @return [Symbol, Sentdm::Models::Profiles::BrandCampaign::Status, nil]
+        optional :status, enum: -> { Sentdm::Profiles::BrandCampaign::Status }, nil?: true
+
+        # @!attribute submitted_at
+        #
+        #   @return [Time, nil]
+        optional :submitted_at, Time, api_name: :submittedAt, nil?: true
+
+        # @!attribute submitted_to_tcr
+        #
+        #   @return [Boolean, nil]
+        optional :submitted_to_tcr, Sentdm::Internal::Type::Boolean, api_name: :submittedToTCR
+
+        # @!attribute tcr_campaign_id
+        #   The Campaign Registry identifier, once the campaign has been accepted.
+        #
+        #   @return [String, nil]
+        optional :tcr_campaign_id, String, api_name: :tcrCampaignId, nil?: true
+
+        # @!attribute tcr_sync_error
+        #   Surfaced so customers can see why a submission did not reach the registry.
+        #
+        #   @return [String, nil]
+        optional :tcr_sync_error, String, api_name: :tcrSyncError, nil?: true
+
+        # @!attribute terms_and_conditions_link
+        #
+        #   @return [String, nil]
+        optional :terms_and_conditions_link, String, api_name: :termsAndConditionsLink, nil?: true
+
+        # @!attribute type
+        #   Campaign type (for example KYC or App).
+        #
+        #   @return [String, nil]
+        optional :type, String
+
+        # @!attribute updated_at
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time, api_name: :updatedAt, nil?: true
+
+        # @!attribute use_cases
+        #
+        #   @return [Array<Sentdm::Models::Profiles::CampaignUseCase>, nil]
+        optional :use_cases,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Profiles::CampaignUseCase] },
+                 api_name: :useCases
+
+        # @!attribute volume
+        #   Expected messaging volume for this campaign — customer-supplied on
+        #   create/update, and the input to both the TCR usecase classification (LOW_VOLUME
+        #   vs MIXED/specific) and the campaign fee tier. Surfaced so customers can read
+        #   back the value they set.
+        #
+        #   @return [String, nil]
+        optional :volume, String, nil?: true
+
+        # @!method initialize(id: nil, billed_date: nil, brand_id: nil, cost: nil, created_at: nil, customer_id: nil, dca_elections_complete: nil, dca_elections_completed_at: nil, description: nil, has_submission_transaction: nil, help_keywords: nil, help_message: nil, message_flow: nil, name: nil, optin_keywords: nil, optin_message: nil, optout_keywords: nil, optout_message: nil, privacy_policy_link: nil, status: nil, submitted_at: nil, submitted_to_tcr: nil, tcr_campaign_id: nil, tcr_sync_error: nil, terms_and_conditions_link: nil, type: nil, updated_at: nil, use_cases: nil, volume: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Profiles::BrandCampaign} for more details.
+        #
+        #   A 10DLC campaign registered for a brand.
+        #
+        #   @param id [String]
+        #
+        #   @param billed_date [Time, nil]
+        #
+        #   @param brand_id [String, nil]
+        #
+        #   @param cost [Float, nil]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param customer_id [String]
+        #
+        #   @param dca_elections_complete [Boolean, nil] True once every carrier has completed its DCA election and the campaign is
+        #
+        #   @param dca_elections_completed_at [Time, nil]
+        #
+        #   @param description [String]
+        #
+        #   @param has_submission_transaction [Boolean] True when the one-time campaign submission fee has already been charged.
+        #
+        #   @param help_keywords [String, nil]
+        #
+        #   @param help_message [String, nil]
+        #
+        #   @param message_flow [String, nil]
+        #
+        #   @param name [String]
+        #
+        #   @param optin_keywords [String, nil]
+        #
+        #   @param optin_message [String, nil]
+        #
+        #   @param optout_keywords [String, nil]
+        #
+        #   @param optout_message [String, nil]
+        #
+        #   @param privacy_policy_link [String, nil]
+        #
+        #   @param status [Symbol, Sentdm::Models::Profiles::BrandCampaign::Status, nil]
+        #
+        #   @param submitted_at [Time, nil]
+        #
+        #   @param submitted_to_tcr [Boolean]
+        #
+        #   @param tcr_campaign_id [String, nil] The Campaign Registry identifier, once the campaign has been accepted.
+        #
+        #   @param tcr_sync_error [String, nil] Surfaced so customers can see why a submission did not reach the registry.
+        #
+        #   @param terms_and_conditions_link [String, nil]
+        #
+        #   @param type [String] Campaign type (for example KYC or App).
+        #
+        #   @param updated_at [Time, nil]
+        #
+        #   @param use_cases [Array<Sentdm::Models::Profiles::CampaignUseCase>]
+        #
+        #   @param volume [String, nil] Expected messaging volume for this campaign — customer-supplied on create/update
+
+        # @see Sentdm::Models::Profiles::BrandCampaign#status
+        module Status
+          extend Sentdm::Internal::Type::Enum
+
+          SENT_CREATED = :SENT_CREATED
+          ACTIVE = :ACTIVE
+          EXPIRED = :EXPIRED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -16,8 +16,8 @@ module Sentdm
         # @!attribute campaign
         #   Campaign data for create or update operation
         #
-        #   @return [Sentdm::Models::Profiles::CampaignCreateParams::Campaign]
-        required :campaign, -> { Sentdm::Profiles::CampaignCreateParams::Campaign }
+        #   @return [Sentdm::Models::Profiles::CampaignData]
+        required :campaign, -> { Sentdm::Profiles::CampaignData }
 
         # @!attribute sandbox
         #   Sandbox flag - when true, the operation is simulated without side effects Useful
@@ -42,7 +42,7 @@ module Sentdm
         #
         #   @param profile_id [String]
         #
-        #   @param campaign [Sentdm::Models::Profiles::CampaignCreateParams::Campaign] Campaign data for create or update operation
+        #   @param campaign [Sentdm::Models::Profiles::CampaignData] Campaign data for create or update operation
         #
         #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
         #
@@ -51,159 +51,6 @@ module Sentdm
         #   @param x_profile_id [String]
         #
         #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
-
-        class Campaign < Sentdm::Internal::Type::BaseModel
-          # @!attribute description
-          #   Campaign description
-          #
-          #   @return [String]
-          required :description, String
-
-          # @!attribute name
-          #   Campaign name
-          #
-          #   @return [String]
-          required :name, String
-
-          # @!attribute type
-          #   Campaign type (e.g., "KYC", "App").
-          #
-          #   Still required of a caller, and consulted by nothing. It named the signup path
-          #   that produced the campaign, was written to a column no query filters on, no TCR
-          #   payload carries and no fee or status decision reads, and is now defaulted at the
-          #   entity instead. It stays required so that a request which was valid before is
-          #   still valid — dropping it would be the client-visible change, not keeping it.
-          #
-          #   @return [String]
-          required :type, String
-
-          # @!attribute use_cases
-          #   List of use cases with sample messages
-          #
-          #   @return [Array<Sentdm::Models::Profiles::CampaignCreateParams::Campaign::UseCase>]
-          required :use_cases,
-                   -> {
-                     Sentdm::Internal::Type::ArrayOf[Sentdm::Profiles::CampaignCreateParams::Campaign::UseCase]
-                   },
-                   api_name: :useCases
-
-          # @!attribute help_keywords
-          #   Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
-          #
-          #   @return [String, nil]
-          optional :help_keywords, String, api_name: :helpKeywords, nil?: true
-
-          # @!attribute help_message
-          #   Message sent when user requests help
-          #
-          #   @return [String, nil]
-          optional :help_message, String, api_name: :helpMessage, nil?: true
-
-          # @!attribute message_flow
-          #   Description of how messages flow in the campaign
-          #
-          #   @return [String, nil]
-          optional :message_flow, String, api_name: :messageFlow, nil?: true
-
-          # @!attribute optin_keywords
-          #   Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
-          #
-          #   @return [String, nil]
-          optional :optin_keywords, String, api_name: :optinKeywords, nil?: true
-
-          # @!attribute optin_message
-          #   Message sent when user opts in
-          #
-          #   @return [String, nil]
-          optional :optin_message, String, api_name: :optinMessage, nil?: true
-
-          # @!attribute optout_keywords
-          #   Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
-          #
-          #   @return [String, nil]
-          optional :optout_keywords, String, api_name: :optoutKeywords, nil?: true
-
-          # @!attribute optout_message
-          #   Message sent when user opts out
-          #
-          #   @return [String, nil]
-          optional :optout_message, String, api_name: :optoutMessage, nil?: true
-
-          # @!attribute privacy_policy_link
-          #   URL to privacy policy
-          #
-          #   @return [String, nil]
-          optional :privacy_policy_link, String, api_name: :privacyPolicyLink, nil?: true
-
-          # @!attribute terms_and_conditions_link
-          #   URL to terms and conditions
-          #
-          #   @return [String, nil]
-          optional :terms_and_conditions_link, String, api_name: :termsAndConditionsLink, nil?: true
-
-          # @!attribute volume
-          #   Expected messaging volume for this campaign. Numeric string (e.g. "1999",
-          #   "5000"). Values below 2000 bill at the low-volume tier.
-          #
-          #   @return [String, nil]
-          optional :volume, String, nil?: true
-
-          # @!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, volume: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Sentdm::Models::Profiles::CampaignCreateParams::Campaign} for more details.
-          #
-          #   Campaign data for create or update operation
-          #
-          #   @param description [String] Campaign description
-          #
-          #   @param name [String] Campaign name
-          #
-          #   @param type [String] Campaign type (e.g., "KYC", "App").
-          #
-          #   @param use_cases [Array<Sentdm::Models::Profiles::CampaignCreateParams::Campaign::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")
-          #
-          #   @param help_message [String, nil] Message sent when user requests help
-          #
-          #   @param message_flow [String, nil] Description of how messages flow in the campaign
-          #
-          #   @param optin_keywords [String, nil] Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
-          #
-          #   @param optin_message [String, nil] Message sent when user opts in
-          #
-          #   @param optout_keywords [String, nil] Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
-          #
-          #   @param optout_message [String, nil] Message sent when user opts out
-          #
-          #   @param privacy_policy_link [String, nil] URL to privacy policy
-          #
-          #   @param terms_and_conditions_link [String, nil] URL to terms and conditions
-          #
-          #   @param volume [String, nil] Expected messaging volume for this campaign. Numeric string (e.g. "1999", "5000"
-
-          class UseCase < Sentdm::Internal::Type::BaseModel
-            # @!attribute messaging_use_case_us
-            #
-            #   @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]
-            #
-            #   @param sample_messages [Array<String>] Sample messages for this use case (1-5 messages, max 1024 characters each)
-          end
-        end
       end
     end
   end

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

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Profiles
+      class CampaignData < Sentdm::Internal::Type::BaseModel
+        # @!attribute description
+        #   Campaign description
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute name
+        #   Campaign name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute type
+        #   Campaign type (e.g., "KYC", "App").
+        #
+        #   Still required of a caller, and consulted by nothing. It named the signup path
+        #   that produced the campaign, was written to a column no query filters on, no TCR
+        #   payload carries and no fee or status decision reads, and is now defaulted at the
+        #   entity instead. It stays required so that a request which was valid before is
+        #   still valid — dropping it would be the client-visible change, not keeping it.
+        #
+        #   @return [String]
+        required :type, String
+
+        # @!attribute use_cases
+        #   List of use cases with sample messages
+        #
+        #   @return [Array<Sentdm::Models::Profiles::CampaignUseCaseData>]
+        required :use_cases,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Profiles::CampaignUseCaseData] },
+                 api_name: :useCases
+
+        # @!attribute help_keywords
+        #   Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
+        #
+        #   @return [String, nil]
+        optional :help_keywords, String, api_name: :helpKeywords, nil?: true
+
+        # @!attribute help_message
+        #   Message sent when user requests help
+        #
+        #   @return [String, nil]
+        optional :help_message, String, api_name: :helpMessage, nil?: true
+
+        # @!attribute message_flow
+        #   Description of how messages flow in the campaign
+        #
+        #   @return [String, nil]
+        optional :message_flow, String, api_name: :messageFlow, nil?: true
+
+        # @!attribute optin_keywords
+        #   Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
+        #
+        #   @return [String, nil]
+        optional :optin_keywords, String, api_name: :optinKeywords, nil?: true
+
+        # @!attribute optin_message
+        #   Message sent when user opts in
+        #
+        #   @return [String, nil]
+        optional :optin_message, String, api_name: :optinMessage, nil?: true
+
+        # @!attribute optout_keywords
+        #   Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
+        #
+        #   @return [String, nil]
+        optional :optout_keywords, String, api_name: :optoutKeywords, nil?: true
+
+        # @!attribute optout_message
+        #   Message sent when user opts out
+        #
+        #   @return [String, nil]
+        optional :optout_message, String, api_name: :optoutMessage, nil?: true
+
+        # @!attribute privacy_policy_link
+        #   URL to privacy policy
+        #
+        #   @return [String, nil]
+        optional :privacy_policy_link, String, api_name: :privacyPolicyLink, nil?: true
+
+        # @!attribute terms_and_conditions_link
+        #   URL to terms and conditions
+        #
+        #   @return [String, nil]
+        optional :terms_and_conditions_link, String, api_name: :termsAndConditionsLink, nil?: true
+
+        # @!attribute volume
+        #   Expected messaging volume for this campaign. Numeric string (e.g. "1999",
+        #   "5000"). Values below 2000 bill at the low-volume tier.
+        #
+        #   @return [String, nil]
+        optional :volume, String, nil?: true
+
+        # @!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, volume: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Profiles::CampaignData} for more details.
+        #
+        #   Campaign data for create or update operation
+        #
+        #   @param description [String] Campaign description
+        #
+        #   @param name [String] Campaign name
+        #
+        #   @param type [String] Campaign type (e.g., "KYC", "App").
+        #
+        #   @param use_cases [Array<Sentdm::Models::Profiles::CampaignUseCaseData>] List of use cases with sample messages
+        #
+        #   @param help_keywords [String, nil] Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
+        #
+        #   @param help_message [String, nil] Message sent when user requests help
+        #
+        #   @param message_flow [String, nil] Description of how messages flow in the campaign
+        #
+        #   @param optin_keywords [String, nil] Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
+        #
+        #   @param optin_message [String, nil] Message sent when user opts in
+        #
+        #   @param optout_keywords [String, nil] Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
+        #
+        #   @param optout_message [String, nil] Message sent when user opts out
+        #
+        #   @param privacy_policy_link [String, nil] URL to privacy policy
+        #
+        #   @param terms_and_conditions_link [String, nil] URL to terms and conditions
+        #
+        #   @param volume [String, nil] Expected messaging volume for this campaign. Numeric string (e.g. "1999", "5000"
+      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,30 +18,15 @@ module Sentdm
         #   @return [String]
         required :campaign_id, String
 
-        # @!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 x_profile_id
         #
         #   @return [String, nil]
         optional :x_profile_id, String
 
-        # @!method initialize(profile_id:, campaign_id:, sandbox: nil, x_profile_id: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::Profiles::CampaignDeleteParams} for more details.
-        #
+        # @!method initialize(profile_id:, campaign_id:, x_profile_id: nil, request_options: {})
         #   @param profile_id [String]
-        #
         #   @param campaign_id [String]
-        #
-        #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
-        #
         #   @param x_profile_id [String]
-        #
         #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
       end
     end