Class: VoucherifySdk::CampaignsImportVoucherItem

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

Overview

Import Vouchers to Campaign

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

Parameters:

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

    Model attributes in the form of hash



126
127
128
129
130
131
132
133
134
135
136
137
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
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 126

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

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

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

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



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

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.



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

def additional_info
  @additional_info
end

#category ⇒ Object

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



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

def category
  @category
end

#code ⇒ Object

Unique custom voucher code.



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

def code
  @code
end

#discount ⇒ Object

Returns the value of attribute discount.



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

def discount
  @discount
end

#gift ⇒ Object

Returns the value of attribute gift.



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

def gift
  @gift
end

#loyalty_card ⇒ Object

Returns the value of attribute loyalty_card.



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

def loyalty_card
  @loyalty_card
end

#metadata ⇒ Object

The metadata object stores all custom attributes assigned to the voucher. 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.



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

def metadata
  @metadata
end

#redemption ⇒ Object

Returns the value of attribute redemption.



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

def redemption
  @redemption
end

#start_date ⇒ Object

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



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

def start_date
  @start_date
end

#type ⇒ Object

Type of voucher.



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

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



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

def validity_day_of_week
  @validity_day_of_week
end

#validity_timeframe ⇒ Object

Returns the value of attribute validity_timeframe.



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



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
318
319
320
321
322
323
324
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 287

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



95
96
97
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 95

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 263

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 230

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



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 358

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



256
257
258
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 256

def hash
  [code, type, redemption, active, metadata, category, start_date, validity_timeframe, validity_day_of_week, additional_info, discount, gift, loyalty_card].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



198
199
200
201
202
203
204
205
206
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 198

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @code.nil?
    invalid_properties.push('invalid value for "code", code cannot be nil.')
  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



334
335
336
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 334

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



340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 340

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



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

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



210
211
212
213
214
215
216
 
# File 'lib/VoucherifySdk/models/campaigns_import_voucher_item.rb', line 210

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