xero-ruby 8.0.0 → 9.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (34) hide show
  1. checksums.yaml +4 -4
  2. data/lib/xero-ruby/api/accounting_api.rb +36 -27
  3. data/lib/xero-ruby/api/payroll_nz_api.rb +330 -7
  4. data/lib/xero-ruby/models/accounting/bank_transactions.rb +23 -1
  5. data/lib/xero-ruby/models/accounting/contacts.rb +23 -1
  6. data/lib/xero-ruby/models/accounting/credit_notes.rb +23 -1
  7. data/lib/xero-ruby/models/accounting/invoices.rb +23 -1
  8. data/lib/xero-ruby/models/accounting/journals.rb +13 -1
  9. data/lib/xero-ruby/models/accounting/manual_journals.rb +23 -1
  10. data/lib/xero-ruby/models/accounting/organisation.rb +6 -2
  11. data/lib/xero-ruby/models/accounting/overpayments.rb +23 -1
  12. data/lib/xero-ruby/models/accounting/{page_info.rb → pagination.rb} +18 -19
  13. data/lib/xero-ruby/models/accounting/payments.rb +23 -1
  14. data/lib/xero-ruby/models/accounting/prepayments.rb +23 -1
  15. data/lib/xero-ruby/models/accounting/purchase_orders.rb +23 -1
  16. data/lib/xero-ruby/models/payroll_nz/employee.rb +24 -4
  17. data/lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb +24 -4
  18. data/lib/xero-ruby/models/payroll_nz/employee_leave_type.rb +14 -4
  19. data/lib/xero-ruby/models/payroll_nz/employee_working_pattern.rb +242 -0
  20. data/lib/xero-ruby/models/{accounting/get_payments_response.rb → payroll_nz/employee_working_pattern_with_working_weeks.rb} +39 -59
  21. data/lib/xero-ruby/models/payroll_nz/employee_working_pattern_with_working_weeks_object.rb +242 -0
  22. data/lib/xero-ruby/models/{accounting/get_invoices_response.rb → payroll_nz/employee_working_pattern_with_working_weeks_request.rb} +32 -62
  23. data/lib/xero-ruby/models/{accounting/get_contacts_response.rb → payroll_nz/employee_working_patterns_object.rb} +27 -57
  24. data/lib/xero-ruby/models/payroll_nz/employment.rb +24 -4
  25. data/lib/xero-ruby/models/payroll_nz/salary_and_wage.rb +28 -4
  26. data/lib/xero-ruby/models/{accounting/get_manual_journals_response.rb → payroll_nz/working_week.rb} +95 -52
  27. data/lib/xero-ruby/version.rb +2 -2
  28. data/lib/xero-ruby.rb +7 -10
  29. metadata +9 -12
  30. data/lib/xero-ruby/models/accounting/get_bank_transactions_response.rb +0 -274
  31. data/lib/xero-ruby/models/accounting/get_credit_notes_response.rb +0 -274
  32. data/lib/xero-ruby/models/accounting/get_overpayments_response.rb +0 -274
  33. data/lib/xero-ruby/models/accounting/get_prepayments_response.rb +0 -274
  34. data/lib/xero-ruby/models/accounting/get_purchase_orders_response.rb +0 -274
@@ -50,6 +50,9 @@ module XeroRuby::PayrollNz
50
50
  # Specific to Annual Leave. Annual leave balance in dollars
51
51
  attr_accessor :annual_leave_total_amount_paid
52
52
 
53
+ # The date when an employee becomes entitled to their accrual.
54
+ attr_accessor :schedule_of_accrual_date
55
+
53
56
  class EnumAttributeValidator
54
57
  attr_reader :datatype
55
58
  attr_reader :allowable_values
@@ -84,7 +87,8 @@ module XeroRuby::PayrollNz
84
87
  :'percentage_of_gross_earnings' => :'percentageOfGrossEarnings',
85
88
  :'include_holiday_pay_every_pay' => :'includeHolidayPayEveryPay',
86
89
  :'show_annual_leave_in_advance' => :'showAnnualLeaveInAdvance',
87
- :'annual_leave_total_amount_paid' => :'annualLeaveTotalAmountPaid'
90
+ :'annual_leave_total_amount_paid' => :'annualLeaveTotalAmountPaid',
91
+ :'schedule_of_accrual_date' => :'scheduleOfAccrualDate'
88
92
  }
89
93
  end
90
94
 
@@ -100,7 +104,8 @@ module XeroRuby::PayrollNz
100
104
  :'percentage_of_gross_earnings' => :'BigDecimal',
101
105
  :'include_holiday_pay_every_pay' => :'Boolean',
102
106
  :'show_annual_leave_in_advance' => :'Boolean',
103
- :'annual_leave_total_amount_paid' => :'BigDecimal'
107
+ :'annual_leave_total_amount_paid' => :'BigDecimal',
108
+ :'schedule_of_accrual_date' => :'Date'
104
109
  }
105
110
  end
106
111
 
@@ -158,6 +163,10 @@ module XeroRuby::PayrollNz
158
163
  if attributes.key?(:'annual_leave_total_amount_paid')
159
164
  self.annual_leave_total_amount_paid = attributes[:'annual_leave_total_amount_paid']
160
165
  end
166
+
167
+ if attributes.key?(:'schedule_of_accrual_date')
168
+ self.schedule_of_accrual_date = attributes[:'schedule_of_accrual_date']
169
+ end
161
170
  end
162
171
 
163
172
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -199,7 +208,8 @@ module XeroRuby::PayrollNz
199
208
  percentage_of_gross_earnings == o.percentage_of_gross_earnings &&
200
209
  include_holiday_pay_every_pay == o.include_holiday_pay_every_pay &&
201
210
  show_annual_leave_in_advance == o.show_annual_leave_in_advance &&
202
- annual_leave_total_amount_paid == o.annual_leave_total_amount_paid
211
+ annual_leave_total_amount_paid == o.annual_leave_total_amount_paid &&
212
+ schedule_of_accrual_date == o.schedule_of_accrual_date
203
213
  end
204
214
 
205
215
  # @see the `==` method
@@ -211,7 +221,7 @@ module XeroRuby::PayrollNz
211
221
  # Calculates hash code according to all attributes.
212
222
  # @return [Integer] Hash code
213
223
  def hash
214
- [leave_type_id, schedule_of_accrual, hours_accrued_annually, maximum_to_accrue, opening_balance, rate_accrued_hourly, percentage_of_gross_earnings, include_holiday_pay_every_pay, show_annual_leave_in_advance, annual_leave_total_amount_paid].hash
224
+ [leave_type_id, schedule_of_accrual, hours_accrued_annually, maximum_to_accrue, opening_balance, rate_accrued_hourly, percentage_of_gross_earnings, include_holiday_pay_every_pay, show_annual_leave_in_advance, annual_leave_total_amount_paid, schedule_of_accrual_date].hash
215
225
  end
216
226
 
217
227
  # Builds the object from hash
@@ -0,0 +1,242 @@
1
+ =begin
2
+ #Xero Payroll NZ
3
+
4
+ #This is the Xero Payroll API for orgs in the NZ region.
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::PayrollNz
16
+ require 'bigdecimal'
17
+
18
+ class EmployeeWorkingPattern
19
+ # The Xero identifier for for Employee working pattern
20
+ attr_accessor :payee_working_pattern_id
21
+
22
+ # The effective date of the corresponding salary and wages
23
+ attr_accessor :effective_from
24
+
25
+ # Attribute mapping from ruby-style variable name to JSON key.
26
+ def self.attribute_map
27
+ {
28
+ :'payee_working_pattern_id' => :'payeeWorkingPatternID',
29
+ :'effective_from' => :'effectiveFrom'
30
+ }
31
+ end
32
+
33
+ # Attribute type mapping.
34
+ def self.openapi_types
35
+ {
36
+ :'payee_working_pattern_id' => :'String',
37
+ :'effective_from' => :'Date'
38
+ }
39
+ end
40
+
41
+ # Initializes the object
42
+ # @param [Hash] attributes Model attributes in the form of hash
43
+ def initialize(attributes = {})
44
+ if (!attributes.is_a?(Hash))
45
+ fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::PayrollNz::EmployeeWorkingPattern` initialize method"
46
+ end
47
+
48
+ # check to see if the attribute exists and convert string to symbol for hash key
49
+ attributes = attributes.each_with_object({}) { |(k, v), h|
50
+ if (!self.class.attribute_map.key?(k.to_sym))
51
+ fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::PayrollNz::EmployeeWorkingPattern`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
52
+ end
53
+ h[k.to_sym] = v
54
+ }
55
+
56
+ if attributes.key?(:'payee_working_pattern_id')
57
+ self.payee_working_pattern_id = attributes[:'payee_working_pattern_id']
58
+ end
59
+
60
+ if attributes.key?(:'effective_from')
61
+ self.effective_from = attributes[:'effective_from']
62
+ end
63
+ end
64
+
65
+ # Show invalid properties with the reasons. Usually used together with valid?
66
+ # @return Array for valid properties with the reasons
67
+ def list_invalid_properties
68
+ invalid_properties = Array.new
69
+ if @payee_working_pattern_id.nil?
70
+ invalid_properties.push('invalid value for "payee_working_pattern_id", payee_working_pattern_id cannot be nil.')
71
+ end
72
+
73
+ if @effective_from.nil?
74
+ invalid_properties.push('invalid value for "effective_from", effective_from cannot be nil.')
75
+ end
76
+
77
+ invalid_properties
78
+ end
79
+
80
+ # Check to see if the all the properties in the model are valid
81
+ # @return true if the model is valid
82
+ def valid?
83
+ return false if @payee_working_pattern_id.nil?
84
+ return false if @effective_from.nil?
85
+ true
86
+ end
87
+
88
+ # Checks equality by comparing each attribute.
89
+ # @param [Object] Object to be compared
90
+ def ==(o)
91
+ return true if self.equal?(o)
92
+ self.class == o.class &&
93
+ payee_working_pattern_id == o.payee_working_pattern_id &&
94
+ effective_from == o.effective_from
95
+ end
96
+
97
+ # @see the `==` method
98
+ # @param [Object] Object to be compared
99
+ def eql?(o)
100
+ self == o
101
+ end
102
+
103
+ # Calculates hash code according to all attributes.
104
+ # @return [Integer] Hash code
105
+ def hash
106
+ [payee_working_pattern_id, effective_from].hash
107
+ end
108
+
109
+ # Builds the object from hash
110
+ # @param [Hash] attributes Model attributes in the form of hash
111
+ # @return [Object] Returns the model itself
112
+ def self.build_from_hash(attributes)
113
+ new.build_from_hash(attributes)
114
+ end
115
+
116
+ # Builds the object from hash
117
+ # @param [Hash] attributes Model attributes in the form of hash
118
+ # @return [Object] Returns the model itself
119
+ def build_from_hash(attributes)
120
+ return nil unless attributes.is_a?(Hash)
121
+ self.class.openapi_types.each_pair do |key, type|
122
+ if type =~ /\AArray<(.*)>/i
123
+ # check to ensure the input is an array given that the attribute
124
+ # is documented as an array but the input is not
125
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
126
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
127
+ end
128
+ elsif !attributes[self.class.attribute_map[key]].nil?
129
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
130
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
131
+ end
132
+
133
+ self
134
+ end
135
+
136
+ # Deserializes the data based on type
137
+ # @param string type Data type
138
+ # @param string value Value to be deserialized
139
+ # @return [Object] Deserialized data
140
+ def _deserialize(type, value)
141
+ case type.to_sym
142
+ when :DateTime
143
+ DateTime.parse(parse_date(value))
144
+ when :Date
145
+ Date.parse(parse_date(value))
146
+ when :String
147
+ value.to_s
148
+ when :Integer
149
+ value.to_i
150
+ when :Float
151
+ value.to_f
152
+ when :BigDecimal
153
+ BigDecimal(value.to_s)
154
+ when :Boolean
155
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
156
+ true
157
+ else
158
+ false
159
+ end
160
+ when :Object
161
+ # generic object (usually a Hash), return directly
162
+ value
163
+ when /\AArray<(?<inner_type>.+)>\z/
164
+ inner_type = Regexp.last_match[:inner_type]
165
+ value.map { |v| _deserialize(inner_type, v) }
166
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
167
+ k_type = Regexp.last_match[:k_type]
168
+ v_type = Regexp.last_match[:v_type]
169
+ {}.tap do |hash|
170
+ value.each do |k, v|
171
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
172
+ end
173
+ end
174
+ else # model
175
+ XeroRuby::PayrollNz.const_get(type).build_from_hash(value)
176
+ end
177
+ end
178
+
179
+ # Returns the string representation of the object
180
+ # @return [String] String presentation of the object
181
+ def to_s
182
+ to_hash.to_s
183
+ end
184
+
185
+ # to_body is an alias to to_hash (backward compatibility)
186
+ # @return [Hash] Returns the object in the form of hash
187
+ def to_body
188
+ to_hash
189
+ end
190
+
191
+ # Returns the object in the form of hash
192
+ # @return [Hash] Returns the object in the form of hash
193
+ def to_hash(downcase: false)
194
+ hash = {}
195
+ self.class.attribute_map.each_pair do |attr, param|
196
+ value = self.send(attr)
197
+ next if value.nil?
198
+ key = downcase ? attr : param
199
+ hash[key] = _to_hash(value, downcase: downcase)
200
+ end
201
+ hash
202
+ end
203
+
204
+ # Returns the object in the form of hash with snake_case
205
+ def to_attributes
206
+ to_hash(downcase: true)
207
+ end
208
+
209
+ # Outputs non-array value in the form of hash
210
+ # For object, use to_hash. Otherwise, just return the value
211
+ # @param [Object] value Any valid value
212
+ # @return [Hash] Returns the value in the form of hash
213
+ def _to_hash(value, downcase: false)
214
+ if value.is_a?(Array)
215
+ value.map do |v|
216
+ v.to_hash(downcase: downcase)
217
+ end
218
+ elsif value.is_a?(Hash)
219
+ {}.tap do |hash|
220
+ value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
221
+ end
222
+ elsif value.respond_to? :to_hash
223
+ value.to_hash(downcase: downcase)
224
+ else
225
+ value
226
+ end
227
+ end
228
+
229
+ def parse_date(datestring)
230
+ if datestring.include?('Date')
231
+ date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
232
+ original, date, timezone = *date_pattern.match(datestring)
233
+ date = (date.to_i / 1000)
234
+ Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
235
+ elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
236
+ Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s
237
+ else # handle date 'types' for small subset of payroll API's
238
+ Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
239
+ end
240
+ end
241
+ end
242
+ end
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #Xero Accounting API
2
+ #Xero Payroll NZ
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #This is the Xero Payroll API for orgs in the NZ region.
5
5
 
6
6
  Contact: api@xero.com
7
7
  Generated by: https://openapi-generator.tech
@@ -12,49 +12,34 @@ OpenAPI Generator version: 4.3.1
12
12
  require 'time'
13
13
  require 'date'
14
14
 
15
- module XeroRuby::Accounting
15
+ module XeroRuby::PayrollNz
16
16
  require 'bigdecimal'
17
17
 
18
- class GetPaymentsResponse
19
-
20
- attr_accessor :id
18
+ class EmployeeWorkingPatternWithWorkingWeeks
19
+ # The Xero identifier for for Employee working pattern
20
+ attr_accessor :payee_working_pattern_id
21
21
 
22
-
23
- attr_accessor :status
22
+ # The effective date of the corresponding salary and wages
23
+ attr_accessor :effective_from
24
24
 
25
25
 
26
- attr_accessor :provider_name
27
-
28
-
29
- attr_accessor :date_time_utc
30
-
31
-
32
- attr_accessor :page_info
33
-
34
-
35
- attr_accessor :payments
26
+ attr_accessor :working_weeks
36
27
 
37
28
  # Attribute mapping from ruby-style variable name to JSON key.
38
29
  def self.attribute_map
39
30
  {
40
- :'id' => :'Id',
41
- :'status' => :'Status',
42
- :'provider_name' => :'ProviderName',
43
- :'date_time_utc' => :'DateTimeUTC',
44
- :'page_info' => :'PageInfo',
45
- :'payments' => :'Payments'
31
+ :'payee_working_pattern_id' => :'payeeWorkingPatternID',
32
+ :'effective_from' => :'effectiveFrom',
33
+ :'working_weeks' => :'workingWeeks'
46
34
  }
47
35
  end
48
36
 
49
37
  # Attribute type mapping.
50
38
  def self.openapi_types
51
39
  {
52
- :'id' => :'String',
53
- :'status' => :'String',
54
- :'provider_name' => :'String',
55
- :'date_time_utc' => :'String',
56
- :'page_info' => :'PageInfo',
57
- :'payments' => :'Array<Payment>'
40
+ :'payee_working_pattern_id' => :'String',
41
+ :'effective_from' => :'Date',
42
+ :'working_weeks' => :'Array<WorkingWeek>'
58
43
  }
59
44
  end
60
45
 
@@ -62,40 +47,28 @@ module XeroRuby::Accounting
62
47
  # @param [Hash] attributes Model attributes in the form of hash
63
48
  def initialize(attributes = {})
64
49
  if (!attributes.is_a?(Hash))
65
- fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::GetPaymentsResponse` initialize method"
50
+ fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::PayrollNz::EmployeeWorkingPatternWithWorkingWeeks` initialize method"
66
51
  end
67
52
 
68
53
  # check to see if the attribute exists and convert string to symbol for hash key
69
54
  attributes = attributes.each_with_object({}) { |(k, v), h|
70
55
  if (!self.class.attribute_map.key?(k.to_sym))
71
- fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::Accounting::GetPaymentsResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
56
+ fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::PayrollNz::EmployeeWorkingPatternWithWorkingWeeks`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
72
57
  end
73
58
  h[k.to_sym] = v
74
59
  }
75
60
 
76
- if attributes.key?(:'id')
77
- self.id = attributes[:'id']
78
- end
79
-
80
- if attributes.key?(:'status')
81
- self.status = attributes[:'status']
82
- end
83
-
84
- if attributes.key?(:'provider_name')
85
- self.provider_name = attributes[:'provider_name']
86
- end
87
-
88
- if attributes.key?(:'date_time_utc')
89
- self.date_time_utc = attributes[:'date_time_utc']
61
+ if attributes.key?(:'payee_working_pattern_id')
62
+ self.payee_working_pattern_id = attributes[:'payee_working_pattern_id']
90
63
  end
91
64
 
92
- if attributes.key?(:'page_info')
93
- self.page_info = attributes[:'page_info']
65
+ if attributes.key?(:'effective_from')
66
+ self.effective_from = attributes[:'effective_from']
94
67
  end
95
68
 
96
- if attributes.key?(:'payments')
97
- if (value = attributes[:'payments']).is_a?(Array)
98
- self.payments = value
69
+ if attributes.key?(:'working_weeks')
70
+ if (value = attributes[:'working_weeks']).is_a?(Array)
71
+ self.working_weeks = value
99
72
  end
100
73
  end
101
74
  end
@@ -104,12 +77,22 @@ module XeroRuby::Accounting
104
77
  # @return Array for valid properties with the reasons
105
78
  def list_invalid_properties
106
79
  invalid_properties = Array.new
80
+ if @payee_working_pattern_id.nil?
81
+ invalid_properties.push('invalid value for "payee_working_pattern_id", payee_working_pattern_id cannot be nil.')
82
+ end
83
+
84
+ if @effective_from.nil?
85
+ invalid_properties.push('invalid value for "effective_from", effective_from cannot be nil.')
86
+ end
87
+
107
88
  invalid_properties
108
89
  end
109
90
 
110
91
  # Check to see if the all the properties in the model are valid
111
92
  # @return true if the model is valid
112
93
  def valid?
94
+ return false if @payee_working_pattern_id.nil?
95
+ return false if @effective_from.nil?
113
96
  true
114
97
  end
115
98
 
@@ -118,12 +101,9 @@ module XeroRuby::Accounting
118
101
  def ==(o)
119
102
  return true if self.equal?(o)
120
103
  self.class == o.class &&
121
- id == o.id &&
122
- status == o.status &&
123
- provider_name == o.provider_name &&
124
- date_time_utc == o.date_time_utc &&
125
- page_info == o.page_info &&
126
- payments == o.payments
104
+ payee_working_pattern_id == o.payee_working_pattern_id &&
105
+ effective_from == o.effective_from &&
106
+ working_weeks == o.working_weeks
127
107
  end
128
108
 
129
109
  # @see the `==` method
@@ -135,7 +115,7 @@ module XeroRuby::Accounting
135
115
  # Calculates hash code according to all attributes.
136
116
  # @return [Integer] Hash code
137
117
  def hash
138
- [id, status, provider_name, date_time_utc, page_info, payments].hash
118
+ [payee_working_pattern_id, effective_from, working_weeks].hash
139
119
  end
140
120
 
141
121
  # Builds the object from hash
@@ -204,7 +184,7 @@ module XeroRuby::Accounting
204
184
  end
205
185
  end
206
186
  else # model
207
- XeroRuby::Accounting.const_get(type).build_from_hash(value)
187
+ XeroRuby::PayrollNz.const_get(type).build_from_hash(value)
208
188
  end
209
189
  end
210
190