Class: VoucherifySdk::VouchersRedemptionGetResponseBody

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

Overview

Response body schema for GET ‘/vouchers/code/redemption`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VouchersRedemptionGetResponseBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
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
 
# File 'lib/VoucherifySdk/models/vouchers_redemption_get_response_body.rb', line 80

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

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

  if attributes.key?(:'object')
    self.object = attributes[:'object']
  else
    self.object = 'list'
  end

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

  if attributes.key?(:'data_ref')
    self.data_ref = attributes[:'data_ref']
  else
    self.data_ref = 'redemption_entries'
  end

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

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

Instance Attribute Details

#data_ref ⇒ Object

Identifies the name of the attribute that contains the array of ‘redemption_entries`.



32
33
34
 
# File 'lib/VoucherifySdk/models/vouchers_redemption_get_response_body.rb', line 32

def data_ref
  @data_ref
end

#object ⇒ Object

The type of object represented by JSON. This object stores information about redemptions in a dictionary.



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

def object
  @object
end

#quantity ⇒ Object

The maximum number of times a voucher can be redeemed.



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

def quantity
  @quantity
end

#redeemed_quantity ⇒ Object

The number of times the voucher was redeemed successfully.



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

def redeemed_quantity
  @redeemed_quantity
end

#redemption_entries ⇒ Object

Contains the array of successful and failed redemption objects.



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

def redemption_entries
  @redemption_entries
end

#total ⇒ Object

Total number of redemption objects.



35
36
37
 
# File 'lib/VoucherifySdk/models/vouchers_redemption_get_response_body.rb', line 35

def total
  @total
end

#url ⇒ Object

URL



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

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



236
237
238
239
240
241
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
 
# File 'lib/VoucherifySdk/models/vouchers_redemption_get_response_body.rb', line 236

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/VoucherifySdk/models/vouchers_redemption_get_response_body.rb', line 41

def self.attribute_map
  {
    :'quantity' => :'quantity',
    :'redeemed_quantity' => :'redeemed_quantity',
    :'object' => :'object',
    :'url' => :'url',
    :'data_ref' => :'data_ref',
    :'total' => :'total',
    :'redemption_entries' => :'redemption_entries'
  }
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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/VoucherifySdk/models/vouchers_redemption_get_response_body.rb', line 212

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



72
73
74
75
76
 
# File 'lib/VoucherifySdk/models/vouchers_redemption_get_response_body.rb', line 72

def self.openapi_nullable
  Set.new([
    :'quantity',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/VoucherifySdk/models/vouchers_redemption_get_response_body.rb', line 59

def self.openapi_types
  {
    :'quantity' => :'Integer',
    :'redeemed_quantity' => :'Integer',
    :'object' => :'String',
    :'url' => :'String',
    :'data_ref' => :'String',
    :'total' => :'Integer',
    :'redemption_entries' => :'Array<VouchersRedemptionGetResponseBodyRedemptionEntriesItem>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/VoucherifySdk/models/vouchers_redemption_get_response_body.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      quantity == o.quantity &&
      redeemed_quantity == o.redeemed_quantity &&
      object == o.object &&
      url == o.url &&
      data_ref == o.data_ref &&
      total == o.total &&
      redemption_entries == o.redemption_entries
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



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/VoucherifySdk/models/vouchers_redemption_get_response_body.rb', line 307

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


199
200
201
 
# File 'lib/VoucherifySdk/models/vouchers_redemption_get_response_body.rb', line 199

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [quantity, redeemed_quantity, object, url, data_ref, total, redemption_entries].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



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

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

  if @object.nil?
    invalid_properties.push('invalid value for "object", object cannot be nil.')
  end

  if @url.nil?
    invalid_properties.push('invalid value for "url", url cannot be nil.')
  end

  if @data_ref.nil?
    invalid_properties.push('invalid value for "data_ref", data_ref cannot be nil.')
  end

  if @total.nil?
    invalid_properties.push('invalid value for "total", total cannot be nil.')
  end

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



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

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



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/VoucherifySdk/models/vouchers_redemption_get_response_body.rb', line 289

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



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

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



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/VoucherifySdk/models/vouchers_redemption_get_response_body.rb', line 172

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @redeemed_quantity.nil?
  return false if @object.nil?
  return false if @url.nil?
  return false if @data_ref.nil?
  return false if @total.nil?
  return false if @redemption_entries.nil?
  true
end