Class: Sentdm::Models::Profiles::TcrCampaignWithUseCases

Inherits:
BaseDto show all
Defined in:
lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb,
sig/sentdm/models/profiles/tcr_campaign_with_use_cases.rbs

Defined Under Namespace

Modules: SharingStatus, Status Classes: UseCase

Instance Attribute Summary collapse

Attributes inherited from BaseDto

#created_at, #id, #updated_at

Class Method 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 ⇒ Object 



170
 
# File 'sig/sentdm/models/profiles/tcr_campaign_with_use_cases.rbs', line 170

def initialize: (

Instance Attribute Details

#billed_date ⇒ Time?

Parameters:

  • _ (Time, nil)

Returns:

  • (Time, nil) 


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

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

#brand_id ⇒ String?

Parameters:

  • _ (String, nil)

Returns:

  • (String, nil) 


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

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

#cost ⇒ Float?

Parameters:

  • _ (Float, nil)

Returns:

  • (Float, nil) 


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

optional :cost, Float, nil?: true

#csp_id ⇒ String?

Parameters:

  • _ (String, nil)

Returns:

  • (String, nil) 


40
 
# File 'lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb', line 40

optional :csp_id, String, api_name: :cspId, nil?: true

#customer_id ⇒ String?

Parameters:

  • _ (String)

Returns:

  • (String, nil) 


45
 
# File 'lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb', line 45

optional :customer_id, String, api_name: :customerId

#dca_elections_complete ⇒ Boolean?

Parameters:

  • _ (Boolean, nil)

Returns:

  • (Boolean, nil) 


50
51
52
53
 
# File 'lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb', line 50

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

#dca_elections_completed_at ⇒ Time?

Parameters:

  • _ (Time, nil)

Returns:

  • (Time, nil) 


58
 
# File 'lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb', line 58

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

#description ⇒ String

Parameters:

  • _ (String)

Returns:

  • (String) 


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

required :description, String

#has_submission_transaction ⇒ Boolean?

True when this campaign already has a billing transaction of reference type TCR_CAMPAIGN_SUBMISSION (the one-time submission fee was charged). Populated only by the campaigns-list path; defaults false on other responses.

Parameters:

  • _ (Boolean)

Returns:

  • (Boolean, nil) 


66
67
68
 
# File 'lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb', line 66

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

#help_keywords ⇒ String?

Parameters:

  • _ (String, nil)

Returns:

  • (String, nil) 


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

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

#help_message ⇒ String?

Parameters:

  • _ (String, nil)

Returns:

  • (String, nil) 


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

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

#kyc_submission_form_id ⇒ String?

Parameters:

  • _ (String, nil)

Returns:

  • (String, nil) 


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

optional :kyc_submission_form_id, String, api_name: :kycSubmissionFormId, nil?: true

#message_flow ⇒ String?

Parameters:

  • _ (String, nil)

Returns:

  • (String, nil) 


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

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

#name ⇒ String

Parameters:

  • _ (String)

Returns:

  • (String) 


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

required :name, String

#optin_keywords ⇒ String?

Parameters:

  • _ (String, nil)

Returns:

  • (String, nil) 


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

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

#optin_message ⇒ String?

Parameters:

  • _ (String, nil)

Returns:

  • (String, nil) 


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

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

#optout_keywords ⇒ String?

Parameters:

  • _ (String, nil)

Returns:

  • (String, nil) 


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

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

#optout_message ⇒ String?

Parameters:

  • _ (String, nil)

Returns:

  • (String, nil) 


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

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

#privacy_policy_link ⇒ String?

Parameters:

  • _ (String, nil)

Returns:

  • (String, nil) 


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

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

#reseller_id ⇒ String?

Parameters:

  • _ (String, nil)

Returns:

  • (String, nil) 


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

optional :reseller_id, String, api_name: :resellerId, nil?: true

#sharing_status ⇒ Symbol, ...

Returns:



123
124
125
126
 
# File 'lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb', line 123

optional :sharing_status,
enum: -> { Sentdm::Profiles::TcrCampaignWithUseCases::SharingStatus },
api_name: :sharingStatus,
nil?: true

#status ⇒ Symbol, ...

Returns:



131
 
# File 'lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb', line 131

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

#submitted_at ⇒ Time?

Parameters:

  • _ (Time, nil)

Returns:

  • (Time, nil) 


136
 
# File 'lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb', line 136

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

#submitted_to_tcr ⇒ Boolean?

Parameters:

  • _ (Boolean)

Returns:

  • (Boolean, nil) 


141
 
# File 'lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb', line 141

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

#tcr_campaign_id ⇒ String?

Parameters:

  • _ (String, nil)

Returns:

  • (String, nil) 


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

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

#tcr_sync_error ⇒ String?

Parameters:

  • _ (String, nil)

Returns:

  • (String, nil) 


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

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

#telnyx_campaign_id ⇒ String?

Parameters:

  • _ (String, nil)

Returns:

  • (String, nil) 


156
 
# File 'lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb', line 156

optional :telnyx_campaign_id, String, api_name: :telnyxCampaignId, nil?: true

#terms_and_conditions_link ⇒ String?

Parameters:

  • _ (String, nil)

Returns:

  • (String, nil) 


161
 
# File 'lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb', line 161

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

#type ⇒ String

Parameters:

  • _ (String)

Returns:

  • (String) 


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

required :type, String

#upstream_cnp_id ⇒ String?

Parameters:

  • _ (String, nil)

Returns:

  • (String, nil) 


166
 
# File 'lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb', line 166

optional :upstream_cnp_id, String, api_name: :upstreamCnpId, nil?: true

#use_cases ⇒ Array<Sentdm::Models::Profiles::TcrCampaignWithUseCases::UseCase>?

Returns:



171
172
173
 
# File 'lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb', line 171

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb', line 248

Instance Method Details

#`type` ⇒ String

Returns:

  • (String) 


48
 
# File 'sig/sentdm/models/profiles/tcr_campaign_with_use_cases.rbs', line 48

def `type`: -> String

#to_hash ⇒ {

Returns:

  • ({) 


204
 
# File 'sig/sentdm/models/profiles/tcr_campaign_with_use_cases.rbs', line 204

def to_hash: -> {