Class: SquareConnect::OrderReturn

Inherits:
Object
  • Object
show all
Defined in:
lib/square_connect/models/order_return.rb

Overview

The set of line items, service charges, taxes, discounts, tips, etc. being returned in an Order.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderReturn

Initializes the object

Parameters:

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

    Model attributes in the form of hash



70
71
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
 
# File 'lib/square_connect/models/order_return.rb', line 70

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#return_amounts ⇒ Object

Aggregate monetary value being returned by this Return entry.



37
38
39
 
# File 'lib/square_connect/models/order_return.rb', line 37

def return_amounts
  @return_amounts
end

#return_discounts ⇒ Object

Collection of discounts which are being returned.



31
32
33
 
# File 'lib/square_connect/models/order_return.rb', line 31

def return_discounts
  @return_discounts
end

#return_line_items ⇒ Object

Collection of line items which are being returned.



22
23
24
 
# File 'lib/square_connect/models/order_return.rb', line 22

def return_line_items
  @return_line_items
end

#return_service_charges ⇒ Object

Collection of service charges which are being returned. This field is read-only.



25
26
27
 
# File 'lib/square_connect/models/order_return.rb', line 25

def return_service_charges
  @return_service_charges
end

#return_taxes ⇒ Object

Collection of taxes which are being returned.



28
29
30
 
# File 'lib/square_connect/models/order_return.rb', line 28

def return_taxes
  @return_taxes
end

#rounding_adjustment ⇒ Object

A positive or negative rounding adjustment to the total value being returned. Commonly used to apply Cash Rounding when the minimum unit of account is smaller than the lowest physical denomination of currency.



34
35
36
 
# File 'lib/square_connect/models/order_return.rb', line 34

def rounding_adjustment
  @rounding_adjustment
end

#source_order_id ⇒ Object

Order which contains the original sale of these returned line items. This will be unset for unlinked returns.



19
20
21
 
# File 'lib/square_connect/models/order_return.rb', line 19

def source_order_id
  @source_order_id
end

#uid ⇒ Object

Unique ID that identifies the return only within this order. This field is read-only.



16
17
18
 
# File 'lib/square_connect/models/order_return.rb', line 16

def uid
  @uid
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'uid' => :'uid',
    :'source_order_id' => :'source_order_id',
    :'return_line_items' => :'return_line_items',
    :'return_service_charges' => :'return_service_charges',
    :'return_taxes' => :'return_taxes',
    :'return_discounts' => :'return_discounts',
    :'rounding_adjustment' => :'rounding_adjustment',
    :'return_amounts' => :'return_amounts'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/square_connect/models/order_return.rb', line 55

def self.swagger_types
  {
    :'uid' => :'String',
    :'source_order_id' => :'String',
    :'return_line_items' => :'Array<OrderReturnLineItem>',
    :'return_service_charges' => :'Array<OrderReturnServiceCharge>',
    :'return_taxes' => :'Array<OrderReturnTax>',
    :'return_discounts' => :'Array<OrderReturnDiscount>',
    :'rounding_adjustment' => :'OrderRoundingAdjustment',
    :'return_amounts' => :'OrderMoneyAmounts'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/square_connect/models/order_return.rb', line 149

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      uid == o.uid &&
      source_order_id == o.source_order_id &&
      return_line_items == o.return_line_items &&
      return_service_charges == o.return_service_charges &&
      return_taxes == o.return_taxes &&
      return_discounts == o.return_discounts &&
      rounding_adjustment == o.rounding_adjustment &&
      return_amounts == o.return_amounts
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



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
231
232
233
234
 
# File 'lib/square_connect/models/order_return.rb', line 198

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 = SquareConnect.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



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/square_connect/models/order_return.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

#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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/square_connect/models/order_return.rb', line 177

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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


164
165
166
 
# File 'lib/square_connect/models/order_return.rb', line 164

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



170
171
172
 
# File 'lib/square_connect/models/order_return.rb', line 170

def hash
  [uid, source_order_id, return_line_items, return_service_charges, return_taxes, return_discounts, rounding_adjustment, return_amounts].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



120
121
122
123
124
125
126
127
 
# File 'lib/square_connect/models/order_return.rb', line 120

def list_invalid_properties
  invalid_properties = Array.new
  if !@uid.nil? && @uid.to_s.length > 60
    invalid_properties.push("invalid value for 'uid', the character length must be smaller than or equal to 60.")
  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



244
245
246
 
# File 'lib/square_connect/models/order_return.rb', line 244

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



250
251
252
253
254
255
256
257
258
 
# File 'lib/square_connect/models/order_return.rb', line 250

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



238
239
240
 
# File 'lib/square_connect/models/order_return.rb', line 238

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



131
132
133
134
 
# File 'lib/square_connect/models/order_return.rb', line 131

def valid?
  return false if !@uid.nil? && @uid.to_s.length > 60
  return true
end