xero-ruby 2.4.1 → 3.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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 UK 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 specific 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 specific 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: PayrollUkApi.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 benefit
94
+ # Creates a new employee benefit
95
95
  # @param xero_tenant_id [String] Xero identifier for Tenant
96
96
  # @param benefit [Benefit]
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 benefit
104
+ # Creates a new employee benefit
105
105
  # @param xero_tenant_id [String] Xero identifier for Tenant
106
106
  # @param benefit [Benefit]
107
107
  # @param [Hash] opts the optional parameters
108
108
  # @return [Array<(BenefitObject, Integer, Hash)>] BenefitObject data, response status code and response headers
109
- def create_benefit_with_http_info(xero_tenant_id, benefit, opts = {})
109
+ def create_benefit_with_http_info(xero_tenant_id, benefit, options = {})
110
+ opts = options.dup
110
111
  if @api_client.config.debugging
111
112
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_benefit ...'
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 deduction
171
+ # Creates a new deduction
171
172
  # @param xero_tenant_id [String] Xero identifier for Tenant
172
173
  # @param deduction [Deduction]
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 deduction
181
+ # Creates a new deduction
181
182
  # @param xero_tenant_id [String] Xero identifier for Tenant
182
183
  # @param deduction [Deduction]
183
184
  # @param [Hash] opts the optional parameters
184
185
  # @return [Array<(DeductionObject, Integer, Hash)>] DeductionObject data, response status code and response headers
185
- def create_deduction_with_http_info(xero_tenant_id, deduction, opts = {})
186
+ def create_deduction_with_http_info(xero_tenant_id, deduction, options = {})
187
+ opts = options.dup
186
188
  if @api_client.config.debugging
187
189
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_deduction ...'
188
190
  end
@@ -243,7 +245,7 @@ module XeroRuby
243
245
  return data, status_code, headers
244
246
  end
245
247
 
246
- # create a new earnings rate
248
+ # Creates a new earnings rate
247
249
  # @param xero_tenant_id [String] Xero identifier for Tenant
248
250
  # @param earnings_rate [EarningsRate]
249
251
  # @param [Hash] opts the optional parameters
@@ -253,12 +255,13 @@ module XeroRuby
253
255
  data
254
256
  end
255
257
 
256
- # create a new earnings rate
258
+ # Creates a new earnings rate
257
259
  # @param xero_tenant_id [String] Xero identifier for Tenant
258
260
  # @param earnings_rate [EarningsRate]
259
261
  # @param [Hash] opts the optional parameters
260
262
  # @return [Array<(EarningsRateObject, Integer, Hash)>] EarningsRateObject data, response status code and response headers
261
- def create_earnings_rate_with_http_info(xero_tenant_id, earnings_rate, opts = {})
263
+ def create_earnings_rate_with_http_info(xero_tenant_id, earnings_rate, options = {})
264
+ opts = options.dup
262
265
  if @api_client.config.debugging
263
266
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_earnings_rate ...'
264
267
  end
@@ -319,7 +322,7 @@ module XeroRuby
319
322
  return data, status_code, headers
320
323
  end
321
324
 
322
- # creates employees
325
+ # Creates employees
323
326
  # @param xero_tenant_id [String] Xero identifier for Tenant
324
327
  # @param employee [Employee]
325
328
  # @param [Hash] opts the optional parameters
@@ -329,12 +332,13 @@ module XeroRuby
329
332
  data
330
333
  end
331
334
 
332
- # creates employees
335
+ # Creates employees
333
336
  # @param xero_tenant_id [String] Xero identifier for Tenant
334
337
  # @param employee [Employee]
335
338
  # @param [Hash] opts the optional parameters
336
339
  # @return [Array<(EmployeeObject, Integer, Hash)>] EmployeeObject data, response status code and response headers
337
- def create_employee_with_http_info(xero_tenant_id, employee, opts = {})
340
+ def create_employee_with_http_info(xero_tenant_id, employee, options = {})
341
+ opts = options.dup
338
342
  if @api_client.config.debugging
339
343
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_employee ...'
340
344
  end
@@ -395,7 +399,7 @@ module XeroRuby
395
399
  return data, status_code, headers
396
400
  end
397
401
 
398
- # creates employee earnings template records
402
+ # Creates an earnings template records for a specific employee
399
403
  # @param xero_tenant_id [String] Xero identifier for Tenant
400
404
  # @param employee_id [String] Employee id for single object
401
405
  # @param earnings_template [EarningsTemplate]
@@ -406,13 +410,14 @@ module XeroRuby
406
410
  data
407
411
  end
408
412
 
409
- # creates employee earnings template records
413
+ # Creates an earnings template records for a specific employee
410
414
  # @param xero_tenant_id [String] Xero identifier for Tenant
411
415
  # @param employee_id [String] Employee id for single object
412
416
  # @param earnings_template [EarningsTemplate]
413
417
  # @param [Hash] opts the optional parameters
414
418
  # @return [Array<(EarningsTemplateObject, Integer, Hash)>] EarningsTemplateObject data, response status code and response headers
415
- def create_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, opts = {})
419
+ def create_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, options = {})
420
+ opts = options.dup
416
421
  if @api_client.config.debugging
417
422
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_employee_earnings_template ...'
418
423
  end
@@ -429,7 +434,7 @@ module XeroRuby
429
434
  fail ArgumentError, "Missing the required parameter 'earnings_template' when calling PayrollUkApi.create_employee_earnings_template"
430
435
  end
431
436
  # resource path
432
- local_var_path = '/Employees/{EmployeeId}/PayTemplates/earnings'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
437
+ local_var_path = '/Employees/{EmployeeID}/PayTemplates/earnings'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
433
438
 
434
439
  # camelize keys of incoming `where` opts
435
440
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -477,7 +482,7 @@ module XeroRuby
477
482
  return data, status_code, headers
478
483
  end
479
484
 
480
- # creates employee leave records
485
+ # Creates leave records for a specific employee
481
486
  # @param xero_tenant_id [String] Xero identifier for Tenant
482
487
  # @param employee_id [String] Employee id for single object
483
488
  # @param employee_leave [EmployeeLeave]
@@ -488,13 +493,14 @@ module XeroRuby
488
493
  data
489
494
  end
490
495
 
491
- # creates employee leave records
496
+ # Creates leave records for a specific employee
492
497
  # @param xero_tenant_id [String] Xero identifier for Tenant
493
498
  # @param employee_id [String] Employee id for single object
494
499
  # @param employee_leave [EmployeeLeave]
495
500
  # @param [Hash] opts the optional parameters
496
501
  # @return [Array<(EmployeeLeaveObject, Integer, Hash)>] EmployeeLeaveObject data, response status code and response headers
497
- def create_employee_leave_with_http_info(xero_tenant_id, employee_id, employee_leave, opts = {})
502
+ def create_employee_leave_with_http_info(xero_tenant_id, employee_id, employee_leave, options = {})
503
+ opts = options.dup
498
504
  if @api_client.config.debugging
499
505
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_employee_leave ...'
500
506
  end
@@ -511,7 +517,7 @@ module XeroRuby
511
517
  fail ArgumentError, "Missing the required parameter 'employee_leave' when calling PayrollUkApi.create_employee_leave"
512
518
  end
513
519
  # resource path
514
- local_var_path = '/Employees/{EmployeeId}/Leave'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
520
+ local_var_path = '/Employees/{EmployeeID}/Leave'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
515
521
 
516
522
  # camelize keys of incoming `where` opts
517
523
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -559,7 +565,7 @@ module XeroRuby
559
565
  return data, status_code, headers
560
566
  end
561
567
 
562
- # creates employee leave type records
568
+ # Creates employee leave type records
563
569
  # @param xero_tenant_id [String] Xero identifier for Tenant
564
570
  # @param employee_id [String] Employee id for single object
565
571
  # @param employee_leave_type [EmployeeLeaveType]
@@ -570,13 +576,14 @@ module XeroRuby
570
576
  data
571
577
  end
572
578
 
573
- # creates employee leave type records
579
+ # Creates employee leave type records
574
580
  # @param xero_tenant_id [String] Xero identifier for Tenant
575
581
  # @param employee_id [String] Employee id for single object
576
582
  # @param employee_leave_type [EmployeeLeaveType]
577
583
  # @param [Hash] opts the optional parameters
578
584
  # @return [Array<(EmployeeLeaveTypeObject, Integer, Hash)>] EmployeeLeaveTypeObject data, response status code and response headers
579
- def create_employee_leave_type_with_http_info(xero_tenant_id, employee_id, employee_leave_type, opts = {})
585
+ def create_employee_leave_type_with_http_info(xero_tenant_id, employee_id, employee_leave_type, options = {})
586
+ opts = options.dup
580
587
  if @api_client.config.debugging
581
588
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_employee_leave_type ...'
582
589
  end
@@ -593,7 +600,7 @@ module XeroRuby
593
600
  fail ArgumentError, "Missing the required parameter 'employee_leave_type' when calling PayrollUkApi.create_employee_leave_type"
594
601
  end
595
602
  # resource path
596
- local_var_path = '/Employees/{EmployeeId}/LeaveTypes'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
603
+ local_var_path = '/Employees/{EmployeeID}/LeaveTypes'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
597
604
 
598
605
  # camelize keys of incoming `where` opts
599
606
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -641,7 +648,7 @@ module XeroRuby
641
648
  return data, status_code, headers
642
649
  end
643
650
 
644
- # creates employee opening balances
651
+ # Creates an opening balance for a specific employee
645
652
  # @param xero_tenant_id [String] Xero identifier for Tenant
646
653
  # @param employee_id [String] Employee id for single object
647
654
  # @param employee_opening_balances [EmployeeOpeningBalances]
@@ -652,13 +659,14 @@ module XeroRuby
652
659
  data
653
660
  end
654
661
 
655
- # creates employee opening balances
662
+ # Creates an opening balance for a specific employee
656
663
  # @param xero_tenant_id [String] Xero identifier for Tenant
657
664
  # @param employee_id [String] Employee id for single object
658
665
  # @param employee_opening_balances [EmployeeOpeningBalances]
659
666
  # @param [Hash] opts the optional parameters
660
667
  # @return [Array<(EmployeeOpeningBalancesObject, Integer, Hash)>] EmployeeOpeningBalancesObject data, response status code and response headers
661
- def create_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balances, opts = {})
668
+ def create_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balances, options = {})
669
+ opts = options.dup
662
670
  if @api_client.config.debugging
663
671
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_employee_opening_balances ...'
664
672
  end
@@ -675,7 +683,7 @@ module XeroRuby
675
683
  fail ArgumentError, "Missing the required parameter 'employee_opening_balances' when calling PayrollUkApi.create_employee_opening_balances"
676
684
  end
677
685
  # resource path
678
- local_var_path = '/Employees/{EmployeeId}/ukopeningbalances'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
686
+ local_var_path = '/Employees/{EmployeeID}/ukopeningbalances'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
679
687
 
680
688
  # camelize keys of incoming `where` opts
681
689
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -723,7 +731,7 @@ module XeroRuby
723
731
  return data, status_code, headers
724
732
  end
725
733
 
726
- # creates employee payment method
734
+ # Creates an employee payment method
727
735
  # @param xero_tenant_id [String] Xero identifier for Tenant
728
736
  # @param employee_id [String] Employee id for single object
729
737
  # @param payment_method [PaymentMethod]
@@ -734,13 +742,14 @@ module XeroRuby
734
742
  data
735
743
  end
736
744
 
737
- # creates employee payment method
745
+ # Creates an employee payment method
738
746
  # @param xero_tenant_id [String] Xero identifier for Tenant
739
747
  # @param employee_id [String] Employee id for single object
740
748
  # @param payment_method [PaymentMethod]
741
749
  # @param [Hash] opts the optional parameters
742
750
  # @return [Array<(PaymentMethodObject, Integer, Hash)>] PaymentMethodObject data, response status code and response headers
743
- def create_employee_payment_method_with_http_info(xero_tenant_id, employee_id, payment_method, opts = {})
751
+ def create_employee_payment_method_with_http_info(xero_tenant_id, employee_id, payment_method, options = {})
752
+ opts = options.dup
744
753
  if @api_client.config.debugging
745
754
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_employee_payment_method ...'
746
755
  end
@@ -757,7 +766,7 @@ module XeroRuby
757
766
  fail ArgumentError, "Missing the required parameter 'payment_method' when calling PayrollUkApi.create_employee_payment_method"
758
767
  end
759
768
  # resource path
760
- local_var_path = '/Employees/{EmployeeId}/PaymentMethods'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
769
+ local_var_path = '/Employees/{EmployeeID}/PaymentMethods'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
761
770
 
762
771
  # camelize keys of incoming `where` opts
763
772
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -805,7 +814,7 @@ module XeroRuby
805
814
  return data, status_code, headers
806
815
  end
807
816
 
808
- # creates employee salary and wage record
817
+ # Creates a salary and wage record for a specific employee
809
818
  # @param xero_tenant_id [String] Xero identifier for Tenant
810
819
  # @param employee_id [String] Employee id for single object
811
820
  # @param salary_and_wage [SalaryAndWage]
@@ -816,13 +825,14 @@ module XeroRuby
816
825
  data
817
826
  end
818
827
 
819
- # creates employee salary and wage record
828
+ # Creates a salary and wage record for a specific employee
820
829
  # @param xero_tenant_id [String] Xero identifier for Tenant
821
830
  # @param employee_id [String] Employee id for single object
822
831
  # @param salary_and_wage [SalaryAndWage]
823
832
  # @param [Hash] opts the optional parameters
824
833
  # @return [Array<(SalaryAndWageObject, Integer, Hash)>] SalaryAndWageObject data, response status code and response headers
825
- def create_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wage, opts = {})
834
+ def create_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wage, options = {})
835
+ opts = options.dup
826
836
  if @api_client.config.debugging
827
837
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_employee_salary_and_wage ...'
828
838
  end
@@ -839,7 +849,7 @@ module XeroRuby
839
849
  fail ArgumentError, "Missing the required parameter 'salary_and_wage' when calling PayrollUkApi.create_employee_salary_and_wage"
840
850
  end
841
851
  # resource path
842
- local_var_path = '/Employees/{EmployeeId}/SalaryAndWages'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
852
+ local_var_path = '/Employees/{EmployeeID}/SalaryAndWages'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
843
853
 
844
854
  # camelize keys of incoming `where` opts
845
855
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -887,7 +897,7 @@ module XeroRuby
887
897
  return data, status_code, headers
888
898
  end
889
899
 
890
- # creates employee statutory sick leave records
900
+ # Creates statutory sick leave records
891
901
  # @param xero_tenant_id [String] Xero identifier for Tenant
892
902
  # @param employee_statutory_sick_leave [EmployeeStatutorySickLeave]
893
903
  # @param [Hash] opts the optional parameters
@@ -897,12 +907,13 @@ module XeroRuby
897
907
  data
898
908
  end
899
909
 
900
- # creates employee statutory sick leave records
910
+ # Creates statutory sick leave records
901
911
  # @param xero_tenant_id [String] Xero identifier for Tenant
902
912
  # @param employee_statutory_sick_leave [EmployeeStatutorySickLeave]
903
913
  # @param [Hash] opts the optional parameters
904
914
  # @return [Array<(EmployeeStatutorySickLeaveObject, Integer, Hash)>] EmployeeStatutorySickLeaveObject data, response status code and response headers
905
- def create_employee_statutory_sick_leave_with_http_info(xero_tenant_id, employee_statutory_sick_leave, opts = {})
915
+ def create_employee_statutory_sick_leave_with_http_info(xero_tenant_id, employee_statutory_sick_leave, options = {})
916
+ opts = options.dup
906
917
  if @api_client.config.debugging
907
918
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_employee_statutory_sick_leave ...'
908
919
  end
@@ -963,7 +974,7 @@ module XeroRuby
963
974
  return data, status_code, headers
964
975
  end
965
976
 
966
- # creates employment
977
+ # Creates employment detail for a specific employee using a unique employee ID
967
978
  # @param xero_tenant_id [String] Xero identifier for Tenant
968
979
  # @param employee_id [String] Employee id for single object
969
980
  # @param employment [Employment]
@@ -974,13 +985,14 @@ module XeroRuby
974
985
  data
975
986
  end
976
987
 
977
- # creates employment
988
+ # Creates employment detail for a specific employee using a unique employee ID
978
989
  # @param xero_tenant_id [String] Xero identifier for Tenant
979
990
  # @param employee_id [String] Employee id for single object
980
991
  # @param employment [Employment]
981
992
  # @param [Hash] opts the optional parameters
982
993
  # @return [Array<(EmploymentObject, Integer, Hash)>] EmploymentObject data, response status code and response headers
983
- def create_employment_with_http_info(xero_tenant_id, employee_id, employment, opts = {})
994
+ def create_employment_with_http_info(xero_tenant_id, employee_id, employment, options = {})
995
+ opts = options.dup
984
996
  if @api_client.config.debugging
985
997
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_employment ...'
986
998
  end
@@ -997,7 +1009,7 @@ module XeroRuby
997
1009
  fail ArgumentError, "Missing the required parameter 'employment' when calling PayrollUkApi.create_employment"
998
1010
  end
999
1011
  # resource path
1000
- local_var_path = '/Employees/{EmployeeId}/Employment'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
1012
+ local_var_path = '/Employees/{EmployeeID}/Employment'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
1001
1013
 
1002
1014
  # camelize keys of incoming `where` opts
1003
1015
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -1045,7 +1057,7 @@ module XeroRuby
1045
1057
  return data, status_code, headers
1046
1058
  end
1047
1059
 
1048
- # create a new leave type
1060
+ # Creates a new leave type
1049
1061
  # @param xero_tenant_id [String] Xero identifier for Tenant
1050
1062
  # @param leave_type [LeaveType]
1051
1063
  # @param [Hash] opts the optional parameters
@@ -1055,12 +1067,13 @@ module XeroRuby
1055
1067
  data
1056
1068
  end
1057
1069
 
1058
- # create a new leave type
1070
+ # Creates a new leave type
1059
1071
  # @param xero_tenant_id [String] Xero identifier for Tenant
1060
1072
  # @param leave_type [LeaveType]
1061
1073
  # @param [Hash] opts the optional parameters
1062
1074
  # @return [Array<(LeaveTypeObject, Integer, Hash)>] LeaveTypeObject data, response status code and response headers
1063
- def create_leave_type_with_http_info(xero_tenant_id, leave_type, opts = {})
1075
+ def create_leave_type_with_http_info(xero_tenant_id, leave_type, options = {})
1076
+ opts = options.dup
1064
1077
  if @api_client.config.debugging
1065
1078
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_leave_type ...'
1066
1079
  end
@@ -1121,7 +1134,7 @@ module XeroRuby
1121
1134
  return data, status_code, headers
1122
1135
  end
1123
1136
 
1124
- # creates multiple employee earnings template records
1137
+ # Creates multiple earnings template records for a specific employee using a unique employee ID
1125
1138
  # @param xero_tenant_id [String] Xero identifier for Tenant
1126
1139
  # @param employee_id [String] Employee id for single object
1127
1140
  # @param earnings_template [Array<EarningsTemplate>]
@@ -1132,13 +1145,14 @@ module XeroRuby
1132
1145
  data
1133
1146
  end
1134
1147
 
1135
- # creates multiple employee earnings template records
1148
+ # Creates multiple earnings template records for a specific employee using a unique employee ID
1136
1149
  # @param xero_tenant_id [String] Xero identifier for Tenant
1137
1150
  # @param employee_id [String] Employee id for single object
1138
1151
  # @param earnings_template [Array<EarningsTemplate>]
1139
1152
  # @param [Hash] opts the optional parameters
1140
1153
  # @return [Array<(EmployeePayTemplates, Integer, Hash)>] EmployeePayTemplates data, response status code and response headers
1141
- def create_multiple_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, opts = {})
1154
+ def create_multiple_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, options = {})
1155
+ opts = options.dup
1142
1156
  if @api_client.config.debugging
1143
1157
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_multiple_employee_earnings_template ...'
1144
1158
  end
@@ -1155,7 +1169,7 @@ module XeroRuby
1155
1169
  fail ArgumentError, "Missing the required parameter 'earnings_template' when calling PayrollUkApi.create_multiple_employee_earnings_template"
1156
1170
  end
1157
1171
  # resource path
1158
- local_var_path = '/Employees/{EmployeeId}/paytemplateearnings'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
1172
+ local_var_path = '/Employees/{EmployeeID}/paytemplateearnings'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
1159
1173
 
1160
1174
  # camelize keys of incoming `where` opts
1161
1175
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -1203,7 +1217,7 @@ module XeroRuby
1203
1217
  return data, status_code, headers
1204
1218
  end
1205
1219
 
1206
- # create a new payrun calendar
1220
+ # Creates a new payrun calendar
1207
1221
  # @param xero_tenant_id [String] Xero identifier for Tenant
1208
1222
  # @param pay_run_calendar [PayRunCalendar]
1209
1223
  # @param [Hash] opts the optional parameters
@@ -1213,12 +1227,13 @@ module XeroRuby
1213
1227
  data
1214
1228
  end
1215
1229
 
1216
- # create a new payrun calendar
1230
+ # Creates a new payrun calendar
1217
1231
  # @param xero_tenant_id [String] Xero identifier for Tenant
1218
1232
  # @param pay_run_calendar [PayRunCalendar]
1219
1233
  # @param [Hash] opts the optional parameters
1220
1234
  # @return [Array<(PayRunCalendarObject, Integer, Hash)>] PayRunCalendarObject data, response status code and response headers
1221
- def create_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar, opts = {})
1235
+ def create_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar, options = {})
1236
+ opts = options.dup
1222
1237
  if @api_client.config.debugging
1223
1238
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_pay_run_calendar ...'
1224
1239
  end
@@ -1279,7 +1294,7 @@ module XeroRuby
1279
1294
  return data, status_code, headers
1280
1295
  end
1281
1296
 
1282
- # create a new reimbursement
1297
+ # Creates a new reimbursement
1283
1298
  # @param xero_tenant_id [String] Xero identifier for Tenant
1284
1299
  # @param reimbursement [Reimbursement]
1285
1300
  # @param [Hash] opts the optional parameters
@@ -1289,12 +1304,13 @@ module XeroRuby
1289
1304
  data
1290
1305
  end
1291
1306
 
1292
- # create a new reimbursement
1307
+ # Creates a new reimbursement
1293
1308
  # @param xero_tenant_id [String] Xero identifier for Tenant
1294
1309
  # @param reimbursement [Reimbursement]
1295
1310
  # @param [Hash] opts the optional parameters
1296
1311
  # @return [Array<(ReimbursementObject, Integer, Hash)>] ReimbursementObject data, response status code and response headers
1297
- def create_reimbursement_with_http_info(xero_tenant_id, reimbursement, opts = {})
1312
+ def create_reimbursement_with_http_info(xero_tenant_id, reimbursement, options = {})
1313
+ opts = options.dup
1298
1314
  if @api_client.config.debugging
1299
1315
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_reimbursement ...'
1300
1316
  end
@@ -1355,7 +1371,7 @@ module XeroRuby
1355
1371
  return data, status_code, headers
1356
1372
  end
1357
1373
 
1358
- # create a new timesheet
1374
+ # Creates a new timesheet
1359
1375
  # @param xero_tenant_id [String] Xero identifier for Tenant
1360
1376
  # @param timesheet [Timesheet]
1361
1377
  # @param [Hash] opts the optional parameters
@@ -1365,12 +1381,13 @@ module XeroRuby
1365
1381
  data
1366
1382
  end
1367
1383
 
1368
- # create a new timesheet
1384
+ # Creates a new timesheet
1369
1385
  # @param xero_tenant_id [String] Xero identifier for Tenant
1370
1386
  # @param timesheet [Timesheet]
1371
1387
  # @param [Hash] opts the optional parameters
1372
1388
  # @return [Array<(TimesheetObject, Integer, Hash)>] TimesheetObject data, response status code and response headers
1373
- def create_timesheet_with_http_info(xero_tenant_id, timesheet, opts = {})
1389
+ def create_timesheet_with_http_info(xero_tenant_id, timesheet, options = {})
1390
+ opts = options.dup
1374
1391
  if @api_client.config.debugging
1375
1392
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_timesheet ...'
1376
1393
  end
@@ -1431,7 +1448,7 @@ module XeroRuby
1431
1448
  return data, status_code, headers
1432
1449
  end
1433
1450
 
1434
- # create a new timesheet line
1451
+ # Creates a new timesheet line for a specific timesheet using a unique timesheet ID
1435
1452
  # @param xero_tenant_id [String] Xero identifier for Tenant
1436
1453
  # @param timesheet_id [String] Identifier for the timesheet
1437
1454
  # @param timesheet_line [TimesheetLine]
@@ -1442,13 +1459,14 @@ module XeroRuby
1442
1459
  data
1443
1460
  end
1444
1461
 
1445
- # create a new timesheet line
1462
+ # Creates a new timesheet line for a specific timesheet using a unique timesheet ID
1446
1463
  # @param xero_tenant_id [String] Xero identifier for Tenant
1447
1464
  # @param timesheet_id [String] Identifier for the timesheet
1448
1465
  # @param timesheet_line [TimesheetLine]
1449
1466
  # @param [Hash] opts the optional parameters
1450
1467
  # @return [Array<(TimesheetLineObject, Integer, Hash)>] TimesheetLineObject data, response status code and response headers
1451
- def create_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line, opts = {})
1468
+ def create_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line, options = {})
1469
+ opts = options.dup
1452
1470
  if @api_client.config.debugging
1453
1471
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_timesheet_line ...'
1454
1472
  end
@@ -1513,7 +1531,7 @@ module XeroRuby
1513
1531
  return data, status_code, headers
1514
1532
  end
1515
1533
 
1516
- # deletes an employee earnings template record
1534
+ # Deletes a specific employee's earnings template record
1517
1535
  # @param xero_tenant_id [String] Xero identifier for Tenant
1518
1536
  # @param employee_id [String] Employee id for single object
1519
1537
  # @param pay_template_earning_id [String] Id for single pay template earnings object
@@ -1524,13 +1542,14 @@ module XeroRuby
1524
1542
  nil
1525
1543
  end
1526
1544
 
1527
- # deletes an employee earnings template record
1545
+ # Deletes a specific employee&#39;s earnings template record
1528
1546
  # @param xero_tenant_id [String] Xero identifier for Tenant
1529
1547
  # @param employee_id [String] Employee id for single object
1530
1548
  # @param pay_template_earning_id [String] Id for single pay template earnings object
1531
1549
  # @param [Hash] opts the optional parameters
1532
1550
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1533
- def delete_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, opts = {})
1551
+ def delete_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, options = {})
1552
+ opts = options.dup
1534
1553
  if @api_client.config.debugging
1535
1554
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.delete_employee_earnings_template ...'
1536
1555
  end
@@ -1547,7 +1566,7 @@ module XeroRuby
1547
1566
  fail ArgumentError, "Missing the required parameter 'pay_template_earning_id' when calling PayrollUkApi.delete_employee_earnings_template"
1548
1567
  end
1549
1568
  # resource path
1550
- local_var_path = '/Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s).sub('{' + 'PayTemplateEarningID' + '}', pay_template_earning_id.to_s)
1569
+ local_var_path = '/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'PayTemplateEarningID' + '}', pay_template_earning_id.to_s)
1551
1570
 
1552
1571
  # camelize keys of incoming `where` opts
1553
1572
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -1591,7 +1610,7 @@ module XeroRuby
1591
1610
  return data, status_code, headers
1592
1611
  end
1593
1612
 
1594
- # deletes an employee leave record
1613
+ # Deletes a specific employee's leave record
1595
1614
  # @param xero_tenant_id [String] Xero identifier for Tenant
1596
1615
  # @param employee_id [String] Employee id for single object
1597
1616
  # @param leave_id [String] Leave id for single object
@@ -1602,13 +1621,14 @@ module XeroRuby
1602
1621
  data
1603
1622
  end
1604
1623
 
1605
- # deletes an employee leave record
1624
+ # Deletes a specific employee&#39;s leave record
1606
1625
  # @param xero_tenant_id [String] Xero identifier for Tenant
1607
1626
  # @param employee_id [String] Employee id for single object
1608
1627
  # @param leave_id [String] Leave id for single object
1609
1628
  # @param [Hash] opts the optional parameters
1610
1629
  # @return [Array<(EmployeeLeaveObject, Integer, Hash)>] EmployeeLeaveObject data, response status code and response headers
1611
- def delete_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, opts = {})
1630
+ def delete_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, options = {})
1631
+ opts = options.dup
1612
1632
  if @api_client.config.debugging
1613
1633
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.delete_employee_leave ...'
1614
1634
  end
@@ -1625,7 +1645,7 @@ module XeroRuby
1625
1645
  fail ArgumentError, "Missing the required parameter 'leave_id' when calling PayrollUkApi.delete_employee_leave"
1626
1646
  end
1627
1647
  # resource path
1628
- local_var_path = '/Employees/{EmployeeId}/Leave/{LeaveID}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s).sub('{' + 'LeaveID' + '}', leave_id.to_s)
1648
+ local_var_path = '/Employees/{EmployeeID}/Leave/{LeaveID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'LeaveID' + '}', leave_id.to_s)
1629
1649
 
1630
1650
  # camelize keys of incoming `where` opts
1631
1651
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -1671,7 +1691,7 @@ module XeroRuby
1671
1691
  return data, status_code, headers
1672
1692
  end
1673
1693
 
1674
- # deletes an employee salary and wages record
1694
+ # Deletes a salary and wages record for a specific employee
1675
1695
  # @param xero_tenant_id [String] Xero identifier for Tenant
1676
1696
  # @param employee_id [String] Employee id for single object
1677
1697
  # @param salary_and_wages_id [String] Id for single salary and wages object
@@ -1682,13 +1702,14 @@ module XeroRuby
1682
1702
  nil
1683
1703
  end
1684
1704
 
1685
- # deletes an employee salary and wages record
1705
+ # Deletes a salary and wages record for a specific employee
1686
1706
  # @param xero_tenant_id [String] Xero identifier for Tenant
1687
1707
  # @param employee_id [String] Employee id for single object
1688
1708
  # @param salary_and_wages_id [String] Id for single salary and wages object
1689
1709
  # @param [Hash] opts the optional parameters
1690
1710
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1691
- def delete_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, opts = {})
1711
+ def delete_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, options = {})
1712
+ opts = options.dup
1692
1713
  if @api_client.config.debugging
1693
1714
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.delete_employee_salary_and_wage ...'
1694
1715
  end
@@ -1705,7 +1726,7 @@ module XeroRuby
1705
1726
  fail ArgumentError, "Missing the required parameter 'salary_and_wages_id' when calling PayrollUkApi.delete_employee_salary_and_wage"
1706
1727
  end
1707
1728
  # resource path
1708
- local_var_path = '/Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s).sub('{' + 'SalaryAndWagesID' + '}', salary_and_wages_id.to_s)
1729
+ local_var_path = '/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'SalaryAndWagesID' + '}', salary_and_wages_id.to_s)
1709
1730
 
1710
1731
  # camelize keys of incoming `where` opts
1711
1732
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -1749,7 +1770,7 @@ module XeroRuby
1749
1770
  return data, status_code, headers
1750
1771
  end
1751
1772
 
1752
- # delete a timesheet
1773
+ # Deletes a specific timesheet
1753
1774
  # @param xero_tenant_id [String] Xero identifier for Tenant
1754
1775
  # @param timesheet_id [String] Identifier for the timesheet
1755
1776
  # @param [Hash] opts the optional parameters
@@ -1759,12 +1780,13 @@ module XeroRuby
1759
1780
  data
1760
1781
  end
1761
1782
 
1762
- # delete a timesheet
1783
+ # Deletes a specific timesheet
1763
1784
  # @param xero_tenant_id [String] Xero identifier for Tenant
1764
1785
  # @param timesheet_id [String] Identifier for the timesheet
1765
1786
  # @param [Hash] opts the optional parameters
1766
1787
  # @return [Array<(TimesheetLine, Integer, Hash)>] TimesheetLine data, response status code and response headers
1767
- def delete_timesheet_with_http_info(xero_tenant_id, timesheet_id, opts = {})
1788
+ def delete_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {})
1789
+ opts = options.dup
1768
1790
  if @api_client.config.debugging
1769
1791
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.delete_timesheet ...'
1770
1792
  end
@@ -1823,7 +1845,7 @@ module XeroRuby
1823
1845
  return data, status_code, headers
1824
1846
  end
1825
1847
 
1826
- # delete a timesheet line
1848
+ # Deletes a specific timesheet line
1827
1849
  # @param xero_tenant_id [String] Xero identifier for Tenant
1828
1850
  # @param timesheet_id [String] Identifier for the timesheet
1829
1851
  # @param timesheet_line_id [String] Identifier for the timesheet line
@@ -1834,13 +1856,14 @@ module XeroRuby
1834
1856
  data
1835
1857
  end
1836
1858
 
1837
- # delete a timesheet line
1859
+ # Deletes a specific timesheet line
1838
1860
  # @param xero_tenant_id [String] Xero identifier for Tenant
1839
1861
  # @param timesheet_id [String] Identifier for the timesheet
1840
1862
  # @param timesheet_line_id [String] Identifier for the timesheet line
1841
1863
  # @param [Hash] opts the optional parameters
1842
1864
  # @return [Array<(TimesheetLine, Integer, Hash)>] TimesheetLine data, response status code and response headers
1843
- def delete_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, opts = {})
1865
+ def delete_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, options = {})
1866
+ opts = options.dup
1844
1867
  if @api_client.config.debugging
1845
1868
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.delete_timesheet_line ...'
1846
1869
  end
@@ -1903,7 +1926,7 @@ module XeroRuby
1903
1926
  return data, status_code, headers
1904
1927
  end
1905
1928
 
1906
- # retrieve a single benefit by id
1929
+ # Retrieves a specific benefit by using a unique benefit ID
1907
1930
  # @param xero_tenant_id [String] Xero identifier for Tenant
1908
1931
  # @param id [String] Identifier for the benefit
1909
1932
  # @param [Hash] opts the optional parameters
@@ -1913,12 +1936,13 @@ module XeroRuby
1913
1936
  data
1914
1937
  end
1915
1938
 
1916
- # retrieve a single benefit by id
1939
+ # Retrieves a specific benefit by using a unique benefit ID
1917
1940
  # @param xero_tenant_id [String] Xero identifier for Tenant
1918
1941
  # @param id [String] Identifier for the benefit
1919
1942
  # @param [Hash] opts the optional parameters
1920
1943
  # @return [Array<(BenefitObject, Integer, Hash)>] BenefitObject data, response status code and response headers
1921
- def get_benefit_with_http_info(xero_tenant_id, id, opts = {})
1944
+ def get_benefit_with_http_info(xero_tenant_id, id, options = {})
1945
+ opts = options.dup
1922
1946
  if @api_client.config.debugging
1923
1947
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_benefit ...'
1924
1948
  end
@@ -1977,7 +2001,7 @@ module XeroRuby
1977
2001
  return data, status_code, headers
1978
2002
  end
1979
2003
 
1980
- # searches benefits
2004
+ # Retrieves employee benefits
1981
2005
  # @param xero_tenant_id [String] Xero identifier for Tenant
1982
2006
  # @param [Hash] opts the optional parameters
1983
2007
  # @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.
@@ -1987,12 +2011,13 @@ module XeroRuby
1987
2011
  data
1988
2012
  end
1989
2013
 
1990
- # searches benefits
2014
+ # Retrieves employee benefits
1991
2015
  # @param xero_tenant_id [String] Xero identifier for Tenant
1992
2016
  # @param [Hash] opts the optional parameters
1993
2017
  # @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.
1994
2018
  # @return [Array<(Benefits, Integer, Hash)>] Benefits data, response status code and response headers
1995
- def get_benefits_with_http_info(xero_tenant_id, opts = {})
2019
+ def get_benefits_with_http_info(xero_tenant_id, options = {})
2020
+ opts = options.dup
1996
2021
  if @api_client.config.debugging
1997
2022
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_benefits ...'
1998
2023
  end
@@ -2048,7 +2073,7 @@ module XeroRuby
2048
2073
  return data, status_code, headers
2049
2074
  end
2050
2075
 
2051
- # retrieve a single deduction by id
2076
+ # Retrieves a specific deduction by using a unique deduction ID
2052
2077
  # @param xero_tenant_id [String] Xero identifier for Tenant
2053
2078
  # @param deduction_id [String] Identifier for the deduction
2054
2079
  # @param [Hash] opts the optional parameters
@@ -2058,12 +2083,13 @@ module XeroRuby
2058
2083
  data
2059
2084
  end
2060
2085
 
2061
- # retrieve a single deduction by id
2086
+ # Retrieves a specific deduction by using a unique deduction ID
2062
2087
  # @param xero_tenant_id [String] Xero identifier for Tenant
2063
2088
  # @param deduction_id [String] Identifier for the deduction
2064
2089
  # @param [Hash] opts the optional parameters
2065
2090
  # @return [Array<(DeductionObject, Integer, Hash)>] DeductionObject data, response status code and response headers
2066
- def get_deduction_with_http_info(xero_tenant_id, deduction_id, opts = {})
2091
+ def get_deduction_with_http_info(xero_tenant_id, deduction_id, options = {})
2092
+ opts = options.dup
2067
2093
  if @api_client.config.debugging
2068
2094
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_deduction ...'
2069
2095
  end
@@ -2122,7 +2148,7 @@ module XeroRuby
2122
2148
  return data, status_code, headers
2123
2149
  end
2124
2150
 
2125
- # searches deductions
2151
+ # Retrieves deductions
2126
2152
  # @param xero_tenant_id [String] Xero identifier for Tenant
2127
2153
  # @param [Hash] opts the optional parameters
2128
2154
  # @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.
@@ -2132,12 +2158,13 @@ module XeroRuby
2132
2158
  data
2133
2159
  end
2134
2160
 
2135
- # searches deductions
2161
+ # Retrieves deductions
2136
2162
  # @param xero_tenant_id [String] Xero identifier for Tenant
2137
2163
  # @param [Hash] opts the optional parameters
2138
2164
  # @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.
2139
2165
  # @return [Array<(Deductions, Integer, Hash)>] Deductions data, response status code and response headers
2140
- def get_deductions_with_http_info(xero_tenant_id, opts = {})
2166
+ def get_deductions_with_http_info(xero_tenant_id, options = {})
2167
+ opts = options.dup
2141
2168
  if @api_client.config.debugging
2142
2169
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_deductions ...'
2143
2170
  end
@@ -2193,7 +2220,7 @@ module XeroRuby
2193
2220
  return data, status_code, headers
2194
2221
  end
2195
2222
 
2196
- # retrieve a single deduction by id
2223
+ # Retrieves a specific earnings orders by using a unique earnings orders id
2197
2224
  # @param xero_tenant_id [String] Xero identifier for Tenant
2198
2225
  # @param id [String] Identifier for the deduction
2199
2226
  # @param [Hash] opts the optional parameters
@@ -2203,12 +2230,13 @@ module XeroRuby
2203
2230
  data
2204
2231
  end
2205
2232
 
2206
- # retrieve a single deduction by id
2233
+ # Retrieves a specific earnings orders by using a unique earnings orders id
2207
2234
  # @param xero_tenant_id [String] Xero identifier for Tenant
2208
2235
  # @param id [String] Identifier for the deduction
2209
2236
  # @param [Hash] opts the optional parameters
2210
2237
  # @return [Array<(EarningsOrderObject, Integer, Hash)>] EarningsOrderObject data, response status code and response headers
2211
- def get_earnings_order_with_http_info(xero_tenant_id, id, opts = {})
2238
+ def get_earnings_order_with_http_info(xero_tenant_id, id, options = {})
2239
+ opts = options.dup
2212
2240
  if @api_client.config.debugging
2213
2241
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_earnings_order ...'
2214
2242
  end
@@ -2267,7 +2295,7 @@ module XeroRuby
2267
2295
  return data, status_code, headers
2268
2296
  end
2269
2297
 
2270
- # searches earnings orders
2298
+ # Retrieves earnings orders
2271
2299
  # @param xero_tenant_id [String] Xero identifier for Tenant
2272
2300
  # @param [Hash] opts the optional parameters
2273
2301
  # @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.
@@ -2277,12 +2305,13 @@ module XeroRuby
2277
2305
  data
2278
2306
  end
2279
2307
 
2280
- # searches earnings orders
2308
+ # Retrieves earnings orders
2281
2309
  # @param xero_tenant_id [String] Xero identifier for Tenant
2282
2310
  # @param [Hash] opts the optional parameters
2283
2311
  # @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.
2284
2312
  # @return [Array<(EarningsOrders, Integer, Hash)>] EarningsOrders data, response status code and response headers
2285
- def get_earnings_orders_with_http_info(xero_tenant_id, opts = {})
2313
+ def get_earnings_orders_with_http_info(xero_tenant_id, options = {})
2314
+ opts = options.dup
2286
2315
  if @api_client.config.debugging
2287
2316
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_earnings_orders ...'
2288
2317
  end
@@ -2338,7 +2367,7 @@ module XeroRuby
2338
2367
  return data, status_code, headers
2339
2368
  end
2340
2369
 
2341
- # retrieve a single earnings rates by id
2370
+ # Retrieves a specific earnings rates by using a unique earnings rate id
2342
2371
  # @param xero_tenant_id [String] Xero identifier for Tenant
2343
2372
  # @param earnings_rate_id [String] Identifier for the earnings rate
2344
2373
  # @param [Hash] opts the optional parameters
@@ -2348,12 +2377,13 @@ module XeroRuby
2348
2377
  data
2349
2378
  end
2350
2379
 
2351
- # retrieve a single earnings rates by id
2380
+ # Retrieves a specific earnings rates by using a unique earnings rate id
2352
2381
  # @param xero_tenant_id [String] Xero identifier for Tenant
2353
2382
  # @param earnings_rate_id [String] Identifier for the earnings rate
2354
2383
  # @param [Hash] opts the optional parameters
2355
2384
  # @return [Array<(EarningsRateObject, Integer, Hash)>] EarningsRateObject data, response status code and response headers
2356
- def get_earnings_rate_with_http_info(xero_tenant_id, earnings_rate_id, opts = {})
2385
+ def get_earnings_rate_with_http_info(xero_tenant_id, earnings_rate_id, options = {})
2386
+ opts = options.dup
2357
2387
  if @api_client.config.debugging
2358
2388
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_earnings_rate ...'
2359
2389
  end
@@ -2412,7 +2442,7 @@ module XeroRuby
2412
2442
  return data, status_code, headers
2413
2443
  end
2414
2444
 
2415
- # searches earnings rates
2445
+ # Retrieves earnings rates
2416
2446
  # @param xero_tenant_id [String] Xero identifier for Tenant
2417
2447
  # @param [Hash] opts the optional parameters
2418
2448
  # @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.
@@ -2422,12 +2452,13 @@ module XeroRuby
2422
2452
  data
2423
2453
  end
2424
2454
 
2425
- # searches earnings rates
2455
+ # Retrieves earnings rates
2426
2456
  # @param xero_tenant_id [String] Xero identifier for Tenant
2427
2457
  # @param [Hash] opts the optional parameters
2428
2458
  # @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.
2429
2459
  # @return [Array<(EarningsRates, Integer, Hash)>] EarningsRates data, response status code and response headers
2430
- def get_earnings_rates_with_http_info(xero_tenant_id, opts = {})
2460
+ def get_earnings_rates_with_http_info(xero_tenant_id, options = {})
2461
+ opts = options.dup
2431
2462
  if @api_client.config.debugging
2432
2463
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_earnings_rates ...'
2433
2464
  end
@@ -2483,7 +2514,7 @@ module XeroRuby
2483
2514
  return data, status_code, headers
2484
2515
  end
2485
2516
 
2486
- # searches employees
2517
+ # Retrieves specific employees by using a unique employee ID
2487
2518
  # @param xero_tenant_id [String] Xero identifier for Tenant
2488
2519
  # @param employee_id [String] Employee id for single object
2489
2520
  # @param [Hash] opts the optional parameters
@@ -2493,12 +2524,13 @@ module XeroRuby
2493
2524
  data
2494
2525
  end
2495
2526
 
2496
- # searches employees
2527
+ # Retrieves specific employees by using a unique employee ID
2497
2528
  # @param xero_tenant_id [String] Xero identifier for Tenant
2498
2529
  # @param employee_id [String] Employee id for single object
2499
2530
  # @param [Hash] opts the optional parameters
2500
2531
  # @return [Array<(EmployeeObject, Integer, Hash)>] EmployeeObject data, response status code and response headers
2501
- def get_employee_with_http_info(xero_tenant_id, employee_id, opts = {})
2532
+ def get_employee_with_http_info(xero_tenant_id, employee_id, options = {})
2533
+ opts = options.dup
2502
2534
  if @api_client.config.debugging
2503
2535
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee ...'
2504
2536
  end
@@ -2511,7 +2543,7 @@ module XeroRuby
2511
2543
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollUkApi.get_employee"
2512
2544
  end
2513
2545
  # resource path
2514
- local_var_path = '/Employees/{EmployeeId}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
2546
+ local_var_path = '/Employees/{EmployeeID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
2515
2547
 
2516
2548
  # camelize keys of incoming `where` opts
2517
2549
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -2557,7 +2589,7 @@ module XeroRuby
2557
2589
  return data, status_code, headers
2558
2590
  end
2559
2591
 
2560
- # retrieve a single employee leave record
2592
+ # Retrieves a specific employee's leave record using a unique employee ID
2561
2593
  # @param xero_tenant_id [String] Xero identifier for Tenant
2562
2594
  # @param employee_id [String] Employee id for single object
2563
2595
  # @param leave_id [String] Leave id for single object
@@ -2568,13 +2600,14 @@ module XeroRuby
2568
2600
  data
2569
2601
  end
2570
2602
 
2571
- # retrieve a single employee leave record
2603
+ # Retrieves a specific employee&#39;s leave record using a unique employee ID
2572
2604
  # @param xero_tenant_id [String] Xero identifier for Tenant
2573
2605
  # @param employee_id [String] Employee id for single object
2574
2606
  # @param leave_id [String] Leave id for single object
2575
2607
  # @param [Hash] opts the optional parameters
2576
2608
  # @return [Array<(EmployeeLeaveObject, Integer, Hash)>] EmployeeLeaveObject data, response status code and response headers
2577
- def get_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, opts = {})
2609
+ def get_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, options = {})
2610
+ opts = options.dup
2578
2611
  if @api_client.config.debugging
2579
2612
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_leave ...'
2580
2613
  end
@@ -2591,7 +2624,7 @@ module XeroRuby
2591
2624
  fail ArgumentError, "Missing the required parameter 'leave_id' when calling PayrollUkApi.get_employee_leave"
2592
2625
  end
2593
2626
  # resource path
2594
- local_var_path = '/Employees/{EmployeeId}/Leave/{LeaveID}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s).sub('{' + 'LeaveID' + '}', leave_id.to_s)
2627
+ local_var_path = '/Employees/{EmployeeID}/Leave/{LeaveID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'LeaveID' + '}', leave_id.to_s)
2595
2628
 
2596
2629
  # camelize keys of incoming `where` opts
2597
2630
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -2637,7 +2670,7 @@ module XeroRuby
2637
2670
  return data, status_code, headers
2638
2671
  end
2639
2672
 
2640
- # search employee leave balances
2673
+ # Retrieves a specific employee's leave balances using a unique employee ID
2641
2674
  # @param xero_tenant_id [String] Xero identifier for Tenant
2642
2675
  # @param employee_id [String] Employee id for single object
2643
2676
  # @param [Hash] opts the optional parameters
@@ -2647,12 +2680,13 @@ module XeroRuby
2647
2680
  data
2648
2681
  end
2649
2682
 
2650
- # search employee leave balances
2683
+ # Retrieves a specific employee&#39;s leave balances using a unique employee ID
2651
2684
  # @param xero_tenant_id [String] Xero identifier for Tenant
2652
2685
  # @param employee_id [String] Employee id for single object
2653
2686
  # @param [Hash] opts the optional parameters
2654
2687
  # @return [Array<(EmployeeLeaveBalances, Integer, Hash)>] EmployeeLeaveBalances data, response status code and response headers
2655
- def get_employee_leave_balances_with_http_info(xero_tenant_id, employee_id, opts = {})
2688
+ def get_employee_leave_balances_with_http_info(xero_tenant_id, employee_id, options = {})
2689
+ opts = options.dup
2656
2690
  if @api_client.config.debugging
2657
2691
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_leave_balances ...'
2658
2692
  end
@@ -2665,7 +2699,7 @@ module XeroRuby
2665
2699
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollUkApi.get_employee_leave_balances"
2666
2700
  end
2667
2701
  # resource path
2668
- local_var_path = '/Employees/{EmployeeId}/LeaveBalances'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
2702
+ local_var_path = '/Employees/{EmployeeID}/LeaveBalances'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
2669
2703
 
2670
2704
  # camelize keys of incoming `where` opts
2671
2705
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -2711,7 +2745,7 @@ module XeroRuby
2711
2745
  return data, status_code, headers
2712
2746
  end
2713
2747
 
2714
- # searches employee leave periods
2748
+ # Retrieves a specific employee's leave periods using a unique employee ID
2715
2749
  # @param xero_tenant_id [String] Xero identifier for Tenant
2716
2750
  # @param employee_id [String] Employee id for single object
2717
2751
  # @param [Hash] opts the optional parameters
@@ -2723,14 +2757,15 @@ module XeroRuby
2723
2757
  data
2724
2758
  end
2725
2759
 
2726
- # searches employee leave periods
2760
+ # Retrieves a specific employee&#39;s leave periods using a unique employee ID
2727
2761
  # @param xero_tenant_id [String] Xero identifier for Tenant
2728
2762
  # @param employee_id [String] Employee id for single object
2729
2763
  # @param [Hash] opts the optional parameters
2730
2764
  # @option opts [Date] :start_date Filter by start date
2731
2765
  # @option opts [Date] :end_date Filter by end date
2732
2766
  # @return [Array<(LeavePeriods, Integer, Hash)>] LeavePeriods data, response status code and response headers
2733
- def get_employee_leave_periods_with_http_info(xero_tenant_id, employee_id, opts = {})
2767
+ def get_employee_leave_periods_with_http_info(xero_tenant_id, employee_id, options = {})
2768
+ opts = options.dup
2734
2769
  if @api_client.config.debugging
2735
2770
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_leave_periods ...'
2736
2771
  end
@@ -2743,7 +2778,7 @@ module XeroRuby
2743
2778
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollUkApi.get_employee_leave_periods"
2744
2779
  end
2745
2780
  # resource path
2746
- local_var_path = '/Employees/{EmployeeId}/LeavePeriods'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
2781
+ local_var_path = '/Employees/{EmployeeID}/LeavePeriods'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
2747
2782
 
2748
2783
  # camelize keys of incoming `where` opts
2749
2784
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -2791,7 +2826,7 @@ module XeroRuby
2791
2826
  return data, status_code, headers
2792
2827
  end
2793
2828
 
2794
- # searches employee leave types
2829
+ # Retrieves a specific employee's leave types using a unique employee ID
2795
2830
  # @param xero_tenant_id [String] Xero identifier for Tenant
2796
2831
  # @param employee_id [String] Employee id for single object
2797
2832
  # @param [Hash] opts the optional parameters
@@ -2801,12 +2836,13 @@ module XeroRuby
2801
2836
  data
2802
2837
  end
2803
2838
 
2804
- # searches employee leave types
2839
+ # Retrieves a specific employee&#39;s leave types using a unique employee ID
2805
2840
  # @param xero_tenant_id [String] Xero identifier for Tenant
2806
2841
  # @param employee_id [String] Employee id for single object
2807
2842
  # @param [Hash] opts the optional parameters
2808
2843
  # @return [Array<(EmployeeLeaveTypes, Integer, Hash)>] EmployeeLeaveTypes data, response status code and response headers
2809
- def get_employee_leave_types_with_http_info(xero_tenant_id, employee_id, opts = {})
2844
+ def get_employee_leave_types_with_http_info(xero_tenant_id, employee_id, options = {})
2845
+ opts = options.dup
2810
2846
  if @api_client.config.debugging
2811
2847
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_leave_types ...'
2812
2848
  end
@@ -2819,7 +2855,7 @@ module XeroRuby
2819
2855
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollUkApi.get_employee_leave_types"
2820
2856
  end
2821
2857
  # resource path
2822
- local_var_path = '/Employees/{EmployeeId}/LeaveTypes'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
2858
+ local_var_path = '/Employees/{EmployeeID}/LeaveTypes'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
2823
2859
 
2824
2860
  # camelize keys of incoming `where` opts
2825
2861
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -2865,7 +2901,7 @@ module XeroRuby
2865
2901
  return data, status_code, headers
2866
2902
  end
2867
2903
 
2868
- # search employee leave records
2904
+ # Retrieves a specific employee's leave records using a unique employee ID
2869
2905
  # @param xero_tenant_id [String] Xero identifier for Tenant
2870
2906
  # @param employee_id [String] Employee id for single object
2871
2907
  # @param [Hash] opts the optional parameters
@@ -2875,12 +2911,13 @@ module XeroRuby
2875
2911
  data
2876
2912
  end
2877
2913
 
2878
- # search employee leave records
2914
+ # Retrieves a specific employee&#39;s leave records using a unique employee ID
2879
2915
  # @param xero_tenant_id [String] Xero identifier for Tenant
2880
2916
  # @param employee_id [String] Employee id for single object
2881
2917
  # @param [Hash] opts the optional parameters
2882
2918
  # @return [Array<(EmployeeLeaves, Integer, Hash)>] EmployeeLeaves data, response status code and response headers
2883
- def get_employee_leaves_with_http_info(xero_tenant_id, employee_id, opts = {})
2919
+ def get_employee_leaves_with_http_info(xero_tenant_id, employee_id, options = {})
2920
+ opts = options.dup
2884
2921
  if @api_client.config.debugging
2885
2922
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_leaves ...'
2886
2923
  end
@@ -2893,7 +2930,7 @@ module XeroRuby
2893
2930
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollUkApi.get_employee_leaves"
2894
2931
  end
2895
2932
  # resource path
2896
- local_var_path = '/Employees/{EmployeeId}/Leave'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
2933
+ local_var_path = '/Employees/{EmployeeID}/Leave'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
2897
2934
 
2898
2935
  # camelize keys of incoming `where` opts
2899
2936
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -2939,7 +2976,7 @@ module XeroRuby
2939
2976
  return data, status_code, headers
2940
2977
  end
2941
2978
 
2942
- # retrieve employee openingbalances
2979
+ # Retrieves a specific employee's openingbalances using a unique employee ID
2943
2980
  # @param xero_tenant_id [String] Xero identifier for Tenant
2944
2981
  # @param employee_id [String] Employee id for single object
2945
2982
  # @param [Hash] opts the optional parameters
@@ -2949,12 +2986,13 @@ module XeroRuby
2949
2986
  data
2950
2987
  end
2951
2988
 
2952
- # retrieve employee openingbalances
2989
+ # Retrieves a specific employee&#39;s openingbalances using a unique employee ID
2953
2990
  # @param xero_tenant_id [String] Xero identifier for Tenant
2954
2991
  # @param employee_id [String] Employee id for single object
2955
2992
  # @param [Hash] opts the optional parameters
2956
2993
  # @return [Array<(EmployeeOpeningBalancesObject, Integer, Hash)>] EmployeeOpeningBalancesObject data, response status code and response headers
2957
- def get_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, opts = {})
2994
+ def get_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, options = {})
2995
+ opts = options.dup
2958
2996
  if @api_client.config.debugging
2959
2997
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_opening_balances ...'
2960
2998
  end
@@ -2967,7 +3005,7 @@ module XeroRuby
2967
3005
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollUkApi.get_employee_opening_balances"
2968
3006
  end
2969
3007
  # resource path
2970
- local_var_path = '/Employees/{EmployeeId}/ukopeningbalances'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
3008
+ local_var_path = '/Employees/{EmployeeID}/ukopeningbalances'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
2971
3009
 
2972
3010
  # camelize keys of incoming `where` opts
2973
3011
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -3013,7 +3051,7 @@ module XeroRuby
3013
3051
  return data, status_code, headers
3014
3052
  end
3015
3053
 
3016
- # searches employee pay templates
3054
+ # Retrieves a specific employee pay templates using a unique employee ID
3017
3055
  # @param xero_tenant_id [String] Xero identifier for Tenant
3018
3056
  # @param employee_id [String] Employee id for single object
3019
3057
  # @param [Hash] opts the optional parameters
@@ -3023,12 +3061,13 @@ module XeroRuby
3023
3061
  data
3024
3062
  end
3025
3063
 
3026
- # searches employee pay templates
3064
+ # Retrieves a specific employee pay templates using a unique employee ID
3027
3065
  # @param xero_tenant_id [String] Xero identifier for Tenant
3028
3066
  # @param employee_id [String] Employee id for single object
3029
3067
  # @param [Hash] opts the optional parameters
3030
3068
  # @return [Array<(EmployeePayTemplateObject, Integer, Hash)>] EmployeePayTemplateObject data, response status code and response headers
3031
- def get_employee_pay_template_with_http_info(xero_tenant_id, employee_id, opts = {})
3069
+ def get_employee_pay_template_with_http_info(xero_tenant_id, employee_id, options = {})
3070
+ opts = options.dup
3032
3071
  if @api_client.config.debugging
3033
3072
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_pay_template ...'
3034
3073
  end
@@ -3041,7 +3080,7 @@ module XeroRuby
3041
3080
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollUkApi.get_employee_pay_template"
3042
3081
  end
3043
3082
  # resource path
3044
- local_var_path = '/Employees/{EmployeeId}/PayTemplates'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
3083
+ local_var_path = '/Employees/{EmployeeID}/PayTemplates'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
3045
3084
 
3046
3085
  # camelize keys of incoming `where` opts
3047
3086
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -3087,7 +3126,7 @@ module XeroRuby
3087
3126
  return data, status_code, headers
3088
3127
  end
3089
3128
 
3090
- # retrieves an employee's payment method
3129
+ # Retrieves a specific employee's payment method using a unique employee ID
3091
3130
  # @param xero_tenant_id [String] Xero identifier for Tenant
3092
3131
  # @param employee_id [String] Employee id for single object
3093
3132
  # @param [Hash] opts the optional parameters
@@ -3097,12 +3136,13 @@ module XeroRuby
3097
3136
  data
3098
3137
  end
3099
3138
 
3100
- # retrieves an employee&#39;s payment method
3139
+ # Retrieves a specific employee&#39;s payment method using a unique employee ID
3101
3140
  # @param xero_tenant_id [String] Xero identifier for Tenant
3102
3141
  # @param employee_id [String] Employee id for single object
3103
3142
  # @param [Hash] opts the optional parameters
3104
3143
  # @return [Array<(PaymentMethodObject, Integer, Hash)>] PaymentMethodObject data, response status code and response headers
3105
- def get_employee_payment_method_with_http_info(xero_tenant_id, employee_id, opts = {})
3144
+ def get_employee_payment_method_with_http_info(xero_tenant_id, employee_id, options = {})
3145
+ opts = options.dup
3106
3146
  if @api_client.config.debugging
3107
3147
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_payment_method ...'
3108
3148
  end
@@ -3115,7 +3155,7 @@ module XeroRuby
3115
3155
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollUkApi.get_employee_payment_method"
3116
3156
  end
3117
3157
  # resource path
3118
- local_var_path = '/Employees/{EmployeeId}/PaymentMethods'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
3158
+ local_var_path = '/Employees/{EmployeeID}/PaymentMethods'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
3119
3159
 
3120
3160
  # camelize keys of incoming `where` opts
3121
3161
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -3161,7 +3201,7 @@ module XeroRuby
3161
3201
  return data, status_code, headers
3162
3202
  end
3163
3203
 
3164
- # get employee salary and wages record by id
3204
+ # Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id
3165
3205
  # @param xero_tenant_id [String] Xero identifier for Tenant
3166
3206
  # @param employee_id [String] Employee id for single object
3167
3207
  # @param salary_and_wages_id [String] Id for single pay template earnings object
@@ -3172,13 +3212,14 @@ module XeroRuby
3172
3212
  data
3173
3213
  end
3174
3214
 
3175
- # get employee salary and wages record by id
3215
+ # Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id
3176
3216
  # @param xero_tenant_id [String] Xero identifier for Tenant
3177
3217
  # @param employee_id [String] Employee id for single object
3178
3218
  # @param salary_and_wages_id [String] Id for single pay template earnings object
3179
3219
  # @param [Hash] opts the optional parameters
3180
3220
  # @return [Array<(SalaryAndWages, Integer, Hash)>] SalaryAndWages data, response status code and response headers
3181
- def get_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, opts = {})
3221
+ def get_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, options = {})
3222
+ opts = options.dup
3182
3223
  if @api_client.config.debugging
3183
3224
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_salary_and_wage ...'
3184
3225
  end
@@ -3195,7 +3236,7 @@ module XeroRuby
3195
3236
  fail ArgumentError, "Missing the required parameter 'salary_and_wages_id' when calling PayrollUkApi.get_employee_salary_and_wage"
3196
3237
  end
3197
3238
  # resource path
3198
- local_var_path = '/Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s).sub('{' + 'SalaryAndWagesID' + '}', salary_and_wages_id.to_s)
3239
+ local_var_path = '/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'SalaryAndWagesID' + '}', salary_and_wages_id.to_s)
3199
3240
 
3200
3241
  # camelize keys of incoming `where` opts
3201
3242
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -3241,7 +3282,7 @@ module XeroRuby
3241
3282
  return data, status_code, headers
3242
3283
  end
3243
3284
 
3244
- # retrieves an employee's salary and wages
3285
+ # Retrieves a specific employee's salary and wages by using a unique employee ID
3245
3286
  # @param xero_tenant_id [String] Xero identifier for Tenant
3246
3287
  # @param employee_id [String] Employee id for single object
3247
3288
  # @param [Hash] opts the optional parameters
@@ -3252,13 +3293,14 @@ module XeroRuby
3252
3293
  data
3253
3294
  end
3254
3295
 
3255
- # retrieves an employee&#39;s salary and wages
3296
+ # Retrieves a specific employee&#39;s salary and wages by using a unique employee ID
3256
3297
  # @param xero_tenant_id [String] Xero identifier for Tenant
3257
3298
  # @param employee_id [String] Employee id for single object
3258
3299
  # @param [Hash] opts the optional parameters
3259
3300
  # @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.
3260
3301
  # @return [Array<(SalaryAndWages, Integer, Hash)>] SalaryAndWages data, response status code and response headers
3261
- def get_employee_salary_and_wages_with_http_info(xero_tenant_id, employee_id, opts = {})
3302
+ def get_employee_salary_and_wages_with_http_info(xero_tenant_id, employee_id, options = {})
3303
+ opts = options.dup
3262
3304
  if @api_client.config.debugging
3263
3305
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_salary_and_wages ...'
3264
3306
  end
@@ -3271,7 +3313,7 @@ module XeroRuby
3271
3313
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollUkApi.get_employee_salary_and_wages"
3272
3314
  end
3273
3315
  # resource path
3274
- local_var_path = '/Employees/{EmployeeId}/SalaryAndWages'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
3316
+ local_var_path = '/Employees/{EmployeeID}/SalaryAndWages'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
3275
3317
 
3276
3318
  # camelize keys of incoming `where` opts
3277
3319
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -3318,7 +3360,7 @@ module XeroRuby
3318
3360
  return data, status_code, headers
3319
3361
  end
3320
3362
 
3321
- # search employee leave balances
3363
+ # Retrieves a specific employee's leave balances using a unique employee ID
3322
3364
  # @param xero_tenant_id [String] Xero identifier for Tenant
3323
3365
  # @param employee_id [String] Employee id for single object
3324
3366
  # @param [Hash] opts the optional parameters
@@ -3330,14 +3372,15 @@ module XeroRuby
3330
3372
  data
3331
3373
  end
3332
3374
 
3333
- # search employee leave balances
3375
+ # Retrieves a specific employee&#39;s leave balances using a unique employee ID
3334
3376
  # @param xero_tenant_id [String] Xero identifier for Tenant
3335
3377
  # @param employee_id [String] Employee id for single object
3336
3378
  # @param [Hash] opts the optional parameters
3337
3379
  # @option opts [String] :leave_type Filter by the type of statutory leave
3338
3380
  # @option opts [Date] :as_of_date The date from which to calculate balance remaining. If not specified, current date UTC is used.
3339
3381
  # @return [Array<(EmployeeStatutoryLeaveBalanceObject, Integer, Hash)>] EmployeeStatutoryLeaveBalanceObject data, response status code and response headers
3340
- def get_employee_statutory_leave_balances_with_http_info(xero_tenant_id, employee_id, opts = {})
3382
+ def get_employee_statutory_leave_balances_with_http_info(xero_tenant_id, employee_id, options = {})
3383
+ opts = options.dup
3341
3384
  if @api_client.config.debugging
3342
3385
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_statutory_leave_balances ...'
3343
3386
  end
@@ -3350,7 +3393,7 @@ module XeroRuby
3350
3393
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollUkApi.get_employee_statutory_leave_balances"
3351
3394
  end
3352
3395
  # resource path
3353
- local_var_path = '/Employees/{EmployeeId}/StatutoryLeaveBalance'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
3396
+ local_var_path = '/Employees/{EmployeeID}/StatutoryLeaveBalance'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
3354
3397
 
3355
3398
  # camelize keys of incoming `where` opts
3356
3399
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -3398,7 +3441,7 @@ module XeroRuby
3398
3441
  return data, status_code, headers
3399
3442
  end
3400
3443
 
3401
- # retrieve a statutory sick leave for an employee
3444
+ # Retrieves a statutory sick leave for an employee
3402
3445
  # @param xero_tenant_id [String] Xero identifier for Tenant
3403
3446
  # @param statutory_sick_leave_id [String] Statutory sick leave id for single object
3404
3447
  # @param [Hash] opts the optional parameters
@@ -3408,12 +3451,13 @@ module XeroRuby
3408
3451
  data
3409
3452
  end
3410
3453
 
3411
- # retrieve a statutory sick leave for an employee
3454
+ # Retrieves a statutory sick leave for an employee
3412
3455
  # @param xero_tenant_id [String] Xero identifier for Tenant
3413
3456
  # @param statutory_sick_leave_id [String] Statutory sick leave id for single object
3414
3457
  # @param [Hash] opts the optional parameters
3415
3458
  # @return [Array<(EmployeeStatutorySickLeaveObject, Integer, Hash)>] EmployeeStatutorySickLeaveObject data, response status code and response headers
3416
- def get_employee_statutory_sick_leave_with_http_info(xero_tenant_id, statutory_sick_leave_id, opts = {})
3459
+ def get_employee_statutory_sick_leave_with_http_info(xero_tenant_id, statutory_sick_leave_id, options = {})
3460
+ opts = options.dup
3417
3461
  if @api_client.config.debugging
3418
3462
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_statutory_sick_leave ...'
3419
3463
  end
@@ -3472,7 +3516,7 @@ module XeroRuby
3472
3516
  return data, status_code, headers
3473
3517
  end
3474
3518
 
3475
- # searches tax records for an employee
3519
+ # Retrieves tax records for a specific employee using a unique employee ID
3476
3520
  # @param xero_tenant_id [String] Xero identifier for Tenant
3477
3521
  # @param employee_id [String] Employee id for single object
3478
3522
  # @param [Hash] opts the optional parameters
@@ -3482,12 +3526,13 @@ module XeroRuby
3482
3526
  data
3483
3527
  end
3484
3528
 
3485
- # searches tax records for an employee
3529
+ # Retrieves tax records for a specific employee using a unique employee ID
3486
3530
  # @param xero_tenant_id [String] Xero identifier for Tenant
3487
3531
  # @param employee_id [String] Employee id for single object
3488
3532
  # @param [Hash] opts the optional parameters
3489
3533
  # @return [Array<(EmployeeTaxObject, Integer, Hash)>] EmployeeTaxObject data, response status code and response headers
3490
- def get_employee_tax_with_http_info(xero_tenant_id, employee_id, opts = {})
3534
+ def get_employee_tax_with_http_info(xero_tenant_id, employee_id, options = {})
3535
+ opts = options.dup
3491
3536
  if @api_client.config.debugging
3492
3537
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_tax ...'
3493
3538
  end
@@ -3500,7 +3545,7 @@ module XeroRuby
3500
3545
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollUkApi.get_employee_tax"
3501
3546
  end
3502
3547
  # resource path
3503
- local_var_path = '/Employees/{EmployeeId}/Tax'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
3548
+ local_var_path = '/Employees/{EmployeeID}/Tax'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
3504
3549
 
3505
3550
  # camelize keys of incoming `where` opts
3506
3551
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -3546,11 +3591,10 @@ module XeroRuby
3546
3591
  return data, status_code, headers
3547
3592
  end
3548
3593
 
3549
- # searches employees
3594
+ # Retrieves employees
3550
3595
  # @param xero_tenant_id [String] Xero identifier for Tenant
3551
3596
  # @param [Hash] opts the optional parameters
3552
- # @option opts [String] :first_name Filter by first name
3553
- # @option opts [String] :last_name Filter by last name
3597
+ # @option opts [String] :filter Filter by first name and/or lastname
3554
3598
  # @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.
3555
3599
  # @return [Employees]
3556
3600
  def get_employees(xero_tenant_id, opts = {})
@@ -3558,14 +3602,14 @@ module XeroRuby
3558
3602
  data
3559
3603
  end
3560
3604
 
3561
- # searches employees
3605
+ # Retrieves employees
3562
3606
  # @param xero_tenant_id [String] Xero identifier for Tenant
3563
3607
  # @param [Hash] opts the optional parameters
3564
- # @option opts [String] :first_name Filter by first name
3565
- # @option opts [String] :last_name Filter by last name
3608
+ # @option opts [String] :filter Filter by first name and/or lastname
3566
3609
  # @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.
3567
3610
  # @return [Array<(Employees, Integer, Hash)>] Employees data, response status code and response headers
3568
- def get_employees_with_http_info(xero_tenant_id, opts = {})
3611
+ def get_employees_with_http_info(xero_tenant_id, options = {})
3612
+ opts = options.dup
3569
3613
  if @api_client.config.debugging
3570
3614
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employees ...'
3571
3615
  end
@@ -3581,8 +3625,7 @@ module XeroRuby
3581
3625
 
3582
3626
  # query parameters
3583
3627
  query_params = opts[:query_params] || {}
3584
- query_params[:'firstName'] = opts[:'first_name'] if !opts[:'first_name'].nil?
3585
- query_params[:'lastName'] = opts[:'last_name'] if !opts[:'last_name'].nil?
3628
+ query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
3586
3629
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
3587
3630
 
3588
3631
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
@@ -3623,7 +3666,7 @@ module XeroRuby
3623
3666
  return data, status_code, headers
3624
3667
  end
3625
3668
 
3626
- # retrieve a single leave type by id
3669
+ # Retrieves a specific leave type by using a unique leave type ID
3627
3670
  # @param xero_tenant_id [String] Xero identifier for Tenant
3628
3671
  # @param leave_type_id [String] Identifier for the leave type
3629
3672
  # @param [Hash] opts the optional parameters
@@ -3633,12 +3676,13 @@ module XeroRuby
3633
3676
  data
3634
3677
  end
3635
3678
 
3636
- # retrieve a single leave type by id
3679
+ # Retrieves a specific leave type by using a unique leave type ID
3637
3680
  # @param xero_tenant_id [String] Xero identifier for Tenant
3638
3681
  # @param leave_type_id [String] Identifier for the leave type
3639
3682
  # @param [Hash] opts the optional parameters
3640
3683
  # @return [Array<(LeaveTypeObject, Integer, Hash)>] LeaveTypeObject data, response status code and response headers
3641
- def get_leave_type_with_http_info(xero_tenant_id, leave_type_id, opts = {})
3684
+ def get_leave_type_with_http_info(xero_tenant_id, leave_type_id, options = {})
3685
+ opts = options.dup
3642
3686
  if @api_client.config.debugging
3643
3687
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_leave_type ...'
3644
3688
  end
@@ -3697,7 +3741,7 @@ module XeroRuby
3697
3741
  return data, status_code, headers
3698
3742
  end
3699
3743
 
3700
- # searches leave types
3744
+ # Retrieves leave types
3701
3745
  # @param xero_tenant_id [String] Xero identifier for Tenant
3702
3746
  # @param [Hash] opts the optional parameters
3703
3747
  # @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.
@@ -3708,13 +3752,14 @@ module XeroRuby
3708
3752
  data
3709
3753
  end
3710
3754
 
3711
- # searches leave types
3755
+ # Retrieves leave types
3712
3756
  # @param xero_tenant_id [String] Xero identifier for Tenant
3713
3757
  # @param [Hash] opts the optional parameters
3714
3758
  # @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.
3715
3759
  # @option opts [Boolean] :active_only Filters leave types by active status. By default the API returns all leave types.
3716
3760
  # @return [Array<(LeaveTypes, Integer, Hash)>] LeaveTypes data, response status code and response headers
3717
- def get_leave_types_with_http_info(xero_tenant_id, opts = {})
3761
+ def get_leave_types_with_http_info(xero_tenant_id, options = {})
3762
+ opts = options.dup
3718
3763
  if @api_client.config.debugging
3719
3764
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_leave_types ...'
3720
3765
  end
@@ -3771,7 +3816,7 @@ module XeroRuby
3771
3816
  return data, status_code, headers
3772
3817
  end
3773
3818
 
3774
- # retrieve a single pay run by id
3819
+ # Retrieves a specific pay run by using a unique pay run ID
3775
3820
  # @param xero_tenant_id [String] Xero identifier for Tenant
3776
3821
  # @param pay_run_id [String] Identifier for the pay run
3777
3822
  # @param [Hash] opts the optional parameters
@@ -3781,12 +3826,13 @@ module XeroRuby
3781
3826
  data
3782
3827
  end
3783
3828
 
3784
- # retrieve a single pay run by id
3829
+ # Retrieves a specific pay run by using a unique pay run ID
3785
3830
  # @param xero_tenant_id [String] Xero identifier for Tenant
3786
3831
  # @param pay_run_id [String] Identifier for the pay run
3787
3832
  # @param [Hash] opts the optional parameters
3788
3833
  # @return [Array<(PayRunObject, Integer, Hash)>] PayRunObject data, response status code and response headers
3789
- def get_pay_run_with_http_info(xero_tenant_id, pay_run_id, opts = {})
3834
+ def get_pay_run_with_http_info(xero_tenant_id, pay_run_id, options = {})
3835
+ opts = options.dup
3790
3836
  if @api_client.config.debugging
3791
3837
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_pay_run ...'
3792
3838
  end
@@ -3845,7 +3891,7 @@ module XeroRuby
3845
3891
  return data, status_code, headers
3846
3892
  end
3847
3893
 
3848
- # retrieve a single payrun calendar by id
3894
+ # Retrieves a specific payrun calendar by using a unique payrun calendar ID
3849
3895
  # @param xero_tenant_id [String] Xero identifier for Tenant
3850
3896
  # @param pay_run_calendar_id [String] Identifier for the payrun calendars
3851
3897
  # @param [Hash] opts the optional parameters
@@ -3855,12 +3901,13 @@ module XeroRuby
3855
3901
  data
3856
3902
  end
3857
3903
 
3858
- # retrieve a single payrun calendar by id
3904
+ # Retrieves a specific payrun calendar by using a unique payrun calendar ID
3859
3905
  # @param xero_tenant_id [String] Xero identifier for Tenant
3860
3906
  # @param pay_run_calendar_id [String] Identifier for the payrun calendars
3861
3907
  # @param [Hash] opts the optional parameters
3862
3908
  # @return [Array<(PayRunCalendarObject, Integer, Hash)>] PayRunCalendarObject data, response status code and response headers
3863
- def get_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar_id, opts = {})
3909
+ def get_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar_id, options = {})
3910
+ opts = options.dup
3864
3911
  if @api_client.config.debugging
3865
3912
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_pay_run_calendar ...'
3866
3913
  end
@@ -3919,7 +3966,7 @@ module XeroRuby
3919
3966
  return data, status_code, headers
3920
3967
  end
3921
3968
 
3922
- # searches payrun calendars
3969
+ # Retrieves payrun calendars
3923
3970
  # @param xero_tenant_id [String] Xero identifier for Tenant
3924
3971
  # @param [Hash] opts the optional parameters
3925
3972
  # @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.
@@ -3929,12 +3976,13 @@ module XeroRuby
3929
3976
  data
3930
3977
  end
3931
3978
 
3932
- # searches payrun calendars
3979
+ # Retrieves payrun calendars
3933
3980
  # @param xero_tenant_id [String] Xero identifier for Tenant
3934
3981
  # @param [Hash] opts the optional parameters
3935
3982
  # @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.
3936
3983
  # @return [Array<(PayRunCalendars, Integer, Hash)>] PayRunCalendars data, response status code and response headers
3937
- def get_pay_run_calendars_with_http_info(xero_tenant_id, opts = {})
3984
+ def get_pay_run_calendars_with_http_info(xero_tenant_id, options = {})
3985
+ opts = options.dup
3938
3986
  if @api_client.config.debugging
3939
3987
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_pay_run_calendars ...'
3940
3988
  end
@@ -3990,7 +4038,7 @@ module XeroRuby
3990
4038
  return data, status_code, headers
3991
4039
  end
3992
4040
 
3993
- # searches pay runs
4041
+ # Retrieves pay runs
3994
4042
  # @param xero_tenant_id [String] Xero identifier for Tenant
3995
4043
  # @param [Hash] opts the optional parameters
3996
4044
  # @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.
@@ -4001,13 +4049,14 @@ module XeroRuby
4001
4049
  data
4002
4050
  end
4003
4051
 
4004
- # searches pay runs
4052
+ # Retrieves pay runs
4005
4053
  # @param xero_tenant_id [String] Xero identifier for Tenant
4006
4054
  # @param [Hash] opts the optional parameters
4007
4055
  # @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.
4008
4056
  # @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.
4009
4057
  # @return [Array<(PayRuns, Integer, Hash)>] PayRuns data, response status code and response headers
4010
- def get_pay_runs_with_http_info(xero_tenant_id, opts = {})
4058
+ def get_pay_runs_with_http_info(xero_tenant_id, options = {})
4059
+ opts = options.dup
4011
4060
  if @api_client.config.debugging
4012
4061
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_pay_runs ...'
4013
4062
  end
@@ -4068,7 +4117,7 @@ module XeroRuby
4068
4117
  return data, status_code, headers
4069
4118
  end
4070
4119
 
4071
- # retrieve a single payslip by id
4120
+ # Retrieves a specific payslip by using a unique payslip ID
4072
4121
  # @param xero_tenant_id [String] Xero identifier for Tenant
4073
4122
  # @param payslip_id [String] Identifier for the payslip
4074
4123
  # @param [Hash] opts the optional parameters
@@ -4078,12 +4127,13 @@ module XeroRuby
4078
4127
  data
4079
4128
  end
4080
4129
 
4081
- # retrieve a single payslip by id
4130
+ # Retrieves a specific payslip by using a unique payslip ID
4082
4131
  # @param xero_tenant_id [String] Xero identifier for Tenant
4083
4132
  # @param payslip_id [String] Identifier for the payslip
4084
4133
  # @param [Hash] opts the optional parameters
4085
4134
  # @return [Array<(PayslipObject, Integer, Hash)>] PayslipObject data, response status code and response headers
4086
- def get_pay_slip_with_http_info(xero_tenant_id, payslip_id, opts = {})
4135
+ def get_pay_slip_with_http_info(xero_tenant_id, payslip_id, options = {})
4136
+ opts = options.dup
4087
4137
  if @api_client.config.debugging
4088
4138
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_pay_slip ...'
4089
4139
  end
@@ -4142,7 +4192,7 @@ module XeroRuby
4142
4192
  return data, status_code, headers
4143
4193
  end
4144
4194
 
4145
- # searches payslips
4195
+ # Retrieves payslips
4146
4196
  # @param xero_tenant_id [String] Xero identifier for Tenant
4147
4197
  # @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.
4148
4198
  # @param [Hash] opts the optional parameters
@@ -4153,13 +4203,14 @@ module XeroRuby
4153
4203
  data
4154
4204
  end
4155
4205
 
4156
- # searches payslips
4206
+ # Retrieves payslips
4157
4207
  # @param xero_tenant_id [String] Xero identifier for Tenant
4158
4208
  # @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.
4159
4209
  # @param [Hash] opts the optional parameters
4160
4210
  # @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.
4161
4211
  # @return [Array<(Payslips, Integer, Hash)>] Payslips data, response status code and response headers
4162
- def get_pay_slips_with_http_info(xero_tenant_id, pay_run_id, opts = {})
4212
+ def get_pay_slips_with_http_info(xero_tenant_id, pay_run_id, options = {})
4213
+ opts = options.dup
4163
4214
  if @api_client.config.debugging
4164
4215
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_pay_slips ...'
4165
4216
  end
@@ -4220,7 +4271,7 @@ module XeroRuby
4220
4271
  return data, status_code, headers
4221
4272
  end
4222
4273
 
4223
- # retrieve a single reimbursement by id
4274
+ # Retrieves a specific reimbursement by using a unique reimbursement id
4224
4275
  # @param xero_tenant_id [String] Xero identifier for Tenant
4225
4276
  # @param reimbursement_id [String] Identifier for the reimbursement
4226
4277
  # @param [Hash] opts the optional parameters
@@ -4230,12 +4281,13 @@ module XeroRuby
4230
4281
  data
4231
4282
  end
4232
4283
 
4233
- # retrieve a single reimbursement by id
4284
+ # Retrieves a specific reimbursement by using a unique reimbursement id
4234
4285
  # @param xero_tenant_id [String] Xero identifier for Tenant
4235
4286
  # @param reimbursement_id [String] Identifier for the reimbursement
4236
4287
  # @param [Hash] opts the optional parameters
4237
4288
  # @return [Array<(ReimbursementObject, Integer, Hash)>] ReimbursementObject data, response status code and response headers
4238
- def get_reimbursement_with_http_info(xero_tenant_id, reimbursement_id, opts = {})
4289
+ def get_reimbursement_with_http_info(xero_tenant_id, reimbursement_id, options = {})
4290
+ opts = options.dup
4239
4291
  if @api_client.config.debugging
4240
4292
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_reimbursement ...'
4241
4293
  end
@@ -4294,7 +4346,7 @@ module XeroRuby
4294
4346
  return data, status_code, headers
4295
4347
  end
4296
4348
 
4297
- # searches reimbursements
4349
+ # Retrieves reimbursements
4298
4350
  # @param xero_tenant_id [String] Xero identifier for Tenant
4299
4351
  # @param [Hash] opts the optional parameters
4300
4352
  # @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.
@@ -4304,12 +4356,13 @@ module XeroRuby
4304
4356
  data
4305
4357
  end
4306
4358
 
4307
- # searches reimbursements
4359
+ # Retrieves reimbursements
4308
4360
  # @param xero_tenant_id [String] Xero identifier for Tenant
4309
4361
  # @param [Hash] opts the optional parameters
4310
4362
  # @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.
4311
4363
  # @return [Array<(Reimbursements, Integer, Hash)>] Reimbursements data, response status code and response headers
4312
- def get_reimbursements_with_http_info(xero_tenant_id, opts = {})
4364
+ def get_reimbursements_with_http_info(xero_tenant_id, options = {})
4365
+ opts = options.dup
4313
4366
  if @api_client.config.debugging
4314
4367
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_reimbursements ...'
4315
4368
  end
@@ -4365,7 +4418,7 @@ module XeroRuby
4365
4418
  return data, status_code, headers
4366
4419
  end
4367
4420
 
4368
- # searches settings
4421
+ # Retrieves payroll settings
4369
4422
  # @param xero_tenant_id [String] Xero identifier for Tenant
4370
4423
  # @param [Hash] opts the optional parameters
4371
4424
  # @return [Settings]
@@ -4374,11 +4427,12 @@ module XeroRuby
4374
4427
  data
4375
4428
  end
4376
4429
 
4377
- # searches settings
4430
+ # Retrieves payroll settings
4378
4431
  # @param xero_tenant_id [String] Xero identifier for Tenant
4379
4432
  # @param [Hash] opts the optional parameters
4380
4433
  # @return [Array<(Settings, Integer, Hash)>] Settings data, response status code and response headers
4381
- def get_settings_with_http_info(xero_tenant_id, opts = {})
4434
+ def get_settings_with_http_info(xero_tenant_id, options = {})
4435
+ opts = options.dup
4382
4436
  if @api_client.config.debugging
4383
4437
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_settings ...'
4384
4438
  end
@@ -4433,7 +4487,7 @@ module XeroRuby
4433
4487
  return data, status_code, headers
4434
4488
  end
4435
4489
 
4436
- # retrieve a summary of statutory leaves for an employee
4490
+ # Retrieves a specific employee's summary of statutory leaves using a unique employee ID
4437
4491
  # @param xero_tenant_id [String] Xero identifier for Tenant
4438
4492
  # @param employee_id [String] Employee id for single object
4439
4493
  # @param [Hash] opts the optional parameters
@@ -4444,13 +4498,14 @@ module XeroRuby
4444
4498
  data
4445
4499
  end
4446
4500
 
4447
- # retrieve a summary of statutory leaves for an employee
4501
+ # Retrieves a specific employee&#39;s summary of statutory leaves using a unique employee ID
4448
4502
  # @param xero_tenant_id [String] Xero identifier for Tenant
4449
4503
  # @param employee_id [String] Employee id for single object
4450
4504
  # @param [Hash] opts the optional parameters
4451
4505
  # @option opts [Boolean] :active_only Filter response with leaves that are currently active or yet to be taken. If not specified, all leaves (past, current, and future scheduled) are returned
4452
4506
  # @return [Array<(EmployeeStatutoryLeavesSummaries, Integer, Hash)>] EmployeeStatutoryLeavesSummaries data, response status code and response headers
4453
- def get_statutory_leave_summary_with_http_info(xero_tenant_id, employee_id, opts = {})
4507
+ def get_statutory_leave_summary_with_http_info(xero_tenant_id, employee_id, options = {})
4508
+ opts = options.dup
4454
4509
  if @api_client.config.debugging
4455
4510
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_statutory_leave_summary ...'
4456
4511
  end
@@ -4463,7 +4518,7 @@ module XeroRuby
4463
4518
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollUkApi.get_statutory_leave_summary"
4464
4519
  end
4465
4520
  # resource path
4466
- local_var_path = '/statutoryleaves/summary/{EmployeeId}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
4521
+ local_var_path = '/StatutoryLeaves/Summary/{EmployeeID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
4467
4522
 
4468
4523
  # camelize keys of incoming `where` opts
4469
4524
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -4510,7 +4565,7 @@ module XeroRuby
4510
4565
  return data, status_code, headers
4511
4566
  end
4512
4567
 
4513
- # retrieve a single timesheet by id
4568
+ # Retrieve a specific timesheet by using a unique timesheet ID
4514
4569
  # @param xero_tenant_id [String] Xero identifier for Tenant
4515
4570
  # @param timesheet_id [String] Identifier for the timesheet
4516
4571
  # @param [Hash] opts the optional parameters
@@ -4520,12 +4575,13 @@ module XeroRuby
4520
4575
  data
4521
4576
  end
4522
4577
 
4523
- # retrieve a single timesheet by id
4578
+ # Retrieve a specific timesheet by using a unique timesheet ID
4524
4579
  # @param xero_tenant_id [String] Xero identifier for Tenant
4525
4580
  # @param timesheet_id [String] Identifier for the timesheet
4526
4581
  # @param [Hash] opts the optional parameters
4527
4582
  # @return [Array<(TimesheetObject, Integer, Hash)>] TimesheetObject data, response status code and response headers
4528
- def get_timesheet_with_http_info(xero_tenant_id, timesheet_id, opts = {})
4583
+ def get_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {})
4584
+ opts = options.dup
4529
4585
  if @api_client.config.debugging
4530
4586
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_timesheet ...'
4531
4587
  end
@@ -4584,26 +4640,25 @@ module XeroRuby
4584
4640
  return data, status_code, headers
4585
4641
  end
4586
4642
 
4587
- # searches timesheets
4643
+ # Retrieves timesheets
4588
4644
  # @param xero_tenant_id [String] Xero identifier for Tenant
4589
4645
  # @param [Hash] opts the optional parameters
4590
4646
  # @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.
4591
- # @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.
4592
- # @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
4647
+ # @option opts [String] :filter Filter by first name and/or lastname
4593
4648
  # @return [Timesheets]
4594
4649
  def get_timesheets(xero_tenant_id, opts = {})
4595
4650
  data, _status_code, _headers = get_timesheets_with_http_info(xero_tenant_id, opts)
4596
4651
  data
4597
4652
  end
4598
4653
 
4599
- # searches timesheets
4654
+ # Retrieves timesheets
4600
4655
  # @param xero_tenant_id [String] Xero identifier for Tenant
4601
4656
  # @param [Hash] opts the optional parameters
4602
4657
  # @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.
4603
- # @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.
4604
- # @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
4658
+ # @option opts [String] :filter Filter by first name and/or lastname
4605
4659
  # @return [Array<(Timesheets, Integer, Hash)>] Timesheets data, response status code and response headers
4606
- def get_timesheets_with_http_info(xero_tenant_id, opts = {})
4660
+ def get_timesheets_with_http_info(xero_tenant_id, options = {})
4661
+ opts = options.dup
4607
4662
  if @api_client.config.debugging
4608
4663
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_timesheets ...'
4609
4664
  end
@@ -4620,8 +4675,7 @@ module XeroRuby
4620
4675
  # query parameters
4621
4676
  query_params = opts[:query_params] || {}
4622
4677
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
4623
- query_params[:'employeeId'] = opts[:'employee_id'] if !opts[:'employee_id'].nil?
4624
- query_params[:'payrollCalendarId'] = opts[:'payroll_calendar_id'] if !opts[:'payroll_calendar_id'].nil?
4678
+ query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
4625
4679
 
4626
4680
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
4627
4681
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
@@ -4661,7 +4715,7 @@ module XeroRuby
4661
4715
  return data, status_code, headers
4662
4716
  end
4663
4717
 
4664
- # searches tracking categories
4718
+ # Retrieves tracking categories
4665
4719
  # @param xero_tenant_id [String] Xero identifier for Tenant
4666
4720
  # @param [Hash] opts the optional parameters
4667
4721
  # @return [TrackingCategories]
@@ -4670,11 +4724,12 @@ module XeroRuby
4670
4724
  data
4671
4725
  end
4672
4726
 
4673
- # searches tracking categories
4727
+ # Retrieves tracking categories
4674
4728
  # @param xero_tenant_id [String] Xero identifier for Tenant
4675
4729
  # @param [Hash] opts the optional parameters
4676
4730
  # @return [Array<(TrackingCategories, Integer, Hash)>] TrackingCategories data, response status code and response headers
4677
- def get_tracking_categories_with_http_info(xero_tenant_id, opts = {})
4731
+ def get_tracking_categories_with_http_info(xero_tenant_id, options = {})
4732
+ opts = options.dup
4678
4733
  if @api_client.config.debugging
4679
4734
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_tracking_categories ...'
4680
4735
  end
@@ -4683,7 +4738,7 @@ module XeroRuby
4683
4738
  fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling PayrollUkApi.get_tracking_categories"
4684
4739
  end
4685
4740
  # resource path
4686
- local_var_path = '/settings/trackingCategories'
4741
+ local_var_path = '/Settings/trackingCategories'
4687
4742
 
4688
4743
  # camelize keys of incoming `where` opts
4689
4744
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -4729,7 +4784,7 @@ module XeroRuby
4729
4784
  return data, status_code, headers
4730
4785
  end
4731
4786
 
4732
- # revert a timesheet to draft
4787
+ # Reverts a specific timesheet to draft
4733
4788
  # @param xero_tenant_id [String] Xero identifier for Tenant
4734
4789
  # @param timesheet_id [String] Identifier for the timesheet
4735
4790
  # @param [Hash] opts the optional parameters
@@ -4739,12 +4794,13 @@ module XeroRuby
4739
4794
  data
4740
4795
  end
4741
4796
 
4742
- # revert a timesheet to draft
4797
+ # Reverts a specific timesheet to draft
4743
4798
  # @param xero_tenant_id [String] Xero identifier for Tenant
4744
4799
  # @param timesheet_id [String] Identifier for the timesheet
4745
4800
  # @param [Hash] opts the optional parameters
4746
4801
  # @return [Array<(TimesheetObject, Integer, Hash)>] TimesheetObject data, response status code and response headers
4747
- def revert_timesheet_with_http_info(xero_tenant_id, timesheet_id, opts = {})
4802
+ def revert_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {})
4803
+ opts = options.dup
4748
4804
  if @api_client.config.debugging
4749
4805
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.revert_timesheet ...'
4750
4806
  end
@@ -4803,7 +4859,7 @@ module XeroRuby
4803
4859
  return data, status_code, headers
4804
4860
  end
4805
4861
 
4806
- # updates employee
4862
+ # Updates a specific employee's detail
4807
4863
  # @param xero_tenant_id [String] Xero identifier for Tenant
4808
4864
  # @param employee_id [String] Employee id for single object
4809
4865
  # @param employee [Employee]
@@ -4814,13 +4870,14 @@ module XeroRuby
4814
4870
  data
4815
4871
  end
4816
4872
 
4817
- # updates employee
4873
+ # Updates a specific employee&#39;s detail
4818
4874
  # @param xero_tenant_id [String] Xero identifier for Tenant
4819
4875
  # @param employee_id [String] Employee id for single object
4820
4876
  # @param employee [Employee]
4821
4877
  # @param [Hash] opts the optional parameters
4822
4878
  # @return [Array<(EmployeeObject, Integer, Hash)>] EmployeeObject data, response status code and response headers
4823
- def update_employee_with_http_info(xero_tenant_id, employee_id, employee, opts = {})
4879
+ def update_employee_with_http_info(xero_tenant_id, employee_id, employee, options = {})
4880
+ opts = options.dup
4824
4881
  if @api_client.config.debugging
4825
4882
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.update_employee ...'
4826
4883
  end
@@ -4837,7 +4894,7 @@ module XeroRuby
4837
4894
  fail ArgumentError, "Missing the required parameter 'employee' when calling PayrollUkApi.update_employee"
4838
4895
  end
4839
4896
  # resource path
4840
- local_var_path = '/Employees/{EmployeeId}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
4897
+ local_var_path = '/Employees/{EmployeeID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
4841
4898
 
4842
4899
  # camelize keys of incoming `where` opts
4843
4900
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -4885,7 +4942,7 @@ module XeroRuby
4885
4942
  return data, status_code, headers
4886
4943
  end
4887
4944
 
4888
- # updates employee earnings template records
4945
+ # Updates a specific employee's earnings template records
4889
4946
  # @param xero_tenant_id [String] Xero identifier for Tenant
4890
4947
  # @param employee_id [String] Employee id for single object
4891
4948
  # @param pay_template_earning_id [String] Id for single pay template earnings object
@@ -4897,14 +4954,15 @@ module XeroRuby
4897
4954
  data
4898
4955
  end
4899
4956
 
4900
- # updates employee earnings template records
4957
+ # Updates a specific employee&#39;s earnings template records
4901
4958
  # @param xero_tenant_id [String] Xero identifier for Tenant
4902
4959
  # @param employee_id [String] Employee id for single object
4903
4960
  # @param pay_template_earning_id [String] Id for single pay template earnings object
4904
4961
  # @param earnings_template [EarningsTemplate]
4905
4962
  # @param [Hash] opts the optional parameters
4906
4963
  # @return [Array<(EarningsTemplateObject, Integer, Hash)>] EarningsTemplateObject data, response status code and response headers
4907
- def update_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, opts = {})
4964
+ def update_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, options = {})
4965
+ opts = options.dup
4908
4966
  if @api_client.config.debugging
4909
4967
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.update_employee_earnings_template ...'
4910
4968
  end
@@ -4925,7 +4983,7 @@ module XeroRuby
4925
4983
  fail ArgumentError, "Missing the required parameter 'earnings_template' when calling PayrollUkApi.update_employee_earnings_template"
4926
4984
  end
4927
4985
  # resource path
4928
- local_var_path = '/Employees/{EmployeeId}/PayTemplates/earnings/{PayTemplateEarningID}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s).sub('{' + 'PayTemplateEarningID' + '}', pay_template_earning_id.to_s)
4986
+ local_var_path = '/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'PayTemplateEarningID' + '}', pay_template_earning_id.to_s)
4929
4987
 
4930
4988
  # camelize keys of incoming `where` opts
4931
4989
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -4973,7 +5031,7 @@ module XeroRuby
4973
5031
  return data, status_code, headers
4974
5032
  end
4975
5033
 
4976
- # updates employee leave records
5034
+ # Updates a specific employee's leave records
4977
5035
  # @param xero_tenant_id [String] Xero identifier for Tenant
4978
5036
  # @param employee_id [String] Employee id for single object
4979
5037
  # @param leave_id [String] Leave id for single object
@@ -4985,14 +5043,15 @@ module XeroRuby
4985
5043
  data
4986
5044
  end
4987
5045
 
4988
- # updates employee leave records
5046
+ # Updates a specific employee&#39;s leave records
4989
5047
  # @param xero_tenant_id [String] Xero identifier for Tenant
4990
5048
  # @param employee_id [String] Employee id for single object
4991
5049
  # @param leave_id [String] Leave id for single object
4992
5050
  # @param employee_leave [EmployeeLeave]
4993
5051
  # @param [Hash] opts the optional parameters
4994
5052
  # @return [Array<(EmployeeLeaveObject, Integer, Hash)>] EmployeeLeaveObject data, response status code and response headers
4995
- def update_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, employee_leave, opts = {})
5053
+ def update_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, employee_leave, options = {})
5054
+ opts = options.dup
4996
5055
  if @api_client.config.debugging
4997
5056
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.update_employee_leave ...'
4998
5057
  end
@@ -5013,7 +5072,7 @@ module XeroRuby
5013
5072
  fail ArgumentError, "Missing the required parameter 'employee_leave' when calling PayrollUkApi.update_employee_leave"
5014
5073
  end
5015
5074
  # resource path
5016
- local_var_path = '/Employees/{EmployeeId}/Leave/{LeaveID}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s).sub('{' + 'LeaveID' + '}', leave_id.to_s)
5075
+ local_var_path = '/Employees/{EmployeeID}/Leave/{LeaveID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'LeaveID' + '}', leave_id.to_s)
5017
5076
 
5018
5077
  # camelize keys of incoming `where` opts
5019
5078
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -5061,7 +5120,7 @@ module XeroRuby
5061
5120
  return data, status_code, headers
5062
5121
  end
5063
5122
 
5064
- # updates employee opening balances
5123
+ # Updates a specific employee's opening balances
5065
5124
  # @param xero_tenant_id [String] Xero identifier for Tenant
5066
5125
  # @param employee_id [String] Employee id for single object
5067
5126
  # @param employee_opening_balances [EmployeeOpeningBalances]
@@ -5072,13 +5131,14 @@ module XeroRuby
5072
5131
  data
5073
5132
  end
5074
5133
 
5075
- # updates employee opening balances
5134
+ # Updates a specific employee&#39;s opening balances
5076
5135
  # @param xero_tenant_id [String] Xero identifier for Tenant
5077
5136
  # @param employee_id [String] Employee id for single object
5078
5137
  # @param employee_opening_balances [EmployeeOpeningBalances]
5079
5138
  # @param [Hash] opts the optional parameters
5080
5139
  # @return [Array<(EmployeeOpeningBalancesObject, Integer, Hash)>] EmployeeOpeningBalancesObject data, response status code and response headers
5081
- def update_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balances, opts = {})
5140
+ def update_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balances, options = {})
5141
+ opts = options.dup
5082
5142
  if @api_client.config.debugging
5083
5143
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.update_employee_opening_balances ...'
5084
5144
  end
@@ -5095,7 +5155,7 @@ module XeroRuby
5095
5155
  fail ArgumentError, "Missing the required parameter 'employee_opening_balances' when calling PayrollUkApi.update_employee_opening_balances"
5096
5156
  end
5097
5157
  # resource path
5098
- local_var_path = '/Employees/{EmployeeId}/ukopeningbalances'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
5158
+ local_var_path = '/Employees/{EmployeeID}/ukopeningbalances'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
5099
5159
 
5100
5160
  # camelize keys of incoming `where` opts
5101
5161
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -5143,7 +5203,7 @@ module XeroRuby
5143
5203
  return data, status_code, headers
5144
5204
  end
5145
5205
 
5146
- # updates employee salary and wages record
5206
+ # Updates salary and wages record for a specific employee
5147
5207
  # @param xero_tenant_id [String] Xero identifier for Tenant
5148
5208
  # @param employee_id [String] Employee id for single object
5149
5209
  # @param salary_and_wages_id [String] Id for single pay template earnings object
@@ -5155,14 +5215,15 @@ module XeroRuby
5155
5215
  data
5156
5216
  end
5157
5217
 
5158
- # updates employee salary and wages record
5218
+ # Updates salary and wages record for a specific employee
5159
5219
  # @param xero_tenant_id [String] Xero identifier for Tenant
5160
5220
  # @param employee_id [String] Employee id for single object
5161
5221
  # @param salary_and_wages_id [String] Id for single pay template earnings object
5162
5222
  # @param salary_and_wage [SalaryAndWage]
5163
5223
  # @param [Hash] opts the optional parameters
5164
5224
  # @return [Array<(SalaryAndWageObject, Integer, Hash)>] SalaryAndWageObject data, response status code and response headers
5165
- def update_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, opts = {})
5225
+ def update_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, options = {})
5226
+ opts = options.dup
5166
5227
  if @api_client.config.debugging
5167
5228
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.update_employee_salary_and_wage ...'
5168
5229
  end
@@ -5183,7 +5244,7 @@ module XeroRuby
5183
5244
  fail ArgumentError, "Missing the required parameter 'salary_and_wage' when calling PayrollUkApi.update_employee_salary_and_wage"
5184
5245
  end
5185
5246
  # resource path
5186
- local_var_path = '/Employees/{EmployeeId}/SalaryAndWages/{SalaryAndWagesID}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s).sub('{' + 'SalaryAndWagesID' + '}', salary_and_wages_id.to_s)
5247
+ local_var_path = '/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'SalaryAndWagesID' + '}', salary_and_wages_id.to_s)
5187
5248
 
5188
5249
  # camelize keys of incoming `where` opts
5189
5250
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -5231,7 +5292,7 @@ module XeroRuby
5231
5292
  return data, status_code, headers
5232
5293
  end
5233
5294
 
5234
- # update a pay run
5295
+ # Updates a specific pay run
5235
5296
  # @param xero_tenant_id [String] Xero identifier for Tenant
5236
5297
  # @param pay_run_id [String] Identifier for the pay run
5237
5298
  # @param pay_run [PayRun]
@@ -5242,13 +5303,14 @@ module XeroRuby
5242
5303
  data
5243
5304
  end
5244
5305
 
5245
- # update a pay run
5306
+ # Updates a specific pay run
5246
5307
  # @param xero_tenant_id [String] Xero identifier for Tenant
5247
5308
  # @param pay_run_id [String] Identifier for the pay run
5248
5309
  # @param pay_run [PayRun]
5249
5310
  # @param [Hash] opts the optional parameters
5250
5311
  # @return [Array<(PayRunObject, Integer, Hash)>] PayRunObject data, response status code and response headers
5251
- def update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, opts = {})
5312
+ def update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, options = {})
5313
+ opts = options.dup
5252
5314
  if @api_client.config.debugging
5253
5315
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.update_pay_run ...'
5254
5316
  end
@@ -5313,7 +5375,7 @@ module XeroRuby
5313
5375
  return data, status_code, headers
5314
5376
  end
5315
5377
 
5316
- # update a timesheet line
5378
+ # Updates a specific timesheet line for a specific timesheet
5317
5379
  # @param xero_tenant_id [String] Xero identifier for Tenant
5318
5380
  # @param timesheet_id [String] Identifier for the timesheet
5319
5381
  # @param timesheet_line_id [String] Identifier for the timesheet line
@@ -5325,14 +5387,15 @@ module XeroRuby
5325
5387
  data
5326
5388
  end
5327
5389
 
5328
- # update a timesheet line
5390
+ # Updates a specific timesheet line for a specific timesheet
5329
5391
  # @param xero_tenant_id [String] Xero identifier for Tenant
5330
5392
  # @param timesheet_id [String] Identifier for the timesheet
5331
5393
  # @param timesheet_line_id [String] Identifier for the timesheet line
5332
5394
  # @param timesheet_line [TimesheetLine]
5333
5395
  # @param [Hash] opts the optional parameters
5334
5396
  # @return [Array<(TimesheetLineObject, Integer, Hash)>] TimesheetLineObject data, response status code and response headers
5335
- def update_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, opts = {})
5397
+ def update_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, options = {})
5398
+ opts = options.dup
5336
5399
  if @api_client.config.debugging
5337
5400
  @api_client.config.logger.debug 'Calling API: PayrollUkApi.update_timesheet_line ...'
5338
5401
  end