Class: VoucherifySdk::DiscountUnit

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DiscountUnit

Initializes the object

Parameters:

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

    Model attributes in the form of hash



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/VoucherifySdk/models/discount_unit.rb', line 101

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

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

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

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

  if attributes.key?(:'unit_type')
    self.unit_type = attributes[:'unit_type']
  else
    self.unit_type = nil
  end

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

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

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

Instance Attribute Details

#effect ⇒ Object

Returns the value of attribute effect.



26
27
28
 
# File 'lib/VoucherifySdk/models/discount_unit.rb', line 26

def effect
  @effect
end

#is_dynamic ⇒ Object

Flag indicating whether the discount was calculated using a formula.



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

def is_dynamic
  @is_dynamic
end

#product ⇒ Object

Returns the value of attribute product.



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

def product
  @product
end

#sku ⇒ Object

Returns the value of attribute sku.



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

def sku
  @sku
end

#type ⇒ Object

Discount type.



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

def type
  @type
end

#unit_off ⇒ Object

Number of units to be granted a full value discount.



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

def unit_off
  @unit_off
end

#unit_off_formula ⇒ Object

Returns the value of attribute unit_off_formula.



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

def unit_off_formula
  @unit_off_formula
end

#unit_type ⇒ Object

The product deemed as free, chosen from product inventory (e.g. time, items).



29
30
31
 
# File 'lib/VoucherifySdk/models/discount_unit.rb', line 29

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



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
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/VoucherifySdk/models/discount_unit.rb', line 242

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



75
76
77
 
# File 'lib/VoucherifySdk/models/discount_unit.rb', line 75

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/VoucherifySdk/models/discount_unit.rb', line 61

def self.attribute_map
  {
    :'type' => :'type',
    :'unit_off' => :'unit_off',
    :'unit_off_formula' => :'unit_off_formula',
    :'effect' => :'effect',
    :'unit_type' => :'unit_type',
    :'product' => :'product',
    :'sku' => :'sku',
    :'is_dynamic' => :'is_dynamic'
  }
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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/VoucherifySdk/models/discount_unit.rb', line 218

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/VoucherifySdk/models/discount_unit.rb', line 80

def self.openapi_types
  {
    :'type' => :'String',
    :'unit_off' => :'Integer',
    :'unit_off_formula' => :'String',
    :'effect' => :'DiscountUnitVouchersEffectTypes',
    :'unit_type' => :'String',
    :'product' => :'SimpleProductDiscountUnit',
    :'sku' => :'SimpleSkuDiscountUnit',
    :'is_dynamic' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/VoucherifySdk/models/discount_unit.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      unit_off == o.unit_off &&
      unit_off_formula == o.unit_off_formula &&
      effect == o.effect &&
      unit_type == o.unit_type &&
      product == o.product &&
      sku == o.sku &&
      is_dynamic == o.is_dynamic
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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/VoucherifySdk/models/discount_unit.rb', line 313

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


205
206
207
 
# File 'lib/VoucherifySdk/models/discount_unit.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



211
212
213
 
# File 'lib/VoucherifySdk/models/discount_unit.rb', line 211

def hash
  [type, unit_off, unit_off_formula, effect, unit_type, product, sku, is_dynamic].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @unit_type.nil?
    invalid_properties.push('invalid value for "unit_type", unit_type 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



289
290
291
 
# File 'lib/VoucherifySdk/models/discount_unit.rb', line 289

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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/VoucherifySdk/models/discount_unit.rb', line 295

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



283
284
285
 
# File 'lib/VoucherifySdk/models/discount_unit.rb', line 283

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



169
170
171
172
173
174
175
176
 
# File 'lib/VoucherifySdk/models/discount_unit.rb', line 169

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