sentdm 0.29.0 → 0.31.0

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

@@ -1,667 +0,0 @@
-# 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::Models::Profiles::CampaignListResponse::Data]
-            )
-          )
-        end
-        attr_accessor :data
-
-        # Error information
-        sig do
-          returns(
-            T.nilable(Sentdm::Models::Profiles::CampaignListResponse::Error)
-          )
-        end
-        attr_reader :error
-
-        sig do
-          params(
-            error:
-              T.nilable(
-                Sentdm::Models::Profiles::CampaignListResponse::Error::OrHash
-              )
-          ).void
-        end
-        attr_writer :error
-
-        # Request and response metadata
-        sig do
-          returns(
-            T.nilable(Sentdm::Models::Profiles::CampaignListResponse::Meta)
-          )
-        end
-        attr_reader :meta
-
-        sig do
-          params(
-            meta: Sentdm::Models::Profiles::CampaignListResponse::Meta::OrHash
-          ).void
-        end
-        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::Models::Profiles::CampaignListResponse::Data::OrHash
-                ]
-              ),
-            error:
-              T.nilable(
-                Sentdm::Models::Profiles::CampaignListResponse::Error::OrHash
-              ),
-            meta: Sentdm::Models::Profiles::CampaignListResponse::Meta::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(
-                  T::Array[Sentdm::Models::Profiles::CampaignListResponse::Data]
-                ),
-              error:
-                T.nilable(
-                  Sentdm::Models::Profiles::CampaignListResponse::Error
-                ),
-              meta: Sentdm::Models::Profiles::CampaignListResponse::Meta,
-              success: T::Boolean
-            }
-          )
-        end
-        def to_hash
-        end
-
-        class Data < Sentdm::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Sentdm::Models::Profiles::CampaignListResponse::Data,
-                Sentdm::Internal::AnyHash
-              )
-            end
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :id
-
-          sig { params(id: String).void }
-          attr_writer :id
-
-          sig { returns(T.nilable(Time)) }
-          attr_accessor :billed_date
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :brand_id
-
-          sig { returns(T.nilable(Float)) }
-          attr_accessor :cost
-
-          sig { returns(T.nilable(Time)) }
-          attr_reader :created_at
-
-          sig { params(created_at: Time).void }
-          attr_writer :created_at
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :customer_id
-
-          sig { params(customer_id: String).void }
-          attr_writer :customer_id
-
-          # True once every carrier has completed its DCA election and the campaign is
-          # operationally ready for traffic.
-          sig { returns(T.nilable(T::Boolean)) }
-          attr_accessor :dca_elections_complete
-
-          sig { returns(T.nilable(Time)) }
-          attr_accessor :dca_elections_completed_at
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :description
-
-          sig { params(description: String).void }
-          attr_writer :description
-
-          # True when the one-time campaign submission fee has already been charged.
-          sig { returns(T.nilable(T::Boolean)) }
-          attr_reader :has_submission_transaction
-
-          sig { params(has_submission_transaction: T::Boolean).void }
-          attr_writer :has_submission_transaction
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :help_keywords
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :help_message
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :message_flow
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :name
-
-          sig { params(name: String).void }
-          attr_writer :name
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :optin_keywords
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :optin_message
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :optout_keywords
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :optout_message
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :privacy_policy_link
-
-          sig do
-            returns(
-              T.nilable(
-                Sentdm::Models::Profiles::CampaignListResponse::Data::Status::TaggedSymbol
-              )
-            )
-          end
-          attr_accessor :status
-
-          sig { returns(T.nilable(Time)) }
-          attr_accessor :submitted_at
-
-          sig { returns(T.nilable(T::Boolean)) }
-          attr_reader :submitted_to_tcr
-
-          sig { params(submitted_to_tcr: T::Boolean).void }
-          attr_writer :submitted_to_tcr
-
-          # The Campaign Registry identifier, once the campaign has been accepted.
-          sig { returns(T.nilable(String)) }
-          attr_accessor :tcr_campaign_id
-
-          # Surfaced so customers can see why a submission did not reach the registry.
-          sig { returns(T.nilable(String)) }
-          attr_accessor :tcr_sync_error
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :terms_and_conditions_link
-
-          # Campaign type (for example KYC or App).
-          sig { returns(T.nilable(String)) }
-          attr_reader :type
-
-          sig { params(type: String).void }
-          attr_writer :type
-
-          sig { returns(T.nilable(Time)) }
-          attr_accessor :updated_at
-
-          sig do
-            returns(
-              T.nilable(
-                T::Array[
-                  Sentdm::Models::Profiles::CampaignListResponse::Data::UseCase
-                ]
-              )
-            )
-          end
-          attr_reader :use_cases
-
-          sig do
-            params(
-              use_cases:
-                T::Array[
-                  Sentdm::Models::Profiles::CampaignListResponse::Data::UseCase::OrHash
-                ]
-            ).void
-          end
-          attr_writer :use_cases
-
-          # 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.
-          sig { returns(T.nilable(String)) }
-          attr_accessor :volume
-
-          # A 10DLC campaign registered for a brand.
-          sig do
-            params(
-              id: String,
-              billed_date: T.nilable(Time),
-              brand_id: T.nilable(String),
-              cost: T.nilable(Float),
-              created_at: Time,
-              customer_id: String,
-              dca_elections_complete: T.nilable(T::Boolean),
-              dca_elections_completed_at: T.nilable(Time),
-              description: String,
-              has_submission_transaction: T::Boolean,
-              help_keywords: T.nilable(String),
-              help_message: T.nilable(String),
-              message_flow: T.nilable(String),
-              name: String,
-              optin_keywords: T.nilable(String),
-              optin_message: T.nilable(String),
-              optout_keywords: T.nilable(String),
-              optout_message: T.nilable(String),
-              privacy_policy_link: T.nilable(String),
-              status:
-                T.nilable(
-                  Sentdm::Models::Profiles::CampaignListResponse::Data::Status::OrSymbol
-                ),
-              submitted_at: T.nilable(Time),
-              submitted_to_tcr: T::Boolean,
-              tcr_campaign_id: T.nilable(String),
-              tcr_sync_error: T.nilable(String),
-              terms_and_conditions_link: T.nilable(String),
-              type: String,
-              updated_at: T.nilable(Time),
-              use_cases:
-                T::Array[
-                  Sentdm::Models::Profiles::CampaignListResponse::Data::UseCase::OrHash
-                ],
-              volume: T.nilable(String)
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            id: nil,
-            billed_date: nil,
-            brand_id: nil,
-            cost: nil,
-            created_at: nil,
-            customer_id: nil,
-            # True once every carrier has completed its DCA election and the campaign is
-            # operationally ready for traffic.
-            dca_elections_complete: nil,
-            dca_elections_completed_at: nil,
-            description: nil,
-            # True when the one-time campaign submission fee has already been charged.
-            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,
-            # The Campaign Registry identifier, once the campaign has been accepted.
-            tcr_campaign_id: nil,
-            # Surfaced so customers can see why a submission did not reach the registry.
-            tcr_sync_error: nil,
-            terms_and_conditions_link: nil,
-            # Campaign type (for example KYC or App).
-            type: nil,
-            updated_at: nil,
-            use_cases: nil,
-            # 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.
-            volume: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                id: String,
-                billed_date: T.nilable(Time),
-                brand_id: T.nilable(String),
-                cost: T.nilable(Float),
-                created_at: Time,
-                customer_id: String,
-                dca_elections_complete: T.nilable(T::Boolean),
-                dca_elections_completed_at: T.nilable(Time),
-                description: String,
-                has_submission_transaction: T::Boolean,
-                help_keywords: T.nilable(String),
-                help_message: T.nilable(String),
-                message_flow: T.nilable(String),
-                name: String,
-                optin_keywords: T.nilable(String),
-                optin_message: T.nilable(String),
-                optout_keywords: T.nilable(String),
-                optout_message: T.nilable(String),
-                privacy_policy_link: T.nilable(String),
-                status:
-                  T.nilable(
-                    Sentdm::Models::Profiles::CampaignListResponse::Data::Status::TaggedSymbol
-                  ),
-                submitted_at: T.nilable(Time),
-                submitted_to_tcr: T::Boolean,
-                tcr_campaign_id: T.nilable(String),
-                tcr_sync_error: T.nilable(String),
-                terms_and_conditions_link: T.nilable(String),
-                type: String,
-                updated_at: T.nilable(Time),
-                use_cases:
-                  T::Array[
-                    Sentdm::Models::Profiles::CampaignListResponse::Data::UseCase
-                  ],
-                volume: T.nilable(String)
-              }
-            )
-          end
-          def to_hash
-          end
-
-          module Status
-            extend Sentdm::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  Sentdm::Models::Profiles::CampaignListResponse::Data::Status
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            SENT_CREATED =
-              T.let(
-                :SENT_CREATED,
-                Sentdm::Models::Profiles::CampaignListResponse::Data::Status::TaggedSymbol
-              )
-            ACTIVE =
-              T.let(
-                :ACTIVE,
-                Sentdm::Models::Profiles::CampaignListResponse::Data::Status::TaggedSymbol
-              )
-            EXPIRED =
-              T.let(
-                :EXPIRED,
-                Sentdm::Models::Profiles::CampaignListResponse::Data::Status::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  Sentdm::Models::Profiles::CampaignListResponse::Data::Status::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-
-          class UseCase < Sentdm::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Sentdm::Models::Profiles::CampaignListResponse::Data::UseCase,
-                  Sentdm::Internal::AnyHash
-                )
-              end
-
-            sig { returns(T.nilable(String)) }
-            attr_reader :id
-
-            sig { params(id: String).void }
-            attr_writer :id
-
-            sig { returns(T.nilable(String)) }
-            attr_reader :campaign_id
-
-            sig { params(campaign_id: String).void }
-            attr_writer :campaign_id
-
-            sig { returns(T.nilable(Time)) }
-            attr_reader :created_at
-
-            sig { params(created_at: Time).void }
-            attr_writer :created_at
-
-            sig { returns(T.nilable(String)) }
-            attr_reader :customer_id
-
-            sig { params(customer_id: String).void }
-            attr_writer :customer_id
-
-            sig do
-              returns(
-                T.nilable(Sentdm::Profiles::MessagingUseCaseUs::TaggedSymbol)
-              )
-            end
-            attr_reader :messaging_use_case_us
-
-            sig do
-              params(
-                messaging_use_case_us:
-                  Sentdm::Profiles::MessagingUseCaseUs::OrSymbol
-              ).void
-            end
-            attr_writer :messaging_use_case_us
-
-            # Sample messages submitted to the registry for this use case.
-            sig { returns(T.nilable(T::Array[String])) }
-            attr_reader :sample_messages
-
-            sig { params(sample_messages: T::Array[String]).void }
-            attr_writer :sample_messages
-
-            sig { returns(T.nilable(Time)) }
-            attr_accessor :updated_at
-
-            # Customer-facing use-case representation for the public v3 campaign contract.
-            # Exists for the same reason as BrandCampaignV3Response: nesting the
-            # TcrCampaignUseCase database entity in a public response means any column added
-            # to that table silently becomes part of the customer-facing contract. This DTO is
-            # an explicit allowlist, so a new column stays invisible until it is added here on
-            # purpose. This mirrors exactly the fields the entity already serialized, so it
-            # removes nothing from the current response shape. It only closes the future-leak
-            # path.
-            sig do
-              params(
-                id: String,
-                campaign_id: String,
-                created_at: Time,
-                customer_id: String,
-                messaging_use_case_us:
-                  Sentdm::Profiles::MessagingUseCaseUs::OrSymbol,
-                sample_messages: T::Array[String],
-                updated_at: T.nilable(Time)
-              ).returns(T.attached_class)
-            end
-            def self.new(
-              id: nil,
-              campaign_id: nil,
-              created_at: nil,
-              customer_id: nil,
-              messaging_use_case_us: nil,
-              # Sample messages submitted to the registry for this use case.
-              sample_messages: nil,
-              updated_at: nil
-            )
-            end
-
-            sig do
-              override.returns(
-                {
-                  id: String,
-                  campaign_id: String,
-                  created_at: Time,
-                  customer_id: String,
-                  messaging_use_case_us:
-                    Sentdm::Profiles::MessagingUseCaseUs::TaggedSymbol,
-                  sample_messages: T::Array[String],
-                  updated_at: T.nilable(Time)
-                }
-              )
-            end
-            def to_hash
-            end
-          end
-        end
-
-        class Error < Sentdm::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Sentdm::Models::Profiles::CampaignListResponse::Error,
-                Sentdm::Internal::AnyHash
-              )
-            end
-
-          # Machine-readable error code (e.g., "RESOURCE_001")
-          sig { returns(T.nilable(String)) }
-          attr_reader :code
-
-          sig { params(code: String).void }
-          attr_writer :code
-
-          # Additional validation error details (field-level errors)
-          sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
-          attr_accessor :details
-
-          # URL to documentation about this error
-          sig { returns(T.nilable(String)) }
-          attr_accessor :doc_url
-
-          # Human-readable error message
-          sig { returns(T.nilable(String)) }
-          attr_reader :message
-
-          sig { params(message: String).void }
-          attr_writer :message
-
-          # Error information
-          sig do
-            params(
-              code: String,
-              details: T.nilable(T::Hash[Symbol, T::Array[String]]),
-              doc_url: T.nilable(String),
-              message: String
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # Machine-readable error code (e.g., "RESOURCE_001")
-            code: nil,
-            # Additional validation error details (field-level errors)
-            details: nil,
-            # URL to documentation about this error
-            doc_url: nil,
-            # Human-readable error message
-            message: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                code: String,
-                details: T.nilable(T::Hash[Symbol, T::Array[String]]),
-                doc_url: T.nilable(String),
-                message: String
-              }
-            )
-          end
-          def to_hash
-          end
-        end
-
-        class Meta < Sentdm::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Sentdm::Models::Profiles::CampaignListResponse::Meta,
-                Sentdm::Internal::AnyHash
-              )
-            end
-
-          # 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
-  end
-end