Class: VoucherifySdk::LoyaltiesMembersTransfersCreateResponseBodyRedemption

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

Overview

Stores a summary of redemptions that have been applied to the voucher.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoyaltiesMembersTransfersCreateResponseBodyRedemption

Initializes the object



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

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

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

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

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

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

Instance Attribute Details

#object ⇒ Object

The type of the object represented is by default list. To get this list, you need to make a call to the endpoint returned in the url attribute.



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

def object
  @object
end

#quantity ⇒ Object

How many times a voucher can be redeemed. A null value means unlimited.



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

def quantity
  @quantity
end

#redeemed_points ⇒ Object

Total loyalty points redeemed.



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

def redeemed_points
  @redeemed_points
end

#redeemed_quantity ⇒ Object

How many times a voucher has already been redeemed.



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

def redeemed_quantity
  @redeemed_quantity
end

#url ⇒ Object

The endpoint where this list of redemptions can be accessed using a GET method. /v1/vouchers/voucher_code/redemptions



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

def url
  @url
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



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

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
 
# File 'lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_redemption.rb', line 57

def self.attribute_map
  {
    :'quantity' => :'quantity',
    :'redeemed_points' => :'redeemed_points',
    :'redeemed_quantity' => :'redeemed_quantity',
    :'object' => :'object',
    :'url' => :'url'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_redemption.rb', line 169

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



84
85
86
87
88
89
90
91
92
 
# File 'lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_redemption.rb', line 84

def self.openapi_nullable
  Set.new([
    :'quantity',
    :'redeemed_points',
    :'redeemed_quantity',
    :'object',
    :'url'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
 
# File 'lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_redemption.rb', line 73

def self.openapi_types
  {
    :'quantity' => :'Integer',
    :'redeemed_points' => :'Integer',
    :'redeemed_quantity' => :'Integer',
    :'object' => :'String',
    :'url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



144
145
146
147
148
149
150
151
152
 
# File 'lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_redemption.rb', line 144

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      quantity == o.quantity &&
      redeemed_points == o.redeemed_points &&
      redeemed_quantity == o.redeemed_quantity &&
      object == o.object &&
      url == o.url
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_redemption.rb', line 264

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


156
157
158
 
# File 'lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_redemption.rb', line 156

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



162
163
164
 
# File 'lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_redemption.rb', line 162

def hash
  [quantity, redeemed_points, redeemed_quantity, object, url].hash
end

#list_invalid_properties ⇒ Object

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



127
128
129
130
131
 
# File 'lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_redemption.rb', line 127

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)



240
241
242
 
# File 'lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_redemption.rb', line 240

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_redemption.rb', line 246

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



234
235
236
 
# File 'lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_redemption.rb', line 234

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



135
136
137
138
139
140
 
# File 'lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_redemption.rb', line 135

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  object_validator = EnumAttributeValidator.new('String', ["list"])
  return false unless object_validator.valid?(@object)
  true
end