xero-ruby 2.4.1 → 3.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (460) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +240 -189
  3. data/lib/xero-ruby.rb +10 -4
  4. data/lib/xero-ruby/api/accounting_api.rb +1308 -920
  5. data/lib/xero-ruby/api/asset_api.rb +15 -14
  6. data/lib/xero-ruby/api/files_api.rb +204 -85
  7. data/lib/xero-ruby/api/payroll_au_api.rb +121 -93
  8. data/lib/xero-ruby/api/payroll_nz_api.rb +307 -240
  9. data/lib/xero-ruby/api/payroll_uk_api.rb +317 -254
  10. data/lib/xero-ruby/api/project_api.rb +71 -59
  11. data/lib/xero-ruby/api_client.rb +182 -128
  12. data/lib/xero-ruby/api_error.rb +4 -4
  13. data/lib/xero-ruby/configuration.rb +17 -5
  14. data/lib/xero-ruby/models/accounting/account.rb +25 -12
  15. data/lib/xero-ruby/models/accounting/account_type.rb +1 -2
  16. data/lib/xero-ruby/models/accounting/accounts.rb +25 -11
  17. data/lib/xero-ruby/models/accounting/accounts_payable.rb +25 -11
  18. data/lib/xero-ruby/models/accounting/accounts_receivable.rb +25 -11
  19. data/lib/xero-ruby/models/accounting/action.rb +25 -11
  20. data/lib/xero-ruby/models/accounting/actions.rb +25 -11
  21. data/lib/xero-ruby/models/accounting/address.rb +27 -14
  22. data/lib/xero-ruby/models/accounting/address_for_organisation.rb +484 -0
  23. data/lib/xero-ruby/models/accounting/allocation.rb +25 -11
  24. data/lib/xero-ruby/models/accounting/allocations.rb +25 -11
  25. data/lib/xero-ruby/models/accounting/attachment.rb +25 -11
  26. data/lib/xero-ruby/models/accounting/attachments.rb +25 -11
  27. data/lib/xero-ruby/models/accounting/balance_details.rb +25 -11
  28. data/lib/xero-ruby/models/accounting/balances.rb +25 -11
  29. data/lib/xero-ruby/models/accounting/bank_transaction.rb +25 -11
  30. data/lib/xero-ruby/models/accounting/bank_transactions.rb +25 -11
  31. data/lib/xero-ruby/models/accounting/bank_transfer.rb +25 -11
  32. data/lib/xero-ruby/models/accounting/bank_transfers.rb +25 -11
  33. data/lib/xero-ruby/models/accounting/batch_payment.rb +41 -15
  34. data/lib/xero-ruby/models/accounting/batch_payment_details.rb +25 -11
  35. data/lib/xero-ruby/models/accounting/batch_payments.rb +25 -11
  36. data/lib/xero-ruby/models/accounting/bill.rb +25 -11
  37. data/lib/xero-ruby/models/accounting/branding_theme.rb +25 -11
  38. data/lib/xero-ruby/models/accounting/branding_themes.rb +25 -11
  39. data/lib/xero-ruby/models/accounting/budget.rb +327 -0
  40. data/lib/xero-ruby/models/accounting/budget_balance.rb +267 -0
  41. data/lib/xero-ruby/models/accounting/budget_line.rb +244 -0
  42. data/lib/xero-ruby/models/{files/file_response204.rb → accounting/budgets.rb} +40 -24
  43. data/lib/xero-ruby/models/accounting/cis_org_setting.rb +26 -12
  44. data/lib/xero-ruby/models/accounting/cis_org_settings.rb +224 -0
  45. data/lib/xero-ruby/models/accounting/cis_setting.rb +26 -12
  46. data/lib/xero-ruby/models/accounting/cis_settings.rb +25 -11
  47. data/lib/xero-ruby/models/accounting/contact.rb +25 -11
  48. data/lib/xero-ruby/models/accounting/contact_group.rb +25 -11
  49. data/lib/xero-ruby/models/accounting/contact_groups.rb +25 -11
  50. data/lib/xero-ruby/models/accounting/contact_person.rb +25 -11
  51. data/lib/xero-ruby/models/accounting/contacts.rb +25 -11
  52. data/lib/xero-ruby/models/accounting/conversion_balances.rb +25 -11
  53. data/lib/xero-ruby/models/accounting/conversion_date.rb +25 -11
  54. data/lib/xero-ruby/models/accounting/country_code.rb +1 -2
  55. data/lib/xero-ruby/models/accounting/credit_note.rb +62 -16
  56. data/lib/xero-ruby/models/accounting/credit_notes.rb +25 -11
  57. data/lib/xero-ruby/models/accounting/currencies.rb +25 -11
  58. data/lib/xero-ruby/models/accounting/currency.rb +25 -11
  59. data/lib/xero-ruby/models/accounting/currency_code.rb +1 -2
  60. data/lib/xero-ruby/models/accounting/element.rb +25 -11
  61. data/lib/xero-ruby/models/accounting/employee.rb +25 -11
  62. data/lib/xero-ruby/models/accounting/employees.rb +25 -11
  63. data/lib/xero-ruby/models/accounting/error.rb +25 -11
  64. data/lib/xero-ruby/models/accounting/expense_claim.rb +25 -11
  65. data/lib/xero-ruby/models/accounting/expense_claims.rb +25 -11
  66. data/lib/xero-ruby/models/accounting/external_link.rb +25 -11
  67. data/lib/xero-ruby/models/accounting/history_record.rb +25 -11
  68. data/lib/xero-ruby/models/accounting/history_records.rb +25 -11
  69. data/lib/xero-ruby/models/accounting/import_summary.rb +25 -11
  70. data/lib/xero-ruby/models/accounting/import_summary_accounts.rb +33 -19
  71. data/lib/xero-ruby/models/accounting/import_summary_object.rb +25 -11
  72. data/lib/xero-ruby/models/accounting/import_summary_organisation.rb +25 -11
  73. data/lib/xero-ruby/models/accounting/invoice.rb +37 -28
  74. data/lib/xero-ruby/models/accounting/invoice_reminder.rb +25 -11
  75. data/lib/xero-ruby/models/accounting/invoice_reminders.rb +25 -11
  76. data/lib/xero-ruby/models/accounting/invoices.rb +25 -11
  77. data/lib/xero-ruby/models/accounting/item.rb +25 -11
  78. data/lib/xero-ruby/models/accounting/items.rb +25 -11
  79. data/lib/xero-ruby/models/accounting/journal.rb +25 -11
  80. data/lib/xero-ruby/models/accounting/journal_line.rb +25 -11
  81. data/lib/xero-ruby/models/accounting/journals.rb +25 -11
  82. data/lib/xero-ruby/models/accounting/line_amount_types.rb +1 -2
  83. data/lib/xero-ruby/models/accounting/line_item.rb +36 -12
  84. data/lib/xero-ruby/models/accounting/line_item_tracking.rb +25 -11
  85. data/lib/xero-ruby/models/accounting/linked_transaction.rb +25 -11
  86. data/lib/xero-ruby/models/accounting/linked_transactions.rb +25 -11
  87. data/lib/xero-ruby/models/accounting/manual_journal.rb +25 -11
  88. data/lib/xero-ruby/models/accounting/manual_journal_line.rb +25 -11
  89. data/lib/xero-ruby/models/accounting/manual_journals.rb +25 -11
  90. data/lib/xero-ruby/models/accounting/online_invoice.rb +25 -11
  91. data/lib/xero-ruby/models/accounting/online_invoices.rb +25 -11
  92. data/lib/xero-ruby/models/accounting/organisation.rb +26 -14
  93. data/lib/xero-ruby/models/accounting/organisations.rb +25 -11
  94. data/lib/xero-ruby/models/accounting/overpayment.rb +25 -11
  95. data/lib/xero-ruby/models/accounting/overpayments.rb +25 -11
  96. data/lib/xero-ruby/models/accounting/payment.rb +36 -12
  97. data/lib/xero-ruby/models/accounting/payment_delete.rb +25 -11
  98. data/lib/xero-ruby/models/accounting/payment_service.rb +25 -11
  99. data/lib/xero-ruby/models/accounting/payment_services.rb +25 -11
  100. data/lib/xero-ruby/models/accounting/payment_term.rb +25 -11
  101. data/lib/xero-ruby/models/accounting/payment_term_type.rb +1 -2
  102. data/lib/xero-ruby/models/accounting/payments.rb +25 -11
  103. data/lib/xero-ruby/models/accounting/phone.rb +25 -11
  104. data/lib/xero-ruby/models/accounting/prepayment.rb +38 -12
  105. data/lib/xero-ruby/models/accounting/prepayments.rb +25 -11
  106. data/lib/xero-ruby/models/accounting/purchase.rb +25 -11
  107. data/lib/xero-ruby/models/accounting/purchase_order.rb +25 -11
  108. data/lib/xero-ruby/models/accounting/purchase_orders.rb +25 -11
  109. data/lib/xero-ruby/models/accounting/quote.rb +25 -11
  110. data/lib/xero-ruby/models/accounting/quote_line_amount_types.rb +1 -2
  111. data/lib/xero-ruby/models/accounting/quote_status_codes.rb +1 -2
  112. data/lib/xero-ruby/models/accounting/quotes.rb +25 -11
  113. data/lib/xero-ruby/models/accounting/receipt.rb +25 -11
  114. data/lib/xero-ruby/models/accounting/receipts.rb +25 -11
  115. data/lib/xero-ruby/models/accounting/repeating_invoice.rb +25 -11
  116. data/lib/xero-ruby/models/accounting/repeating_invoices.rb +25 -11
  117. data/lib/xero-ruby/models/accounting/report.rb +26 -22
  118. data/lib/xero-ruby/models/accounting/report_attribute.rb +25 -11
  119. data/lib/xero-ruby/models/accounting/report_cell.rb +25 -11
  120. data/lib/xero-ruby/models/accounting/report_fields.rb +25 -11
  121. data/lib/xero-ruby/models/accounting/report_row.rb +25 -11
  122. data/lib/xero-ruby/models/accounting/report_rows.rb +25 -11
  123. data/lib/xero-ruby/models/accounting/report_with_row.rb +26 -12
  124. data/lib/xero-ruby/models/accounting/report_with_rows.rb +25 -11
  125. data/lib/xero-ruby/models/accounting/reports.rb +25 -11
  126. data/lib/xero-ruby/models/accounting/request_empty.rb +25 -11
  127. data/lib/xero-ruby/models/accounting/row_type.rb +1 -2
  128. data/lib/xero-ruby/models/accounting/sales_tracking_category.rb +25 -11
  129. data/lib/xero-ruby/models/accounting/schedule.rb +25 -11
  130. data/lib/xero-ruby/models/accounting/setup.rb +25 -11
  131. data/lib/xero-ruby/models/accounting/tax_component.rb +25 -11
  132. data/lib/xero-ruby/models/accounting/tax_rate.rb +25 -11
  133. data/lib/xero-ruby/models/accounting/tax_rates.rb +25 -11
  134. data/lib/xero-ruby/models/accounting/tax_type.rb +1 -2
  135. data/lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb +25 -11
  136. data/lib/xero-ruby/models/accounting/time_zone.rb +1 -2
  137. data/lib/xero-ruby/models/accounting/tracking_categories.rb +25 -11
  138. data/lib/xero-ruby/models/accounting/tracking_category.rb +25 -11
  139. data/lib/xero-ruby/models/accounting/tracking_option.rb +25 -11
  140. data/lib/xero-ruby/models/accounting/tracking_options.rb +25 -11
  141. data/lib/xero-ruby/models/accounting/user.rb +25 -11
  142. data/lib/xero-ruby/models/accounting/users.rb +25 -11
  143. data/lib/xero-ruby/models/accounting/validation_error.rb +25 -11
  144. data/lib/xero-ruby/models/assets/asset.rb +25 -11
  145. data/lib/xero-ruby/models/assets/asset_status.rb +1 -2
  146. data/lib/xero-ruby/models/assets/asset_status_query_param.rb +1 -2
  147. data/lib/xero-ruby/models/assets/asset_type.rb +25 -11
  148. data/lib/xero-ruby/models/assets/assets.rb +25 -11
  149. data/lib/xero-ruby/models/assets/book_depreciation_detail.rb +25 -11
  150. data/lib/xero-ruby/models/assets/book_depreciation_setting.rb +25 -11
  151. data/lib/xero-ruby/models/assets/error.rb +25 -11
  152. data/lib/xero-ruby/models/assets/field_validation_errors_element.rb +26 -12
  153. data/lib/xero-ruby/models/assets/pagination.rb +25 -11
  154. data/lib/xero-ruby/models/assets/resource_validation_errors_element.rb +26 -12
  155. data/lib/xero-ruby/models/assets/setting.rb +25 -11
  156. data/lib/xero-ruby/models/files/association.rb +25 -11
  157. data/lib/xero-ruby/models/files/file_object.rb +25 -11
  158. data/lib/xero-ruby/models/files/files.rb +25 -11
  159. data/lib/xero-ruby/models/files/folder.rb +25 -11
  160. data/lib/xero-ruby/models/files/folders.rb +25 -11
  161. data/lib/xero-ruby/models/files/object_group.rb +1 -2
  162. data/lib/xero-ruby/models/files/object_type.rb +1 -2
  163. data/lib/xero-ruby/models/files/{inline_object.rb → upload_object.rb} +43 -14
  164. data/lib/xero-ruby/models/files/user.rb +25 -11
  165. data/lib/xero-ruby/models/payroll_au/account.rb +25 -11
  166. data/lib/xero-ruby/models/payroll_au/account_type.rb +1 -2
  167. data/lib/xero-ruby/models/payroll_au/allowance_type.rb +1 -2
  168. data/lib/xero-ruby/models/payroll_au/api_exception.rb +25 -11
  169. data/lib/xero-ruby/models/payroll_au/bank_account.rb +25 -11
  170. data/lib/xero-ruby/models/payroll_au/calendar_type.rb +1 -2
  171. data/lib/xero-ruby/models/payroll_au/deduction_line.rb +25 -16
  172. data/lib/xero-ruby/models/payroll_au/deduction_type.rb +25 -11
  173. data/lib/xero-ruby/models/payroll_au/deduction_type_calculation_type.rb +1 -2
  174. data/lib/xero-ruby/models/payroll_au/earnings_line.rb +25 -11
  175. data/lib/xero-ruby/models/payroll_au/earnings_rate.rb +25 -11
  176. data/lib/xero-ruby/models/payroll_au/earnings_rate_calculation_type.rb +1 -2
  177. data/lib/xero-ruby/models/payroll_au/earnings_type.rb +2 -2
  178. data/lib/xero-ruby/models/payroll_au/employee.rb +25 -11
  179. data/lib/xero-ruby/models/payroll_au/employee_status.rb +1 -2
  180. data/lib/xero-ruby/models/payroll_au/employees.rb +25 -11
  181. data/lib/xero-ruby/models/payroll_au/employment_basis.rb +1 -2
  182. data/lib/xero-ruby/models/payroll_au/employment_termination_payment_type.rb +1 -2
  183. data/lib/xero-ruby/models/payroll_au/entitlement_final_pay_payout_type.rb +1 -2
  184. data/lib/xero-ruby/models/payroll_au/home_address.rb +25 -11
  185. data/lib/xero-ruby/models/payroll_au/leave_accrual_line.rb +25 -11
  186. data/lib/xero-ruby/models/payroll_au/leave_application.rb +25 -11
  187. data/lib/xero-ruby/models/payroll_au/leave_applications.rb +25 -11
  188. data/lib/xero-ruby/models/payroll_au/leave_balance.rb +25 -11
  189. data/lib/xero-ruby/models/payroll_au/leave_earnings_line.rb +25 -11
  190. data/lib/xero-ruby/models/payroll_au/leave_line.rb +25 -11
  191. data/lib/xero-ruby/models/payroll_au/leave_line_calculation_type.rb +1 -2
  192. data/lib/xero-ruby/models/payroll_au/leave_lines.rb +25 -11
  193. data/lib/xero-ruby/models/payroll_au/leave_period.rb +25 -11
  194. data/lib/xero-ruby/models/payroll_au/leave_period_status.rb +1 -2
  195. data/lib/xero-ruby/models/payroll_au/leave_type.rb +25 -11
  196. data/lib/xero-ruby/models/payroll_au/leave_type_contribution_type.rb +1 -2
  197. data/lib/xero-ruby/models/payroll_au/manual_tax_type.rb +1 -2
  198. data/lib/xero-ruby/models/payroll_au/opening_balances.rb +25 -11
  199. data/lib/xero-ruby/models/payroll_au/pay_item.rb +25 -11
  200. data/lib/xero-ruby/models/payroll_au/pay_items.rb +25 -11
  201. data/lib/xero-ruby/models/payroll_au/pay_run.rb +25 -11
  202. data/lib/xero-ruby/models/payroll_au/pay_run_status.rb +1 -2
  203. data/lib/xero-ruby/models/payroll_au/pay_runs.rb +25 -11
  204. data/lib/xero-ruby/models/payroll_au/pay_template.rb +25 -11
  205. data/lib/xero-ruby/models/payroll_au/payment_frequency_type.rb +1 -2
  206. data/lib/xero-ruby/models/payroll_au/payroll_calendar.rb +25 -11
  207. data/lib/xero-ruby/models/payroll_au/payroll_calendars.rb +25 -11
  208. data/lib/xero-ruby/models/payroll_au/payslip.rb +25 -11
  209. data/lib/xero-ruby/models/payroll_au/payslip_lines.rb +25 -11
  210. data/lib/xero-ruby/models/payroll_au/payslip_object.rb +25 -11
  211. data/lib/xero-ruby/models/payroll_au/payslip_summary.rb +25 -11
  212. data/lib/xero-ruby/models/payroll_au/payslips.rb +25 -11
  213. data/lib/xero-ruby/models/payroll_au/rate_type.rb +1 -2
  214. data/lib/xero-ruby/models/payroll_au/reimbursement_line.rb +25 -11
  215. data/lib/xero-ruby/models/payroll_au/reimbursement_lines.rb +25 -11
  216. data/lib/xero-ruby/models/payroll_au/reimbursement_type.rb +25 -11
  217. data/lib/xero-ruby/models/payroll_au/residency_status.rb +1 -2
  218. data/lib/xero-ruby/models/payroll_au/settings.rb +25 -11
  219. data/lib/xero-ruby/models/payroll_au/settings_object.rb +25 -11
  220. data/lib/xero-ruby/models/payroll_au/settings_tracking_categories.rb +25 -11
  221. data/lib/xero-ruby/models/payroll_au/settings_tracking_categories_employee_groups.rb +25 -11
  222. data/lib/xero-ruby/models/payroll_au/settings_tracking_categories_timesheet_categories.rb +25 -11
  223. data/lib/xero-ruby/models/payroll_au/state.rb +1 -2
  224. data/lib/xero-ruby/models/payroll_au/super_fund.rb +25 -11
  225. data/lib/xero-ruby/models/payroll_au/super_fund_product.rb +25 -11
  226. data/lib/xero-ruby/models/payroll_au/super_fund_products.rb +25 -11
  227. data/lib/xero-ruby/models/payroll_au/super_fund_type.rb +1 -2
  228. data/lib/xero-ruby/models/payroll_au/super_funds.rb +25 -11
  229. data/lib/xero-ruby/models/payroll_au/super_line.rb +26 -12
  230. data/lib/xero-ruby/models/payroll_au/super_membership.rb +26 -12
  231. data/lib/xero-ruby/models/payroll_au/superannuation_calculation_type.rb +1 -2
  232. data/lib/xero-ruby/models/payroll_au/superannuation_contribution_type.rb +1 -2
  233. data/lib/xero-ruby/models/payroll_au/superannuation_line.rb +25 -11
  234. data/lib/xero-ruby/models/payroll_au/tax_declaration.rb +25 -11
  235. data/lib/xero-ruby/models/payroll_au/tax_line.rb +25 -11
  236. data/lib/xero-ruby/models/payroll_au/tfn_exemption_type.rb +1 -2
  237. data/lib/xero-ruby/models/payroll_au/timesheet.rb +25 -11
  238. data/lib/xero-ruby/models/payroll_au/timesheet_line.rb +25 -11
  239. data/lib/xero-ruby/models/payroll_au/timesheet_object.rb +25 -11
  240. data/lib/xero-ruby/models/payroll_au/timesheet_status.rb +1 -2
  241. data/lib/xero-ruby/models/payroll_au/timesheets.rb +25 -11
  242. data/lib/xero-ruby/models/payroll_au/validation_error.rb +25 -11
  243. data/lib/xero-ruby/models/payroll_nz/account.rb +24 -10
  244. data/lib/xero-ruby/models/payroll_nz/accounts.rb +24 -10
  245. data/lib/xero-ruby/models/payroll_nz/address.rb +24 -10
  246. data/lib/xero-ruby/models/payroll_nz/bank_account.rb +24 -10
  247. data/lib/xero-ruby/models/payroll_nz/benefit.rb +24 -10
  248. data/lib/xero-ruby/models/payroll_nz/calendar_type.rb +0 -1
  249. data/lib/xero-ruby/models/payroll_nz/deduction.rb +24 -10
  250. data/lib/xero-ruby/models/payroll_nz/deduction_line.rb +24 -10
  251. data/lib/xero-ruby/models/payroll_nz/deduction_object.rb +24 -10
  252. data/lib/xero-ruby/models/payroll_nz/deductions.rb +24 -10
  253. data/lib/xero-ruby/models/payroll_nz/earnings_line.rb +25 -11
  254. data/lib/xero-ruby/models/payroll_nz/earnings_order.rb +24 -10
  255. data/lib/xero-ruby/models/payroll_nz/earnings_order_object.rb +24 -10
  256. data/lib/xero-ruby/models/payroll_nz/earnings_orders.rb +24 -10
  257. data/lib/xero-ruby/models/payroll_nz/earnings_rate.rb +24 -10
  258. data/lib/xero-ruby/models/payroll_nz/earnings_rate_object.rb +24 -10
  259. data/lib/xero-ruby/models/payroll_nz/earnings_rates.rb +24 -10
  260. data/lib/xero-ruby/models/payroll_nz/earnings_template.rb +24 -10
  261. data/lib/xero-ruby/models/payroll_nz/earnings_template_object.rb +24 -10
  262. data/lib/xero-ruby/models/payroll_nz/employee.rb +24 -10
  263. data/lib/xero-ruby/models/payroll_nz/employee_earnings_templates.rb +24 -10
  264. data/lib/xero-ruby/models/payroll_nz/employee_leave.rb +24 -10
  265. data/lib/xero-ruby/models/payroll_nz/employee_leave_balance.rb +24 -10
  266. data/lib/xero-ruby/models/payroll_nz/employee_leave_balances.rb +24 -10
  267. data/lib/xero-ruby/models/payroll_nz/employee_leave_object.rb +24 -10
  268. data/lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb +24 -10
  269. data/lib/xero-ruby/models/payroll_nz/employee_leave_setup_object.rb +24 -10
  270. data/lib/xero-ruby/models/payroll_nz/employee_leave_type.rb +24 -10
  271. data/lib/xero-ruby/models/payroll_nz/employee_leave_type_object.rb +24 -10
  272. data/lib/xero-ruby/models/payroll_nz/employee_leave_types.rb +24 -10
  273. data/lib/xero-ruby/models/payroll_nz/employee_leaves.rb +24 -10
  274. data/lib/xero-ruby/models/payroll_nz/employee_object.rb +24 -10
  275. data/lib/xero-ruby/models/payroll_nz/employee_opening_balance.rb +24 -10
  276. data/lib/xero-ruby/models/payroll_nz/employee_opening_balances_object.rb +24 -10
  277. data/lib/xero-ruby/models/payroll_nz/employee_pay_template.rb +24 -10
  278. data/lib/xero-ruby/models/payroll_nz/employee_pay_template_object.rb +24 -10
  279. data/lib/xero-ruby/models/payroll_nz/employee_pay_templates.rb +24 -10
  280. data/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_balance.rb +24 -10
  281. data/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_balance_object.rb +24 -10
  282. data/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_summary.rb +24 -10
  283. data/lib/xero-ruby/models/payroll_nz/employee_statutory_leaves_summaries.rb +24 -10
  284. data/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leave.rb +25 -11
  285. data/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leave_object.rb +24 -10
  286. data/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leaves.rb +24 -10
  287. data/lib/xero-ruby/models/payroll_nz/employee_tax.rb +24 -10
  288. data/lib/xero-ruby/models/payroll_nz/employee_tax_object.rb +24 -10
  289. data/lib/xero-ruby/models/payroll_nz/employees.rb +24 -10
  290. data/lib/xero-ruby/models/payroll_nz/employment.rb +24 -10
  291. data/lib/xero-ruby/models/payroll_nz/employment_object.rb +24 -10
  292. data/lib/xero-ruby/models/payroll_nz/gross_earnings_history.rb +24 -10
  293. data/lib/xero-ruby/models/payroll_nz/invalid_field.rb +24 -10
  294. data/lib/xero-ruby/models/payroll_nz/leave_accrual_line.rb +24 -10
  295. data/lib/xero-ruby/models/payroll_nz/leave_earnings_line.rb +25 -11
  296. data/lib/xero-ruby/models/payroll_nz/leave_period.rb +24 -10
  297. data/lib/xero-ruby/models/payroll_nz/leave_periods.rb +24 -10
  298. data/lib/xero-ruby/models/payroll_nz/leave_type.rb +24 -10
  299. data/lib/xero-ruby/models/payroll_nz/leave_type_object.rb +24 -10
  300. data/lib/xero-ruby/models/payroll_nz/leave_types.rb +24 -10
  301. data/lib/xero-ruby/models/payroll_nz/pagination.rb +24 -10
  302. data/lib/xero-ruby/models/payroll_nz/pay_run.rb +24 -10
  303. data/lib/xero-ruby/models/payroll_nz/pay_run_calendar.rb +24 -10
  304. data/lib/xero-ruby/models/payroll_nz/pay_run_calendar_object.rb +24 -10
  305. data/lib/xero-ruby/models/payroll_nz/pay_run_calendars.rb +24 -10
  306. data/lib/xero-ruby/models/payroll_nz/pay_run_object.rb +24 -10
  307. data/lib/xero-ruby/models/payroll_nz/pay_runs.rb +24 -10
  308. data/lib/xero-ruby/models/payroll_nz/pay_slip.rb +24 -10
  309. data/lib/xero-ruby/models/payroll_nz/pay_slip_object.rb +24 -10
  310. data/lib/xero-ruby/models/payroll_nz/pay_slips.rb +24 -10
  311. data/lib/xero-ruby/models/payroll_nz/payment_line.rb +24 -10
  312. data/lib/xero-ruby/models/payroll_nz/payment_method.rb +24 -10
  313. data/lib/xero-ruby/models/payroll_nz/payment_method_object.rb +24 -10
  314. data/lib/xero-ruby/models/payroll_nz/problem.rb +24 -10
  315. data/lib/xero-ruby/models/payroll_nz/reimbursement.rb +24 -10
  316. data/lib/xero-ruby/models/payroll_nz/reimbursement_line.rb +24 -10
  317. data/lib/xero-ruby/models/payroll_nz/reimbursement_object.rb +24 -10
  318. data/lib/xero-ruby/models/payroll_nz/reimbursements.rb +24 -10
  319. data/lib/xero-ruby/models/payroll_nz/salary_and_wage.rb +28 -13
  320. data/lib/xero-ruby/models/payroll_nz/salary_and_wage_object.rb +24 -10
  321. data/lib/xero-ruby/models/payroll_nz/salary_and_wages.rb +24 -10
  322. data/lib/xero-ruby/models/payroll_nz/settings.rb +24 -10
  323. data/lib/xero-ruby/models/payroll_nz/statutory_deduction.rb +24 -10
  324. data/lib/xero-ruby/models/payroll_nz/statutory_deduction_category.rb +0 -1
  325. data/lib/xero-ruby/models/payroll_nz/statutory_deduction_line.rb +24 -10
  326. data/lib/xero-ruby/models/payroll_nz/statutory_deduction_object.rb +24 -10
  327. data/lib/xero-ruby/models/payroll_nz/statutory_deductions.rb +24 -10
  328. data/lib/xero-ruby/models/payroll_nz/superannuation_line.rb +25 -11
  329. data/lib/xero-ruby/models/payroll_nz/superannuation_object.rb +24 -10
  330. data/lib/xero-ruby/models/payroll_nz/superannuations.rb +24 -10
  331. data/lib/xero-ruby/models/payroll_nz/tax_code.rb +0 -1
  332. data/lib/xero-ruby/models/payroll_nz/tax_line.rb +24 -10
  333. data/lib/xero-ruby/models/payroll_nz/tax_settings.rb +24 -10
  334. data/lib/xero-ruby/models/payroll_nz/timesheet.rb +28 -13
  335. data/lib/xero-ruby/models/payroll_nz/timesheet_earnings_line.rb +25 -11
  336. data/lib/xero-ruby/models/payroll_nz/timesheet_line.rb +24 -10
  337. data/lib/xero-ruby/models/payroll_nz/timesheet_line_object.rb +24 -10
  338. data/lib/xero-ruby/models/payroll_nz/timesheet_object.rb +24 -10
  339. data/lib/xero-ruby/models/payroll_nz/timesheets.rb +24 -10
  340. data/lib/xero-ruby/models/payroll_nz/tracking_categories.rb +24 -10
  341. data/lib/xero-ruby/models/payroll_nz/tracking_category.rb +24 -10
  342. data/lib/xero-ruby/models/payroll_uk/account.rb +24 -10
  343. data/lib/xero-ruby/models/payroll_uk/accounts.rb +24 -10
  344. data/lib/xero-ruby/models/payroll_uk/address.rb +24 -10
  345. data/lib/xero-ruby/models/payroll_uk/bank_account.rb +24 -10
  346. data/lib/xero-ruby/models/payroll_uk/benefit.rb +24 -10
  347. data/lib/xero-ruby/models/payroll_uk/benefit_line.rb +24 -10
  348. data/lib/xero-ruby/models/payroll_uk/benefit_object.rb +24 -10
  349. data/lib/xero-ruby/models/payroll_uk/benefits.rb +24 -10
  350. data/lib/xero-ruby/models/payroll_uk/court_order_line.rb +24 -10
  351. data/lib/xero-ruby/models/payroll_uk/deduction.rb +24 -10
  352. data/lib/xero-ruby/models/payroll_uk/deduction_line.rb +24 -10
  353. data/lib/xero-ruby/models/payroll_uk/deduction_object.rb +24 -10
  354. data/lib/xero-ruby/models/payroll_uk/deductions.rb +24 -10
  355. data/lib/xero-ruby/models/payroll_uk/earnings_line.rb +24 -10
  356. data/lib/xero-ruby/models/payroll_uk/earnings_order.rb +24 -10
  357. data/lib/xero-ruby/models/payroll_uk/earnings_order_object.rb +24 -10
  358. data/lib/xero-ruby/models/payroll_uk/earnings_orders.rb +24 -10
  359. data/lib/xero-ruby/models/payroll_uk/earnings_rate.rb +34 -12
  360. data/lib/xero-ruby/models/payroll_uk/earnings_rate_object.rb +24 -10
  361. data/lib/xero-ruby/models/payroll_uk/earnings_rates.rb +24 -10
  362. data/lib/xero-ruby/models/payroll_uk/earnings_template.rb +24 -10
  363. data/lib/xero-ruby/models/payroll_uk/earnings_template_object.rb +24 -10
  364. data/lib/xero-ruby/models/payroll_uk/employee.rb +24 -10
  365. data/lib/xero-ruby/models/payroll_uk/employee_leave.rb +24 -10
  366. data/lib/xero-ruby/models/payroll_uk/employee_leave_balance.rb +24 -10
  367. data/lib/xero-ruby/models/payroll_uk/employee_leave_balances.rb +24 -10
  368. data/lib/xero-ruby/models/payroll_uk/employee_leave_object.rb +24 -10
  369. data/lib/xero-ruby/models/payroll_uk/employee_leave_type.rb +24 -10
  370. data/lib/xero-ruby/models/payroll_uk/employee_leave_type_object.rb +24 -10
  371. data/lib/xero-ruby/models/payroll_uk/employee_leave_types.rb +24 -10
  372. data/lib/xero-ruby/models/payroll_uk/employee_leaves.rb +24 -10
  373. data/lib/xero-ruby/models/payroll_uk/employee_object.rb +24 -10
  374. data/lib/xero-ruby/models/payroll_uk/employee_opening_balances.rb +24 -10
  375. data/lib/xero-ruby/models/payroll_uk/employee_opening_balances_object.rb +24 -10
  376. data/lib/xero-ruby/models/payroll_uk/employee_pay_template.rb +24 -10
  377. data/lib/xero-ruby/models/payroll_uk/employee_pay_template_object.rb +24 -10
  378. data/lib/xero-ruby/models/payroll_uk/employee_pay_templates.rb +24 -10
  379. data/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_balance.rb +24 -10
  380. data/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_balance_object.rb +24 -10
  381. data/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_summary.rb +24 -10
  382. data/lib/xero-ruby/models/payroll_uk/employee_statutory_leaves_summaries.rb +24 -10
  383. data/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb +25 -11
  384. data/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave_object.rb +24 -10
  385. data/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leaves.rb +24 -10
  386. data/lib/xero-ruby/models/payroll_uk/employee_tax.rb +24 -10
  387. data/lib/xero-ruby/models/payroll_uk/employee_tax_object.rb +24 -10
  388. data/lib/xero-ruby/models/payroll_uk/employees.rb +24 -10
  389. data/lib/xero-ruby/models/payroll_uk/employment.rb +24 -10
  390. data/lib/xero-ruby/models/payroll_uk/employment_object.rb +24 -10
  391. data/lib/xero-ruby/models/payroll_uk/invalid_field.rb +24 -10
  392. data/lib/xero-ruby/models/payroll_uk/leave_accrual_line.rb +24 -10
  393. data/lib/xero-ruby/models/payroll_uk/leave_earnings_line.rb +24 -10
  394. data/lib/xero-ruby/models/payroll_uk/leave_period.rb +24 -10
  395. data/lib/xero-ruby/models/payroll_uk/leave_periods.rb +24 -10
  396. data/lib/xero-ruby/models/payroll_uk/leave_type.rb +24 -10
  397. data/lib/xero-ruby/models/payroll_uk/leave_type_object.rb +24 -10
  398. data/lib/xero-ruby/models/payroll_uk/leave_types.rb +24 -10
  399. data/lib/xero-ruby/models/payroll_uk/pagination.rb +24 -10
  400. data/lib/xero-ruby/models/payroll_uk/pay_run.rb +24 -10
  401. data/lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb +24 -10
  402. data/lib/xero-ruby/models/payroll_uk/pay_run_calendar_object.rb +24 -10
  403. data/lib/xero-ruby/models/payroll_uk/pay_run_calendars.rb +24 -10
  404. data/lib/xero-ruby/models/payroll_uk/pay_run_object.rb +24 -10
  405. data/lib/xero-ruby/models/payroll_uk/pay_runs.rb +24 -10
  406. data/lib/xero-ruby/models/payroll_uk/payment_line.rb +24 -10
  407. data/lib/xero-ruby/models/payroll_uk/payment_method.rb +24 -10
  408. data/lib/xero-ruby/models/payroll_uk/payment_method_object.rb +24 -10
  409. data/lib/xero-ruby/models/payroll_uk/payslip.rb +24 -10
  410. data/lib/xero-ruby/models/payroll_uk/payslip_object.rb +24 -10
  411. data/lib/xero-ruby/models/payroll_uk/payslips.rb +24 -10
  412. data/lib/xero-ruby/models/payroll_uk/problem.rb +24 -10
  413. data/lib/xero-ruby/models/payroll_uk/reimbursement.rb +24 -10
  414. data/lib/xero-ruby/models/payroll_uk/reimbursement_line.rb +24 -10
  415. data/lib/xero-ruby/models/payroll_uk/reimbursement_object.rb +24 -10
  416. data/lib/xero-ruby/models/payroll_uk/reimbursements.rb +24 -10
  417. data/lib/xero-ruby/models/payroll_uk/salary_and_wage.rb +27 -12
  418. data/lib/xero-ruby/models/payroll_uk/salary_and_wage_object.rb +24 -10
  419. data/lib/xero-ruby/models/payroll_uk/salary_and_wages.rb +24 -10
  420. data/lib/xero-ruby/models/payroll_uk/settings.rb +24 -10
  421. data/lib/xero-ruby/models/payroll_uk/statutory_deduction.rb +24 -10
  422. data/lib/xero-ruby/models/payroll_uk/statutory_deduction_category.rb +0 -1
  423. data/lib/xero-ruby/models/payroll_uk/tax_line.rb +24 -10
  424. data/lib/xero-ruby/models/payroll_uk/timesheet.rb +25 -11
  425. data/lib/xero-ruby/models/payroll_uk/timesheet_earnings_line.rb +24 -10
  426. data/lib/xero-ruby/models/payroll_uk/timesheet_line.rb +24 -10
  427. data/lib/xero-ruby/models/payroll_uk/timesheet_line_object.rb +24 -10
  428. data/lib/xero-ruby/models/payroll_uk/timesheet_object.rb +24 -10
  429. data/lib/xero-ruby/models/payroll_uk/timesheets.rb +24 -10
  430. data/lib/xero-ruby/models/payroll_uk/tracking_categories.rb +24 -10
  431. data/lib/xero-ruby/models/payroll_uk/tracking_category.rb +24 -10
  432. data/lib/xero-ruby/models/projects/amount.rb +24 -10
  433. data/lib/xero-ruby/models/projects/charge_type.rb +0 -1
  434. data/lib/xero-ruby/models/projects/currency_code.rb +0 -1
  435. data/lib/xero-ruby/models/projects/error.rb +24 -10
  436. data/lib/xero-ruby/models/projects/pagination.rb +24 -10
  437. data/lib/xero-ruby/models/projects/project.rb +24 -10
  438. data/lib/xero-ruby/models/projects/project_create_or_update.rb +24 -10
  439. data/lib/xero-ruby/models/projects/project_patch.rb +24 -10
  440. data/lib/xero-ruby/models/projects/project_status.rb +0 -1
  441. data/lib/xero-ruby/models/projects/project_user.rb +24 -10
  442. data/lib/xero-ruby/models/projects/project_users.rb +24 -10
  443. data/lib/xero-ruby/models/projects/projects.rb +24 -10
  444. data/lib/xero-ruby/models/projects/task.rb +24 -10
  445. data/lib/xero-ruby/models/projects/task_create_or_update.rb +24 -10
  446. data/lib/xero-ruby/models/projects/tasks.rb +24 -10
  447. data/lib/xero-ruby/models/projects/time_entries.rb +24 -10
  448. data/lib/xero-ruby/models/projects/time_entry.rb +27 -12
  449. data/lib/xero-ruby/models/projects/time_entry_create_or_update.rb +24 -10
  450. data/lib/xero-ruby/string_serialization.rb +52 -0
  451. data/lib/xero-ruby/version.rb +3 -3
  452. data/lib/xero-ruby/where.rb +65 -0
  453. data/spec/api_client_spec.rb +292 -14
  454. data/spec/api_error_spec.rb +45 -0
  455. data/spec/configuration_spec.rb +26 -16
  456. data/spec/files/models/inline_object_spec.rb +3 -3
  457. data/spec/helper_methods_spec.rb +110 -0
  458. data/spec/where_spec.rb +82 -0
  459. metadata +43 -12
  460. data/spec/files/models/file_response204_spec.rb +0 -41
@@ -3,7 +3,6 @@
3
3
 
4
4
  #This is the Xero Payroll API for orgs in the NZ region.
5
5
 
6
- The version of the OpenAPI document: 2.6.0
7
6
  Contact: api@xero.com
8
7
  Generated by: https://openapi-generator.tech
9
8
  OpenAPI Generator version: 4.3.1
@@ -17,7 +16,7 @@ module XeroRuby
17
16
  def initialize(api_client = ApiClient.new)
18
17
  @api_client = api_client
19
18
  end
20
- # approve a timesheet
19
+ # Approves a timesheet
21
20
  # @param xero_tenant_id [String] Xero identifier for Tenant
22
21
  # @param timesheet_id [String] Identifier for the timesheet
23
22
  # @param [Hash] opts the optional parameters
@@ -27,12 +26,13 @@ module XeroRuby
27
26
  data
28
27
  end
29
28
 
30
- # approve a timesheet
29
+ # Approves a timesheet
31
30
  # @param xero_tenant_id [String] Xero identifier for Tenant
32
31
  # @param timesheet_id [String] Identifier for the timesheet
33
32
  # @param [Hash] opts the optional parameters
34
33
  # @return [Array<(TimesheetObject, Integer, Hash)>] TimesheetObject data, response status code and response headers
35
- def approve_timesheet_with_http_info(xero_tenant_id, timesheet_id, opts = {})
34
+ def approve_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {})
35
+ opts = options.dup
36
36
  if @api_client.config.debugging
37
37
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.approve_timesheet ...'
38
38
  end
@@ -91,7 +91,7 @@ module XeroRuby
91
91
  return data, status_code, headers
92
92
  end
93
93
 
94
- # create a new deduction
94
+ # Creates a new deduction for a specific employee
95
95
  # @param xero_tenant_id [String] Xero identifier for Tenant
96
96
  # @param deduction [Deduction]
97
97
  # @param [Hash] opts the optional parameters
@@ -101,12 +101,13 @@ module XeroRuby
101
101
  data
102
102
  end
103
103
 
104
- # create a new deduction
104
+ # Creates a new deduction for a specific employee
105
105
  # @param xero_tenant_id [String] Xero identifier for Tenant
106
106
  # @param deduction [Deduction]
107
107
  # @param [Hash] opts the optional parameters
108
108
  # @return [Array<(DeductionObject, Integer, Hash)>] DeductionObject data, response status code and response headers
109
- def create_deduction_with_http_info(xero_tenant_id, deduction, opts = {})
109
+ def create_deduction_with_http_info(xero_tenant_id, deduction, options = {})
110
+ opts = options.dup
110
111
  if @api_client.config.debugging
111
112
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.create_deduction ...'
112
113
  end
@@ -167,7 +168,7 @@ module XeroRuby
167
168
  return data, status_code, headers
168
169
  end
169
170
 
170
- # create a new earnings rate
171
+ # Creates a new earnings rate
171
172
  # @param xero_tenant_id [String] Xero identifier for Tenant
172
173
  # @param earnings_rate [EarningsRate]
173
174
  # @param [Hash] opts the optional parameters
@@ -177,12 +178,13 @@ module XeroRuby
177
178
  data
178
179
  end
179
180
 
180
- # create a new earnings rate
181
+ # Creates a new earnings rate
181
182
  # @param xero_tenant_id [String] Xero identifier for Tenant
182
183
  # @param earnings_rate [EarningsRate]
183
184
  # @param [Hash] opts the optional parameters
184
185
  # @return [Array<(EarningsRateObject, Integer, Hash)>] EarningsRateObject data, response status code and response headers
185
- def create_earnings_rate_with_http_info(xero_tenant_id, earnings_rate, opts = {})
186
+ def create_earnings_rate_with_http_info(xero_tenant_id, earnings_rate, options = {})
187
+ opts = options.dup
186
188
  if @api_client.config.debugging
187
189
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.create_earnings_rate ...'
188
190
  end
@@ -243,7 +245,7 @@ module XeroRuby
243
245
  return data, status_code, headers
244
246
  end
245
247
 
246
- # creates employees
248
+ # Creates an employees
247
249
  # @param xero_tenant_id [String] Xero identifier for Tenant
248
250
  # @param employee [Employee]
249
251
  # @param [Hash] opts the optional parameters
@@ -253,12 +255,13 @@ module XeroRuby
253
255
  data
254
256
  end
255
257
 
256
- # creates employees
258
+ # Creates an employees
257
259
  # @param xero_tenant_id [String] Xero identifier for Tenant
258
260
  # @param employee [Employee]
259
261
  # @param [Hash] opts the optional parameters
260
262
  # @return [Array<(EmployeeObject, Integer, Hash)>] EmployeeObject data, response status code and response headers
261
- def create_employee_with_http_info(xero_tenant_id, employee, opts = {})
263
+ def create_employee_with_http_info(xero_tenant_id, employee, options = {})
264
+ opts = options.dup
262
265
  if @api_client.config.debugging
263
266
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.create_employee ...'
264
267
  end
@@ -319,7 +322,7 @@ module XeroRuby
319
322
  return data, status_code, headers
320
323
  end
321
324
 
322
- # creates employee earnings template records
325
+ # Creates earnings template records for an employee
323
326
  # @param xero_tenant_id [String] Xero identifier for Tenant
324
327
  # @param employee_id [String] Employee id for single object
325
328
  # @param earnings_template [EarningsTemplate]
@@ -330,13 +333,14 @@ module XeroRuby
330
333
  data
331
334
  end
332
335
 
333
- # creates employee earnings template records
336
+ # Creates earnings template records for an employee
334
337
  # @param xero_tenant_id [String] Xero identifier for Tenant
335
338
  # @param employee_id [String] Employee id for single object
336
339
  # @param earnings_template [EarningsTemplate]
337
340
  # @param [Hash] opts the optional parameters
338
341
  # @return [Array<(EarningsTemplateObject, Integer, Hash)>] EarningsTemplateObject data, response status code and response headers
339
- def create_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, opts = {})
342
+ def create_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, options = {})
343
+ opts = options.dup
340
344
  if @api_client.config.debugging
341
345
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.create_employee_earnings_template ...'
342
346
  end
@@ -353,7 +357,7 @@ module XeroRuby
353
357
  fail ArgumentError, "Missing the required parameter 'earnings_template' when calling PayrollNzApi.create_employee_earnings_template"
354
358
  end
355
359
  # resource path
356
- local_var_path = '/Employees/{EmployeeId}/PayTemplates/earnings'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
360
+ local_var_path = '/Employees/{EmployeeID}/PayTemplates/earnings'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
357
361
 
358
362
  # camelize keys of incoming `where` opts
359
363
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -401,7 +405,7 @@ module XeroRuby
401
405
  return data, status_code, headers
402
406
  end
403
407
 
404
- # creates employee leave records
408
+ # Creates leave records for a specific employee
405
409
  # @param xero_tenant_id [String] Xero identifier for Tenant
406
410
  # @param employee_id [String] Employee id for single object
407
411
  # @param employee_leave [EmployeeLeave]
@@ -412,13 +416,14 @@ module XeroRuby
412
416
  data
413
417
  end
414
418
 
415
- # creates employee leave records
419
+ # Creates leave records for a specific employee
416
420
  # @param xero_tenant_id [String] Xero identifier for Tenant
417
421
  # @param employee_id [String] Employee id for single object
418
422
  # @param employee_leave [EmployeeLeave]
419
423
  # @param [Hash] opts the optional parameters
420
424
  # @return [Array<(EmployeeLeaveObject, Integer, Hash)>] EmployeeLeaveObject data, response status code and response headers
421
- def create_employee_leave_with_http_info(xero_tenant_id, employee_id, employee_leave, opts = {})
425
+ def create_employee_leave_with_http_info(xero_tenant_id, employee_id, employee_leave, options = {})
426
+ opts = options.dup
422
427
  if @api_client.config.debugging
423
428
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.create_employee_leave ...'
424
429
  end
@@ -435,7 +440,7 @@ module XeroRuby
435
440
  fail ArgumentError, "Missing the required parameter 'employee_leave' when calling PayrollNzApi.create_employee_leave"
436
441
  end
437
442
  # resource path
438
- local_var_path = '/Employees/{EmployeeId}/Leave'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
443
+ local_var_path = '/Employees/{EmployeeID}/Leave'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
439
444
 
440
445
  # camelize keys of incoming `where` opts
441
446
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -483,7 +488,7 @@ module XeroRuby
483
488
  return data, status_code, headers
484
489
  end
485
490
 
486
- # Allows you to set-up leave for a specific employee. This is required before viewing, configuring and requesting leave for an employee
491
+ # Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee
487
492
  # @param xero_tenant_id [String] Xero identifier for Tenant
488
493
  # @param employee_id [String] Employee id for single object
489
494
  # @param employee_leave_setup [EmployeeLeaveSetup]
@@ -494,13 +499,14 @@ module XeroRuby
494
499
  data
495
500
  end
496
501
 
497
- # Allows you to set-up leave for a specific employee. This is required before viewing, configuring and requesting leave for an employee
502
+ # Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee
498
503
  # @param xero_tenant_id [String] Xero identifier for Tenant
499
504
  # @param employee_id [String] Employee id for single object
500
505
  # @param employee_leave_setup [EmployeeLeaveSetup]
501
506
  # @param [Hash] opts the optional parameters
502
507
  # @return [Array<(EmployeeLeaveSetupObject, Integer, Hash)>] EmployeeLeaveSetupObject data, response status code and response headers
503
- def create_employee_leave_setup_with_http_info(xero_tenant_id, employee_id, employee_leave_setup, opts = {})
508
+ def create_employee_leave_setup_with_http_info(xero_tenant_id, employee_id, employee_leave_setup, options = {})
509
+ opts = options.dup
504
510
  if @api_client.config.debugging
505
511
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.create_employee_leave_setup ...'
506
512
  end
@@ -517,7 +523,7 @@ module XeroRuby
517
523
  fail ArgumentError, "Missing the required parameter 'employee_leave_setup' when calling PayrollNzApi.create_employee_leave_setup"
518
524
  end
519
525
  # resource path
520
- local_var_path = '/Employees/{EmployeeId}/leaveSetup'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
526
+ local_var_path = '/Employees/{EmployeeID}/leaveSetup'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
521
527
 
522
528
  # camelize keys of incoming `where` opts
523
529
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -565,7 +571,7 @@ module XeroRuby
565
571
  return data, status_code, headers
566
572
  end
567
573
 
568
- # creates employee leave type records
574
+ # Creates leave type records for a specific employee
569
575
  # @param xero_tenant_id [String] Xero identifier for Tenant
570
576
  # @param employee_id [String] Employee id for single object
571
577
  # @param employee_leave_type [EmployeeLeaveType]
@@ -576,13 +582,14 @@ module XeroRuby
576
582
  data
577
583
  end
578
584
 
579
- # creates employee leave type records
585
+ # Creates leave type records for a specific employee
580
586
  # @param xero_tenant_id [String] Xero identifier for Tenant
581
587
  # @param employee_id [String] Employee id for single object
582
588
  # @param employee_leave_type [EmployeeLeaveType]
583
589
  # @param [Hash] opts the optional parameters
584
590
  # @return [Array<(EmployeeLeaveTypeObject, Integer, Hash)>] EmployeeLeaveTypeObject data, response status code and response headers
585
- def create_employee_leave_type_with_http_info(xero_tenant_id, employee_id, employee_leave_type, opts = {})
591
+ def create_employee_leave_type_with_http_info(xero_tenant_id, employee_id, employee_leave_type, options = {})
592
+ opts = options.dup
586
593
  if @api_client.config.debugging
587
594
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.create_employee_leave_type ...'
588
595
  end
@@ -599,7 +606,7 @@ module XeroRuby
599
606
  fail ArgumentError, "Missing the required parameter 'employee_leave_type' when calling PayrollNzApi.create_employee_leave_type"
600
607
  end
601
608
  # resource path
602
- local_var_path = '/Employees/{EmployeeId}/LeaveTypes'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
609
+ local_var_path = '/Employees/{EmployeeID}/LeaveTypes'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
603
610
 
604
611
  # camelize keys of incoming `where` opts
605
612
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -647,7 +654,7 @@ module XeroRuby
647
654
  return data, status_code, headers
648
655
  end
649
656
 
650
- # creates employee opening balances
657
+ # Creates opening balances for a specific employee
651
658
  # @param xero_tenant_id [String] Xero identifier for Tenant
652
659
  # @param employee_id [String] Employee id for single object
653
660
  # @param employee_opening_balance [Array<EmployeeOpeningBalance>]
@@ -658,13 +665,14 @@ module XeroRuby
658
665
  data
659
666
  end
660
667
 
661
- # creates employee opening balances
668
+ # Creates opening balances for a specific employee
662
669
  # @param xero_tenant_id [String] Xero identifier for Tenant
663
670
  # @param employee_id [String] Employee id for single object
664
671
  # @param employee_opening_balance [Array<EmployeeOpeningBalance>]
665
672
  # @param [Hash] opts the optional parameters
666
673
  # @return [Array<(EmployeeOpeningBalancesObject, Integer, Hash)>] EmployeeOpeningBalancesObject data, response status code and response headers
667
- def create_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balance, opts = {})
674
+ def create_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balance, options = {})
675
+ opts = options.dup
668
676
  if @api_client.config.debugging
669
677
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.create_employee_opening_balances ...'
670
678
  end
@@ -681,7 +689,7 @@ module XeroRuby
681
689
  fail ArgumentError, "Missing the required parameter 'employee_opening_balance' when calling PayrollNzApi.create_employee_opening_balances"
682
690
  end
683
691
  # resource path
684
- local_var_path = '/Employees/{EmployeeId}/openingBalances'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
692
+ local_var_path = '/Employees/{EmployeeID}/openingBalances'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
685
693
 
686
694
  # camelize keys of incoming `where` opts
687
695
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -729,7 +737,7 @@ module XeroRuby
729
737
  return data, status_code, headers
730
738
  end
731
739
 
732
- # creates employee payment method
740
+ # Creates a payment method for an employee
733
741
  # @param xero_tenant_id [String] Xero identifier for Tenant
734
742
  # @param employee_id [String] Employee id for single object
735
743
  # @param payment_method [PaymentMethod]
@@ -740,13 +748,14 @@ module XeroRuby
740
748
  data
741
749
  end
742
750
 
743
- # creates employee payment method
751
+ # Creates a payment method for an employee
744
752
  # @param xero_tenant_id [String] Xero identifier for Tenant
745
753
  # @param employee_id [String] Employee id for single object
746
754
  # @param payment_method [PaymentMethod]
747
755
  # @param [Hash] opts the optional parameters
748
756
  # @return [Array<(PaymentMethodObject, Integer, Hash)>] PaymentMethodObject data, response status code and response headers
749
- def create_employee_payment_method_with_http_info(xero_tenant_id, employee_id, payment_method, opts = {})
757
+ def create_employee_payment_method_with_http_info(xero_tenant_id, employee_id, payment_method, options = {})
758
+ opts = options.dup
750
759
  if @api_client.config.debugging
751
760
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.create_employee_payment_method ...'
752
761
  end
@@ -763,7 +772,7 @@ module XeroRuby
763
772
  fail ArgumentError, "Missing the required parameter 'payment_method' when calling PayrollNzApi.create_employee_payment_method"
764
773
  end
765
774
  # resource path
766
- local_var_path = '/Employees/{EmployeeId}/PaymentMethods'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
775
+ local_var_path = '/Employees/{EmployeeID}/PaymentMethods'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
767
776
 
768
777
  # camelize keys of incoming `where` opts
769
778
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -811,7 +820,7 @@ module XeroRuby
811
820
  return data, status_code, headers
812
821
  end
813
822
 
814
- # creates employee salary and wage record
823
+ # Creates an employee salary and wage record
815
824
  # @param xero_tenant_id [String] Xero identifier for Tenant
816
825
  # @param employee_id [String] Employee id for single object
817
826
  # @param salary_and_wage [SalaryAndWage]
@@ -822,13 +831,14 @@ module XeroRuby
822
831
  data
823
832
  end
824
833
 
825
- # creates employee salary and wage record
834
+ # Creates an employee salary and wage record
826
835
  # @param xero_tenant_id [String] Xero identifier for Tenant
827
836
  # @param employee_id [String] Employee id for single object
828
837
  # @param salary_and_wage [SalaryAndWage]
829
838
  # @param [Hash] opts the optional parameters
830
839
  # @return [Array<(SalaryAndWageObject, Integer, Hash)>] SalaryAndWageObject data, response status code and response headers
831
- def create_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wage, opts = {})
840
+ def create_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wage, options = {})
841
+ opts = options.dup
832
842
  if @api_client.config.debugging
833
843
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.create_employee_salary_and_wage ...'
834
844
  end
@@ -845,7 +855,7 @@ module XeroRuby
845
855
  fail ArgumentError, "Missing the required parameter 'salary_and_wage' when calling PayrollNzApi.create_employee_salary_and_wage"
846
856
  end
847
857
  # resource path
848
- local_var_path = '/Employees/{EmployeeId}/SalaryAndWages'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
858
+ local_var_path = '/Employees/{EmployeeID}/SalaryAndWages'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
849
859
 
850
860
  # camelize keys of incoming `where` opts
851
861
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -893,7 +903,7 @@ module XeroRuby
893
903
  return data, status_code, headers
894
904
  end
895
905
 
896
- # creates employment
906
+ # Creates an employment detail for a specific employee
897
907
  # @param xero_tenant_id [String] Xero identifier for Tenant
898
908
  # @param employee_id [String] Employee id for single object
899
909
  # @param employment [Employment]
@@ -904,13 +914,14 @@ module XeroRuby
904
914
  data
905
915
  end
906
916
 
907
- # creates employment
917
+ # Creates an employment detail for a specific employee
908
918
  # @param xero_tenant_id [String] Xero identifier for Tenant
909
919
  # @param employee_id [String] Employee id for single object
910
920
  # @param employment [Employment]
911
921
  # @param [Hash] opts the optional parameters
912
922
  # @return [Array<(EmploymentObject, Integer, Hash)>] EmploymentObject data, response status code and response headers
913
- def create_employment_with_http_info(xero_tenant_id, employee_id, employment, opts = {})
923
+ def create_employment_with_http_info(xero_tenant_id, employee_id, employment, options = {})
924
+ opts = options.dup
914
925
  if @api_client.config.debugging
915
926
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.create_employment ...'
916
927
  end
@@ -927,7 +938,7 @@ module XeroRuby
927
938
  fail ArgumentError, "Missing the required parameter 'employment' when calling PayrollNzApi.create_employment"
928
939
  end
929
940
  # resource path
930
- local_var_path = '/Employees/{EmployeeId}/Employment'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
941
+ local_var_path = '/Employees/{EmployeeID}/Employment'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
931
942
 
932
943
  # camelize keys of incoming `where` opts
933
944
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -975,7 +986,7 @@ module XeroRuby
975
986
  return data, status_code, headers
976
987
  end
977
988
 
978
- # create a new leave type
989
+ # Creates a new leave type
979
990
  # @param xero_tenant_id [String] Xero identifier for Tenant
980
991
  # @param leave_type [LeaveType]
981
992
  # @param [Hash] opts the optional parameters
@@ -985,12 +996,13 @@ module XeroRuby
985
996
  data
986
997
  end
987
998
 
988
- # create a new leave type
999
+ # Creates a new leave type
989
1000
  # @param xero_tenant_id [String] Xero identifier for Tenant
990
1001
  # @param leave_type [LeaveType]
991
1002
  # @param [Hash] opts the optional parameters
992
1003
  # @return [Array<(LeaveTypeObject, Integer, Hash)>] LeaveTypeObject data, response status code and response headers
993
- def create_leave_type_with_http_info(xero_tenant_id, leave_type, opts = {})
1004
+ def create_leave_type_with_http_info(xero_tenant_id, leave_type, options = {})
1005
+ opts = options.dup
994
1006
  if @api_client.config.debugging
995
1007
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.create_leave_type ...'
996
1008
  end
@@ -1051,7 +1063,7 @@ module XeroRuby
1051
1063
  return data, status_code, headers
1052
1064
  end
1053
1065
 
1054
- # creates multiple employee earnings template records
1066
+ # Creates multiple employee earnings template records for a specific employee
1055
1067
  # @param xero_tenant_id [String] Xero identifier for Tenant
1056
1068
  # @param employee_id [String] Employee id for single object
1057
1069
  # @param earnings_template [Array<EarningsTemplate>]
@@ -1062,13 +1074,14 @@ module XeroRuby
1062
1074
  data
1063
1075
  end
1064
1076
 
1065
- # creates multiple employee earnings template records
1077
+ # Creates multiple employee earnings template records for a specific employee
1066
1078
  # @param xero_tenant_id [String] Xero identifier for Tenant
1067
1079
  # @param employee_id [String] Employee id for single object
1068
1080
  # @param earnings_template [Array<EarningsTemplate>]
1069
1081
  # @param [Hash] opts the optional parameters
1070
1082
  # @return [Array<(EmployeeEarningsTemplates, Integer, Hash)>] EmployeeEarningsTemplates data, response status code and response headers
1071
- def create_multiple_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, opts = {})
1083
+ def create_multiple_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, options = {})
1084
+ opts = options.dup
1072
1085
  if @api_client.config.debugging
1073
1086
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.create_multiple_employee_earnings_template ...'
1074
1087
  end
@@ -1085,7 +1098,7 @@ module XeroRuby
1085
1098
  fail ArgumentError, "Missing the required parameter 'earnings_template' when calling PayrollNzApi.create_multiple_employee_earnings_template"
1086
1099
  end
1087
1100
  # resource path
1088
- local_var_path = '/Employees/{EmployeeId}/paytemplateearnings'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
1101
+ local_var_path = '/Employees/{EmployeeID}/paytemplateearnings'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
1089
1102
 
1090
1103
  # camelize keys of incoming `where` opts
1091
1104
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -1133,7 +1146,7 @@ module XeroRuby
1133
1146
  return data, status_code, headers
1134
1147
  end
1135
1148
 
1136
- # create a pay run
1149
+ # Creates a pay run
1137
1150
  # @param xero_tenant_id [String] Xero identifier for Tenant
1138
1151
  # @param pay_run [PayRun]
1139
1152
  # @param [Hash] opts the optional parameters
@@ -1143,12 +1156,13 @@ module XeroRuby
1143
1156
  data
1144
1157
  end
1145
1158
 
1146
- # create a pay run
1159
+ # Creates a pay run
1147
1160
  # @param xero_tenant_id [String] Xero identifier for Tenant
1148
1161
  # @param pay_run [PayRun]
1149
1162
  # @param [Hash] opts the optional parameters
1150
1163
  # @return [Array<(PayRunObject, Integer, Hash)>] PayRunObject data, response status code and response headers
1151
- def create_pay_run_with_http_info(xero_tenant_id, pay_run, opts = {})
1164
+ def create_pay_run_with_http_info(xero_tenant_id, pay_run, options = {})
1165
+ opts = options.dup
1152
1166
  if @api_client.config.debugging
1153
1167
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.create_pay_run ...'
1154
1168
  end
@@ -1209,7 +1223,7 @@ module XeroRuby
1209
1223
  return data, status_code, headers
1210
1224
  end
1211
1225
 
1212
- # create a new payrun calendar
1226
+ # Creates a new payrun calendar
1213
1227
  # @param xero_tenant_id [String] Xero identifier for Tenant
1214
1228
  # @param pay_run_calendar [PayRunCalendar]
1215
1229
  # @param [Hash] opts the optional parameters
@@ -1219,12 +1233,13 @@ module XeroRuby
1219
1233
  data
1220
1234
  end
1221
1235
 
1222
- # create a new payrun calendar
1236
+ # Creates a new payrun calendar
1223
1237
  # @param xero_tenant_id [String] Xero identifier for Tenant
1224
1238
  # @param pay_run_calendar [PayRunCalendar]
1225
1239
  # @param [Hash] opts the optional parameters
1226
1240
  # @return [Array<(PayRunCalendarObject, Integer, Hash)>] PayRunCalendarObject data, response status code and response headers
1227
- def create_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar, opts = {})
1241
+ def create_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar, options = {})
1242
+ opts = options.dup
1228
1243
  if @api_client.config.debugging
1229
1244
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.create_pay_run_calendar ...'
1230
1245
  end
@@ -1285,7 +1300,7 @@ module XeroRuby
1285
1300
  return data, status_code, headers
1286
1301
  end
1287
1302
 
1288
- # create a new reimbursement
1303
+ # Creates a new reimbursement
1289
1304
  # @param xero_tenant_id [String] Xero identifier for Tenant
1290
1305
  # @param reimbursement [Reimbursement]
1291
1306
  # @param [Hash] opts the optional parameters
@@ -1295,12 +1310,13 @@ module XeroRuby
1295
1310
  data
1296
1311
  end
1297
1312
 
1298
- # create a new reimbursement
1313
+ # Creates a new reimbursement
1299
1314
  # @param xero_tenant_id [String] Xero identifier for Tenant
1300
1315
  # @param reimbursement [Reimbursement]
1301
1316
  # @param [Hash] opts the optional parameters
1302
1317
  # @return [Array<(ReimbursementObject, Integer, Hash)>] ReimbursementObject data, response status code and response headers
1303
- def create_reimbursement_with_http_info(xero_tenant_id, reimbursement, opts = {})
1318
+ def create_reimbursement_with_http_info(xero_tenant_id, reimbursement, options = {})
1319
+ opts = options.dup
1304
1320
  if @api_client.config.debugging
1305
1321
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.create_reimbursement ...'
1306
1322
  end
@@ -1361,7 +1377,7 @@ module XeroRuby
1361
1377
  return data, status_code, headers
1362
1378
  end
1363
1379
 
1364
- # create a new superannuation
1380
+ # Creates a new superannuation
1365
1381
  # @param xero_tenant_id [String] Xero identifier for Tenant
1366
1382
  # @param benefit [Benefit]
1367
1383
  # @param [Hash] opts the optional parameters
@@ -1371,12 +1387,13 @@ module XeroRuby
1371
1387
  data
1372
1388
  end
1373
1389
 
1374
- # create a new superannuation
1390
+ # Creates a new superannuation
1375
1391
  # @param xero_tenant_id [String] Xero identifier for Tenant
1376
1392
  # @param benefit [Benefit]
1377
1393
  # @param [Hash] opts the optional parameters
1378
1394
  # @return [Array<(SuperannuationObject, Integer, Hash)>] SuperannuationObject data, response status code and response headers
1379
- def create_superannuation_with_http_info(xero_tenant_id, benefit, opts = {})
1395
+ def create_superannuation_with_http_info(xero_tenant_id, benefit, options = {})
1396
+ opts = options.dup
1380
1397
  if @api_client.config.debugging
1381
1398
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.create_superannuation ...'
1382
1399
  end
@@ -1389,7 +1406,7 @@ module XeroRuby
1389
1406
  fail ArgumentError, "Missing the required parameter 'benefit' when calling PayrollNzApi.create_superannuation"
1390
1407
  end
1391
1408
  # resource path
1392
- local_var_path = '/superannuations'
1409
+ local_var_path = '/Superannuations'
1393
1410
 
1394
1411
  # camelize keys of incoming `where` opts
1395
1412
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -1437,7 +1454,7 @@ module XeroRuby
1437
1454
  return data, status_code, headers
1438
1455
  end
1439
1456
 
1440
- # create a new timesheet
1457
+ # Creates a new timesheet
1441
1458
  # @param xero_tenant_id [String] Xero identifier for Tenant
1442
1459
  # @param timesheet [Timesheet]
1443
1460
  # @param [Hash] opts the optional parameters
@@ -1447,12 +1464,13 @@ module XeroRuby
1447
1464
  data
1448
1465
  end
1449
1466
 
1450
- # create a new timesheet
1467
+ # Creates a new timesheet
1451
1468
  # @param xero_tenant_id [String] Xero identifier for Tenant
1452
1469
  # @param timesheet [Timesheet]
1453
1470
  # @param [Hash] opts the optional parameters
1454
1471
  # @return [Array<(TimesheetObject, Integer, Hash)>] TimesheetObject data, response status code and response headers
1455
- def create_timesheet_with_http_info(xero_tenant_id, timesheet, opts = {})
1472
+ def create_timesheet_with_http_info(xero_tenant_id, timesheet, options = {})
1473
+ opts = options.dup
1456
1474
  if @api_client.config.debugging
1457
1475
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.create_timesheet ...'
1458
1476
  end
@@ -1513,7 +1531,7 @@ module XeroRuby
1513
1531
  return data, status_code, headers
1514
1532
  end
1515
1533
 
1516
- # create a new timesheet line
1534
+ # Create a new timesheet line for a specific time sheet
1517
1535
  # @param xero_tenant_id [String] Xero identifier for Tenant
1518
1536
  # @param timesheet_id [String] Identifier for the timesheet
1519
1537
  # @param timesheet_line [TimesheetLine]
@@ -1524,13 +1542,14 @@ module XeroRuby
1524
1542
  data
1525
1543
  end
1526
1544
 
1527
- # create a new timesheet line
1545
+ # Create a new timesheet line for a specific time sheet
1528
1546
  # @param xero_tenant_id [String] Xero identifier for Tenant
1529
1547
  # @param timesheet_id [String] Identifier for the timesheet
1530
1548
  # @param timesheet_line [TimesheetLine]
1531
1549
  # @param [Hash] opts the optional parameters
1532
1550
  # @return [Array<(TimesheetLineObject, Integer, Hash)>] TimesheetLineObject data, response status code and response headers
1533
- def create_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line, opts = {})
1551
+ def create_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line, options = {})
1552
+ opts = options.dup
1534
1553
  if @api_client.config.debugging
1535
1554
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.create_timesheet_line ...'
1536
1555
  end
@@ -1595,7 +1614,7 @@ module XeroRuby
1595
1614
  return data, status_code, headers
1596
1615
  end
1597
1616
 
1598
- # deletes an employee earnings template record
1617
+ # Deletes an employee's earnings template record
1599
1618
  # @param xero_tenant_id [String] Xero identifier for Tenant
1600
1619
  # @param employee_id [String] Employee id for single object
1601
1620
  # @param pay_template_earning_id [String] Id for single pay template earnings object
@@ -1606,13 +1625,14 @@ module XeroRuby
1606
1625
  data
1607
1626
  end
1608
1627
 
1609
- # deletes an employee earnings template record
1628
+ # Deletes an employee&#39;s earnings template record
1610
1629
  # @param xero_tenant_id [String] Xero identifier for Tenant
1611
1630
  # @param employee_id [String] Employee id for single object
1612
1631
  # @param pay_template_earning_id [String] Id for single pay template earnings object
1613
1632
  # @param [Hash] opts the optional parameters
1614
1633
  # @return [Array<(EarningsTemplateObject, Integer, Hash)>] EarningsTemplateObject data, response status code and response headers
1615
- def delete_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, opts = {})
1634
+ def delete_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, options = {})
1635
+ opts = options.dup
1616
1636
  if @api_client.config.debugging
1617
1637
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.delete_employee_earnings_template ...'
1618
1638
  end
@@ -1629,7 +1649,7 @@ module XeroRuby
1629
1649
  fail ArgumentError, "Missing the required parameter 'pay_template_earning_id' when calling PayrollNzApi.delete_employee_earnings_template"
1630
1650
  end
1631
1651
  # resource path
1632
- local_var_path = '/Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s).sub('{' + 'PayTemplateEarningID' + '}', pay_template_earning_id.to_s)
1652
+ local_var_path = '/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'PayTemplateEarningID' + '}', pay_template_earning_id.to_s)
1633
1653
 
1634
1654
  # camelize keys of incoming `where` opts
1635
1655
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -1675,7 +1695,7 @@ module XeroRuby
1675
1695
  return data, status_code, headers
1676
1696
  end
1677
1697
 
1678
- # deletes an employee leave record
1698
+ # Deletes a leave record for a specific employee
1679
1699
  # @param xero_tenant_id [String] Xero identifier for Tenant
1680
1700
  # @param employee_id [String] Employee id for single object
1681
1701
  # @param leave_id [String] Leave id for single object
@@ -1686,13 +1706,14 @@ module XeroRuby
1686
1706
  data
1687
1707
  end
1688
1708
 
1689
- # deletes an employee leave record
1709
+ # Deletes a leave record for a specific employee
1690
1710
  # @param xero_tenant_id [String] Xero identifier for Tenant
1691
1711
  # @param employee_id [String] Employee id for single object
1692
1712
  # @param leave_id [String] Leave id for single object
1693
1713
  # @param [Hash] opts the optional parameters
1694
1714
  # @return [Array<(EmployeeLeaveObject, Integer, Hash)>] EmployeeLeaveObject data, response status code and response headers
1695
- def delete_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, opts = {})
1715
+ def delete_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, options = {})
1716
+ opts = options.dup
1696
1717
  if @api_client.config.debugging
1697
1718
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.delete_employee_leave ...'
1698
1719
  end
@@ -1709,7 +1730,7 @@ module XeroRuby
1709
1730
  fail ArgumentError, "Missing the required parameter 'leave_id' when calling PayrollNzApi.delete_employee_leave"
1710
1731
  end
1711
1732
  # resource path
1712
- local_var_path = '/Employees/{EmployeeId}/Leave/{LeaveID}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s).sub('{' + 'LeaveID' + '}', leave_id.to_s)
1733
+ local_var_path = '/Employees/{EmployeeID}/Leave/{LeaveID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'LeaveID' + '}', leave_id.to_s)
1713
1734
 
1714
1735
  # camelize keys of incoming `where` opts
1715
1736
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -1755,7 +1776,7 @@ module XeroRuby
1755
1776
  return data, status_code, headers
1756
1777
  end
1757
1778
 
1758
- # deletes an employee salary and wages record
1779
+ # Deletes an employee's salary and wages record
1759
1780
  # @param xero_tenant_id [String] Xero identifier for Tenant
1760
1781
  # @param employee_id [String] Employee id for single object
1761
1782
  # @param salary_and_wages_id [String] Id for single salary and wages object
@@ -1766,13 +1787,14 @@ module XeroRuby
1766
1787
  data
1767
1788
  end
1768
1789
 
1769
- # deletes an employee salary and wages record
1790
+ # Deletes an employee&#39;s salary and wages record
1770
1791
  # @param xero_tenant_id [String] Xero identifier for Tenant
1771
1792
  # @param employee_id [String] Employee id for single object
1772
1793
  # @param salary_and_wages_id [String] Id for single salary and wages object
1773
1794
  # @param [Hash] opts the optional parameters
1774
1795
  # @return [Array<(SalaryAndWageObject, Integer, Hash)>] SalaryAndWageObject data, response status code and response headers
1775
- def delete_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, opts = {})
1796
+ def delete_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, options = {})
1797
+ opts = options.dup
1776
1798
  if @api_client.config.debugging
1777
1799
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.delete_employee_salary_and_wage ...'
1778
1800
  end
@@ -1789,7 +1811,7 @@ module XeroRuby
1789
1811
  fail ArgumentError, "Missing the required parameter 'salary_and_wages_id' when calling PayrollNzApi.delete_employee_salary_and_wage"
1790
1812
  end
1791
1813
  # resource path
1792
- local_var_path = '/Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s).sub('{' + 'SalaryAndWagesID' + '}', salary_and_wages_id.to_s)
1814
+ local_var_path = '/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'SalaryAndWagesID' + '}', salary_and_wages_id.to_s)
1793
1815
 
1794
1816
  # camelize keys of incoming `where` opts
1795
1817
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -1835,7 +1857,7 @@ module XeroRuby
1835
1857
  return data, status_code, headers
1836
1858
  end
1837
1859
 
1838
- # delete a timesheet
1860
+ # Deletes a timesheet
1839
1861
  # @param xero_tenant_id [String] Xero identifier for Tenant
1840
1862
  # @param timesheet_id [String] Identifier for the timesheet
1841
1863
  # @param [Hash] opts the optional parameters
@@ -1845,12 +1867,13 @@ module XeroRuby
1845
1867
  data
1846
1868
  end
1847
1869
 
1848
- # delete a timesheet
1870
+ # Deletes a timesheet
1849
1871
  # @param xero_tenant_id [String] Xero identifier for Tenant
1850
1872
  # @param timesheet_id [String] Identifier for the timesheet
1851
1873
  # @param [Hash] opts the optional parameters
1852
1874
  # @return [Array<(TimesheetLine, Integer, Hash)>] TimesheetLine data, response status code and response headers
1853
- def delete_timesheet_with_http_info(xero_tenant_id, timesheet_id, opts = {})
1875
+ def delete_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {})
1876
+ opts = options.dup
1854
1877
  if @api_client.config.debugging
1855
1878
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.delete_timesheet ...'
1856
1879
  end
@@ -1909,7 +1932,7 @@ module XeroRuby
1909
1932
  return data, status_code, headers
1910
1933
  end
1911
1934
 
1912
- # delete a timesheet line
1935
+ # Deletes a timesheet line for a specific timesheet
1913
1936
  # @param xero_tenant_id [String] Xero identifier for Tenant
1914
1937
  # @param timesheet_id [String] Identifier for the timesheet
1915
1938
  # @param timesheet_line_id [String] Identifier for the timesheet line
@@ -1920,13 +1943,14 @@ module XeroRuby
1920
1943
  data
1921
1944
  end
1922
1945
 
1923
- # delete a timesheet line
1946
+ # Deletes a timesheet line for a specific timesheet
1924
1947
  # @param xero_tenant_id [String] Xero identifier for Tenant
1925
1948
  # @param timesheet_id [String] Identifier for the timesheet
1926
1949
  # @param timesheet_line_id [String] Identifier for the timesheet line
1927
1950
  # @param [Hash] opts the optional parameters
1928
1951
  # @return [Array<(TimesheetLine, Integer, Hash)>] TimesheetLine data, response status code and response headers
1929
- def delete_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, opts = {})
1952
+ def delete_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, options = {})
1953
+ opts = options.dup
1930
1954
  if @api_client.config.debugging
1931
1955
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.delete_timesheet_line ...'
1932
1956
  end
@@ -1989,7 +2013,7 @@ module XeroRuby
1989
2013
  return data, status_code, headers
1990
2014
  end
1991
2015
 
1992
- # retrieve a single deduction by id
2016
+ # Retrieves a single deduction by using a unique deduction ID
1993
2017
  # @param xero_tenant_id [String] Xero identifier for Tenant
1994
2018
  # @param deduction_id [String] Identifier for the deduction
1995
2019
  # @param [Hash] opts the optional parameters
@@ -1999,12 +2023,13 @@ module XeroRuby
1999
2023
  data
2000
2024
  end
2001
2025
 
2002
- # retrieve a single deduction by id
2026
+ # Retrieves a single deduction by using a unique deduction ID
2003
2027
  # @param xero_tenant_id [String] Xero identifier for Tenant
2004
2028
  # @param deduction_id [String] Identifier for the deduction
2005
2029
  # @param [Hash] opts the optional parameters
2006
2030
  # @return [Array<(DeductionObject, Integer, Hash)>] DeductionObject data, response status code and response headers
2007
- def get_deduction_with_http_info(xero_tenant_id, deduction_id, opts = {})
2031
+ def get_deduction_with_http_info(xero_tenant_id, deduction_id, options = {})
2032
+ opts = options.dup
2008
2033
  if @api_client.config.debugging
2009
2034
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_deduction ...'
2010
2035
  end
@@ -2063,7 +2088,7 @@ module XeroRuby
2063
2088
  return data, status_code, headers
2064
2089
  end
2065
2090
 
2066
- # searches deductions
2091
+ # Retrieves deductions for a specific employee
2067
2092
  # @param xero_tenant_id [String] Xero identifier for Tenant
2068
2093
  # @param [Hash] opts the optional parameters
2069
2094
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
@@ -2073,12 +2098,13 @@ module XeroRuby
2073
2098
  data
2074
2099
  end
2075
2100
 
2076
- # searches deductions
2101
+ # Retrieves deductions for a specific employee
2077
2102
  # @param xero_tenant_id [String] Xero identifier for Tenant
2078
2103
  # @param [Hash] opts the optional parameters
2079
2104
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
2080
2105
  # @return [Array<(Deductions, Integer, Hash)>] Deductions data, response status code and response headers
2081
- def get_deductions_with_http_info(xero_tenant_id, opts = {})
2106
+ def get_deductions_with_http_info(xero_tenant_id, options = {})
2107
+ opts = options.dup
2082
2108
  if @api_client.config.debugging
2083
2109
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_deductions ...'
2084
2110
  end
@@ -2134,7 +2160,7 @@ module XeroRuby
2134
2160
  return data, status_code, headers
2135
2161
  end
2136
2162
 
2137
- # retrieve a single earnings rates by id
2163
+ # Retrieves a specific earnings rates by using a unique earnings rate id
2138
2164
  # @param xero_tenant_id [String] Xero identifier for Tenant
2139
2165
  # @param earnings_rate_id [String] Identifier for the earnings rate
2140
2166
  # @param [Hash] opts the optional parameters
@@ -2144,12 +2170,13 @@ module XeroRuby
2144
2170
  data
2145
2171
  end
2146
2172
 
2147
- # retrieve a single earnings rates by id
2173
+ # Retrieves a specific earnings rates by using a unique earnings rate id
2148
2174
  # @param xero_tenant_id [String] Xero identifier for Tenant
2149
2175
  # @param earnings_rate_id [String] Identifier for the earnings rate
2150
2176
  # @param [Hash] opts the optional parameters
2151
2177
  # @return [Array<(EarningsRateObject, Integer, Hash)>] EarningsRateObject data, response status code and response headers
2152
- def get_earnings_rate_with_http_info(xero_tenant_id, earnings_rate_id, opts = {})
2178
+ def get_earnings_rate_with_http_info(xero_tenant_id, earnings_rate_id, options = {})
2179
+ opts = options.dup
2153
2180
  if @api_client.config.debugging
2154
2181
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_earnings_rate ...'
2155
2182
  end
@@ -2208,7 +2235,7 @@ module XeroRuby
2208
2235
  return data, status_code, headers
2209
2236
  end
2210
2237
 
2211
- # searches earnings rates
2238
+ # Retrieves earnings rates
2212
2239
  # @param xero_tenant_id [String] Xero identifier for Tenant
2213
2240
  # @param [Hash] opts the optional parameters
2214
2241
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
@@ -2218,12 +2245,13 @@ module XeroRuby
2218
2245
  data
2219
2246
  end
2220
2247
 
2221
- # searches earnings rates
2248
+ # Retrieves earnings rates
2222
2249
  # @param xero_tenant_id [String] Xero identifier for Tenant
2223
2250
  # @param [Hash] opts the optional parameters
2224
2251
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
2225
2252
  # @return [Array<(EarningsRates, Integer, Hash)>] EarningsRates data, response status code and response headers
2226
- def get_earnings_rates_with_http_info(xero_tenant_id, opts = {})
2253
+ def get_earnings_rates_with_http_info(xero_tenant_id, options = {})
2254
+ opts = options.dup
2227
2255
  if @api_client.config.debugging
2228
2256
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_earnings_rates ...'
2229
2257
  end
@@ -2279,7 +2307,7 @@ module XeroRuby
2279
2307
  return data, status_code, headers
2280
2308
  end
2281
2309
 
2282
- # searches employees
2310
+ # Retrieves an employees using a unique employee ID
2283
2311
  # @param xero_tenant_id [String] Xero identifier for Tenant
2284
2312
  # @param employee_id [String] Employee id for single object
2285
2313
  # @param [Hash] opts the optional parameters
@@ -2289,12 +2317,13 @@ module XeroRuby
2289
2317
  data
2290
2318
  end
2291
2319
 
2292
- # searches employees
2320
+ # Retrieves an employees using a unique employee ID
2293
2321
  # @param xero_tenant_id [String] Xero identifier for Tenant
2294
2322
  # @param employee_id [String] Employee id for single object
2295
2323
  # @param [Hash] opts the optional parameters
2296
2324
  # @return [Array<(EmployeeObject, Integer, Hash)>] EmployeeObject data, response status code and response headers
2297
- def get_employee_with_http_info(xero_tenant_id, employee_id, opts = {})
2325
+ def get_employee_with_http_info(xero_tenant_id, employee_id, options = {})
2326
+ opts = options.dup
2298
2327
  if @api_client.config.debugging
2299
2328
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_employee ...'
2300
2329
  end
@@ -2307,7 +2336,7 @@ module XeroRuby
2307
2336
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollNzApi.get_employee"
2308
2337
  end
2309
2338
  # resource path
2310
- local_var_path = '/Employees/{EmployeeId}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
2339
+ local_var_path = '/Employees/{EmployeeID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
2311
2340
 
2312
2341
  # camelize keys of incoming `where` opts
2313
2342
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -2353,7 +2382,7 @@ module XeroRuby
2353
2382
  return data, status_code, headers
2354
2383
  end
2355
2384
 
2356
- # search employee leave balances
2385
+ # Retrieves leave balances for a specific employee
2357
2386
  # @param xero_tenant_id [String] Xero identifier for Tenant
2358
2387
  # @param employee_id [String] Employee id for single object
2359
2388
  # @param [Hash] opts the optional parameters
@@ -2363,12 +2392,13 @@ module XeroRuby
2363
2392
  data
2364
2393
  end
2365
2394
 
2366
- # search employee leave balances
2395
+ # Retrieves leave balances for a specific employee
2367
2396
  # @param xero_tenant_id [String] Xero identifier for Tenant
2368
2397
  # @param employee_id [String] Employee id for single object
2369
2398
  # @param [Hash] opts the optional parameters
2370
2399
  # @return [Array<(EmployeeLeaveBalances, Integer, Hash)>] EmployeeLeaveBalances data, response status code and response headers
2371
- def get_employee_leave_balances_with_http_info(xero_tenant_id, employee_id, opts = {})
2400
+ def get_employee_leave_balances_with_http_info(xero_tenant_id, employee_id, options = {})
2401
+ opts = options.dup
2372
2402
  if @api_client.config.debugging
2373
2403
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_employee_leave_balances ...'
2374
2404
  end
@@ -2381,7 +2411,7 @@ module XeroRuby
2381
2411
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollNzApi.get_employee_leave_balances"
2382
2412
  end
2383
2413
  # resource path
2384
- local_var_path = '/Employees/{EmployeeId}/LeaveBalances'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
2414
+ local_var_path = '/Employees/{EmployeeID}/LeaveBalances'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
2385
2415
 
2386
2416
  # camelize keys of incoming `where` opts
2387
2417
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -2427,7 +2457,7 @@ module XeroRuby
2427
2457
  return data, status_code, headers
2428
2458
  end
2429
2459
 
2430
- # searches employee leave periods
2460
+ # Retrieves leave periods for a specific employee
2431
2461
  # @param xero_tenant_id [String] Xero identifier for Tenant
2432
2462
  # @param employee_id [String] Employee id for single object
2433
2463
  # @param [Hash] opts the optional parameters
@@ -2439,14 +2469,15 @@ module XeroRuby
2439
2469
  data
2440
2470
  end
2441
2471
 
2442
- # searches employee leave periods
2472
+ # Retrieves leave periods for a specific employee
2443
2473
  # @param xero_tenant_id [String] Xero identifier for Tenant
2444
2474
  # @param employee_id [String] Employee id for single object
2445
2475
  # @param [Hash] opts the optional parameters
2446
2476
  # @option opts [Date] :start_date Filter by start date
2447
2477
  # @option opts [Date] :end_date Filter by end date
2448
2478
  # @return [Array<(LeavePeriods, Integer, Hash)>] LeavePeriods data, response status code and response headers
2449
- def get_employee_leave_periods_with_http_info(xero_tenant_id, employee_id, opts = {})
2479
+ def get_employee_leave_periods_with_http_info(xero_tenant_id, employee_id, options = {})
2480
+ opts = options.dup
2450
2481
  if @api_client.config.debugging
2451
2482
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_employee_leave_periods ...'
2452
2483
  end
@@ -2459,7 +2490,7 @@ module XeroRuby
2459
2490
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollNzApi.get_employee_leave_periods"
2460
2491
  end
2461
2492
  # resource path
2462
- local_var_path = '/Employees/{EmployeeId}/LeavePeriods'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
2493
+ local_var_path = '/Employees/{EmployeeID}/LeavePeriods'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
2463
2494
 
2464
2495
  # camelize keys of incoming `where` opts
2465
2496
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -2507,7 +2538,7 @@ module XeroRuby
2507
2538
  return data, status_code, headers
2508
2539
  end
2509
2540
 
2510
- # searches employee leave types
2541
+ # Retrieves leave types for a specific employee
2511
2542
  # @param xero_tenant_id [String] Xero identifier for Tenant
2512
2543
  # @param employee_id [String] Employee id for single object
2513
2544
  # @param [Hash] opts the optional parameters
@@ -2517,12 +2548,13 @@ module XeroRuby
2517
2548
  data
2518
2549
  end
2519
2550
 
2520
- # searches employee leave types
2551
+ # Retrieves leave types for a specific employee
2521
2552
  # @param xero_tenant_id [String] Xero identifier for Tenant
2522
2553
  # @param employee_id [String] Employee id for single object
2523
2554
  # @param [Hash] opts the optional parameters
2524
2555
  # @return [Array<(EmployeeLeaveTypes, Integer, Hash)>] EmployeeLeaveTypes data, response status code and response headers
2525
- def get_employee_leave_types_with_http_info(xero_tenant_id, employee_id, opts = {})
2556
+ def get_employee_leave_types_with_http_info(xero_tenant_id, employee_id, options = {})
2557
+ opts = options.dup
2526
2558
  if @api_client.config.debugging
2527
2559
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_employee_leave_types ...'
2528
2560
  end
@@ -2535,7 +2567,7 @@ module XeroRuby
2535
2567
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollNzApi.get_employee_leave_types"
2536
2568
  end
2537
2569
  # resource path
2538
- local_var_path = '/Employees/{EmployeeId}/LeaveTypes'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
2570
+ local_var_path = '/Employees/{EmployeeID}/LeaveTypes'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
2539
2571
 
2540
2572
  # camelize keys of incoming `where` opts
2541
2573
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -2581,7 +2613,7 @@ module XeroRuby
2581
2613
  return data, status_code, headers
2582
2614
  end
2583
2615
 
2584
- # search employee leave records
2616
+ # Retrieves leave records for a specific employee
2585
2617
  # @param xero_tenant_id [String] Xero identifier for Tenant
2586
2618
  # @param employee_id [String] Employee id for single object
2587
2619
  # @param [Hash] opts the optional parameters
@@ -2591,12 +2623,13 @@ module XeroRuby
2591
2623
  data
2592
2624
  end
2593
2625
 
2594
- # search employee leave records
2626
+ # Retrieves leave records for a specific employee
2595
2627
  # @param xero_tenant_id [String] Xero identifier for Tenant
2596
2628
  # @param employee_id [String] Employee id for single object
2597
2629
  # @param [Hash] opts the optional parameters
2598
2630
  # @return [Array<(EmployeeLeaves, Integer, Hash)>] EmployeeLeaves data, response status code and response headers
2599
- def get_employee_leaves_with_http_info(xero_tenant_id, employee_id, opts = {})
2631
+ def get_employee_leaves_with_http_info(xero_tenant_id, employee_id, options = {})
2632
+ opts = options.dup
2600
2633
  if @api_client.config.debugging
2601
2634
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_employee_leaves ...'
2602
2635
  end
@@ -2609,7 +2642,7 @@ module XeroRuby
2609
2642
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollNzApi.get_employee_leaves"
2610
2643
  end
2611
2644
  # resource path
2612
- local_var_path = '/Employees/{EmployeeId}/Leave'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
2645
+ local_var_path = '/Employees/{EmployeeID}/Leave'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
2613
2646
 
2614
2647
  # camelize keys of incoming `where` opts
2615
2648
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -2655,7 +2688,7 @@ module XeroRuby
2655
2688
  return data, status_code, headers
2656
2689
  end
2657
2690
 
2658
- # retrieve employee openingbalances
2691
+ # Retrieves the opening balance for a specific employee
2659
2692
  # @param xero_tenant_id [String] Xero identifier for Tenant
2660
2693
  # @param employee_id [String] Employee id for single object
2661
2694
  # @param [Hash] opts the optional parameters
@@ -2665,12 +2698,13 @@ module XeroRuby
2665
2698
  data
2666
2699
  end
2667
2700
 
2668
- # retrieve employee openingbalances
2701
+ # Retrieves the opening balance for a specific employee
2669
2702
  # @param xero_tenant_id [String] Xero identifier for Tenant
2670
2703
  # @param employee_id [String] Employee id for single object
2671
2704
  # @param [Hash] opts the optional parameters
2672
2705
  # @return [Array<(EmployeeOpeningBalancesObject, Integer, Hash)>] EmployeeOpeningBalancesObject data, response status code and response headers
2673
- def get_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, opts = {})
2706
+ def get_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, options = {})
2707
+ opts = options.dup
2674
2708
  if @api_client.config.debugging
2675
2709
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_employee_opening_balances ...'
2676
2710
  end
@@ -2683,7 +2717,7 @@ module XeroRuby
2683
2717
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollNzApi.get_employee_opening_balances"
2684
2718
  end
2685
2719
  # resource path
2686
- local_var_path = '/Employees/{EmployeeId}/openingBalances'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
2720
+ local_var_path = '/Employees/{EmployeeID}/openingBalances'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
2687
2721
 
2688
2722
  # camelize keys of incoming `where` opts
2689
2723
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -2729,7 +2763,7 @@ module XeroRuby
2729
2763
  return data, status_code, headers
2730
2764
  end
2731
2765
 
2732
- # searches employee pay templates
2766
+ # Retrieves pay templates for a specific employee
2733
2767
  # @param xero_tenant_id [String] Xero identifier for Tenant
2734
2768
  # @param employee_id [String] Employee id for single object
2735
2769
  # @param [Hash] opts the optional parameters
@@ -2739,12 +2773,13 @@ module XeroRuby
2739
2773
  data
2740
2774
  end
2741
2775
 
2742
- # searches employee pay templates
2776
+ # Retrieves pay templates for a specific employee
2743
2777
  # @param xero_tenant_id [String] Xero identifier for Tenant
2744
2778
  # @param employee_id [String] Employee id for single object
2745
2779
  # @param [Hash] opts the optional parameters
2746
2780
  # @return [Array<(EmployeePayTemplates, Integer, Hash)>] EmployeePayTemplates data, response status code and response headers
2747
- def get_employee_pay_templates_with_http_info(xero_tenant_id, employee_id, opts = {})
2781
+ def get_employee_pay_templates_with_http_info(xero_tenant_id, employee_id, options = {})
2782
+ opts = options.dup
2748
2783
  if @api_client.config.debugging
2749
2784
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_employee_pay_templates ...'
2750
2785
  end
@@ -2757,7 +2792,7 @@ module XeroRuby
2757
2792
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollNzApi.get_employee_pay_templates"
2758
2793
  end
2759
2794
  # resource path
2760
- local_var_path = '/Employees/{EmployeeId}/PayTemplates'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
2795
+ local_var_path = '/Employees/{EmployeeID}/PayTemplates'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
2761
2796
 
2762
2797
  # camelize keys of incoming `where` opts
2763
2798
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -2803,7 +2838,7 @@ module XeroRuby
2803
2838
  return data, status_code, headers
2804
2839
  end
2805
2840
 
2806
- # retrieves an employee's payment method
2841
+ # Retrieves available payment methods for a specific employee
2807
2842
  # @param xero_tenant_id [String] Xero identifier for Tenant
2808
2843
  # @param employee_id [String] Employee id for single object
2809
2844
  # @param [Hash] opts the optional parameters
@@ -2813,12 +2848,13 @@ module XeroRuby
2813
2848
  data
2814
2849
  end
2815
2850
 
2816
- # retrieves an employee&#39;s payment method
2851
+ # Retrieves available payment methods for a specific employee
2817
2852
  # @param xero_tenant_id [String] Xero identifier for Tenant
2818
2853
  # @param employee_id [String] Employee id for single object
2819
2854
  # @param [Hash] opts the optional parameters
2820
2855
  # @return [Array<(PaymentMethodObject, Integer, Hash)>] PaymentMethodObject data, response status code and response headers
2821
- def get_employee_payment_method_with_http_info(xero_tenant_id, employee_id, opts = {})
2856
+ def get_employee_payment_method_with_http_info(xero_tenant_id, employee_id, options = {})
2857
+ opts = options.dup
2822
2858
  if @api_client.config.debugging
2823
2859
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_employee_payment_method ...'
2824
2860
  end
@@ -2831,7 +2867,7 @@ module XeroRuby
2831
2867
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollNzApi.get_employee_payment_method"
2832
2868
  end
2833
2869
  # resource path
2834
- local_var_path = '/Employees/{EmployeeId}/PaymentMethods'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
2870
+ local_var_path = '/Employees/{EmployeeID}/PaymentMethods'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
2835
2871
 
2836
2872
  # camelize keys of incoming `where` opts
2837
2873
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -2877,7 +2913,7 @@ module XeroRuby
2877
2913
  return data, status_code, headers
2878
2914
  end
2879
2915
 
2880
- # get employee salary and wages record by id
2916
+ # Retrieves an employee's salary and wages record by using a unique salary and wage ID
2881
2917
  # @param xero_tenant_id [String] Xero identifier for Tenant
2882
2918
  # @param employee_id [String] Employee id for single object
2883
2919
  # @param salary_and_wages_id [String] Id for single pay template earnings object
@@ -2888,13 +2924,14 @@ module XeroRuby
2888
2924
  data
2889
2925
  end
2890
2926
 
2891
- # get employee salary and wages record by id
2927
+ # Retrieves an employee&#39;s salary and wages record by using a unique salary and wage ID
2892
2928
  # @param xero_tenant_id [String] Xero identifier for Tenant
2893
2929
  # @param employee_id [String] Employee id for single object
2894
2930
  # @param salary_and_wages_id [String] Id for single pay template earnings object
2895
2931
  # @param [Hash] opts the optional parameters
2896
2932
  # @return [Array<(SalaryAndWages, Integer, Hash)>] SalaryAndWages data, response status code and response headers
2897
- def get_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, opts = {})
2933
+ def get_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, options = {})
2934
+ opts = options.dup
2898
2935
  if @api_client.config.debugging
2899
2936
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_employee_salary_and_wage ...'
2900
2937
  end
@@ -2911,7 +2948,7 @@ module XeroRuby
2911
2948
  fail ArgumentError, "Missing the required parameter 'salary_and_wages_id' when calling PayrollNzApi.get_employee_salary_and_wage"
2912
2949
  end
2913
2950
  # resource path
2914
- local_var_path = '/Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s).sub('{' + 'SalaryAndWagesID' + '}', salary_and_wages_id.to_s)
2951
+ local_var_path = '/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'SalaryAndWagesID' + '}', salary_and_wages_id.to_s)
2915
2952
 
2916
2953
  # camelize keys of incoming `where` opts
2917
2954
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -2957,7 +2994,7 @@ module XeroRuby
2957
2994
  return data, status_code, headers
2958
2995
  end
2959
2996
 
2960
- # retrieves an employee's salary and wages
2997
+ # Retrieves an employee's salary and wages
2961
2998
  # @param xero_tenant_id [String] Xero identifier for Tenant
2962
2999
  # @param employee_id [String] Employee id for single object
2963
3000
  # @param [Hash] opts the optional parameters
@@ -2968,13 +3005,14 @@ module XeroRuby
2968
3005
  data
2969
3006
  end
2970
3007
 
2971
- # retrieves an employee&#39;s salary and wages
3008
+ # Retrieves an employee&#39;s salary and wages
2972
3009
  # @param xero_tenant_id [String] Xero identifier for Tenant
2973
3010
  # @param employee_id [String] Employee id for single object
2974
3011
  # @param [Hash] opts the optional parameters
2975
3012
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
2976
3013
  # @return [Array<(SalaryAndWages, Integer, Hash)>] SalaryAndWages data, response status code and response headers
2977
- def get_employee_salary_and_wages_with_http_info(xero_tenant_id, employee_id, opts = {})
3014
+ def get_employee_salary_and_wages_with_http_info(xero_tenant_id, employee_id, options = {})
3015
+ opts = options.dup
2978
3016
  if @api_client.config.debugging
2979
3017
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_employee_salary_and_wages ...'
2980
3018
  end
@@ -2987,7 +3025,7 @@ module XeroRuby
2987
3025
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollNzApi.get_employee_salary_and_wages"
2988
3026
  end
2989
3027
  # resource path
2990
- local_var_path = '/Employees/{EmployeeId}/SalaryAndWages'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
3028
+ local_var_path = '/Employees/{EmployeeID}/SalaryAndWages'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
2991
3029
 
2992
3030
  # camelize keys of incoming `where` opts
2993
3031
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -3034,7 +3072,7 @@ module XeroRuby
3034
3072
  return data, status_code, headers
3035
3073
  end
3036
3074
 
3037
- # searches tax records for an employee
3075
+ # Retrieves tax records for a specific employee
3038
3076
  # @param xero_tenant_id [String] Xero identifier for Tenant
3039
3077
  # @param employee_id [String] Employee id for single object
3040
3078
  # @param [Hash] opts the optional parameters
@@ -3044,12 +3082,13 @@ module XeroRuby
3044
3082
  data
3045
3083
  end
3046
3084
 
3047
- # searches tax records for an employee
3085
+ # Retrieves tax records for a specific employee
3048
3086
  # @param xero_tenant_id [String] Xero identifier for Tenant
3049
3087
  # @param employee_id [String] Employee id for single object
3050
3088
  # @param [Hash] opts the optional parameters
3051
3089
  # @return [Array<(EmployeeTaxObject, Integer, Hash)>] EmployeeTaxObject data, response status code and response headers
3052
- def get_employee_tax_with_http_info(xero_tenant_id, employee_id, opts = {})
3090
+ def get_employee_tax_with_http_info(xero_tenant_id, employee_id, options = {})
3091
+ opts = options.dup
3053
3092
  if @api_client.config.debugging
3054
3093
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_employee_tax ...'
3055
3094
  end
@@ -3062,7 +3101,7 @@ module XeroRuby
3062
3101
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollNzApi.get_employee_tax"
3063
3102
  end
3064
3103
  # resource path
3065
- local_var_path = '/Employees/{EmployeeId}/Tax'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
3104
+ local_var_path = '/Employees/{EmployeeID}/Tax'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
3066
3105
 
3067
3106
  # camelize keys of incoming `where` opts
3068
3107
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -3108,7 +3147,7 @@ module XeroRuby
3108
3147
  return data, status_code, headers
3109
3148
  end
3110
3149
 
3111
- # searches employees
3150
+ # Retrieves employees
3112
3151
  # @param xero_tenant_id [String] Xero identifier for Tenant
3113
3152
  # @param [Hash] opts the optional parameters
3114
3153
  # @option opts [String] :first_name Filter by first name
@@ -3120,14 +3159,15 @@ module XeroRuby
3120
3159
  data
3121
3160
  end
3122
3161
 
3123
- # searches employees
3162
+ # Retrieves employees
3124
3163
  # @param xero_tenant_id [String] Xero identifier for Tenant
3125
3164
  # @param [Hash] opts the optional parameters
3126
3165
  # @option opts [String] :first_name Filter by first name
3127
3166
  # @option opts [String] :last_name Filter by last name
3128
3167
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
3129
3168
  # @return [Array<(Employees, Integer, Hash)>] Employees data, response status code and response headers
3130
- def get_employees_with_http_info(xero_tenant_id, opts = {})
3169
+ def get_employees_with_http_info(xero_tenant_id, options = {})
3170
+ opts = options.dup
3131
3171
  if @api_client.config.debugging
3132
3172
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_employees ...'
3133
3173
  end
@@ -3185,7 +3225,7 @@ module XeroRuby
3185
3225
  return data, status_code, headers
3186
3226
  end
3187
3227
 
3188
- # retrieve a single leave type by id
3228
+ # Retrieves a specific leave type by using a unique leave type ID
3189
3229
  # @param xero_tenant_id [String] Xero identifier for Tenant
3190
3230
  # @param leave_type_id [String] Identifier for the leave type
3191
3231
  # @param [Hash] opts the optional parameters
@@ -3195,12 +3235,13 @@ module XeroRuby
3195
3235
  data
3196
3236
  end
3197
3237
 
3198
- # retrieve a single leave type by id
3238
+ # Retrieves a specific leave type by using a unique leave type ID
3199
3239
  # @param xero_tenant_id [String] Xero identifier for Tenant
3200
3240
  # @param leave_type_id [String] Identifier for the leave type
3201
3241
  # @param [Hash] opts the optional parameters
3202
3242
  # @return [Array<(LeaveTypeObject, Integer, Hash)>] LeaveTypeObject data, response status code and response headers
3203
- def get_leave_type_with_http_info(xero_tenant_id, leave_type_id, opts = {})
3243
+ def get_leave_type_with_http_info(xero_tenant_id, leave_type_id, options = {})
3244
+ opts = options.dup
3204
3245
  if @api_client.config.debugging
3205
3246
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_leave_type ...'
3206
3247
  end
@@ -3259,7 +3300,7 @@ module XeroRuby
3259
3300
  return data, status_code, headers
3260
3301
  end
3261
3302
 
3262
- # searches leave types
3303
+ # Retrieves leave types
3263
3304
  # @param xero_tenant_id [String] Xero identifier for Tenant
3264
3305
  # @param [Hash] opts the optional parameters
3265
3306
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
@@ -3270,13 +3311,14 @@ module XeroRuby
3270
3311
  data
3271
3312
  end
3272
3313
 
3273
- # searches leave types
3314
+ # Retrieves leave types
3274
3315
  # @param xero_tenant_id [String] Xero identifier for Tenant
3275
3316
  # @param [Hash] opts the optional parameters
3276
3317
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
3277
3318
  # @option opts [Boolean] :active_only Filters leave types by active status. By default the API returns all leave types.
3278
3319
  # @return [Array<(LeaveTypes, Integer, Hash)>] LeaveTypes data, response status code and response headers
3279
- def get_leave_types_with_http_info(xero_tenant_id, opts = {})
3320
+ def get_leave_types_with_http_info(xero_tenant_id, options = {})
3321
+ opts = options.dup
3280
3322
  if @api_client.config.debugging
3281
3323
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_leave_types ...'
3282
3324
  end
@@ -3333,7 +3375,7 @@ module XeroRuby
3333
3375
  return data, status_code, headers
3334
3376
  end
3335
3377
 
3336
- # retrieve a single pay run by id
3378
+ # Retrieves a specific pay run by using a unique pay run ID
3337
3379
  # @param xero_tenant_id [String] Xero identifier for Tenant
3338
3380
  # @param pay_run_id [String] Identifier for the pay run
3339
3381
  # @param [Hash] opts the optional parameters
@@ -3343,12 +3385,13 @@ module XeroRuby
3343
3385
  data
3344
3386
  end
3345
3387
 
3346
- # retrieve a single pay run by id
3388
+ # Retrieves a specific pay run by using a unique pay run ID
3347
3389
  # @param xero_tenant_id [String] Xero identifier for Tenant
3348
3390
  # @param pay_run_id [String] Identifier for the pay run
3349
3391
  # @param [Hash] opts the optional parameters
3350
3392
  # @return [Array<(PayRunObject, Integer, Hash)>] PayRunObject data, response status code and response headers
3351
- def get_pay_run_with_http_info(xero_tenant_id, pay_run_id, opts = {})
3393
+ def get_pay_run_with_http_info(xero_tenant_id, pay_run_id, options = {})
3394
+ opts = options.dup
3352
3395
  if @api_client.config.debugging
3353
3396
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_pay_run ...'
3354
3397
  end
@@ -3407,7 +3450,7 @@ module XeroRuby
3407
3450
  return data, status_code, headers
3408
3451
  end
3409
3452
 
3410
- # retrieve a single payrun calendar by id
3453
+ # Retrieves a specific payrun calendar by using a unique payroll calendar ID
3411
3454
  # @param xero_tenant_id [String] Xero identifier for Tenant
3412
3455
  # @param payroll_calendar_id [String] Identifier for the payrun calendars
3413
3456
  # @param [Hash] opts the optional parameters
@@ -3417,12 +3460,13 @@ module XeroRuby
3417
3460
  data
3418
3461
  end
3419
3462
 
3420
- # retrieve a single payrun calendar by id
3463
+ # Retrieves a specific payrun calendar by using a unique payroll calendar ID
3421
3464
  # @param xero_tenant_id [String] Xero identifier for Tenant
3422
3465
  # @param payroll_calendar_id [String] Identifier for the payrun calendars
3423
3466
  # @param [Hash] opts the optional parameters
3424
3467
  # @return [Array<(PayRunCalendarObject, Integer, Hash)>] PayRunCalendarObject data, response status code and response headers
3425
- def get_pay_run_calendar_with_http_info(xero_tenant_id, payroll_calendar_id, opts = {})
3468
+ def get_pay_run_calendar_with_http_info(xero_tenant_id, payroll_calendar_id, options = {})
3469
+ opts = options.dup
3426
3470
  if @api_client.config.debugging
3427
3471
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_pay_run_calendar ...'
3428
3472
  end
@@ -3481,7 +3525,7 @@ module XeroRuby
3481
3525
  return data, status_code, headers
3482
3526
  end
3483
3527
 
3484
- # searches payrun calendars
3528
+ # Retrieves payrun calendars
3485
3529
  # @param xero_tenant_id [String] Xero identifier for Tenant
3486
3530
  # @param [Hash] opts the optional parameters
3487
3531
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
@@ -3491,12 +3535,13 @@ module XeroRuby
3491
3535
  data
3492
3536
  end
3493
3537
 
3494
- # searches payrun calendars
3538
+ # Retrieves payrun calendars
3495
3539
  # @param xero_tenant_id [String] Xero identifier for Tenant
3496
3540
  # @param [Hash] opts the optional parameters
3497
3541
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
3498
3542
  # @return [Array<(PayRunCalendars, Integer, Hash)>] PayRunCalendars data, response status code and response headers
3499
- def get_pay_run_calendars_with_http_info(xero_tenant_id, opts = {})
3543
+ def get_pay_run_calendars_with_http_info(xero_tenant_id, options = {})
3544
+ opts = options.dup
3500
3545
  if @api_client.config.debugging
3501
3546
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_pay_run_calendars ...'
3502
3547
  end
@@ -3552,7 +3597,7 @@ module XeroRuby
3552
3597
  return data, status_code, headers
3553
3598
  end
3554
3599
 
3555
- # searches pay runs
3600
+ # Retrieves pay runs
3556
3601
  # @param xero_tenant_id [String] Xero identifier for Tenant
3557
3602
  # @param [Hash] opts the optional parameters
3558
3603
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
@@ -3563,13 +3608,14 @@ module XeroRuby
3563
3608
  data
3564
3609
  end
3565
3610
 
3566
- # searches pay runs
3611
+ # Retrieves pay runs
3567
3612
  # @param xero_tenant_id [String] Xero identifier for Tenant
3568
3613
  # @param [Hash] opts the optional parameters
3569
3614
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
3570
3615
  # @option opts [String] :status By default get payruns will return all the payruns for an organization. You can add GET https://api.xero.com/payroll.xro/2.0/payRuns?statu&#x3D;{PayRunStatus} to filter the payruns by status.
3571
3616
  # @return [Array<(PayRuns, Integer, Hash)>] PayRuns data, response status code and response headers
3572
- def get_pay_runs_with_http_info(xero_tenant_id, opts = {})
3617
+ def get_pay_runs_with_http_info(xero_tenant_id, options = {})
3618
+ opts = options.dup
3573
3619
  if @api_client.config.debugging
3574
3620
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_pay_runs ...'
3575
3621
  end
@@ -3630,7 +3676,7 @@ module XeroRuby
3630
3676
  return data, status_code, headers
3631
3677
  end
3632
3678
 
3633
- # retrieve a single payslip by id
3679
+ # Retrieves a specific payslip by a unique pay slip ID
3634
3680
  # @param xero_tenant_id [String] Xero identifier for Tenant
3635
3681
  # @param pay_slip_id [String] Identifier for the payslip
3636
3682
  # @param [Hash] opts the optional parameters
@@ -3640,12 +3686,13 @@ module XeroRuby
3640
3686
  data
3641
3687
  end
3642
3688
 
3643
- # retrieve a single payslip by id
3689
+ # Retrieves a specific payslip by a unique pay slip ID
3644
3690
  # @param xero_tenant_id [String] Xero identifier for Tenant
3645
3691
  # @param pay_slip_id [String] Identifier for the payslip
3646
3692
  # @param [Hash] opts the optional parameters
3647
3693
  # @return [Array<(PaySlipObject, Integer, Hash)>] PaySlipObject data, response status code and response headers
3648
- def get_pay_slip_with_http_info(xero_tenant_id, pay_slip_id, opts = {})
3694
+ def get_pay_slip_with_http_info(xero_tenant_id, pay_slip_id, options = {})
3695
+ opts = options.dup
3649
3696
  if @api_client.config.debugging
3650
3697
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_pay_slip ...'
3651
3698
  end
@@ -3704,7 +3751,7 @@ module XeroRuby
3704
3751
  return data, status_code, headers
3705
3752
  end
3706
3753
 
3707
- # searches payslips
3754
+ # Retrieves payslips
3708
3755
  # @param xero_tenant_id [String] Xero identifier for Tenant
3709
3756
  # @param pay_run_id [String] PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun.
3710
3757
  # @param [Hash] opts the optional parameters
@@ -3715,13 +3762,14 @@ module XeroRuby
3715
3762
  data
3716
3763
  end
3717
3764
 
3718
- # searches payslips
3765
+ # Retrieves payslips
3719
3766
  # @param xero_tenant_id [String] Xero identifier for Tenant
3720
3767
  # @param pay_run_id [String] PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun.
3721
3768
  # @param [Hash] opts the optional parameters
3722
3769
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
3723
3770
  # @return [Array<(PaySlips, Integer, Hash)>] PaySlips data, response status code and response headers
3724
- def get_pay_slips_with_http_info(xero_tenant_id, pay_run_id, opts = {})
3771
+ def get_pay_slips_with_http_info(xero_tenant_id, pay_run_id, options = {})
3772
+ opts = options.dup
3725
3773
  if @api_client.config.debugging
3726
3774
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_pay_slips ...'
3727
3775
  end
@@ -3782,7 +3830,7 @@ module XeroRuby
3782
3830
  return data, status_code, headers
3783
3831
  end
3784
3832
 
3785
- # retrieve a single reimbursement by id
3833
+ # Retrieves a specific reimbursement by using a unique reimbursement ID
3786
3834
  # @param xero_tenant_id [String] Xero identifier for Tenant
3787
3835
  # @param reimbursement_id [String] Identifier for the reimbursement
3788
3836
  # @param [Hash] opts the optional parameters
@@ -3792,12 +3840,13 @@ module XeroRuby
3792
3840
  data
3793
3841
  end
3794
3842
 
3795
- # retrieve a single reimbursement by id
3843
+ # Retrieves a specific reimbursement by using a unique reimbursement ID
3796
3844
  # @param xero_tenant_id [String] Xero identifier for Tenant
3797
3845
  # @param reimbursement_id [String] Identifier for the reimbursement
3798
3846
  # @param [Hash] opts the optional parameters
3799
3847
  # @return [Array<(ReimbursementObject, Integer, Hash)>] ReimbursementObject data, response status code and response headers
3800
- def get_reimbursement_with_http_info(xero_tenant_id, reimbursement_id, opts = {})
3848
+ def get_reimbursement_with_http_info(xero_tenant_id, reimbursement_id, options = {})
3849
+ opts = options.dup
3801
3850
  if @api_client.config.debugging
3802
3851
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_reimbursement ...'
3803
3852
  end
@@ -3856,7 +3905,7 @@ module XeroRuby
3856
3905
  return data, status_code, headers
3857
3906
  end
3858
3907
 
3859
- # searches reimbursements
3908
+ # Retrieves reimbursements
3860
3909
  # @param xero_tenant_id [String] Xero identifier for Tenant
3861
3910
  # @param [Hash] opts the optional parameters
3862
3911
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
@@ -3866,12 +3915,13 @@ module XeroRuby
3866
3915
  data
3867
3916
  end
3868
3917
 
3869
- # searches reimbursements
3918
+ # Retrieves reimbursements
3870
3919
  # @param xero_tenant_id [String] Xero identifier for Tenant
3871
3920
  # @param [Hash] opts the optional parameters
3872
3921
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
3873
3922
  # @return [Array<(Reimbursements, Integer, Hash)>] Reimbursements data, response status code and response headers
3874
- def get_reimbursements_with_http_info(xero_tenant_id, opts = {})
3923
+ def get_reimbursements_with_http_info(xero_tenant_id, options = {})
3924
+ opts = options.dup
3875
3925
  if @api_client.config.debugging
3876
3926
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_reimbursements ...'
3877
3927
  end
@@ -3927,7 +3977,7 @@ module XeroRuby
3927
3977
  return data, status_code, headers
3928
3978
  end
3929
3979
 
3930
- # searches settings
3980
+ # Retrieves settings
3931
3981
  # @param xero_tenant_id [String] Xero identifier for Tenant
3932
3982
  # @param [Hash] opts the optional parameters
3933
3983
  # @return [Settings]
@@ -3936,11 +3986,12 @@ module XeroRuby
3936
3986
  data
3937
3987
  end
3938
3988
 
3939
- # searches settings
3989
+ # Retrieves settings
3940
3990
  # @param xero_tenant_id [String] Xero identifier for Tenant
3941
3991
  # @param [Hash] opts the optional parameters
3942
3992
  # @return [Array<(Settings, Integer, Hash)>] Settings data, response status code and response headers
3943
- def get_settings_with_http_info(xero_tenant_id, opts = {})
3993
+ def get_settings_with_http_info(xero_tenant_id, options = {})
3994
+ opts = options.dup
3944
3995
  if @api_client.config.debugging
3945
3996
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_settings ...'
3946
3997
  end
@@ -3995,7 +4046,7 @@ module XeroRuby
3995
4046
  return data, status_code, headers
3996
4047
  end
3997
4048
 
3998
- # retrieve a single statutory deduction by id
4049
+ # Retrieves a specific statutory deduction by using a unique statutory deductions id
3999
4050
  # @param xero_tenant_id [String] Xero identifier for Tenant
4000
4051
  # @param id [String] Identifier for the statutory deduction
4001
4052
  # @param [Hash] opts the optional parameters
@@ -4005,12 +4056,13 @@ module XeroRuby
4005
4056
  data
4006
4057
  end
4007
4058
 
4008
- # retrieve a single statutory deduction by id
4059
+ # Retrieves a specific statutory deduction by using a unique statutory deductions id
4009
4060
  # @param xero_tenant_id [String] Xero identifier for Tenant
4010
4061
  # @param id [String] Identifier for the statutory deduction
4011
4062
  # @param [Hash] opts the optional parameters
4012
4063
  # @return [Array<(StatutoryDeductionObject, Integer, Hash)>] StatutoryDeductionObject data, response status code and response headers
4013
- def get_statutory_deduction_with_http_info(xero_tenant_id, id, opts = {})
4064
+ def get_statutory_deduction_with_http_info(xero_tenant_id, id, options = {})
4065
+ opts = options.dup
4014
4066
  if @api_client.config.debugging
4015
4067
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_statutory_deduction ...'
4016
4068
  end
@@ -4023,7 +4075,7 @@ module XeroRuby
4023
4075
  fail ArgumentError, "Missing the required parameter 'id' when calling PayrollNzApi.get_statutory_deduction"
4024
4076
  end
4025
4077
  # resource path
4026
- local_var_path = '/StatutoryDeductions/{Id}'.sub('{' + 'Id' + '}', id.to_s)
4078
+ local_var_path = '/StatutoryDeductions/{id}'.sub('{' + 'id' + '}', id.to_s)
4027
4079
 
4028
4080
  # camelize keys of incoming `where` opts
4029
4081
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -4069,7 +4121,7 @@ module XeroRuby
4069
4121
  return data, status_code, headers
4070
4122
  end
4071
4123
 
4072
- # searches statutory deductions
4124
+ # Retrieves statutory deductions
4073
4125
  # @param xero_tenant_id [String] Xero identifier for Tenant
4074
4126
  # @param [Hash] opts the optional parameters
4075
4127
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
@@ -4079,12 +4131,13 @@ module XeroRuby
4079
4131
  data
4080
4132
  end
4081
4133
 
4082
- # searches statutory deductions
4134
+ # Retrieves statutory deductions
4083
4135
  # @param xero_tenant_id [String] Xero identifier for Tenant
4084
4136
  # @param [Hash] opts the optional parameters
4085
4137
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
4086
4138
  # @return [Array<(StatutoryDeductions, Integer, Hash)>] StatutoryDeductions data, response status code and response headers
4087
- def get_statutory_deductions_with_http_info(xero_tenant_id, opts = {})
4139
+ def get_statutory_deductions_with_http_info(xero_tenant_id, options = {})
4140
+ opts = options.dup
4088
4141
  if @api_client.config.debugging
4089
4142
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_statutory_deductions ...'
4090
4143
  end
@@ -4140,7 +4193,7 @@ module XeroRuby
4140
4193
  return data, status_code, headers
4141
4194
  end
4142
4195
 
4143
- # searches for a unique superannuation
4196
+ # Retrieves a specific superannuation using a unique superannuation ID
4144
4197
  # @param xero_tenant_id [String] Xero identifier for Tenant
4145
4198
  # @param superannuation_id [String] Identifier for the superannuation
4146
4199
  # @param [Hash] opts the optional parameters
@@ -4150,12 +4203,13 @@ module XeroRuby
4150
4203
  data
4151
4204
  end
4152
4205
 
4153
- # searches for a unique superannuation
4206
+ # Retrieves a specific superannuation using a unique superannuation ID
4154
4207
  # @param xero_tenant_id [String] Xero identifier for Tenant
4155
4208
  # @param superannuation_id [String] Identifier for the superannuation
4156
4209
  # @param [Hash] opts the optional parameters
4157
4210
  # @return [Array<(SuperannuationObject, Integer, Hash)>] SuperannuationObject data, response status code and response headers
4158
- def get_superannuation_with_http_info(xero_tenant_id, superannuation_id, opts = {})
4211
+ def get_superannuation_with_http_info(xero_tenant_id, superannuation_id, options = {})
4212
+ opts = options.dup
4159
4213
  if @api_client.config.debugging
4160
4214
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_superannuation ...'
4161
4215
  end
@@ -4168,7 +4222,7 @@ module XeroRuby
4168
4222
  fail ArgumentError, "Missing the required parameter 'superannuation_id' when calling PayrollNzApi.get_superannuation"
4169
4223
  end
4170
4224
  # resource path
4171
- local_var_path = '/superannuations/{SuperannuationID}'.sub('{' + 'SuperannuationID' + '}', superannuation_id.to_s)
4225
+ local_var_path = '/Superannuations/{SuperannuationID}'.sub('{' + 'SuperannuationID' + '}', superannuation_id.to_s)
4172
4226
 
4173
4227
  # camelize keys of incoming `where` opts
4174
4228
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -4214,7 +4268,7 @@ module XeroRuby
4214
4268
  return data, status_code, headers
4215
4269
  end
4216
4270
 
4217
- # searches statutory deductions
4271
+ # Retrieves superannuations
4218
4272
  # @param xero_tenant_id [String] Xero identifier for Tenant
4219
4273
  # @param [Hash] opts the optional parameters
4220
4274
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
@@ -4224,12 +4278,13 @@ module XeroRuby
4224
4278
  data
4225
4279
  end
4226
4280
 
4227
- # searches statutory deductions
4281
+ # Retrieves superannuations
4228
4282
  # @param xero_tenant_id [String] Xero identifier for Tenant
4229
4283
  # @param [Hash] opts the optional parameters
4230
4284
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
4231
4285
  # @return [Array<(Superannuations, Integer, Hash)>] Superannuations data, response status code and response headers
4232
- def get_superannuations_with_http_info(xero_tenant_id, opts = {})
4286
+ def get_superannuations_with_http_info(xero_tenant_id, options = {})
4287
+ opts = options.dup
4233
4288
  if @api_client.config.debugging
4234
4289
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_superannuations ...'
4235
4290
  end
@@ -4238,7 +4293,7 @@ module XeroRuby
4238
4293
  fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling PayrollNzApi.get_superannuations"
4239
4294
  end
4240
4295
  # resource path
4241
- local_var_path = '/superannuations'
4296
+ local_var_path = '/Superannuations'
4242
4297
 
4243
4298
  # camelize keys of incoming `where` opts
4244
4299
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -4285,7 +4340,7 @@ module XeroRuby
4285
4340
  return data, status_code, headers
4286
4341
  end
4287
4342
 
4288
- # retrieve a single timesheet by id
4343
+ # Retrieves a specific timesheet by using a unique timesheet ID
4289
4344
  # @param xero_tenant_id [String] Xero identifier for Tenant
4290
4345
  # @param timesheet_id [String] Identifier for the timesheet
4291
4346
  # @param [Hash] opts the optional parameters
@@ -4295,12 +4350,13 @@ module XeroRuby
4295
4350
  data
4296
4351
  end
4297
4352
 
4298
- # retrieve a single timesheet by id
4353
+ # Retrieves a specific timesheet by using a unique timesheet ID
4299
4354
  # @param xero_tenant_id [String] Xero identifier for Tenant
4300
4355
  # @param timesheet_id [String] Identifier for the timesheet
4301
4356
  # @param [Hash] opts the optional parameters
4302
4357
  # @return [Array<(TimesheetObject, Integer, Hash)>] TimesheetObject data, response status code and response headers
4303
- def get_timesheet_with_http_info(xero_tenant_id, timesheet_id, opts = {})
4358
+ def get_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {})
4359
+ opts = options.dup
4304
4360
  if @api_client.config.debugging
4305
4361
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_timesheet ...'
4306
4362
  end
@@ -4359,11 +4415,11 @@ module XeroRuby
4359
4415
  return data, status_code, headers
4360
4416
  end
4361
4417
 
4362
- # searches timesheets
4418
+ # Retrieves timesheets
4363
4419
  # @param xero_tenant_id [String] Xero identifier for Tenant
4364
4420
  # @param [Hash] opts the optional parameters
4365
4421
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
4366
- # @option opts [String] :employee_id By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter&#x3D;employeeId&#x3D;&#x3D;{EmployeeId} to get only the timesheets of a particular employee.
4422
+ # @option opts [String] :employee_id By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter&#x3D;employeeId&#x3D;&#x3D;{EmployeeID} to get only the timesheets of a particular employee.
4367
4423
  # @option opts [String] :payroll_calendar_id By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter&#x3D;payrollCalendarId&#x3D;&#x3D;{PayrollCalendarID} to filter the timesheets by payroll calendar id
4368
4424
  # @return [Timesheets]
4369
4425
  def get_timesheets(xero_tenant_id, opts = {})
@@ -4371,14 +4427,15 @@ module XeroRuby
4371
4427
  data
4372
4428
  end
4373
4429
 
4374
- # searches timesheets
4430
+ # Retrieves timesheets
4375
4431
  # @param xero_tenant_id [String] Xero identifier for Tenant
4376
4432
  # @param [Hash] opts the optional parameters
4377
4433
  # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
4378
- # @option opts [String] :employee_id By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter&#x3D;employeeId&#x3D;&#x3D;{EmployeeId} to get only the timesheets of a particular employee.
4434
+ # @option opts [String] :employee_id By default get Timesheets will return the timesheets for all employees in an organization. You can add GET https://…/timesheets?filter&#x3D;employeeId&#x3D;&#x3D;{EmployeeID} to get only the timesheets of a particular employee.
4379
4435
  # @option opts [String] :payroll_calendar_id By default get Timesheets will return all the timesheets for an organization. You can add GET https://…/timesheets?filter&#x3D;payrollCalendarId&#x3D;&#x3D;{PayrollCalendarID} to filter the timesheets by payroll calendar id
4380
4436
  # @return [Array<(Timesheets, Integer, Hash)>] Timesheets data, response status code and response headers
4381
- def get_timesheets_with_http_info(xero_tenant_id, opts = {})
4437
+ def get_timesheets_with_http_info(xero_tenant_id, options = {})
4438
+ opts = options.dup
4382
4439
  if @api_client.config.debugging
4383
4440
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_timesheets ...'
4384
4441
  end
@@ -4436,7 +4493,7 @@ module XeroRuby
4436
4493
  return data, status_code, headers
4437
4494
  end
4438
4495
 
4439
- # searches tracking categories
4496
+ # Retrieves tracking categories
4440
4497
  # @param xero_tenant_id [String] Xero identifier for Tenant
4441
4498
  # @param [Hash] opts the optional parameters
4442
4499
  # @return [TrackingCategories]
@@ -4445,11 +4502,12 @@ module XeroRuby
4445
4502
  data
4446
4503
  end
4447
4504
 
4448
- # searches tracking categories
4505
+ # Retrieves tracking categories
4449
4506
  # @param xero_tenant_id [String] Xero identifier for Tenant
4450
4507
  # @param [Hash] opts the optional parameters
4451
4508
  # @return [Array<(TrackingCategories, Integer, Hash)>] TrackingCategories data, response status code and response headers
4452
- def get_tracking_categories_with_http_info(xero_tenant_id, opts = {})
4509
+ def get_tracking_categories_with_http_info(xero_tenant_id, options = {})
4510
+ opts = options.dup
4453
4511
  if @api_client.config.debugging
4454
4512
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.get_tracking_categories ...'
4455
4513
  end
@@ -4458,7 +4516,7 @@ module XeroRuby
4458
4516
  fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling PayrollNzApi.get_tracking_categories"
4459
4517
  end
4460
4518
  # resource path
4461
- local_var_path = '/settings/trackingCategories'
4519
+ local_var_path = '/Settings/TrackingCategories'
4462
4520
 
4463
4521
  # camelize keys of incoming `where` opts
4464
4522
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -4504,7 +4562,7 @@ module XeroRuby
4504
4562
  return data, status_code, headers
4505
4563
  end
4506
4564
 
4507
- # revert a timesheet to draft
4565
+ # Reverts a timesheet to draft
4508
4566
  # @param xero_tenant_id [String] Xero identifier for Tenant
4509
4567
  # @param timesheet_id [String] Identifier for the timesheet
4510
4568
  # @param [Hash] opts the optional parameters
@@ -4514,12 +4572,13 @@ module XeroRuby
4514
4572
  data
4515
4573
  end
4516
4574
 
4517
- # revert a timesheet to draft
4575
+ # Reverts a timesheet to draft
4518
4576
  # @param xero_tenant_id [String] Xero identifier for Tenant
4519
4577
  # @param timesheet_id [String] Identifier for the timesheet
4520
4578
  # @param [Hash] opts the optional parameters
4521
4579
  # @return [Array<(TimesheetObject, Integer, Hash)>] TimesheetObject data, response status code and response headers
4522
- def revert_timesheet_with_http_info(xero_tenant_id, timesheet_id, opts = {})
4580
+ def revert_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {})
4581
+ opts = options.dup
4523
4582
  if @api_client.config.debugging
4524
4583
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.revert_timesheet ...'
4525
4584
  end
@@ -4578,7 +4637,7 @@ module XeroRuby
4578
4637
  return data, status_code, headers
4579
4638
  end
4580
4639
 
4581
- # updates employee
4640
+ # Updates an existing employee
4582
4641
  # @param xero_tenant_id [String] Xero identifier for Tenant
4583
4642
  # @param employee_id [String] Employee id for single object
4584
4643
  # @param employee [Employee]
@@ -4589,13 +4648,14 @@ module XeroRuby
4589
4648
  data
4590
4649
  end
4591
4650
 
4592
- # updates employee
4651
+ # Updates an existing employee
4593
4652
  # @param xero_tenant_id [String] Xero identifier for Tenant
4594
4653
  # @param employee_id [String] Employee id for single object
4595
4654
  # @param employee [Employee]
4596
4655
  # @param [Hash] opts the optional parameters
4597
4656
  # @return [Array<(EmployeeObject, Integer, Hash)>] EmployeeObject data, response status code and response headers
4598
- def update_employee_with_http_info(xero_tenant_id, employee_id, employee, opts = {})
4657
+ def update_employee_with_http_info(xero_tenant_id, employee_id, employee, options = {})
4658
+ opts = options.dup
4599
4659
  if @api_client.config.debugging
4600
4660
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.update_employee ...'
4601
4661
  end
@@ -4612,7 +4672,7 @@ module XeroRuby
4612
4672
  fail ArgumentError, "Missing the required parameter 'employee' when calling PayrollNzApi.update_employee"
4613
4673
  end
4614
4674
  # resource path
4615
- local_var_path = '/Employees/{EmployeeId}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
4675
+ local_var_path = '/Employees/{EmployeeID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
4616
4676
 
4617
4677
  # camelize keys of incoming `where` opts
4618
4678
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -4660,7 +4720,7 @@ module XeroRuby
4660
4720
  return data, status_code, headers
4661
4721
  end
4662
4722
 
4663
- # updates employee earnings template records
4723
+ # Updates an earnings template records for an employee
4664
4724
  # @param xero_tenant_id [String] Xero identifier for Tenant
4665
4725
  # @param employee_id [String] Employee id for single object
4666
4726
  # @param pay_template_earning_id [String] Id for single pay template earnings object
@@ -4672,14 +4732,15 @@ module XeroRuby
4672
4732
  data
4673
4733
  end
4674
4734
 
4675
- # updates employee earnings template records
4735
+ # Updates an earnings template records for an employee
4676
4736
  # @param xero_tenant_id [String] Xero identifier for Tenant
4677
4737
  # @param employee_id [String] Employee id for single object
4678
4738
  # @param pay_template_earning_id [String] Id for single pay template earnings object
4679
4739
  # @param earnings_template [EarningsTemplate]
4680
4740
  # @param [Hash] opts the optional parameters
4681
4741
  # @return [Array<(EarningsTemplateObject, Integer, Hash)>] EarningsTemplateObject data, response status code and response headers
4682
- def update_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, opts = {})
4742
+ def update_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, options = {})
4743
+ opts = options.dup
4683
4744
  if @api_client.config.debugging
4684
4745
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.update_employee_earnings_template ...'
4685
4746
  end
@@ -4700,7 +4761,7 @@ module XeroRuby
4700
4761
  fail ArgumentError, "Missing the required parameter 'earnings_template' when calling PayrollNzApi.update_employee_earnings_template"
4701
4762
  end
4702
4763
  # resource path
4703
- local_var_path = '/Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s).sub('{' + 'PayTemplateEarningID' + '}', pay_template_earning_id.to_s)
4764
+ local_var_path = '/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'PayTemplateEarningID' + '}', pay_template_earning_id.to_s)
4704
4765
 
4705
4766
  # camelize keys of incoming `where` opts
4706
4767
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -4748,7 +4809,7 @@ module XeroRuby
4748
4809
  return data, status_code, headers
4749
4810
  end
4750
4811
 
4751
- # updates employee leave records
4812
+ # Updates leave records for a specific employee
4752
4813
  # @param xero_tenant_id [String] Xero identifier for Tenant
4753
4814
  # @param employee_id [String] Employee id for single object
4754
4815
  # @param leave_id [String] Leave id for single object
@@ -4760,14 +4821,15 @@ module XeroRuby
4760
4821
  data
4761
4822
  end
4762
4823
 
4763
- # updates employee leave records
4824
+ # Updates leave records for a specific employee
4764
4825
  # @param xero_tenant_id [String] Xero identifier for Tenant
4765
4826
  # @param employee_id [String] Employee id for single object
4766
4827
  # @param leave_id [String] Leave id for single object
4767
4828
  # @param employee_leave [EmployeeLeave]
4768
4829
  # @param [Hash] opts the optional parameters
4769
4830
  # @return [Array<(EmployeeLeaveObject, Integer, Hash)>] EmployeeLeaveObject data, response status code and response headers
4770
- def update_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, employee_leave, opts = {})
4831
+ def update_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, employee_leave, options = {})
4832
+ opts = options.dup
4771
4833
  if @api_client.config.debugging
4772
4834
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.update_employee_leave ...'
4773
4835
  end
@@ -4788,7 +4850,7 @@ module XeroRuby
4788
4850
  fail ArgumentError, "Missing the required parameter 'employee_leave' when calling PayrollNzApi.update_employee_leave"
4789
4851
  end
4790
4852
  # resource path
4791
- local_var_path = '/Employees/{EmployeeId}/Leave/{LeaveID}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s).sub('{' + 'LeaveID' + '}', leave_id.to_s)
4853
+ local_var_path = '/Employees/{EmployeeID}/Leave/{LeaveID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'LeaveID' + '}', leave_id.to_s)
4792
4854
 
4793
4855
  # camelize keys of incoming `where` opts
4794
4856
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -4836,7 +4898,7 @@ module XeroRuby
4836
4898
  return data, status_code, headers
4837
4899
  end
4838
4900
 
4839
- # updates employee salary and wages record
4901
+ # Updates an employee's salary and wages record
4840
4902
  # @param xero_tenant_id [String] Xero identifier for Tenant
4841
4903
  # @param employee_id [String] Employee id for single object
4842
4904
  # @param salary_and_wages_id [String] Id for single pay template earnings object
@@ -4848,14 +4910,15 @@ module XeroRuby
4848
4910
  data
4849
4911
  end
4850
4912
 
4851
- # updates employee salary and wages record
4913
+ # Updates an employee&#39;s salary and wages record
4852
4914
  # @param xero_tenant_id [String] Xero identifier for Tenant
4853
4915
  # @param employee_id [String] Employee id for single object
4854
4916
  # @param salary_and_wages_id [String] Id for single pay template earnings object
4855
4917
  # @param salary_and_wage [SalaryAndWage]
4856
4918
  # @param [Hash] opts the optional parameters
4857
4919
  # @return [Array<(SalaryAndWageObject, Integer, Hash)>] SalaryAndWageObject data, response status code and response headers
4858
- def update_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, opts = {})
4920
+ def update_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, options = {})
4921
+ opts = options.dup
4859
4922
  if @api_client.config.debugging
4860
4923
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.update_employee_salary_and_wage ...'
4861
4924
  end
@@ -4876,7 +4939,7 @@ module XeroRuby
4876
4939
  fail ArgumentError, "Missing the required parameter 'salary_and_wage' when calling PayrollNzApi.update_employee_salary_and_wage"
4877
4940
  end
4878
4941
  # resource path
4879
- local_var_path = '/Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s).sub('{' + 'SalaryAndWagesID' + '}', salary_and_wages_id.to_s)
4942
+ local_var_path = '/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'SalaryAndWagesID' + '}', salary_and_wages_id.to_s)
4880
4943
 
4881
4944
  # camelize keys of incoming `where` opts
4882
4945
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -4924,7 +4987,7 @@ module XeroRuby
4924
4987
  return data, status_code, headers
4925
4988
  end
4926
4989
 
4927
- # updates the tax records for an employee
4990
+ # Updates the tax records for a specific employee
4928
4991
  # @param xero_tenant_id [String] Xero identifier for Tenant
4929
4992
  # @param employee_id [String] Employee id for single object
4930
4993
  # @param employee_tax [EmployeeTax]
@@ -4935,13 +4998,14 @@ module XeroRuby
4935
4998
  data
4936
4999
  end
4937
5000
 
4938
- # updates the tax records for an employee
5001
+ # Updates the tax records for a specific employee
4939
5002
  # @param xero_tenant_id [String] Xero identifier for Tenant
4940
5003
  # @param employee_id [String] Employee id for single object
4941
5004
  # @param employee_tax [EmployeeTax]
4942
5005
  # @param [Hash] opts the optional parameters
4943
5006
  # @return [Array<(EmployeeTaxObject, Integer, Hash)>] EmployeeTaxObject data, response status code and response headers
4944
- def update_employee_tax_with_http_info(xero_tenant_id, employee_id, employee_tax, opts = {})
5007
+ def update_employee_tax_with_http_info(xero_tenant_id, employee_id, employee_tax, options = {})
5008
+ opts = options.dup
4945
5009
  if @api_client.config.debugging
4946
5010
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.update_employee_tax ...'
4947
5011
  end
@@ -4958,7 +5022,7 @@ module XeroRuby
4958
5022
  fail ArgumentError, "Missing the required parameter 'employee_tax' when calling PayrollNzApi.update_employee_tax"
4959
5023
  end
4960
5024
  # resource path
4961
- local_var_path = '/Employees/{EmployeeId}/Tax'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
5025
+ local_var_path = '/Employees/{EmployeeID}/Tax'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
4962
5026
 
4963
5027
  # camelize keys of incoming `where` opts
4964
5028
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -5006,7 +5070,7 @@ module XeroRuby
5006
5070
  return data, status_code, headers
5007
5071
  end
5008
5072
 
5009
- # update a pay run
5073
+ # Updates a pay run
5010
5074
  # @param xero_tenant_id [String] Xero identifier for Tenant
5011
5075
  # @param pay_run_id [String] Identifier for the pay run
5012
5076
  # @param pay_run [PayRun]
@@ -5017,13 +5081,14 @@ module XeroRuby
5017
5081
  data
5018
5082
  end
5019
5083
 
5020
- # update a pay run
5084
+ # Updates a pay run
5021
5085
  # @param xero_tenant_id [String] Xero identifier for Tenant
5022
5086
  # @param pay_run_id [String] Identifier for the pay run
5023
5087
  # @param pay_run [PayRun]
5024
5088
  # @param [Hash] opts the optional parameters
5025
5089
  # @return [Array<(PayRunObject, Integer, Hash)>] PayRunObject data, response status code and response headers
5026
- def update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, opts = {})
5090
+ def update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, options = {})
5091
+ opts = options.dup
5027
5092
  if @api_client.config.debugging
5028
5093
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.update_pay_run ...'
5029
5094
  end
@@ -5088,7 +5153,7 @@ module XeroRuby
5088
5153
  return data, status_code, headers
5089
5154
  end
5090
5155
 
5091
- # creates employee pay slip
5156
+ # Creates an employee pay slip
5092
5157
  # @param xero_tenant_id [String] Xero identifier for Tenant
5093
5158
  # @param pay_slip_id [String] Identifier for the payslip
5094
5159
  # @param pay_slip [PaySlip]
@@ -5099,13 +5164,14 @@ module XeroRuby
5099
5164
  data
5100
5165
  end
5101
5166
 
5102
- # creates employee pay slip
5167
+ # Creates an employee pay slip
5103
5168
  # @param xero_tenant_id [String] Xero identifier for Tenant
5104
5169
  # @param pay_slip_id [String] Identifier for the payslip
5105
5170
  # @param pay_slip [PaySlip]
5106
5171
  # @param [Hash] opts the optional parameters
5107
5172
  # @return [Array<(PaySlipObject, Integer, Hash)>] PaySlipObject data, response status code and response headers
5108
- def update_pay_slip_line_items_with_http_info(xero_tenant_id, pay_slip_id, pay_slip, opts = {})
5173
+ def update_pay_slip_line_items_with_http_info(xero_tenant_id, pay_slip_id, pay_slip, options = {})
5174
+ opts = options.dup
5109
5175
  if @api_client.config.debugging
5110
5176
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.update_pay_slip_line_items ...'
5111
5177
  end
@@ -5170,7 +5236,7 @@ module XeroRuby
5170
5236
  return data, status_code, headers
5171
5237
  end
5172
5238
 
5173
- # update a timesheet line
5239
+ # Updates a timesheet line for a specific timesheet
5174
5240
  # @param xero_tenant_id [String] Xero identifier for Tenant
5175
5241
  # @param timesheet_id [String] Identifier for the timesheet
5176
5242
  # @param timesheet_line_id [String] Identifier for the timesheet line
@@ -5182,14 +5248,15 @@ module XeroRuby
5182
5248
  data
5183
5249
  end
5184
5250
 
5185
- # update a timesheet line
5251
+ # Updates a timesheet line for a specific timesheet
5186
5252
  # @param xero_tenant_id [String] Xero identifier for Tenant
5187
5253
  # @param timesheet_id [String] Identifier for the timesheet
5188
5254
  # @param timesheet_line_id [String] Identifier for the timesheet line
5189
5255
  # @param timesheet_line [TimesheetLine]
5190
5256
  # @param [Hash] opts the optional parameters
5191
5257
  # @return [Array<(TimesheetLineObject, Integer, Hash)>] TimesheetLineObject data, response status code and response headers
5192
- def update_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, opts = {})
5258
+ def update_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, options = {})
5259
+ opts = options.dup
5193
5260
  if @api_client.config.debugging
5194
5261
  @api_client.config.logger.debug 'Calling API: PayrollNzApi.update_timesheet_line ...'
5195
5262
  end