Class: VoucherifySdk::VouchersCreateRequestBody

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VouchersCreateRequestBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

A flag to toggle the voucher on or off. You can disable a voucher even though it’s within the active period defined by the ‘start_date` and `expiration_date`. - `true` indicates an active voucher - `false` indicates an inactive voucher



47
48
49
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 47

def active
  @active
end

#additional_info ⇒ Object

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



50
51
52
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 50

def additional_info
  @additional_info
end

#campaign ⇒ Object

Identifies the voucher’s parent campaign using a unique campaign name.



22
23
24
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 22

def campaign
  @campaign
end

#campaign_id ⇒ Object

Identifies the voucher’s parent campaign using a unique campaign ID assigned by the Voucherify API.



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

def campaign_id
  @campaign_id
end

#category ⇒ Object

The name of the category that this voucher belongs to. Useful when listing vouchers with the [List Vouchers](ref:list-vouchers) endpoint.



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

def category
  @category
end

#category_id ⇒ Object

Unique identifier assigned by Voucherify to the name of the category that this voucher belongs to. Useful when listing vouchers with the [List Vouchers](ref:list-vouchers) endpoint.



31
32
33
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 31

def category_id
  @category_id
end

#code ⇒ Object

Code that identifies a voucher. The pattern can use all the letters of the English alphabet, Arabic numerals, and special characters. Pass this attribute in the request body to create a distinct code. Otherwise, either use the ‘code_config` object to set the rules that the Voucherify API will use to create a random code, or don’t pass any code and Voucherify will generate a random code.



19
20
21
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 19

def code
  @code
end

#code_config ⇒ Object

Returns the value of attribute code_config.



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

def code_config
  @code_config
end

#discount ⇒ Object

Returns the value of attribute discount.



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

def discount
  @discount
end

#expiration_date ⇒ Object

Expiration date defines when the code expires. Expiration timestamp is presented in the ISO 8601 format. Voucher is *inactive after* this date.



37
38
39
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 37

def expiration_date
  @expiration_date
end

#gift ⇒ Object

Returns the value of attribute gift.



66
67
68
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 66

def gift
  @gift
end

#loyalty_card ⇒ Object

Returns the value of attribute loyalty_card.



62
63
64
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 62

def loyalty_card
  @loyalty_card
end

#metadata ⇒ Object

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



53
54
55
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 53

def metadata
  @metadata
end

#redemption ⇒ Object

Returns the value of attribute redemption.



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

def redemption
  @redemption
end

#start_date ⇒ Object

Start date defines when the code starts to be active. Activation timestamp is presented in the ISO 8601 format. Voucher is *inactive before* this date.



34
35
36
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 34

def start_date
  @start_date
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#validation_rules ⇒ Object

Array containing the ID of the validation rule associated with the voucher.



56
57
58
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 56

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



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

def validity_day_of_week
  @validity_day_of_week
end

#validity_hours ⇒ Object

Returns the value of attribute validity_hours.



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

def validity_hours
  @validity_hours
end

#validity_timeframe ⇒ Object

Returns the value of attribute validity_timeframe.



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

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



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
373
374
375
376
377
378
379
380
381
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 344

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



119
120
121
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 119

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 93

def self.attribute_map
  {
    :'code' => :'code',
    :'campaign' => :'campaign',
    :'campaign_id' => :'campaign_id',
    :'category' => :'category',
    :'category_id' => :'category_id',
    :'start_date' => :'start_date',
    :'expiration_date' => :'expiration_date',
    :'validity_timeframe' => :'validity_timeframe',
    :'validity_day_of_week' => :'validity_day_of_week',
    :'validity_hours' => :'validity_hours',
    :'active' => :'active',
    :'additional_info' => :'additional_info',
    :'metadata' => :'metadata',
    :'validation_rules' => :'validation_rules',
    :'redemption' => :'redemption',
    :'type' => :'type',
    :'loyalty_card' => :'loyalty_card',
    :'code_config' => :'code_config',
    :'gift' => :'gift',
    :'discount' => :'discount'
  }
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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 320

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



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 150

def self.openapi_nullable
  Set.new([
    :'code',
    :'campaign',
    :'campaign_id',
    :'category',
    :'category_id',
    :'start_date',
    :'expiration_date',
    :'active',
    :'additional_info',
    :'metadata',
    :'validation_rules',
    :'redemption',
    :'type',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 124

def self.openapi_types
  {
    :'code' => :'String',
    :'campaign' => :'String',
    :'campaign_id' => :'String',
    :'category' => :'String',
    :'category_id' => :'String',
    :'start_date' => :'Time',
    :'expiration_date' => :'Time',
    :'validity_timeframe' => :'ValidityTimeframe',
    :'validity_day_of_week' => :'Array<Integer>',
    :'validity_hours' => :'ValidityHours',
    :'active' => :'Boolean',
    :'additional_info' => :'String',
    :'metadata' => :'Object',
    :'validation_rules' => :'Array<String>',
    :'redemption' => :'VouchersCreateRequestBodyRedemption',
    :'type' => :'String',
    :'loyalty_card' => :'SimpleLoyaltyCard',
    :'code_config' => :'CodeConfig',
    :'gift' => :'Gift',
    :'discount' => :'Discount'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      code == o.code &&
      campaign == o.campaign &&
      campaign_id == o.campaign_id &&
      category == o.category &&
      category_id == o.category_id &&
      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 &&
      active == o.active &&
      additional_info == o.additional_info &&
      metadata == o.metadata &&
      validation_rules == o.validation_rules &&
      redemption == o.redemption &&
      type == o.type &&
      loyalty_card == o.loyalty_card &&
      code_config == o.code_config &&
      gift == o.gift &&
      discount == o.discount
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



415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 415

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


307
308
309
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 307

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



313
314
315
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 313

def hash
  [code, campaign, campaign_id, category, category_id, start_date, expiration_date, validity_timeframe, validity_day_of_week, validity_hours, active, additional_info, metadata, validation_rules, redemption, type, loyalty_card, code_config, gift, discount].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



263
264
265
266
267
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 263

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



391
392
393
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 391

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



397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 397

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



385
386
387
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 385

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



271
272
273
274
275
276
 
# File 'lib/VoucherifySdk/models/vouchers_create_request_body.rb', line 271

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