Class: Klaviyo::Campaign

Inherits:
Object
  • Object
show all
Defined in:
lib/klaviyo_sdk/models/campaign.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Campaign

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 146

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Klaviyo::Campaign` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Klaviyo::Campaign`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'object')
    self.object = attributes[:'object']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'subject')
    self.subject = attributes[:'subject']
  end

  if attributes.key?(:'from_email')
    self.from_email = attributes[:'from_email']
  end

  if attributes.key?(:'from_name')
    self.from_name = attributes[:'from_name']
  end

  if attributes.key?(:'lists')
    if (value = attributes[:'lists']).is_a?(Array)
      self.lists = value
    end
  end

  if attributes.key?(:'excluded_lists')
    if (value = attributes[:'excluded_lists']).is_a?(Array)
      self.excluded_lists = value
    end
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'status_id')
    self.status_id = attributes[:'status_id']
  end

  if attributes.key?(:'status_label')
    self.status_label = attributes[:'status_label']
  end

  if attributes.key?(:'sent_at')
    self.sent_at = attributes[:'sent_at']
  end

  if attributes.key?(:'send_time')
    self.send_time = attributes[:'send_time']
  end

  if attributes.key?(:'created')
    self.created = attributes[:'created']
  end

  if attributes.key?(:'updated')
    self.updated = attributes[:'updated']
  end

  if attributes.key?(:'num_recipients')
    self.num_recipients = attributes[:'num_recipients']
  end

  if attributes.key?(:'campaign_type')
    self.campaign_type = attributes[:'campaign_type']
  end

  if attributes.key?(:'is_segmented')
    self.is_segmented = attributes[:'is_segmented']
  end

  if attributes.key?(:'message_type')
    self.message_type = attributes[:'message_type']
  end

  if attributes.key?(:'template')
    if (value = attributes[:'template']).is_a?(Hash)
      self.template = value
    end
  end
end

Instance Attribute Details

#campaign_type ⇒ Object

Returns the value of attribute campaign_type.



50
51
52
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 50

def campaign_type
  @campaign_type
end

#created ⇒ Object

Returns the value of attribute created.



44
45
46
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 44

def created
  @created
end

#excluded_lists ⇒ Object

Returns the value of attribute excluded_lists.



32
33
34
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 32

def excluded_lists
  @excluded_lists
end

#from_email ⇒ Object

Returns the value of attribute from_email.



26
27
28
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 26

def from_email
  @from_email
end

#from_name ⇒ Object

Returns the value of attribute from_name.



28
29
30
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 28

def from_name
  @from_name
end

#id ⇒ Object

Returns the value of attribute id.



20
21
22
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 20

def id
  @id
end

#is_segmented ⇒ Object

Returns the value of attribute is_segmented.



52
53
54
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 52

def is_segmented
  @is_segmented
end

#lists ⇒ Object

Returns the value of attribute lists.



30
31
32
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 30

def lists
  @lists
end

#message_type ⇒ Object

Returns the value of attribute message_type.



54
55
56
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 54

def message_type
  @message_type
end

#name ⇒ Object

Returns the value of attribute name.



22
23
24
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 22

def name
  @name
end

#num_recipients ⇒ Object

Returns the value of attribute num_recipients.



48
49
50
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 48

def num_recipients
  @num_recipients
end

#object ⇒ Object

Returns the value of attribute object.



18
19
20
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 18

def object
  @object
end

#send_time ⇒ Object

Returns the value of attribute send_time.



42
43
44
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 42

def send_time
  @send_time
end

#sent_at ⇒ Object

Returns the value of attribute sent_at.



40
41
42
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 40

def sent_at
  @sent_at
end

#status ⇒ Object

Returns the value of attribute status.



34
35
36
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 34

def status
  @status
end

#status_id ⇒ Object

Returns the value of attribute status_id.



36
37
38
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 36

def status_id
  @status_id
end

#status_label ⇒ Object

Returns the value of attribute status_label.



38
39
40
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 38

def status_label
  @status_label
end

#subject ⇒ Object

Returns the value of attribute subject.



24
25
26
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 24

def subject
  @subject
end

#template ⇒ Object

Returns the value of attribute template.



56
57
58
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 56

def template
  @template
end

#updated ⇒ Object

Returns the value of attribute updated.



46
47
48
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 46

def updated
  @updated
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



107
108
109
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 107

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 81

def self.attribute_map
  {
    :'object' => :'object',
    :'id' => :'id',
    :'name' => :'name',
    :'subject' => :'subject',
    :'from_email' => :'from_email',
    :'from_name' => :'from_name',
    :'lists' => :'lists',
    :'excluded_lists' => :'excluded_lists',
    :'status' => :'status',
    :'status_id' => :'status_id',
    :'status_label' => :'status_label',
    :'sent_at' => :'sent_at',
    :'send_time' => :'send_time',
    :'created' => :'created',
    :'updated' => :'updated',
    :'num_recipients' => :'num_recipients',
    :'campaign_type' => :'campaign_type',
    :'is_segmented' => :'is_segmented',
    :'message_type' => :'message_type',
    :'template' => :'template'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



373
374
375
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 373

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



138
139
140
141
142
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 138

def self.openapi_nullable
  Set.new([
    :'sent_at',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 112

def self.openapi_types
  {
    :'object' => :'String',
    :'id' => :'String',
    :'name' => :'String',
    :'subject' => :'String',
    :'from_email' => :'String',
    :'from_name' => :'String',
    :'lists' => :'Array<CampaignLists>',
    :'excluded_lists' => :'Array<CampaignLists>',
    :'status' => :'String',
    :'status_id' => :'Integer',
    :'status_label' => :'String',
    :'sent_at' => :'Time',
    :'send_time' => :'Time',
    :'created' => :'Time',
    :'updated' => :'Time',
    :'num_recipients' => :'Integer',
    :'campaign_type' => :'String',
    :'is_segmented' => :'Boolean',
    :'message_type' => :'String',
    :'template' => :'Hash<String, Object>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 333

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      object == o.object &&
      id == o.id &&
      name == o.name &&
      subject == o.subject &&
      from_email == o.from_email &&
      from_name == o.from_name &&
      lists == o.lists &&
      excluded_lists == o.excluded_lists &&
      status == o.status &&
      status_id == o.status_id &&
      status_label == o.status_label &&
      sent_at == o.sent_at &&
      send_time == o.send_time &&
      created == o.created &&
      updated == o.updated &&
      num_recipients == o.num_recipients &&
      campaign_type == o.campaign_type &&
      is_segmented == o.is_segmented &&
      message_type == o.message_type &&
      template == o.template
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 403

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Klaviyo.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 474

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 380

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


360
361
362
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 360

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



366
367
368
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 366

def hash
  [object, id, name, subject, from_email, from_name, lists, excluded_lists, status, status_id, status_label, sent_at, send_time, created, updated, num_recipients, campaign_type, is_segmented, message_type, template].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 248

def list_invalid_properties
  invalid_properties = Array.new
  if !@status_id.nil? && @status_id > 13
    invalid_properties.push('invalid value for "status_id", must be smaller than or equal to 13.')
  end

  if !@status_id.nil? && @status_id < 0
    invalid_properties.push('invalid value for "status_id", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



450
451
452
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 450

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 456

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



444
445
446
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 444

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/klaviyo_sdk/models/campaign.rb', line 263

def valid?
  status_validator = EnumAttributeValidator.new('String', ["draft", "sent", "cancelled", "queued", "cancelled_no_recipients_smart_sending", "cancelled_no_recipients_scheduling", "cancelled_account_disabled", "scheduling", "sending", "sending_timezones", "variations_sent", "preparing_to_schedule", "cancelled_internal_error"])
  return false unless status_validator.valid?(@status)
  return false if !@status_id.nil? && @status_id > 13
  return false if !@status_id.nil? && @status_id < 0
  status_label_validator = EnumAttributeValidator.new('String', ["Scheduled", "Sent", "Draft", "Cancelled", "Adding Recipients", "Sending", "Variations Sent", "Sending Segments", "Cancelled: Smart Sending", "Preparing to send", "Cancelled: Account Disabled", "Cancelled: No Recipients", "Preparing to schedule", "Cancelled: Internal Error"])
  return false unless status_label_validator.valid?(@status_label)
  campaign_type_validator = EnumAttributeValidator.new('String', ["Timezone", "REGULAR", "A/B Content", "A/B Send Time", "Batch", "A/B Segments by Send Time", "A/B Segments by Send Time (STO)", "SMS Segments by Message Per Second"])
  return false unless campaign_type_validator.valid?(@campaign_type)
  message_type_validator = EnumAttributeValidator.new('String', ["email", "sms", "push"])
  return false unless message_type_validator.valid?(@message_type)
  true
end