Class: SendX::CampaignRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/sendx-ruby-sdk/models/campaign_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CampaignRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 160

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SendX::CampaignRequest` 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 `SendX::CampaignRequest`. 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?(:'name')
    self.name = attributes[:'name']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'excluded_segments')
    if (value = attributes[:'excluded_segments']).is_a?(Array)
      self.excluded_segments = 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?(:'excluded_tags')
    if (value = attributes[:'excluded_tags']).is_a?(Array)
      self.excluded_tags = value
    end
  end
end

Instance Attribute Details

#excluded_lists ⇒ Object

List of list IDs to exclude.



70
71
72
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 70

def excluded_lists
  @excluded_lists
end

#excluded_segments ⇒ Object

List of segment IDs to exclude.



67
68
69
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 67

def excluded_segments
  @excluded_segments
end

#excluded_tags ⇒ Object

List of tag IDs to exclude.



73
74
75
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 73

def excluded_tags
  @excluded_tags
end

#html_code ⇒ Object

The HTML code of the campaign.



22
23
24
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 22

def html_code
  @html_code
end

#included_lists ⇒ Object

List of list IDs to include.



61
62
63
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 61

def included_lists
  @included_lists
end

#included_segments ⇒ Object

List of segment IDs to include.



58
59
60
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 58

def included_segments
  @included_segments
end

#included_tags ⇒ Object

List of tag IDs to include.



64
65
66
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 64

def included_tags
  @included_tags
end

#name ⇒ Object

The name of the campaign.



19
20
21
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 19

def name
  @name
end

#preferred_time_condition ⇒ Object

Specific time preference for sending the campaign.



49
50
51
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 49

def preferred_time_condition
  @preferred_time_condition
end

#preferred_timezone ⇒ Object

Preferred timezone for scheduling.



46
47
48
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 46

def preferred_timezone
  @preferred_timezone
end

#preview_text ⇒ Object

The preview text shown in email clients.



31
32
33
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 31

def preview_text
  @preview_text
end

#schedule_condition ⇒ Object

The condition for scheduling the campaign.



37
38
39
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 37

def schedule_condition
  @schedule_condition
end

#schedule_type ⇒ Object

The type of scheduling for the campaign
0: Send Now
1: Send Later



34
35
36
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 34

def schedule_type
  @schedule_type
end

#send_in_contacts_timezone ⇒ Object

Whether to send emails in each contact’s timezone.



52
53
54
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 52

def send_in_contacts_timezone
  @send_in_contacts_timezone
end

#sender ⇒ Object

Sender unique identifier.



28
29
30
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 28

def sender
  @sender
end

#smart_send ⇒ Object

Whether to enable smart send features (e.g., optimizing send time).



55
56
57
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 55

def smart_send
  @smart_send
end

#subject ⇒ Object

The subject of the campaign.



25
26
27
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 25

def subject
  @subject
end

#time_condition ⇒ Object

The specific time to send the campaign.



40
41
42
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 40

def time_condition
  @time_condition
end

#timezone ⇒ Object

The timezone for the campaign scheduling.



43
44
45
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 43

def timezone
  @timezone
end

Class Method Details

._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



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
385
386
387
388
389
390
391
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 354

def self._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 = SendX.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



123
124
125
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 123

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 98

def self.attribute_map
  {
    :'name' => :'name',
    :'html_code' => :'htmlCode',
    :'subject' => :'subject',
    :'sender' => :'sender',
    :'preview_text' => :'previewText',
    :'schedule_type' => :'scheduleType',
    :'schedule_condition' => :'scheduleCondition',
    :'time_condition' => :'timeCondition',
    :'timezone' => :'timezone',
    :'preferred_timezone' => :'preferredTimezone',
    :'preferred_time_condition' => :'preferredTimeCondition',
    :'send_in_contacts_timezone' => :'sendInContactsTimezone',
    :'smart_send' => :'smartSend',
    :'included_segments' => :'includedSegments',
    :'included_lists' => :'includedLists',
    :'included_tags' => :'includedTags',
    :'excluded_segments' => :'excludedSegments',
    :'excluded_lists' => :'excludedLists',
    :'excluded_tags' => :'excludedTags'
  }
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



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 330

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



153
154
155
156
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 153

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 128

def self.openapi_types
  {
    :'name' => :'String',
    :'html_code' => :'String',
    :'subject' => :'String',
    :'sender' => :'String',
    :'preview_text' => :'String',
    :'schedule_type' => :'Integer',
    :'schedule_condition' => :'String',
    :'time_condition' => :'String',
    :'timezone' => :'String',
    :'preferred_timezone' => :'String',
    :'preferred_time_condition' => :'String',
    :'send_in_contacts_timezone' => :'Boolean',
    :'smart_send' => :'Boolean',
    :'included_segments' => :'Array<String>',
    :'included_lists' => :'Array<String>',
    :'included_tags' => :'Array<String>',
    :'excluded_segments' => :'Array<String>',
    :'excluded_lists' => :'Array<String>',
    :'excluded_tags' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 291

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      html_code == o.html_code &&
      subject == o.subject &&
      sender == o.sender &&
      preview_text == o.preview_text &&
      schedule_type == o.schedule_type &&
      schedule_condition == o.schedule_condition &&
      time_condition == o.time_condition &&
      timezone == o.timezone &&
      preferred_timezone == o.preferred_timezone &&
      preferred_time_condition == o.preferred_time_condition &&
      send_in_contacts_timezone == o.send_in_contacts_timezone &&
      smart_send == o.smart_send &&
      included_segments == o.included_segments &&
      included_lists == o.included_lists &&
      included_tags == o.included_tags &&
      excluded_segments == o.excluded_segments &&
      excluded_lists == o.excluded_lists &&
      excluded_tags == o.excluded_tags
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



425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 425

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


317
318
319
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 317

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



323
324
325
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 323

def hash
  [name, html_code, subject, sender, preview_text, schedule_type, schedule_condition, time_condition, timezone, preferred_timezone, preferred_time_condition, send_in_contacts_timezone, smart_send, included_segments, included_lists, included_tags, excluded_segments, excluded_lists, excluded_tags].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



264
265
266
267
268
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 264

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



401
402
403
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 401

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



407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 407

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



395
396
397
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 395

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



272
273
274
275
276
277
 
# File 'lib/sendx-ruby-sdk/models/campaign_request.rb', line 272

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  schedule_type_validator = EnumAttributeValidator.new('Integer', [0, 1])
  return false unless schedule_type_validator.valid?(@schedule_type)
  true
end