Class: VoucherifySdk::CampaignsCreateBase

Inherits:
Object
  • Object
show all
Defined in:
lib/VoucherifySdk/models/campaigns_create_base.rb

Overview

Base body schema for creating a campaign using POST ‘/campaigns`.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CampaignsCreateBase

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 145

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#activity_duration_after_publishing ⇒ Object

Defines the amount of time the campaign will be active in ISO 8601 format after publishing. For example, a campaign with a ‘duration` of `P24D` will be valid for a duration of 24 days.



52
53
54
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 52

def activity_duration_after_publishing
  @activity_duration_after_publishing
end

#auto_join ⇒ Object

Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.



32
33
34
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 32

def auto_join
  @auto_join
end

#category ⇒ Object

The category assigned to the campaign. Either pass this parameter OR the ‘category_id`.



61
62
63
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 61

def category
  @category
end

#category_id ⇒ Object

Unique category ID that this campaign belongs to. Either pass this parameter OR the ‘category`.



58
59
60
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 58

def category_id
  @category_id
end

#description ⇒ Object

An optional field to keep any extra textual information about the campaign such as a campaign description and details.



23
24
25
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 23

def description
  @description
end

#expiration_date ⇒ Object

Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is *inactive after* this date.



44
45
46
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 44

def expiration_date
  @expiration_date
end

#join_once ⇒ Object

If this value is set to ‘true`, customers will be able to join the campaign only once.



29
30
31
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 29

def join_once
  @join_once
end

#metadata ⇒ Object

The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format.



64
65
66
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 64

def metadata
  @metadata
end

#name ⇒ Object

Campaign name.



20
21
22
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 20

def name
  @name
end

#start_date ⇒ Object

Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date.



41
42
43
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 41

def start_date
  @start_date
end

#type ⇒ Object

Defines whether the campaign can be updated with new vouchers after campaign creation. - ‘AUTO_UPDATE`: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method). - `STATIC`: vouchers need to be manually published.



26
27
28
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 26

def type
  @type
end

#use_voucher_metadata_schema ⇒ Object

Flag indicating whether the campaign is to use the voucher’s metadata schema instead of the campaign metadata schema.



35
36
37
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 35

def use_voucher_metadata_schema
  @use_voucher_metadata_schema
end

#validation_rules ⇒ Object

Array containing the ID of the validation rule associated with the promotion tier.



55
56
57
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 55

def validation_rules
  @validation_rules
end

#validity_day_of_week ⇒ Object

Integer array corresponding to the particular days of the week in which the campaign is valid. - ‘0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday



49
50
51
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 49

def validity_day_of_week
  @validity_day_of_week
end

#validity_timeframe ⇒ Object

Returns the value of attribute validity_timeframe.



46
47
48
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 46

def validity_timeframe
  @validity_timeframe
end

#vouchers_count ⇒ Object

Total number of unique vouchers in campaign (size of campaign).



38
39
40
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 38

def vouchers_count
  @vouchers_count
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



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
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 335

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 = VoucherifySdk.const_get(type)
    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



111
112
113
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 111

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 89

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'type' => :'type',
    :'join_once' => :'join_once',
    :'auto_join' => :'auto_join',
    :'use_voucher_metadata_schema' => :'use_voucher_metadata_schema',
    :'vouchers_count' => :'vouchers_count',
    :'start_date' => :'start_date',
    :'expiration_date' => :'expiration_date',
    :'validity_timeframe' => :'validity_timeframe',
    :'validity_day_of_week' => :'validity_day_of_week',
    :'activity_duration_after_publishing' => :'activity_duration_after_publishing',
    :'validation_rules' => :'validation_rules',
    :'category_id' => :'category_id',
    :'category' => :'category',
    :'metadata' => :'metadata'
  }
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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 311

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



138
139
140
141
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 138

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

.openapi_types ⇒ Object

Attribute type mapping.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 116

def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'type' => :'String',
    :'join_once' => :'Boolean',
    :'auto_join' => :'Boolean',
    :'use_voucher_metadata_schema' => :'Boolean',
    :'vouchers_count' => :'Integer',
    :'start_date' => :'Time',
    :'expiration_date' => :'Time',
    :'validity_timeframe' => :'CampaignBaseValidityTimeframe',
    :'validity_day_of_week' => :'Array<Integer>',
    :'activity_duration_after_publishing' => :'String',
    :'validation_rules' => :'Array<String>',
    :'category_id' => :'String',
    :'category' => :'String',
    :'metadata' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 275

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      type == o.type &&
      join_once == o.join_once &&
      auto_join == o.auto_join &&
      use_voucher_metadata_schema == o.use_voucher_metadata_schema &&
      vouchers_count == o.vouchers_count &&
      start_date == o.start_date &&
      expiration_date == o.expiration_date &&
      validity_timeframe == o.validity_timeframe &&
      validity_day_of_week == o.validity_day_of_week &&
      activity_duration_after_publishing == o.activity_duration_after_publishing &&
      validation_rules == o.validation_rules &&
      category_id == o.category_id &&
      category == o.category &&
      metadata == o.metadata
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



406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 406

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


298
299
300
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 298

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



304
305
306
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 304

def hash
  [name, description, type, join_once, auto_join, use_voucher_metadata_schema, vouchers_count, start_date, expiration_date, validity_timeframe, validity_day_of_week, activity_duration_after_publishing, validation_rules, category_id, category, metadata].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



229
230
231
232
233
234
235
236
237
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 229

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@validation_rules.nil? && @validation_rules.length > 1
    invalid_properties.push('invalid value for "validation_rules", number of items must be less than or equal to 1.')
  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



382
383
384
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 382

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



388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 388

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



376
377
378
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 376

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



241
242
243
244
245
246
247
 
# File 'lib/VoucherifySdk/models/campaigns_create_base.rb', line 241

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["AUTO_UPDATE", "STATIC"])
  return false unless type_validator.valid?(@type)
  return false if !@validation_rules.nil? && @validation_rules.length > 1
  true
end