Class: Zavudev::Models::Number10dlc::TenDlcCampaign

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb

Overview

See Also:

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:, affiliate_marketing:, age_gated:, brand_id:, created_at:, description:, direct_lending:, embedded_link:, embedded_phone:, name:, number_pooling:, sample_messages:, status:, subscriber_help:, subscriber_opt_in:, subscriber_opt_out:, updated_at:, use_case:, approved_at: nil, daily_limit: nil, failure_reason: nil, help_message: nil, message_flow: nil, monthly_fee_cents: nil, opt_in_keywords: nil, opt_out_keywords: nil, registration_cost_cents: nil, submitted_at: nil, sub_use_cases: nil) ⇒ Object

Parameters:

  • id (String)
  • affiliate_marketing (Boolean)
  • age_gated (Boolean)
  • brand_id (String) —

    ID of the brand this campaign belongs to.

  • created_at (Time)
  • description (String) —

    Description of the messaging campaign.

  • direct_lending (Boolean)
  • embedded_link (Boolean)
  • embedded_phone (Boolean)
  • name (String)
  • number_pooling (Boolean)
  • sample_messages (Array<String>) —

    Sample messages representative of campaign content.

  • status (Symbol, Zavudev::Models::Number10dlc::TenDlcCampaign::Status) —

    Status of a 10DLC campaign registration.

  • subscriber_help (Boolean)
  • subscriber_opt_in (Boolean)
  • subscriber_opt_out (Boolean)
  • updated_at (Time)
  • use_case (String) —

    Campaign use case type.

  • approved_at (Time, nil) (defaults to: nil)
  • daily_limit (Integer, nil) (defaults to: nil) —

    Daily message limit based on brand trust score.

  • failure_reason (String, nil) (defaults to: nil)
  • help_message (String, nil) (defaults to: nil)
  • message_flow (String, nil) (defaults to: nil)
  • monthly_fee_cents (Integer, nil) (defaults to: nil) —

    Recurring monthly fee in cents.

  • opt_in_keywords (Array<String>, nil) (defaults to: nil)
  • opt_out_keywords (Array<String>, nil) (defaults to: nil)
  • registration_cost_cents (Integer, nil) (defaults to: nil) —

    One-time registration cost in cents.

  • submitted_at (Time, nil) (defaults to: nil)
  • sub_use_cases (Array<String>, nil) (defaults to: nil) 



# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 167

Instance Attribute Details

#affiliate_marketing ⇒ Boolean

Returns:

  • (Boolean) 


16
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 16

required :affiliate_marketing, Zavudev::Internal::Type::Boolean, api_name: :affiliateMarketing

#age_gated ⇒ Boolean

Returns:

  • (Boolean) 


21
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 21

required :age_gated, Zavudev::Internal::Type::Boolean, api_name: :ageGated

#approved_at ⇒ Time?

Returns:

  • (Time, nil) 


106
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 106

optional :approved_at, Time, api_name: :approvedAt, nil?: true

#brand_id ⇒ String

ID of the brand this campaign belongs to.

Returns:

  • (String) 


27
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 27

required :brand_id, String, api_name: :brandId

#created_at ⇒ Time

Returns:

  • (Time) 


32
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 32

required :created_at, Time, api_name: :createdAt

#daily_limit ⇒ Integer?

Daily message limit based on brand trust score.

Returns:

  • (Integer, nil) 


112
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 112

optional :daily_limit, Integer, api_name: :dailyLimit, nil?: true

#description ⇒ String

Description of the messaging campaign.

Returns:

  • (String) 


38
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 38

required :description, String

#direct_lending ⇒ Boolean

Returns:

  • (Boolean) 


43
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 43

required :direct_lending, Zavudev::Internal::Type::Boolean, api_name: :directLending

#embedded_link ⇒ Boolean

Returns:

  • (Boolean) 


48
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 48

required :embedded_link, Zavudev::Internal::Type::Boolean, api_name: :embeddedLink

#embedded_phone ⇒ Boolean

Returns:

  • (Boolean) 


53
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 53

required :embedded_phone, Zavudev::Internal::Type::Boolean, api_name: :embeddedPhone

#failure_reason ⇒ String?

Returns:

  • (String, nil) 


117
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 117

optional :failure_reason, String, api_name: :failureReason, nil?: true

#help_message ⇒ String?

Returns:

  • (String, nil) 


122
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 122

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

#id ⇒ String

Returns:

  • (String) 


11
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 11

required :id, String

#message_flow ⇒ String?

Returns:

  • (String, nil) 


127
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 127

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

#monthly_fee_cents ⇒ Integer?

Recurring monthly fee in cents.

Returns:

  • (Integer, nil) 


133
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 133

optional :monthly_fee_cents, Integer, api_name: :monthlyFeeCents, nil?: true

#name ⇒ String

Returns:

  • (String) 


58
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 58

required :name, String

#number_pooling ⇒ Boolean

Returns:

  • (Boolean) 


63
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 63

required :number_pooling, Zavudev::Internal::Type::Boolean, api_name: :numberPooling

#opt_in_keywords ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


138
139
140
141
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 138

optional :opt_in_keywords,
Zavudev::Internal::Type::ArrayOf[String],
api_name: :optInKeywords,
nil?: true

#opt_out_keywords ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


146
147
148
149
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 146

optional :opt_out_keywords,
Zavudev::Internal::Type::ArrayOf[String],
api_name: :optOutKeywords,
nil?: true

#registration_cost_cents ⇒ Integer?

One-time registration cost in cents.

Returns:

  • (Integer, nil) 


155
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 155

optional :registration_cost_cents, Integer, api_name: :registrationCostCents, nil?: true

#sample_messages ⇒ Array<String>

Sample messages representative of campaign content.

Returns:

  • (Array<String>) 


69
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 69

required :sample_messages, Zavudev::Internal::Type::ArrayOf[String], api_name: :sampleMessages

#status ⇒ Symbol, Zavudev::Models::Number10dlc::TenDlcCampaign::Status

Status of a 10DLC campaign registration.

Returns:



75
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 75

required :status, enum: -> { Zavudev::Number10dlc::TenDlcCampaign::Status }

#sub_use_cases ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


165
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 165

optional :sub_use_cases, Zavudev::Internal::Type::ArrayOf[String], api_name: :subUseCases, nil?: true

#submitted_at ⇒ Time?

Returns:

  • (Time, nil) 


160
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 160

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

#subscriber_help ⇒ Boolean

Returns:

  • (Boolean) 


80
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 80

required :subscriber_help, Zavudev::Internal::Type::Boolean, api_name: :subscriberHelp

#subscriber_opt_in ⇒ Boolean

Returns:

  • (Boolean) 


85
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 85

required :subscriber_opt_in, Zavudev::Internal::Type::Boolean, api_name: :subscriberOptIn

#subscriber_opt_out ⇒ Boolean

Returns:

  • (Boolean) 


90
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 90

required :subscriber_opt_out, Zavudev::Internal::Type::Boolean, api_name: :subscriberOptOut

#updated_at ⇒ Time

Returns:

  • (Time) 


95
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 95

required :updated_at, Time, api_name: :updatedAt

#use_case ⇒ String

Campaign use case type.

Returns:

  • (String) 


101
 
# File 'lib/zavudev/models/number_10dlc/ten_dlc_campaign.rb', line 101

required :use_case, String, api_name: :useCase