Class: ZipMoney::CheckoutOrder

Inherits:
Object
  • Object
show all
Defined in:
lib/zip_money/models/checkout_order.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CheckoutOrder

Initializes the object

Parameters:

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

    Model attributes in the form of hash



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/zip_money/models/checkout_order.rb', line 55

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'reference')
    self.reference = attributes[:'reference']
  end

  if attributes.has_key?(:'amount')
    self.amount = attributes[:'amount']
  end

  if attributes.has_key?(:'currency')
    self.currency = attributes[:'currency']
  end

  if attributes.has_key?(:'shipping')
    self.shipping = attributes[:'shipping']
  end

  if attributes.has_key?(:'items')
    if (value = attributes[:'items']).is_a?(Array)
      self.items = value
    end
  end

  if attributes.has_key?(:'cart_reference')
    self.cart_reference = attributes[:'cart_reference']
  end

end

Instance Attribute Details

#amount ⇒ Object

The total amount of the order



15
16
17
 
# File 'lib/zip_money/models/checkout_order.rb', line 15

def amount
  @amount
end

#cart_reference ⇒ Object

The shopping cart reference id



26
27
28
 
# File 'lib/zip_money/models/checkout_order.rb', line 26

def cart_reference
  @cart_reference
end

#currency ⇒ Object

The ISO-4217 currency code. See en.wikipedia.org/wiki/ISO_4217



18
19
20
 
# File 'lib/zip_money/models/checkout_order.rb', line 18

def currency
  @currency
end

#items ⇒ Object

The order item breakdown



23
24
25
 
# File 'lib/zip_money/models/checkout_order.rb', line 23

def items
  @items
end

#reference ⇒ Object

The order id in the eCommerce system



12
13
14
 
# File 'lib/zip_money/models/checkout_order.rb', line 12

def reference
  @reference
end

#shipping ⇒ Object

Returns the value of attribute shipping.



20
21
22
 
# File 'lib/zip_money/models/checkout_order.rb', line 20

def shipping
  @shipping
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/zip_money/models/checkout_order.rb', line 30

def self.attribute_map
  {
    :'reference' => :'reference',
    :'amount' => :'amount',
    :'currency' => :'currency',
    :'shipping' => :'shipping',
    :'items' => :'items',
    :'cart_reference' => :'cart_reference'
  }
end

.zip_types ⇒ Object

Attribute type mapping.



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

def self.zip_types
  {
    :'reference' => :'String',
    :'amount' => :'Float',
    :'currency' => :'String',
    :'shipping' => :'OrderShipping',
    :'items' => :'Array<OrderItem>',
    :'cart_reference' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/zip_money/models/checkout_order.rb', line 170

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      reference == o.reference &&
      amount == o.amount &&
      currency == o.currency &&
      shipping == o.shipping &&
      items == o.items &&
      cart_reference == o.cart_reference
end

#_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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/zip_money/models/checkout_order.rb', line 217

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = ZipMoney.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/zip_money/models/checkout_order.rb', line 283

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

#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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/zip_money/models/checkout_order.rb', line 196

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.zip_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


183
184
185
 
# File 'lib/zip_money/models/checkout_order.rb', line 183

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



189
190
191
 
# File 'lib/zip_money/models/checkout_order.rb', line 189

def hash
  [reference, amount, currency, shipping, items, cart_reference].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



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
 
# File 'lib/zip_money/models/checkout_order.rb', line 91

def list_invalid_properties
  invalid_properties = Array.new
  if !@reference.nil? && @reference.to_s.length > 200
    invalid_properties.push("invalid value for 'reference', the character length must be smaller than or equal to 200.")
  end

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

  if @amount < 0
    invalid_properties.push("invalid value for 'amount', must be greater than or equal to 0.")
  end

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

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

  if !@cart_reference.nil? && @cart_reference.to_s.length > 200
    invalid_properties.push("invalid value for 'cart_reference', the character length must be smaller than or equal to 200.")
  end

  return 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



263
264
265
 
# File 'lib/zip_money/models/checkout_order.rb', line 263

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



269
270
271
272
273
274
275
276
277
 
# File 'lib/zip_money/models/checkout_order.rb', line 269

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



257
258
259
 
# File 'lib/zip_money/models/checkout_order.rb', line 257

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



122
123
124
125
126
127
128
129
130
 
# File 'lib/zip_money/models/checkout_order.rb', line 122

def valid?
  return false if !@reference.nil? && @reference.to_s.length > 200
  return false if @amount.nil?
  return false if @amount < 0
  return false if @currency.nil?
  return false if @shipping.nil?
  return false if !@cart_reference.nil? && @cart_reference.to_s.length > 200
  return true
end