Class: Sentdm::Models::Profiles::BrandCampaign

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/sentdm/models/profiles/brand_campaign.rb,
sig/sentdm/models/profiles/brand_campaign.rbs

Defined Under Namespace

Modules: Status

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#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) ⇒ Object

Some parameter documentations has been truncated, see Sentdm::Models::Profiles::BrandCampaign for more details.

A 10DLC campaign registered for a brand.

Parameters:

  • id (String) (defaults to: nil)
  • billed_date (Time, nil) (defaults to: nil)
  • brand_id (String, nil) (defaults to: nil)
  • cost (Float, nil) (defaults to: nil)
  • created_at (Time) (defaults to: nil)
  • customer_id (String) (defaults to: nil)
  • dca_elections_complete (Boolean, nil) (defaults to: nil) —

    True once every carrier has completed its DCA election and the campaign is

  • dca_elections_completed_at (Time, nil) (defaults to: nil)
  • description (String) (defaults to: nil)
  • has_submission_transaction (Boolean) (defaults to: nil) —

    True when the one-time campaign submission fee has already been charged.

  • help_keywords (String, nil) (defaults to: nil)
  • help_message (String, nil) (defaults to: nil)
  • message_flow (String, nil) (defaults to: nil)
  • name (String) (defaults to: nil)
  • optin_keywords (String, nil) (defaults to: nil)
  • optin_message (String, nil) (defaults to: nil)
  • optout_keywords (String, nil) (defaults to: nil)
  • optout_message (String, nil) (defaults to: nil)
  • privacy_policy_link (String, nil) (defaults to: nil)
  • status (Symbol, Sentdm::Models::Profiles::BrandCampaign::Status, nil) (defaults to: nil)
  • submitted_at (Time, nil) (defaults to: nil)
  • submitted_to_tcr (Boolean) (defaults to: nil)
  • tcr_campaign_id (String, nil) (defaults to: nil) —

    The Campaign Registry identifier, once the campaign has been accepted.

  • tcr_sync_error (String, nil) (defaults to: nil) —

    Surfaced so customers can see why a submission did not reach the registry.

  • terms_and_conditions_link (String, nil) (defaults to: nil)
  • type (String) (defaults to: nil) —

    Campaign type (for example KYC or App).

  • updated_at (Time, nil) (defaults to: nil)
  • use_cases (Array<Sentdm::Models::Profiles::CampaignUseCase>) (defaults to: nil)
  • volume (String, nil) (defaults to: nil) —

    Expected messaging volume for this campaign — customer-supplied on create/update




# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 169

Instance Attribute Details

#billed_date ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


15
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 15

optional :billed_date, Time, api_name: :billedDate, nil?: true

#brand_id ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


20
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 20

optional :brand_id, String, api_name: :brandId, nil?: true

#cost ⇒ Float?

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


25
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 25

optional :cost, Float, nil?: true

#created_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


30
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 30

optional :created_at, Time, api_name: :createdAt

#customer_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


35
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 35

optional :customer_id, String, api_name: :customerId

#dca_elections_complete ⇒ Boolean?

True once every carrier has completed its DCA election and the campaign is operationally ready for traffic.

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


42
43
44
45
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 42

optional :dca_elections_complete,
Sentdm::Internal::Type::Boolean,
api_name: :dcaElectionsComplete,
nil?: true

#dca_elections_completed_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


50
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 50

optional :dca_elections_completed_at, Time, api_name: :dcaElectionsCompletedAt, nil?: true

#description ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


55
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 55

optional :description, String

#has_submission_transaction ⇒ Boolean?

True when the one-time campaign submission fee has already been charged.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


61
62
63
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 61

optional :has_submission_transaction,
Sentdm::Internal::Type::Boolean,
api_name: :hasSubmissionTransaction

#help_keywords ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


68
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 68

optional :help_keywords, String, api_name: :helpKeywords, nil?: true

#help_message ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


73
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 73

optional :help_message, String, api_name: :helpMessage, nil?: true

#id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


10
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 10

optional :id, String

#message_flow ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


78
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 78

optional :message_flow, String, api_name: :messageFlow, nil?: true

#name ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


83
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 83

optional :name, String

#optin_keywords ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


88
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 88

optional :optin_keywords, String, api_name: :optinKeywords, nil?: true

#optin_message ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


93
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 93

optional :optin_message, String, api_name: :optinMessage, nil?: true

#optout_keywords ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


98
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 98

optional :optout_keywords, String, api_name: :optoutKeywords, nil?: true

#optout_message ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


103
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 103

optional :optout_message, String, api_name: :optoutMessage, nil?: true

#privacy_policy_link ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


108
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 108

optional :privacy_policy_link, String, api_name: :privacyPolicyLink, nil?: true

#status ⇒ Symbol, ...

Parameters:

  • value (Sentdm::Models::Profiles::BrandCampaign::status, nil)

Returns:



113
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 113

optional :status, enum: -> { Sentdm::Profiles::BrandCampaign::Status }, nil?: true

#submitted_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


118
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 118

optional :submitted_at, Time, api_name: :submittedAt, nil?: true

#submitted_to_tcr ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


123
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 123

optional :submitted_to_tcr, Sentdm::Internal::Type::Boolean, api_name: :submittedToTCR

#tcr_campaign_id ⇒ String?

The Campaign Registry identifier, once the campaign has been accepted.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


129
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 129

optional :tcr_campaign_id, String, api_name: :tcrCampaignId, nil?: true

#tcr_sync_error ⇒ String?

Surfaced so customers can see why a submission did not reach the registry.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


135
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 135

optional :tcr_sync_error, String, api_name: :tcrSyncError, nil?: true

#terms_and_conditions_link ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


140
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 140

optional :terms_and_conditions_link, String, api_name: :termsAndConditionsLink, nil?: true

#type ⇒ String?

Campaign type (for example KYC or App).

Parameters:

  • (String)

Returns:

  • (String, nil) 


146
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 146

optional :type, String

#updated_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


151
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 151

optional :updated_at, Time, api_name: :updatedAt, nil?: true

#use_cases ⇒ Array<Sentdm::Models::Profiles::CampaignUseCase>?

Returns:



156
157
158
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 156

optional :use_cases,
-> { Sentdm::Internal::Type::ArrayOf[Sentdm::Profiles::CampaignUseCase] },
api_name: :useCases

#volume ⇒ String?

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.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


167
 
# File 'lib/sentdm/models/profiles/brand_campaign.rb', line 167

optional :volume, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


148
 
# File 'sig/sentdm/models/profiles/brand_campaign.rbs', line 148

def to_hash: -> {