xero-ruby 3.6.0 → 3.7.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,254 @@
1
+ =begin
2
+ #Xero Finance API
3
+
4
+ #The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
5
+
6
+ Contact: api@xero.com
7
+ Generated by: https://openapi-generator.tech
8
+ OpenAPI Generator version: 4.3.1
9
+
10
+ =end
11
+
12
+ require 'time'
13
+ require 'date'
14
+
15
+ module XeroRuby::Finance
16
+ require 'bigdecimal'
17
+
18
+ class OverpaymentResponse
19
+ # Xero Identifier of overpayment
20
+ attr_accessor :overpayment_id
21
+
22
+
23
+ attr_accessor :contact
24
+
25
+ # Total of Invoice tax inclusive (i.e. SubTotal + TotalTax); Not included in summary mode
26
+ attr_accessor :total
27
+
28
+ # Not included in summary mode
29
+ attr_accessor :line_items
30
+
31
+ # Attribute mapping from ruby-style variable name to JSON key.
32
+ def self.attribute_map
33
+ {
34
+ :'overpayment_id' => :'overpaymentId',
35
+ :'contact' => :'contact',
36
+ :'total' => :'total',
37
+ :'line_items' => :'lineItems'
38
+ }
39
+ end
40
+
41
+ # Attribute type mapping.
42
+ def self.openapi_types
43
+ {
44
+ :'overpayment_id' => :'String',
45
+ :'contact' => :'ContactResponse',
46
+ :'total' => :'BigDecimal',
47
+ :'line_items' => :'Array<LineItemResponse>'
48
+ }
49
+ end
50
+
51
+ # Initializes the object
52
+ # @param [Hash] attributes Model attributes in the form of hash
53
+ def initialize(attributes = {})
54
+ if (!attributes.is_a?(Hash))
55
+ fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Finance::OverpaymentResponse` initialize method"
56
+ end
57
+
58
+ # check to see if the attribute exists and convert string to symbol for hash key
59
+ attributes = attributes.each_with_object({}) { |(k, v), h|
60
+ if (!self.class.attribute_map.key?(k.to_sym))
61
+ fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::Finance::OverpaymentResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
62
+ end
63
+ h[k.to_sym] = v
64
+ }
65
+
66
+ if attributes.key?(:'overpayment_id')
67
+ self.overpayment_id = attributes[:'overpayment_id']
68
+ end
69
+
70
+ if attributes.key?(:'contact')
71
+ self.contact = attributes[:'contact']
72
+ end
73
+
74
+ if attributes.key?(:'total')
75
+ self.total = attributes[:'total']
76
+ end
77
+
78
+ if attributes.key?(:'line_items')
79
+ if (value = attributes[:'line_items']).is_a?(Array)
80
+ self.line_items = value
81
+ end
82
+ end
83
+ end
84
+
85
+ # Show invalid properties with the reasons. Usually used together with valid?
86
+ # @return Array for valid properties with the reasons
87
+ def list_invalid_properties
88
+ invalid_properties = Array.new
89
+ invalid_properties
90
+ end
91
+
92
+ # Check to see if the all the properties in the model are valid
93
+ # @return true if the model is valid
94
+ def valid?
95
+ true
96
+ end
97
+
98
+ # Checks equality by comparing each attribute.
99
+ # @param [Object] Object to be compared
100
+ def ==(o)
101
+ return true if self.equal?(o)
102
+ self.class == o.class &&
103
+ overpayment_id == o.overpayment_id &&
104
+ contact == o.contact &&
105
+ total == o.total &&
106
+ line_items == o.line_items
107
+ end
108
+
109
+ # @see the `==` method
110
+ # @param [Object] Object to be compared
111
+ def eql?(o)
112
+ self == o
113
+ end
114
+
115
+ # Calculates hash code according to all attributes.
116
+ # @return [Integer] Hash code
117
+ def hash
118
+ [overpayment_id, contact, total, line_items].hash
119
+ end
120
+
121
+ # Builds the object from hash
122
+ # @param [Hash] attributes Model attributes in the form of hash
123
+ # @return [Object] Returns the model itself
124
+ def self.build_from_hash(attributes)
125
+ new.build_from_hash(attributes)
126
+ end
127
+
128
+ # Builds the object from hash
129
+ # @param [Hash] attributes Model attributes in the form of hash
130
+ # @return [Object] Returns the model itself
131
+ def build_from_hash(attributes)
132
+ return nil unless attributes.is_a?(Hash)
133
+ self.class.openapi_types.each_pair do |key, type|
134
+ if type =~ /\AArray<(.*)>/i
135
+ # check to ensure the input is an array given that the attribute
136
+ # is documented as an array but the input is not
137
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
138
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
139
+ end
140
+ elsif !attributes[self.class.attribute_map[key]].nil?
141
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
142
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
143
+ end
144
+
145
+ self
146
+ end
147
+
148
+ # Deserializes the data based on type
149
+ # @param string type Data type
150
+ # @param string value Value to be deserialized
151
+ # @return [Object] Deserialized data
152
+ def _deserialize(type, value)
153
+ case type.to_sym
154
+ when :DateTime
155
+ DateTime.parse(parse_date(value))
156
+ when :Date
157
+ Date.parse(parse_date(value))
158
+ when :String
159
+ value.to_s
160
+ when :Integer
161
+ value.to_i
162
+ when :Float
163
+ value.to_f
164
+ when :BigDecimal
165
+ BigDecimal(value.to_s)
166
+ when :Boolean
167
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
168
+ true
169
+ else
170
+ false
171
+ end
172
+ when :Object
173
+ # generic object (usually a Hash), return directly
174
+ value
175
+ when /\AArray<(?<inner_type>.+)>\z/
176
+ inner_type = Regexp.last_match[:inner_type]
177
+ value.map { |v| _deserialize(inner_type, v) }
178
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
179
+ k_type = Regexp.last_match[:k_type]
180
+ v_type = Regexp.last_match[:v_type]
181
+ {}.tap do |hash|
182
+ value.each do |k, v|
183
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
184
+ end
185
+ end
186
+ else # model
187
+ XeroRuby::Finance.const_get(type).build_from_hash(value)
188
+ end
189
+ end
190
+
191
+ # Returns the string representation of the object
192
+ # @return [String] String presentation of the object
193
+ def to_s
194
+ to_hash.to_s
195
+ end
196
+
197
+ # to_body is an alias to to_hash (backward compatibility)
198
+ # @return [Hash] Returns the object in the form of hash
199
+ def to_body
200
+ to_hash
201
+ end
202
+
203
+ # Returns the object in the form of hash
204
+ # @return [Hash] Returns the object in the form of hash
205
+ def to_hash(downcase: false)
206
+ hash = {}
207
+ self.class.attribute_map.each_pair do |attr, param|
208
+ value = self.send(attr)
209
+ next if value.nil?
210
+ key = downcase ? attr : param
211
+ hash[key] = _to_hash(value, downcase: downcase)
212
+ end
213
+ hash
214
+ end
215
+
216
+ # Returns the object in the form of hash with snake_case
217
+ def to_attributes
218
+ to_hash(downcase: true)
219
+ end
220
+
221
+ # Outputs non-array value in the form of hash
222
+ # For object, use to_hash. Otherwise, just return the value
223
+ # @param [Object] value Any valid value
224
+ # @return [Hash] Returns the value in the form of hash
225
+ def _to_hash(value, downcase: false)
226
+ if value.is_a?(Array)
227
+ value.map do |v|
228
+ v.to_hash(downcase: downcase)
229
+ end
230
+ elsif value.is_a?(Hash)
231
+ {}.tap do |hash|
232
+ value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
233
+ end
234
+ elsif value.respond_to? :to_hash
235
+ value.to_hash(downcase: downcase)
236
+ else
237
+ value
238
+ end
239
+ end
240
+
241
+ def parse_date(datestring)
242
+ if datestring.include?('Date')
243
+ date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
244
+ original, date, timezone = *date_pattern.match(datestring)
245
+ date = (date.to_i / 1000)
246
+ Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
247
+ elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
248
+ Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s
249
+ else # handle date 'types' for small subset of payroll API's
250
+ Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
251
+ end
252
+ end
253
+ end
254
+ end
@@ -0,0 +1,312 @@
1
+ =begin
2
+ #Xero Finance API
3
+
4
+ #The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
5
+
6
+ Contact: api@xero.com
7
+ Generated by: https://openapi-generator.tech
8
+ OpenAPI Generator version: 4.3.1
9
+
10
+ =end
11
+
12
+ require 'time'
13
+ require 'date'
14
+
15
+ module XeroRuby::Finance
16
+ require 'bigdecimal'
17
+
18
+ class PaymentResponse
19
+ # Xero Identifier of payment
20
+ attr_accessor :payment_id
21
+
22
+ # Xero Identifier of batch payment. Present if the payment was created as part of a batch.
23
+ attr_accessor :batch_payment_id
24
+
25
+ # Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06
26
+ attr_accessor :date
27
+
28
+ # The amount of the payment
29
+ attr_accessor :amount
30
+
31
+ # The bank amount of the payment
32
+ attr_accessor :bank_amount
33
+
34
+ # Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500
35
+ attr_accessor :currency_rate
36
+
37
+
38
+ attr_accessor :invoice
39
+
40
+
41
+ attr_accessor :credit_note
42
+
43
+
44
+ attr_accessor :prepayment
45
+
46
+
47
+ attr_accessor :overpayment
48
+
49
+ # Attribute mapping from ruby-style variable name to JSON key.
50
+ def self.attribute_map
51
+ {
52
+ :'payment_id' => :'paymentId',
53
+ :'batch_payment_id' => :'batchPaymentId',
54
+ :'date' => :'date',
55
+ :'amount' => :'amount',
56
+ :'bank_amount' => :'bankAmount',
57
+ :'currency_rate' => :'currencyRate',
58
+ :'invoice' => :'invoice',
59
+ :'credit_note' => :'creditNote',
60
+ :'prepayment' => :'prepayment',
61
+ :'overpayment' => :'overpayment'
62
+ }
63
+ end
64
+
65
+ # Attribute type mapping.
66
+ def self.openapi_types
67
+ {
68
+ :'payment_id' => :'String',
69
+ :'batch_payment_id' => :'String',
70
+ :'date' => :'DateTime',
71
+ :'amount' => :'BigDecimal',
72
+ :'bank_amount' => :'BigDecimal',
73
+ :'currency_rate' => :'Float',
74
+ :'invoice' => :'InvoiceResponse',
75
+ :'credit_note' => :'CreditNoteResponse',
76
+ :'prepayment' => :'PrepaymentResponse',
77
+ :'overpayment' => :'OverpaymentResponse'
78
+ }
79
+ end
80
+
81
+ # Initializes the object
82
+ # @param [Hash] attributes Model attributes in the form of hash
83
+ def initialize(attributes = {})
84
+ if (!attributes.is_a?(Hash))
85
+ fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Finance::PaymentResponse` initialize method"
86
+ end
87
+
88
+ # check to see if the attribute exists and convert string to symbol for hash key
89
+ attributes = attributes.each_with_object({}) { |(k, v), h|
90
+ if (!self.class.attribute_map.key?(k.to_sym))
91
+ fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::Finance::PaymentResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
92
+ end
93
+ h[k.to_sym] = v
94
+ }
95
+
96
+ if attributes.key?(:'payment_id')
97
+ self.payment_id = attributes[:'payment_id']
98
+ end
99
+
100
+ if attributes.key?(:'batch_payment_id')
101
+ self.batch_payment_id = attributes[:'batch_payment_id']
102
+ end
103
+
104
+ if attributes.key?(:'date')
105
+ self.date = attributes[:'date']
106
+ end
107
+
108
+ if attributes.key?(:'amount')
109
+ self.amount = attributes[:'amount']
110
+ end
111
+
112
+ if attributes.key?(:'bank_amount')
113
+ self.bank_amount = attributes[:'bank_amount']
114
+ end
115
+
116
+ if attributes.key?(:'currency_rate')
117
+ self.currency_rate = attributes[:'currency_rate']
118
+ end
119
+
120
+ if attributes.key?(:'invoice')
121
+ self.invoice = attributes[:'invoice']
122
+ end
123
+
124
+ if attributes.key?(:'credit_note')
125
+ self.credit_note = attributes[:'credit_note']
126
+ end
127
+
128
+ if attributes.key?(:'prepayment')
129
+ self.prepayment = attributes[:'prepayment']
130
+ end
131
+
132
+ if attributes.key?(:'overpayment')
133
+ self.overpayment = attributes[:'overpayment']
134
+ end
135
+ end
136
+
137
+ # Show invalid properties with the reasons. Usually used together with valid?
138
+ # @return Array for valid properties with the reasons
139
+ def list_invalid_properties
140
+ invalid_properties = Array.new
141
+ invalid_properties
142
+ end
143
+
144
+ # Check to see if the all the properties in the model are valid
145
+ # @return true if the model is valid
146
+ def valid?
147
+ true
148
+ end
149
+
150
+ # Checks equality by comparing each attribute.
151
+ # @param [Object] Object to be compared
152
+ def ==(o)
153
+ return true if self.equal?(o)
154
+ self.class == o.class &&
155
+ payment_id == o.payment_id &&
156
+ batch_payment_id == o.batch_payment_id &&
157
+ date == o.date &&
158
+ amount == o.amount &&
159
+ bank_amount == o.bank_amount &&
160
+ currency_rate == o.currency_rate &&
161
+ invoice == o.invoice &&
162
+ credit_note == o.credit_note &&
163
+ prepayment == o.prepayment &&
164
+ overpayment == o.overpayment
165
+ end
166
+
167
+ # @see the `==` method
168
+ # @param [Object] Object to be compared
169
+ def eql?(o)
170
+ self == o
171
+ end
172
+
173
+ # Calculates hash code according to all attributes.
174
+ # @return [Integer] Hash code
175
+ def hash
176
+ [payment_id, batch_payment_id, date, amount, bank_amount, currency_rate, invoice, credit_note, prepayment, overpayment].hash
177
+ end
178
+
179
+ # Builds the object from hash
180
+ # @param [Hash] attributes Model attributes in the form of hash
181
+ # @return [Object] Returns the model itself
182
+ def self.build_from_hash(attributes)
183
+ new.build_from_hash(attributes)
184
+ end
185
+
186
+ # Builds the object from hash
187
+ # @param [Hash] attributes Model attributes in the form of hash
188
+ # @return [Object] Returns the model itself
189
+ def build_from_hash(attributes)
190
+ return nil unless attributes.is_a?(Hash)
191
+ self.class.openapi_types.each_pair do |key, type|
192
+ if type =~ /\AArray<(.*)>/i
193
+ # check to ensure the input is an array given that the attribute
194
+ # is documented as an array but the input is not
195
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
196
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
197
+ end
198
+ elsif !attributes[self.class.attribute_map[key]].nil?
199
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
200
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
201
+ end
202
+
203
+ self
204
+ end
205
+
206
+ # Deserializes the data based on type
207
+ # @param string type Data type
208
+ # @param string value Value to be deserialized
209
+ # @return [Object] Deserialized data
210
+ def _deserialize(type, value)
211
+ case type.to_sym
212
+ when :DateTime
213
+ DateTime.parse(parse_date(value))
214
+ when :Date
215
+ Date.parse(parse_date(value))
216
+ when :String
217
+ value.to_s
218
+ when :Integer
219
+ value.to_i
220
+ when :Float
221
+ value.to_f
222
+ when :BigDecimal
223
+ BigDecimal(value.to_s)
224
+ when :Boolean
225
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
226
+ true
227
+ else
228
+ false
229
+ end
230
+ when :Object
231
+ # generic object (usually a Hash), return directly
232
+ value
233
+ when /\AArray<(?<inner_type>.+)>\z/
234
+ inner_type = Regexp.last_match[:inner_type]
235
+ value.map { |v| _deserialize(inner_type, v) }
236
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
237
+ k_type = Regexp.last_match[:k_type]
238
+ v_type = Regexp.last_match[:v_type]
239
+ {}.tap do |hash|
240
+ value.each do |k, v|
241
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
242
+ end
243
+ end
244
+ else # model
245
+ XeroRuby::Finance.const_get(type).build_from_hash(value)
246
+ end
247
+ end
248
+
249
+ # Returns the string representation of the object
250
+ # @return [String] String presentation of the object
251
+ def to_s
252
+ to_hash.to_s
253
+ end
254
+
255
+ # to_body is an alias to to_hash (backward compatibility)
256
+ # @return [Hash] Returns the object in the form of hash
257
+ def to_body
258
+ to_hash
259
+ end
260
+
261
+ # Returns the object in the form of hash
262
+ # @return [Hash] Returns the object in the form of hash
263
+ def to_hash(downcase: false)
264
+ hash = {}
265
+ self.class.attribute_map.each_pair do |attr, param|
266
+ value = self.send(attr)
267
+ next if value.nil?
268
+ key = downcase ? attr : param
269
+ hash[key] = _to_hash(value, downcase: downcase)
270
+ end
271
+ hash
272
+ end
273
+
274
+ # Returns the object in the form of hash with snake_case
275
+ def to_attributes
276
+ to_hash(downcase: true)
277
+ end
278
+
279
+ # Outputs non-array value in the form of hash
280
+ # For object, use to_hash. Otherwise, just return the value
281
+ # @param [Object] value Any valid value
282
+ # @return [Hash] Returns the value in the form of hash
283
+ def _to_hash(value, downcase: false)
284
+ if value.is_a?(Array)
285
+ value.map do |v|
286
+ v.to_hash(downcase: downcase)
287
+ end
288
+ elsif value.is_a?(Hash)
289
+ {}.tap do |hash|
290
+ value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
291
+ end
292
+ elsif value.respond_to? :to_hash
293
+ value.to_hash(downcase: downcase)
294
+ else
295
+ value
296
+ end
297
+ end
298
+
299
+ def parse_date(datestring)
300
+ if datestring.include?('Date')
301
+ date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
302
+ original, date, timezone = *date_pattern.match(datestring)
303
+ date = (date.to_i / 1000)
304
+ Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
305
+ elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
306
+ Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s
307
+ else # handle date 'types' for small subset of payroll API's
308
+ Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
309
+ end
310
+ end
311
+ end
312
+ end