Class: VoucherifySdk::LoyaltiesCreateCampaignRequestBody

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

Overview

Request body schema for POST ‘/loyalties`.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoyaltiesCreateCampaignRequestBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    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?(:'validity_hours')
    self.validity_hours = attributes[:'validity_hours']
  end

  if attributes.key?(:'activity_duration_after_publishing')
    self.activity_duration_after_publishing = attributes[:'activity_duration_after_publishing']
  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

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

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

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

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

Instance Attribute Details

#access_settings ⇒ Object

Returns the value of attribute access_settings.



65
66
67
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 65

def access_settings
  @access_settings
end

#activity_duration_after_publishing ⇒ Object

Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days.



54
55
56
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 54

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/loyalties_create_campaign_request_body.rb', line 32

def auto_join
  @auto_join
end

#campaign_type ⇒ Object

Type of campaign.



71
72
73
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 71

def campaign_type
  @campaign_type
end

#category ⇒ Object

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



60
61
62
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 60

def category
  @category
end

#category_id ⇒ Object

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



57
58
59
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 57

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/loyalties_create_campaign_request_body.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/loyalties_create_campaign_request_body.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/loyalties_create_campaign_request_body.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.



63
64
65
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 63

def metadata
  @metadata
end

#name ⇒ Object

Campaign name.



20
21
22
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.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/loyalties_create_campaign_request_body.rb', line 41

def start_date
  @start_date
end

#type ⇒ Object

Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers. - ‘AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published



26
27
28
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.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/loyalties_create_campaign_request_body.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.



68
69
70
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 68

def validation_rules
  @validation_rules
end

#validity_day_of_week ⇒ Object

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



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

def validity_day_of_week
  @validity_day_of_week
end

#validity_hours ⇒ Object

Returns the value of attribute validity_hours.



51
52
53
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 51

def validity_hours
  @validity_hours
end

#validity_timeframe ⇒ Object

Returns the value of attribute validity_timeframe.



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

def validity_timeframe
  @validity_timeframe
end

#voucher ⇒ Object

Returns the value of attribute voucher.



73
74
75
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 73

def voucher
  @voucher
end

#vouchers_count ⇒ Object

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



38
39
40
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.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



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
392
393
394
395
396
397
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 360

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



124
125
126
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 124

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
121
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 98

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',
    :'validity_hours' => :'validity_hours',
    :'activity_duration_after_publishing' => :'activity_duration_after_publishing',
    :'category_id' => :'category_id',
    :'category' => :'category',
    :'metadata' => :'metadata',
    :'access_settings' => :'access_settings',
    :'validation_rules' => :'validation_rules',
    :'campaign_type' => :'campaign_type',
    :'voucher' => :'voucher'
  }
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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 336

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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 155

def self.openapi_nullable
  Set.new([
    :'name',
    :'description',
    :'type',
    :'join_once',
    :'auto_join',
    :'use_voucher_metadata_schema',
    :'vouchers_count',
    :'start_date',
    :'expiration_date',
    :'activity_duration_after_publishing',
    :'category_id',
    :'category',
    :'metadata',
    :'validation_rules',
    :'campaign_type',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 129

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' => :'ValidityTimeframe',
    :'validity_day_of_week' => :'Array<Integer>',
    :'validity_hours' => :'ValidityHours',
    :'activity_duration_after_publishing' => :'String',
    :'category_id' => :'String',
    :'category' => :'String',
    :'metadata' => :'Object',
    :'access_settings' => :'AccessSettings',
    :'validation_rules' => :'Array<String>',
    :'campaign_type' => :'String',
    :'voucher' => :'CampaignLoyaltyVoucher'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 296

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 &&
      validity_hours == o.validity_hours &&
      activity_duration_after_publishing == o.activity_duration_after_publishing &&
      category_id == o.category_id &&
      category == o.category &&
      metadata == o.metadata &&
      access_settings == o.access_settings &&
      validation_rules == o.validation_rules &&
      campaign_type == o.campaign_type &&
      voucher == o.voucher
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



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 431

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


323
324
325
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 323

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



329
330
331
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 329

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, validity_hours, activity_duration_after_publishing, category_id, category, metadata, access_settings, validation_rules, campaign_type, voucher].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



272
273
274
275
276
277
278
279
280
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 272

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



407
408
409
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 407

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



413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 413

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



401
402
403
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 401

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



284
285
286
287
288
289
290
291
292
 
# File 'lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb', line 284

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
  campaign_type_validator = EnumAttributeValidator.new('String', ["LOYALTY_PROGRAM"])
  return false unless campaign_type_validator.valid?(@campaign_type)
  true
end