Class: VoucherifySdk::CampaignsImportVoucherItem

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CampaignsImportVoucherItem

Initializes the object



138
139
140
141
142
143
144
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
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 138

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

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

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

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



24
25
26
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 24

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.



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

def additional_info
  @additional_info
end

#category ⇒ Object

Tag defining the category that this voucher belongs to. Useful when listing vouchers using the [List Vouchers](ref:list-vouchers) endpoint.



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

def category
  @category
end

#code ⇒ Object

Value representing the imported code.



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

def code
  @code
end

#discount ⇒ Object

Returns the value of attribute discount.



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

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. Allowed date formats are: - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ



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

def expiration_date
  @expiration_date
end

#gift ⇒ Object

Returns the value of attribute gift.



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

def gift
  @gift
end

#loyalty_card ⇒ Object

Returns the value of attribute loyalty_card.



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

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.



27
28
29
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 27

def metadata
  @metadata
end

#redemption ⇒ Object

Returns the value of attribute redemption.



21
22
23
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 21

def redemption
  @redemption
end

#start_date ⇒ Object

Activation timestamp presented in the ISO 8601 format. Voucher is *inactive before* this date. Start date defines when the code starts to be active. Allowed date formats are: - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ



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

def start_date
  @start_date
end

#type ⇒ Object

Returns the value of attribute type.



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

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



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

def validity_day_of_week
  @validity_day_of_week
end

#validity_timeframe ⇒ Object

Returns the value of attribute validity_timeframe.



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

def validity_timeframe
  @validity_timeframe
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 280

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



97
98
99
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 77

def self.attribute_map
  {
    :'code' => :'code',
    :'redemption' => :'redemption',
    :'active' => :'active',
    :'metadata' => :'metadata',
    :'category' => :'category',
    :'start_date' => :'start_date',
    :'expiration_date' => :'expiration_date',
    :'validity_timeframe' => :'validity_timeframe',
    :'validity_day_of_week' => :'validity_day_of_week',
    :'additional_info' => :'additional_info',
    :'type' => :'type',
    :'loyalty_card' => :'loyalty_card',
    :'gift' => :'gift',
    :'discount' => :'discount'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 256

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



122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 122

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

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 102

def self.openapi_types
  {
    :'code' => :'String',
    :'redemption' => :'CampaignsImportVoucherItemRedemption',
    :'active' => :'Boolean',
    :'metadata' => :'Object',
    :'category' => :'String',
    :'start_date' => :'Time',
    :'expiration_date' => :'Time',
    :'validity_timeframe' => :'ValidityTimeframe',
    :'validity_day_of_week' => :'Array<Integer>',
    :'additional_info' => :'String',
    :'type' => :'String',
    :'loyalty_card' => :'SimpleLoyaltyCard',
    :'gift' => :'Gift',
    :'discount' => :'Discount'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      code == o.code &&
      redemption == o.redemption &&
      active == o.active &&
      metadata == o.metadata &&
      category == o.category &&
      start_date == o.start_date &&
      expiration_date == o.expiration_date &&
      validity_timeframe == o.validity_timeframe &&
      validity_day_of_week == o.validity_day_of_week &&
      additional_info == o.additional_info &&
      type == o.type &&
      loyalty_card == o.loyalty_card &&
      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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 351

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

See Also:

  • `==` method


243
244
245
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 243

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



249
250
251
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 249

def hash
  [code, redemption, active, metadata, category, start_date, expiration_date, validity_timeframe, validity_day_of_week, additional_info, type, loyalty_card, gift, discount].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



205
206
207
208
209
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 205

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)



327
328
329
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 327

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 333

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



321
322
323
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 321

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



213
214
215
216
217
218
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 213

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