Class: Sentdm::Models::Profiles::CampaignListResponse::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/sentdm/models/profiles/campaign_list_response.rb

Defined Under Namespace

Modules: SharingStatus, Status Classes: UseCase

Instance Attribute Summary collapse

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(id: nil, billed_date: nil, brand_id: nil, cost: nil, created_at: nil, csp_id: nil, customer_id: nil, dca_elections_complete: nil, dca_elections_completed_at: nil, description: nil, help_keywords: nil, help_message: nil, kyc_submission_form_id: nil, message_flow: nil, name: nil, optin_keywords: nil, optin_message: nil, optout_keywords: nil, optout_message: nil, privacy_policy_link: nil, reseller_id: nil, sharing_status: nil, status: nil, submitted_at: nil, submitted_to_tcr: nil, tcr_campaign_id: nil, tcr_sync_error: nil, telnyx_campaign_id: nil, terms_and_conditions_link: nil, type: nil, updated_at: nil, upstream_cnp_id: nil, use_cases: nil) ⇒ Object

Parameters:

  • id (String) (defaults to: nil)

    Unique identifier

  • 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)
  • csp_id (String, nil) (defaults to: nil)
  • customer_id (String) (defaults to: nil)
  • dca_elections_complete (Boolean) (defaults to: nil)
  • dca_elections_completed_at (Time, nil) (defaults to: nil)
  • description (String) (defaults to: nil)
  • help_keywords (String, nil) (defaults to: nil)
  • help_message (String, nil) (defaults to: nil)
  • kyc_submission_form_id (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)
  • reseller_id (String, nil) (defaults to: nil)
  • sharing_status (Symbol, Sentdm::Models::Profiles::CampaignListResponse::Data::SharingStatus, nil) (defaults to: nil)
  • status (Symbol, Sentdm::Models::Profiles::CampaignListResponse::Data::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)
  • tcr_sync_error (String, nil) (defaults to: nil)
  • telnyx_campaign_id (String, nil) (defaults to: nil)
  • terms_and_conditions_link (String, nil) (defaults to: nil)
  • type (String) (defaults to: nil)
  • updated_at (Time, nil) (defaults to: nil)
  • upstream_cnp_id (String, nil) (defaults to: nil)
  • use_cases (Array<Sentdm::Models::Profiles::CampaignListResponse::Data::UseCase>) (defaults to: nil)


45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 45

class Data < Sentdm::Internal::Type::BaseModel
  # @!attribute id
  #   Unique identifier
  #
  #   @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 csp_id
  #
  #   @return [String, nil]
  optional :csp_id, String, api_name: :cspId, nil?: true

  # @!attribute customer_id
  #
  #   @return [String, nil]
  optional :customer_id, String, api_name: :customerId

  # @!attribute dca_elections_complete
  #
  #   @return [Boolean, nil]
  optional :dca_elections_complete, Sentdm::Internal::Type::Boolean, api_name: :dcaElectionsComplete

  # @!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 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 kyc_submission_form_id
  #
  #   @return [String, nil]
  optional :kyc_submission_form_id, String, api_name: :kycSubmissionFormId, 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 reseller_id
  #
  #   @return [String, nil]
  optional :reseller_id, String, api_name: :resellerId, nil?: true

  # @!attribute sharing_status
  #
  #   @return [Symbol, Sentdm::Models::Profiles::CampaignListResponse::Data::SharingStatus, nil]
  optional :sharing_status,
           enum: -> { Sentdm::Models::Profiles::CampaignListResponse::Data::SharingStatus },
           api_name: :sharingStatus,
           nil?: true

  # @!attribute status
  #
  #   @return [Symbol, Sentdm::Models::Profiles::CampaignListResponse::Data::Status, nil]
  optional :status, enum: -> { Sentdm::Models::Profiles::CampaignListResponse::Data::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
  #
  #   @return [String, nil]
  optional :tcr_campaign_id, String, api_name: :tcrCampaignId, nil?: true

  # @!attribute tcr_sync_error
  #
  #   @return [String, nil]
  optional :tcr_sync_error, String, api_name: :tcrSyncError, nil?: true

  # @!attribute telnyx_campaign_id
  #
  #   @return [String, nil]
  optional :telnyx_campaign_id, String, api_name: :telnyxCampaignId, nil?: true

  # @!attribute terms_and_conditions_link
  #
  #   @return [String, nil]
  optional :terms_and_conditions_link, String, api_name: :termsAndConditionsLink, nil?: true

  # @!attribute type
  #
  #   @return [String, nil]
  optional :type, String

  # @!attribute updated_at
  #
  #   @return [Time, nil]
  optional :updated_at, Time, api_name: :updatedAt, nil?: true

  # @!attribute upstream_cnp_id
  #
  #   @return [String, nil]
  optional :upstream_cnp_id, String, api_name: :upstreamCnpId, nil?: true

  # @!attribute use_cases
  #
  #   @return [Array<Sentdm::Models::Profiles::CampaignListResponse::Data::UseCase>, nil]
  optional :use_cases,
           -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::Profiles::CampaignListResponse::Data::UseCase] },
           api_name: :useCases

  # @!method initialize(id: nil, billed_date: nil, brand_id: nil, cost: nil, created_at: nil, csp_id: nil, customer_id: nil, dca_elections_complete: nil, dca_elections_completed_at: nil, description: nil, help_keywords: nil, help_message: nil, kyc_submission_form_id: nil, message_flow: nil, name: nil, optin_keywords: nil, optin_message: nil, optout_keywords: nil, optout_message: nil, privacy_policy_link: nil, reseller_id: nil, sharing_status: nil, status: nil, submitted_at: nil, submitted_to_tcr: nil, tcr_campaign_id: nil, tcr_sync_error: nil, telnyx_campaign_id: nil, terms_and_conditions_link: nil, type: nil, updated_at: nil, upstream_cnp_id: nil, use_cases: nil)
  #   @param id [String] Unique identifier
  #
  #   @param billed_date [Time, nil]
  #
  #   @param brand_id [String, nil]
  #
  #   @param cost [Float, nil]
  #
  #   @param created_at [Time]
  #
  #   @param csp_id [String, nil]
  #
  #   @param customer_id [String]
  #
  #   @param dca_elections_complete [Boolean]
  #
  #   @param dca_elections_completed_at [Time, nil]
  #
  #   @param description [String]
  #
  #   @param help_keywords [String, nil]
  #
  #   @param help_message [String, nil]
  #
  #   @param kyc_submission_form_id [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 reseller_id [String, nil]
  #
  #   @param sharing_status [Symbol, Sentdm::Models::Profiles::CampaignListResponse::Data::SharingStatus, nil]
  #
  #   @param status [Symbol, Sentdm::Models::Profiles::CampaignListResponse::Data::Status, nil]
  #
  #   @param submitted_at [Time, nil]
  #
  #   @param submitted_to_tcr [Boolean]
  #
  #   @param tcr_campaign_id [String, nil]
  #
  #   @param tcr_sync_error [String, nil]
  #
  #   @param telnyx_campaign_id [String, nil]
  #
  #   @param terms_and_conditions_link [String, nil]
  #
  #   @param type [String]
  #
  #   @param updated_at [Time, nil]
  #
  #   @param upstream_cnp_id [String, nil]
  #
  #   @param use_cases [Array<Sentdm::Models::Profiles::CampaignListResponse::Data::UseCase>]

  # @see Sentdm::Models::Profiles::CampaignListResponse::Data#sharing_status
  module SharingStatus
    extend Sentdm::Internal::Type::Enum

    PENDING = :PENDING
    ACCEPTED = :ACCEPTED
    DECLINED = :DECLINED

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see Sentdm::Models::Profiles::CampaignListResponse::Data#status
  module Status
    extend Sentdm::Internal::Type::Enum

    SENT_CREATED = :SENT_CREATED
    ACTIVE = :ACTIVE
    EXPIRED = :EXPIRED

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  class UseCase < Sentdm::Internal::Type::BaseModel
    # @!attribute id
    #   Unique identifier
    #
    #   @return [String, nil]
    optional :id, String

    # @!attribute campaign_id
    #
    #   @return [String, nil]
    optional :campaign_id, String, api_name: :campaignId

    # @!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 messaging_use_case_us
    #
    #   @return [Symbol, Sentdm::Models::Profiles::CampaignListResponse::Data::UseCase::MessagingUseCaseUs, nil]
    optional :messaging_use_case_us,
             enum: -> { Sentdm::Models::Profiles::CampaignListResponse::Data::UseCase::MessagingUseCaseUs },
             api_name: :messagingUseCaseUs

    # @!attribute sample_messages
    #
    #   @return [Array<String>, nil]
    optional :sample_messages, Sentdm::Internal::Type::ArrayOf[String], api_name: :sampleMessages

    # @!attribute updated_at
    #
    #   @return [Time, nil]
    optional :updated_at, Time, api_name: :updatedAt, nil?: true

    # @!method initialize(id: nil, campaign_id: nil, created_at: nil, customer_id: nil, messaging_use_case_us: nil, sample_messages: nil, updated_at: nil)
    #   @param id [String] Unique identifier
    #
    #   @param campaign_id [String]
    #
    #   @param created_at [Time]
    #
    #   @param customer_id [String]
    #
    #   @param messaging_use_case_us [Symbol, Sentdm::Models::Profiles::CampaignListResponse::Data::UseCase::MessagingUseCaseUs]
    #
    #   @param sample_messages [Array<String>]
    #
    #   @param updated_at [Time, nil]

    # @see Sentdm::Models::Profiles::CampaignListResponse::Data::UseCase#messaging_use_case_us
    module MessagingUseCaseUs
      extend Sentdm::Internal::Type::Enum

      MARKETING = :MARKETING
      ACCOUNT_NOTIFICATION = :ACCOUNT_NOTIFICATION
      CUSTOMER_CARE = :CUSTOMER_CARE
      FRAUD_ALERT = :FRAUD_ALERT
      TWO_FA = :TWO_FA
      DELIVERY_NOTIFICATION = :DELIVERY_NOTIFICATION
      SECURITY_ALERT = :SECURITY_ALERT
      M2_M = :M2M
      MIXED = :MIXED
      HIGHER_EDUCATION = :HIGHER_EDUCATION
      POLLING_VOTING = :POLLING_VOTING
      PUBLIC_SERVICE_ANNOUNCEMENT = :PUBLIC_SERVICE_ANNOUNCEMENT
      LOW_VOLUME = :LOW_VOLUME

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end
end

Instance Attribute Details

#billed_dateTime?

Returns:

  • (Time, nil)


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

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

#brand_idString?

Returns:

  • (String, nil)


60
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 60

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

#costFloat?

Returns:

  • (Float, nil)


65
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 65

optional :cost, Float, nil?: true

#created_atTime?

Returns:

  • (Time, nil)


70
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 70

optional :created_at, Time, api_name: :createdAt

#csp_idString?

Returns:

  • (String, nil)


75
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 75

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

#customer_idString?

Returns:

  • (String, nil)


80
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 80

optional :customer_id, String, api_name: :customerId

#dca_elections_completeBoolean?

Returns:

  • (Boolean, nil)


85
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 85

optional :dca_elections_complete, Sentdm::Internal::Type::Boolean, api_name: :dcaElectionsComplete

#dca_elections_completed_atTime?

Returns:

  • (Time, nil)


90
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 90

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

#descriptionString?

Returns:

  • (String, nil)


95
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 95

optional :description, String

#help_keywordsString?

Returns:

  • (String, nil)


100
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 100

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

#help_messageString?

Returns:

  • (String, nil)


105
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 105

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

#idString?

Unique identifier

Returns:

  • (String, nil)


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

optional :id, String

#kyc_submission_form_idString?

Returns:

  • (String, nil)


110
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 110

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

#message_flowString?

Returns:

  • (String, nil)


115
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 115

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

#nameString?

Returns:

  • (String, nil)


120
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 120

optional :name, String

#optin_keywordsString?

Returns:

  • (String, nil)


125
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 125

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

#optin_messageString?

Returns:

  • (String, nil)


130
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 130

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

#optout_keywordsString?

Returns:

  • (String, nil)


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

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

#optout_messageString?

Returns:

  • (String, nil)


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

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

Returns:

  • (String, nil)


145
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 145

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

#reseller_idString?

Returns:

  • (String, nil)


150
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 150

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

#sharing_statusSymbol, ...



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

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

#statusSymbol, ...



163
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 163

optional :status, enum: -> { Sentdm::Models::Profiles::CampaignListResponse::Data::Status }, nil?: true

#submitted_atTime?

Returns:

  • (Time, nil)


168
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 168

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

#submitted_to_tcrBoolean?

Returns:

  • (Boolean, nil)


173
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 173

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

#tcr_campaign_idString?

Returns:

  • (String, nil)


178
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 178

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

#tcr_sync_errorString?

Returns:

  • (String, nil)


183
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 183

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

#telnyx_campaign_idString?

Returns:

  • (String, nil)


188
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 188

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

Returns:

  • (String, nil)


193
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 193

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

#typeString?

Returns:

  • (String, nil)


198
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 198

optional :type, String

#updated_atTime?

Returns:

  • (Time, nil)


203
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 203

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

#upstream_cnp_idString?

Returns:

  • (String, nil)


208
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 208

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

#use_casesArray<Sentdm::Models::Profiles::CampaignListResponse::Data::UseCase>?



213
214
215
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 213

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

Class Method Details

.valuesArray<Symbol>

Returns:

  • (Array<Symbol>)


# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 292