Class: ZipMoney::Checkout

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

Overview

The checkout request

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Checkout

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/zip_money/models/checkout.rb', line 97

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

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

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = "standard"
  end

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#config ⇒ Object

Returns the value of attribute config.



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

def config
  @config
end

#created ⇒ Object

Date the checkout was created



29
30
31
 
# File 'lib/zip_money/models/checkout.rb', line 29

def created
  @created
end

#customer_id ⇒ Object

The id of the customer who has approved this checkout request. Only present if approved.



35
36
37
 
# File 'lib/zip_money/models/checkout.rb', line 35

def customer_id
  @customer_id
end

#features ⇒ Object

Returns the value of attribute features.



24
25
26
 
# File 'lib/zip_money/models/checkout.rb', line 24

def features
  @features
end

#id ⇒ Object

The checkout id



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

def id
  @id
end

#metadata ⇒ Object

Returns the value of attribute metadata.



37
38
39
 
# File 'lib/zip_money/models/checkout.rb', line 37

def metadata
  @metadata
end

#order ⇒ Object

Returns the value of attribute order.



22
23
24
 
# File 'lib/zip_money/models/checkout.rb', line 22

def order
  @order
end

#shopper ⇒ Object

Returns the value of attribute shopper.



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

def shopper
  @shopper
end

#state ⇒ Object

Current state of the checkout



32
33
34
 
# File 'lib/zip_money/models/checkout.rb', line 32

def state
  @state
end

#type ⇒ Object

The type of checkout



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

def type
  @type
end

#uri ⇒ Object

The uri to redirect the user to in order to approve this checkout.



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

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/zip_money/models/checkout.rb', line 62

def self.attribute_map
  {
    :'id' => :'id',
    :'uri' => :'uri',
    :'type' => :'type',
    :'shopper' => :'shopper',
    :'order' => :'order',
    :'features' => :'features',
    :'config' => :'config',
    :'created' => :'created',
    :'state' => :'state',
    :'customer_id' => :'customer_id',
    :'metadata' => :'metadata'
  }
end

.zip_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/zip_money/models/checkout.rb', line 79

def self.zip_types
  {
    :'id' => :'String',
    :'uri' => :'String',
    :'type' => :'String',
    :'shopper' => :'Shopper',
    :'order' => :'CheckoutOrder',
    :'features' => :'CheckoutFeatures',
    :'config' => :'CheckoutConfiguration',
    :'created' => :'DateTime',
    :'state' => :'String',
    :'customer_id' => :'String',
    :'metadata' => :'Metadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/zip_money/models/checkout.rb', line 210

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      uri == o.uri &&
      type == o.type &&
      shopper == o.shopper &&
      order == o.order &&
      features == o.features &&
      config == o.config &&
      created == o.created &&
      state == o.state &&
      customer_id == o.customer_id &&
      metadata == o.metadata
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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/zip_money/models/checkout.rb', line 262

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



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/zip_money/models/checkout.rb', line 328

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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/zip_money/models/checkout.rb', line 241

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


228
229
230
 
# File 'lib/zip_money/models/checkout.rb', line 228

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



234
235
236
 
# File 'lib/zip_money/models/checkout.rb', line 234

def hash
  [id, uri, type, shopper, order, features, config, created, state, customer_id, metadata].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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/zip_money/models/checkout.rb', line 153

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push("invalid value for 'id', id cannot be nil.")
  end

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

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

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



308
309
310
 
# File 'lib/zip_money/models/checkout.rb', line 308

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



314
315
316
317
318
319
320
321
322
 
# File 'lib/zip_money/models/checkout.rb', line 314

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



302
303
304
 
# File 'lib/zip_money/models/checkout.rb', line 302

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



176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/zip_money/models/checkout.rb', line 176

def valid?
  return false if @id.nil?
  return false if @uri.nil?
  type_validator = EnumAttributeValidator.new('String', ["standard", "express"])
  return false unless type_validator.valid?(@type)
  return false if @created.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["created", "expired", "approved", "completed"])
  return false unless state_validator.valid?(@state)
  return true
end