Class: VoucherifySdk::LoyaltiesUpdateCampaignRequestBody

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

Overview

Request body schema for PUT ‘/loyalties/campaignId`.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoyaltiesUpdateCampaignRequestBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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?(:'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?(:'description')
    self.description = attributes[:'description']
  end

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

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

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

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

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

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

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

Instance Attribute Details

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



48
49
50
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 48

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.



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

def auto_join
  @auto_join
end

#category ⇒ Object

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



36
37
38
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 36

def category
  @category
end

#category_id ⇒ Object

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



45
46
47
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 45

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.



33
34
35
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 33

def description
  @description
end

#expiration_date ⇒ Object

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



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

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.



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

def join_once
  @join_once
end

#loyalty_tiers_expiration ⇒ Object

Returns the value of attribute loyalty_tiers_expiration.



59
60
61
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 59

def loyalty_tiers_expiration
  @loyalty_tiers_expiration
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.



39
40
41
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 39

def metadata
  @metadata
end

#options ⇒ Object

Returns the value of attribute options.



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

def options
  @options
end

#start_date ⇒ Object

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



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

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.



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

def type
  @type
end

#unset_metadata_fields ⇒ Object

Determine which metadata should be removed from campaign.



42
43
44
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 42

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



28
29
30
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 28

def validity_day_of_week
  @validity_day_of_week
end

#validity_hours ⇒ Object

Returns the value of attribute validity_hours.



30
31
32
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 30

def validity_hours
  @validity_hours
end

#validity_timeframe ⇒ Object

Returns the value of attribute validity_timeframe.



25
26
27
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 25

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



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

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



108
109
110
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 108

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 86

def self.attribute_map
  {
    :'start_date' => :'start_date',
    :'expiration_date' => :'expiration_date',
    :'validity_timeframe' => :'validity_timeframe',
    :'validity_day_of_week' => :'validity_day_of_week',
    :'validity_hours' => :'validity_hours',
    :'description' => :'description',
    :'category' => :'category',
    :'metadata' => :'metadata',
    :'unset_metadata_fields' => :'unset_metadata_fields',
    :'category_id' => :'category_id',
    :'activity_duration_after_publishing' => :'activity_duration_after_publishing',
    :'join_once' => :'join_once',
    :'auto_join' => :'auto_join',
    :'type' => :'type',
    :'loyalty_tiers_expiration' => :'loyalty_tiers_expiration',
    :'options' => :'options'
  }
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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 284

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



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 135

def self.openapi_nullable
  Set.new([
    :'start_date',
    :'expiration_date',
    :'description',
    :'category',
    :'metadata',
    :'unset_metadata_fields',
    :'category_id',
    :'activity_duration_after_publishing',
    :'join_once',
    :'auto_join',
    :'type',
    :'options'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 113

def self.openapi_types
  {
    :'start_date' => :'Time',
    :'expiration_date' => :'Time',
    :'validity_timeframe' => :'ValidityTimeframe',
    :'validity_day_of_week' => :'Array<Integer>',
    :'validity_hours' => :'ValidityHours',
    :'description' => :'String',
    :'category' => :'String',
    :'metadata' => :'Object',
    :'unset_metadata_fields' => :'Array<String>',
    :'category_id' => :'String',
    :'activity_duration_after_publishing' => :'String',
    :'join_once' => :'Boolean',
    :'auto_join' => :'Boolean',
    :'type' => :'String',
    :'loyalty_tiers_expiration' => :'LoyaltyTiersExpirationAll',
    :'options' => :'LoyaltiesUpdateCampaignRequestBodyOptions'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 248

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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 &&
      description == o.description &&
      category == o.category &&
      metadata == o.metadata &&
      unset_metadata_fields == o.unset_metadata_fields &&
      category_id == o.category_id &&
      activity_duration_after_publishing == o.activity_duration_after_publishing &&
      join_once == o.join_once &&
      auto_join == o.auto_join &&
      type == o.type &&
      loyalty_tiers_expiration == o.loyalty_tiers_expiration &&
      options == o.options
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



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 379

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


271
272
273
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 271

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



277
278
279
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 277

def hash
  [start_date, expiration_date, validity_timeframe, validity_day_of_week, validity_hours, description, category, metadata, unset_metadata_fields, category_id, activity_duration_after_publishing, join_once, auto_join, type, loyalty_tiers_expiration, options].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



231
232
233
234
235
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 231

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



355
356
357
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 355

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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 361

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



349
350
351
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 349

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



239
240
241
242
243
244
 
# File 'lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb', line 239

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