Class: SezzleClient::Order

Inherits:
Object
  • Object
show all
Defined in:
lib/sezzle_client/models/order.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Order

Initializes the object

Parameters:

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

    Model attributes in the form of hash



72
73
74
75
76
77
78
79
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
 
# File 'lib/sezzle_client/models/order.rb', line 72

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

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

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

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

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

  if attributes.key?(:'metadata')
    if (value = attributes[:'metadata']).is_a?(Hash)
      self.metadata = value
    end
  end

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

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

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

Instance Attribute Details

#checkout_expiration ⇒ Object

Returns the value of attribute checkout_expiration.



32
33
34
 
# File 'lib/sezzle_client/models/order.rb', line 32

def checkout_expiration
  @checkout_expiration
end

#description ⇒ Object

Returns the value of attribute description.



18
19
20
 
# File 'lib/sezzle_client/models/order.rb', line 18

def description
  @description
end

#discounts ⇒ Object

Returns the value of attribute discounts.



24
25
26
 
# File 'lib/sezzle_client/models/order.rb', line 24

def discounts
  @discounts
end

#items ⇒ Object

Returns the value of attribute items.



22
23
24
 
# File 'lib/sezzle_client/models/order.rb', line 22

def items
  @items
end

#metadata ⇒ Object

Returns the value of attribute metadata.



26
27
28
 
# File 'lib/sezzle_client/models/order.rb', line 26

def metadata
  @metadata
end

#reference_id ⇒ Object

Returns the value of attribute reference_id.



16
17
18
 
# File 'lib/sezzle_client/models/order.rb', line 16

def reference_id
  @reference_id
end

#requires_shipping_info ⇒ Object

Returns the value of attribute requires_shipping_info.



20
21
22
 
# File 'lib/sezzle_client/models/order.rb', line 20

def requires_shipping_info
  @requires_shipping_info
end

#shipping_amount ⇒ Object

Returns the value of attribute shipping_amount.



28
29
30
 
# File 'lib/sezzle_client/models/order.rb', line 28

def shipping_amount
  @shipping_amount
end

#tax_amount ⇒ Object

Returns the value of attribute tax_amount.



30
31
32
 
# File 'lib/sezzle_client/models/order.rb', line 30

def tax_amount
  @tax_amount
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/sezzle_client/models/order.rb', line 35

def self.attribute_map
  {
    :'reference_id' => :'reference_id',
    :'description' => :'description',
    :'requires_shipping_info' => :'requires_shipping_info',
    :'items' => :'items',
    :'discounts' => :'discounts',
    :'metadata' => :'metadata',
    :'shipping_amount' => :'shipping_amount',
    :'tax_amount' => :'tax_amount',
    :'checkout_expiration' => :'checkout_expiration'
  }
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



172
173
174
 
# File 'lib/sezzle_client/models/order.rb', line 172

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



65
66
67
68
 
# File 'lib/sezzle_client/models/order.rb', line 65

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

.openapi_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/sezzle_client/models/order.rb', line 50

def self.openapi_types
  {
    :'reference_id' => :'Object',
    :'description' => :'Object',
    :'requires_shipping_info' => :'Object',
    :'items' => :'Object',
    :'discounts' => :'Object',
    :'metadata' => :'Object',
    :'shipping_amount' => :'Object',
    :'tax_amount' => :'Object',
    :'checkout_expiration' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/sezzle_client/models/order.rb', line 143

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      reference_id == o.reference_id &&
      description == o.description &&
      requires_shipping_info == o.requires_shipping_info &&
      items == o.items &&
      discounts == o.discounts &&
      metadata == o.metadata &&
      shipping_amount == o.shipping_amount &&
      tax_amount == o.tax_amount &&
      checkout_expiration == o.checkout_expiration
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



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
231
232
233
234
235
236
237
 
# File 'lib/sezzle_client/models/order.rb', line 202

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
    SezzleClient.const_get(type).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



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/sezzle_client/models/order.rb', line 271

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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/sezzle_client/models/order.rb', line 179

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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[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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


159
160
161
 
# File 'lib/sezzle_client/models/order.rb', line 159

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



165
166
167
 
# File 'lib/sezzle_client/models/order.rb', line 165

def hash
  [reference_id, description, requires_shipping_info, items, discounts, metadata, shipping_amount, tax_amount, checkout_expiration].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



130
131
132
133
 
# File 'lib/sezzle_client/models/order.rb', line 130

def list_invalid_properties
  invalid_properties = Array.new
  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



247
248
249
 
# File 'lib/sezzle_client/models/order.rb', line 247

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



253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/sezzle_client/models/order.rb', line 253

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



241
242
243
 
# File 'lib/sezzle_client/models/order.rb', line 241

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



137
138
139
 
# File 'lib/sezzle_client/models/order.rb', line 137

def valid?
  true
end