xero-ruby 2.6.2 → 2.7.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (253) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +18 -8
  3. data/lib/xero-ruby.rb +4 -2
  4. data/lib/xero-ruby/api/accounting_api.rb +446 -446
  5. data/lib/xero-ruby/api/asset_api.rb +3 -7
  6. data/lib/xero-ruby/api/files_api.rb +49 -55
  7. data/lib/xero-ruby/api/payroll_au_api.rb +63 -63
  8. data/lib/xero-ruby/api/payroll_nz_api.rb +171 -171
  9. data/lib/xero-ruby/api/payroll_uk_api.rb +173 -173
  10. data/lib/xero-ruby/api/project_api.rb +45 -45
  11. data/lib/xero-ruby/api_client.rb +22 -87
  12. data/lib/xero-ruby/api_error.rb +1 -1
  13. data/lib/xero-ruby/configuration.rb +3 -3
  14. data/lib/xero-ruby/models/accounting/account.rb +1 -1
  15. data/lib/xero-ruby/models/accounting/account_type.rb +1 -1
  16. data/lib/xero-ruby/models/accounting/accounts.rb +1 -1
  17. data/lib/xero-ruby/models/accounting/accounts_payable.rb +1 -1
  18. data/lib/xero-ruby/models/accounting/accounts_receivable.rb +1 -1
  19. data/lib/xero-ruby/models/accounting/action.rb +1 -1
  20. data/lib/xero-ruby/models/accounting/actions.rb +1 -1
  21. data/lib/xero-ruby/models/accounting/address.rb +1 -1
  22. data/lib/xero-ruby/models/accounting/address_for_organisation.rb +1 -1
  23. data/lib/xero-ruby/models/accounting/allocation.rb +1 -1
  24. data/lib/xero-ruby/models/accounting/allocations.rb +1 -1
  25. data/lib/xero-ruby/models/accounting/attachment.rb +1 -1
  26. data/lib/xero-ruby/models/accounting/attachments.rb +1 -1
  27. data/lib/xero-ruby/models/accounting/balance_details.rb +1 -1
  28. data/lib/xero-ruby/models/accounting/balances.rb +1 -1
  29. data/lib/xero-ruby/models/accounting/bank_transaction.rb +1 -1
  30. data/lib/xero-ruby/models/accounting/bank_transactions.rb +1 -1
  31. data/lib/xero-ruby/models/accounting/bank_transfer.rb +1 -1
  32. data/lib/xero-ruby/models/accounting/bank_transfers.rb +1 -1
  33. data/lib/xero-ruby/models/accounting/batch_payment.rb +1 -1
  34. data/lib/xero-ruby/models/accounting/batch_payment_details.rb +1 -1
  35. data/lib/xero-ruby/models/accounting/batch_payments.rb +1 -1
  36. data/lib/xero-ruby/models/accounting/bill.rb +1 -1
  37. data/lib/xero-ruby/models/accounting/branding_theme.rb +1 -1
  38. data/lib/xero-ruby/models/accounting/branding_themes.rb +1 -1
  39. data/lib/xero-ruby/models/accounting/cis_org_setting.rb +1 -1
  40. data/lib/xero-ruby/models/{files/file_response204.rb → accounting/cis_org_settings.rb} +16 -14
  41. data/lib/xero-ruby/models/accounting/cis_setting.rb +1 -1
  42. data/lib/xero-ruby/models/accounting/cis_settings.rb +1 -1
  43. data/lib/xero-ruby/models/accounting/contact.rb +1 -1
  44. data/lib/xero-ruby/models/accounting/contact_group.rb +1 -1
  45. data/lib/xero-ruby/models/accounting/contact_groups.rb +1 -1
  46. data/lib/xero-ruby/models/accounting/contact_person.rb +1 -1
  47. data/lib/xero-ruby/models/accounting/contacts.rb +1 -1
  48. data/lib/xero-ruby/models/accounting/conversion_balances.rb +1 -1
  49. data/lib/xero-ruby/models/accounting/conversion_date.rb +1 -1
  50. data/lib/xero-ruby/models/accounting/country_code.rb +1 -1
  51. data/lib/xero-ruby/models/accounting/credit_note.rb +18 -6
  52. data/lib/xero-ruby/models/accounting/credit_notes.rb +1 -1
  53. data/lib/xero-ruby/models/accounting/currencies.rb +1 -1
  54. data/lib/xero-ruby/models/accounting/currency.rb +1 -1
  55. data/lib/xero-ruby/models/accounting/currency_code.rb +1 -1
  56. data/lib/xero-ruby/models/accounting/element.rb +1 -1
  57. data/lib/xero-ruby/models/accounting/employee.rb +1 -1
  58. data/lib/xero-ruby/models/accounting/employees.rb +1 -1
  59. data/lib/xero-ruby/models/accounting/error.rb +1 -1
  60. data/lib/xero-ruby/models/accounting/expense_claim.rb +1 -1
  61. data/lib/xero-ruby/models/accounting/expense_claims.rb +1 -1
  62. data/lib/xero-ruby/models/accounting/external_link.rb +1 -1
  63. data/lib/xero-ruby/models/accounting/history_record.rb +1 -1
  64. data/lib/xero-ruby/models/accounting/history_records.rb +1 -1
  65. data/lib/xero-ruby/models/accounting/import_summary.rb +1 -1
  66. data/lib/xero-ruby/models/accounting/import_summary_accounts.rb +1 -1
  67. data/lib/xero-ruby/models/accounting/import_summary_object.rb +1 -1
  68. data/lib/xero-ruby/models/accounting/import_summary_organisation.rb +1 -1
  69. data/lib/xero-ruby/models/accounting/invoice.rb +1 -1
  70. data/lib/xero-ruby/models/accounting/invoice_reminder.rb +1 -1
  71. data/lib/xero-ruby/models/accounting/invoice_reminders.rb +1 -1
  72. data/lib/xero-ruby/models/accounting/invoices.rb +1 -1
  73. data/lib/xero-ruby/models/accounting/item.rb +1 -1
  74. data/lib/xero-ruby/models/accounting/items.rb +1 -1
  75. data/lib/xero-ruby/models/accounting/journal.rb +1 -1
  76. data/lib/xero-ruby/models/accounting/journal_line.rb +1 -1
  77. data/lib/xero-ruby/models/accounting/journals.rb +1 -1
  78. data/lib/xero-ruby/models/accounting/line_amount_types.rb +1 -1
  79. data/lib/xero-ruby/models/accounting/line_item.rb +1 -1
  80. data/lib/xero-ruby/models/accounting/line_item_tracking.rb +1 -1
  81. data/lib/xero-ruby/models/accounting/linked_transaction.rb +1 -1
  82. data/lib/xero-ruby/models/accounting/linked_transactions.rb +1 -1
  83. data/lib/xero-ruby/models/accounting/manual_journal.rb +1 -1
  84. data/lib/xero-ruby/models/accounting/manual_journal_line.rb +1 -1
  85. data/lib/xero-ruby/models/accounting/manual_journals.rb +1 -1
  86. data/lib/xero-ruby/models/accounting/online_invoice.rb +1 -1
  87. data/lib/xero-ruby/models/accounting/online_invoices.rb +1 -1
  88. data/lib/xero-ruby/models/accounting/organisation.rb +1 -1
  89. data/lib/xero-ruby/models/accounting/organisations.rb +1 -1
  90. data/lib/xero-ruby/models/accounting/overpayment.rb +1 -1
  91. data/lib/xero-ruby/models/accounting/overpayments.rb +1 -1
  92. data/lib/xero-ruby/models/accounting/payment.rb +12 -2
  93. data/lib/xero-ruby/models/accounting/payment_delete.rb +1 -1
  94. data/lib/xero-ruby/models/accounting/payment_service.rb +1 -1
  95. data/lib/xero-ruby/models/accounting/payment_services.rb +1 -1
  96. data/lib/xero-ruby/models/accounting/payment_term.rb +1 -1
  97. data/lib/xero-ruby/models/accounting/payment_term_type.rb +1 -1
  98. data/lib/xero-ruby/models/accounting/payments.rb +1 -1
  99. data/lib/xero-ruby/models/accounting/phone.rb +1 -1
  100. data/lib/xero-ruby/models/accounting/prepayment.rb +1 -1
  101. data/lib/xero-ruby/models/accounting/prepayments.rb +1 -1
  102. data/lib/xero-ruby/models/accounting/purchase.rb +1 -1
  103. data/lib/xero-ruby/models/accounting/purchase_order.rb +1 -1
  104. data/lib/xero-ruby/models/accounting/purchase_orders.rb +1 -1
  105. data/lib/xero-ruby/models/accounting/quote.rb +1 -1
  106. data/lib/xero-ruby/models/accounting/quote_line_amount_types.rb +1 -1
  107. data/lib/xero-ruby/models/accounting/quote_status_codes.rb +1 -1
  108. data/lib/xero-ruby/models/accounting/quotes.rb +1 -1
  109. data/lib/xero-ruby/models/accounting/receipt.rb +1 -1
  110. data/lib/xero-ruby/models/accounting/receipts.rb +1 -1
  111. data/lib/xero-ruby/models/accounting/repeating_invoice.rb +1 -1
  112. data/lib/xero-ruby/models/accounting/repeating_invoices.rb +1 -1
  113. data/lib/xero-ruby/models/accounting/report.rb +1 -1
  114. data/lib/xero-ruby/models/accounting/report_attribute.rb +1 -1
  115. data/lib/xero-ruby/models/accounting/report_cell.rb +1 -1
  116. data/lib/xero-ruby/models/accounting/report_fields.rb +1 -1
  117. data/lib/xero-ruby/models/accounting/report_row.rb +1 -1
  118. data/lib/xero-ruby/models/accounting/report_rows.rb +1 -1
  119. data/lib/xero-ruby/models/accounting/report_with_row.rb +1 -1
  120. data/lib/xero-ruby/models/accounting/report_with_rows.rb +1 -1
  121. data/lib/xero-ruby/models/accounting/reports.rb +1 -1
  122. data/lib/xero-ruby/models/accounting/request_empty.rb +1 -1
  123. data/lib/xero-ruby/models/accounting/row_type.rb +1 -1
  124. data/lib/xero-ruby/models/accounting/sales_tracking_category.rb +1 -1
  125. data/lib/xero-ruby/models/accounting/schedule.rb +1 -1
  126. data/lib/xero-ruby/models/accounting/setup.rb +1 -1
  127. data/lib/xero-ruby/models/accounting/tax_component.rb +1 -1
  128. data/lib/xero-ruby/models/accounting/tax_rate.rb +1 -1
  129. data/lib/xero-ruby/models/accounting/tax_rates.rb +1 -1
  130. data/lib/xero-ruby/models/accounting/tax_type.rb +1 -1
  131. data/lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb +1 -1
  132. data/lib/xero-ruby/models/accounting/time_zone.rb +1 -1
  133. data/lib/xero-ruby/models/accounting/tracking_categories.rb +1 -1
  134. data/lib/xero-ruby/models/accounting/tracking_category.rb +1 -1
  135. data/lib/xero-ruby/models/accounting/tracking_option.rb +1 -1
  136. data/lib/xero-ruby/models/accounting/tracking_options.rb +1 -1
  137. data/lib/xero-ruby/models/accounting/user.rb +1 -1
  138. data/lib/xero-ruby/models/accounting/users.rb +1 -1
  139. data/lib/xero-ruby/models/accounting/validation_error.rb +1 -1
  140. data/lib/xero-ruby/models/assets/asset.rb +1 -1
  141. data/lib/xero-ruby/models/assets/asset_status.rb +1 -1
  142. data/lib/xero-ruby/models/assets/asset_status_query_param.rb +1 -1
  143. data/lib/xero-ruby/models/assets/asset_type.rb +1 -1
  144. data/lib/xero-ruby/models/assets/assets.rb +1 -1
  145. data/lib/xero-ruby/models/assets/book_depreciation_detail.rb +1 -1
  146. data/lib/xero-ruby/models/assets/book_depreciation_setting.rb +1 -1
  147. data/lib/xero-ruby/models/assets/error.rb +1 -1
  148. data/lib/xero-ruby/models/assets/field_validation_errors_element.rb +2 -2
  149. data/lib/xero-ruby/models/assets/pagination.rb +1 -1
  150. data/lib/xero-ruby/models/assets/resource_validation_errors_element.rb +2 -2
  151. data/lib/xero-ruby/models/assets/setting.rb +1 -1
  152. data/lib/xero-ruby/models/files/association.rb +1 -1
  153. data/lib/xero-ruby/models/files/file_object.rb +1 -1
  154. data/lib/xero-ruby/models/files/files.rb +1 -1
  155. data/lib/xero-ruby/models/files/folder.rb +1 -1
  156. data/lib/xero-ruby/models/files/folders.rb +1 -1
  157. data/lib/xero-ruby/models/files/inline_object.rb +1 -1
  158. data/lib/xero-ruby/models/files/object_group.rb +1 -1
  159. data/lib/xero-ruby/models/files/object_type.rb +1 -1
  160. data/lib/xero-ruby/models/files/user.rb +1 -1
  161. data/lib/xero-ruby/models/payroll_au/account.rb +1 -1
  162. data/lib/xero-ruby/models/payroll_au/account_type.rb +1 -1
  163. data/lib/xero-ruby/models/payroll_au/allowance_type.rb +1 -1
  164. data/lib/xero-ruby/models/payroll_au/api_exception.rb +1 -1
  165. data/lib/xero-ruby/models/payroll_au/bank_account.rb +1 -1
  166. data/lib/xero-ruby/models/payroll_au/calendar_type.rb +1 -1
  167. data/lib/xero-ruby/models/payroll_au/deduction_line.rb +1 -1
  168. data/lib/xero-ruby/models/payroll_au/deduction_type.rb +1 -1
  169. data/lib/xero-ruby/models/payroll_au/deduction_type_calculation_type.rb +1 -1
  170. data/lib/xero-ruby/models/payroll_au/earnings_line.rb +1 -1
  171. data/lib/xero-ruby/models/payroll_au/earnings_rate.rb +1 -1
  172. data/lib/xero-ruby/models/payroll_au/earnings_rate_calculation_type.rb +1 -1
  173. data/lib/xero-ruby/models/payroll_au/earnings_type.rb +1 -1
  174. data/lib/xero-ruby/models/payroll_au/employee.rb +1 -1
  175. data/lib/xero-ruby/models/payroll_au/employee_status.rb +1 -1
  176. data/lib/xero-ruby/models/payroll_au/employees.rb +1 -1
  177. data/lib/xero-ruby/models/payroll_au/employment_basis.rb +1 -1
  178. data/lib/xero-ruby/models/payroll_au/employment_termination_payment_type.rb +1 -1
  179. data/lib/xero-ruby/models/payroll_au/entitlement_final_pay_payout_type.rb +1 -1
  180. data/lib/xero-ruby/models/payroll_au/home_address.rb +1 -1
  181. data/lib/xero-ruby/models/payroll_au/leave_accrual_line.rb +1 -1
  182. data/lib/xero-ruby/models/payroll_au/leave_application.rb +1 -1
  183. data/lib/xero-ruby/models/payroll_au/leave_applications.rb +1 -1
  184. data/lib/xero-ruby/models/payroll_au/leave_balance.rb +1 -1
  185. data/lib/xero-ruby/models/payroll_au/leave_earnings_line.rb +1 -1
  186. data/lib/xero-ruby/models/payroll_au/leave_line.rb +1 -1
  187. data/lib/xero-ruby/models/payroll_au/leave_line_calculation_type.rb +1 -1
  188. data/lib/xero-ruby/models/payroll_au/leave_lines.rb +1 -1
  189. data/lib/xero-ruby/models/payroll_au/leave_period.rb +1 -1
  190. data/lib/xero-ruby/models/payroll_au/leave_period_status.rb +1 -1
  191. data/lib/xero-ruby/models/payroll_au/leave_type.rb +1 -1
  192. data/lib/xero-ruby/models/payroll_au/leave_type_contribution_type.rb +1 -1
  193. data/lib/xero-ruby/models/payroll_au/manual_tax_type.rb +1 -1
  194. data/lib/xero-ruby/models/payroll_au/opening_balances.rb +1 -1
  195. data/lib/xero-ruby/models/payroll_au/pay_item.rb +1 -1
  196. data/lib/xero-ruby/models/payroll_au/pay_items.rb +1 -1
  197. data/lib/xero-ruby/models/payroll_au/pay_run.rb +1 -1
  198. data/lib/xero-ruby/models/payroll_au/pay_run_status.rb +1 -1
  199. data/lib/xero-ruby/models/payroll_au/pay_runs.rb +1 -1
  200. data/lib/xero-ruby/models/payroll_au/pay_template.rb +1 -1
  201. data/lib/xero-ruby/models/payroll_au/payment_frequency_type.rb +1 -1
  202. data/lib/xero-ruby/models/payroll_au/payroll_calendar.rb +1 -1
  203. data/lib/xero-ruby/models/payroll_au/payroll_calendars.rb +1 -1
  204. data/lib/xero-ruby/models/payroll_au/payslip.rb +1 -1
  205. data/lib/xero-ruby/models/payroll_au/payslip_lines.rb +1 -1
  206. data/lib/xero-ruby/models/payroll_au/payslip_object.rb +1 -1
  207. data/lib/xero-ruby/models/payroll_au/payslip_summary.rb +1 -1
  208. data/lib/xero-ruby/models/payroll_au/payslips.rb +1 -1
  209. data/lib/xero-ruby/models/payroll_au/rate_type.rb +1 -1
  210. data/lib/xero-ruby/models/payroll_au/reimbursement_line.rb +1 -1
  211. data/lib/xero-ruby/models/payroll_au/reimbursement_lines.rb +1 -1
  212. data/lib/xero-ruby/models/payroll_au/reimbursement_type.rb +1 -1
  213. data/lib/xero-ruby/models/payroll_au/residency_status.rb +1 -1
  214. data/lib/xero-ruby/models/payroll_au/settings.rb +1 -1
  215. data/lib/xero-ruby/models/payroll_au/settings_object.rb +1 -1
  216. data/lib/xero-ruby/models/payroll_au/settings_tracking_categories.rb +1 -1
  217. data/lib/xero-ruby/models/payroll_au/settings_tracking_categories_employee_groups.rb +1 -1
  218. data/lib/xero-ruby/models/payroll_au/settings_tracking_categories_timesheet_categories.rb +1 -1
  219. data/lib/xero-ruby/models/payroll_au/state.rb +1 -1
  220. data/lib/xero-ruby/models/payroll_au/super_fund.rb +1 -1
  221. data/lib/xero-ruby/models/payroll_au/super_fund_product.rb +1 -1
  222. data/lib/xero-ruby/models/payroll_au/super_fund_products.rb +1 -1
  223. data/lib/xero-ruby/models/payroll_au/super_fund_type.rb +1 -1
  224. data/lib/xero-ruby/models/payroll_au/super_funds.rb +1 -1
  225. data/lib/xero-ruby/models/payroll_au/super_line.rb +2 -2
  226. data/lib/xero-ruby/models/payroll_au/super_membership.rb +2 -2
  227. data/lib/xero-ruby/models/payroll_au/superannuation_calculation_type.rb +1 -1
  228. data/lib/xero-ruby/models/payroll_au/superannuation_contribution_type.rb +1 -1
  229. data/lib/xero-ruby/models/payroll_au/superannuation_line.rb +1 -1
  230. data/lib/xero-ruby/models/payroll_au/tax_declaration.rb +1 -1
  231. data/lib/xero-ruby/models/payroll_au/tax_line.rb +1 -1
  232. data/lib/xero-ruby/models/payroll_au/tfn_exemption_type.rb +1 -1
  233. data/lib/xero-ruby/models/payroll_au/timesheet.rb +1 -1
  234. data/lib/xero-ruby/models/payroll_au/timesheet_line.rb +1 -1
  235. data/lib/xero-ruby/models/payroll_au/timesheet_object.rb +1 -1
  236. data/lib/xero-ruby/models/payroll_au/timesheet_status.rb +1 -1
  237. data/lib/xero-ruby/models/payroll_au/timesheets.rb +1 -1
  238. data/lib/xero-ruby/models/payroll_au/validation_error.rb +1 -1
  239. data/lib/xero-ruby/models/payroll_nz/earnings_line.rb +1 -1
  240. data/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leave.rb +1 -1
  241. data/lib/xero-ruby/models/payroll_nz/leave_earnings_line.rb +1 -1
  242. data/lib/xero-ruby/models/payroll_nz/superannuation_line.rb +1 -1
  243. data/lib/xero-ruby/models/payroll_nz/timesheet.rb +1 -1
  244. data/lib/xero-ruby/models/payroll_nz/timesheet_earnings_line.rb +1 -1
  245. data/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb +1 -1
  246. data/lib/xero-ruby/models/payroll_uk/timesheet.rb +1 -1
  247. data/lib/xero-ruby/string_serialization.rb +52 -0
  248. data/lib/xero-ruby/version.rb +3 -3
  249. data/lib/xero-ruby/where.rb +65 -0
  250. data/spec/configuration_spec.rb +1 -1
  251. data/spec/where_spec.rb +82 -0
  252. metadata +8 -6
  253. data/spec/files/models/file_response204_spec.rb +0 -41
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Xero Assets API
3
3
 
4
- #This is the Xero Assets API
4
+ #The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc.
5
5
 
6
6
  Contact: api@xero.com
7
7
  Generated by: https://openapi-generator.tech
@@ -168,7 +168,7 @@ module XeroRuby
168
168
  return data, status_code, headers
169
169
  end
170
170
 
171
- # retrieves fixed asset by id
171
+ # Retrieves fixed asset by id
172
172
  # By passing in the appropriate asset id, you can search for a specific fixed asset in the system
173
173
  # @param xero_tenant_id [String] Xero identifier for Tenant
174
174
  # @param id [String] fixed asset id for single object
@@ -179,7 +179,7 @@ module XeroRuby
179
179
  data
180
180
  end
181
181
 
182
- # retrieves fixed asset by id
182
+ # Retrieves fixed asset by id
183
183
  # By passing in the appropriate asset id, you can search for a specific fixed asset in the system
184
184
  # @param xero_tenant_id [String] Xero identifier for Tenant
185
185
  # @param id [String] fixed asset id for single object
@@ -431,10 +431,6 @@ module XeroRuby
431
431
  if @api_client.config.client_side_validation && opts[:'sort_direction'] && !allowable_values.include?(opts[:'sort_direction'])
432
432
  fail ArgumentError, "invalid value for \"sort_direction\", must be one of #{allowable_values}"
433
433
  end
434
- allowable_values = ["AssetName", "AssetNumber", "Description", "AssetTypeName"]
435
- if @api_client.config.client_side_validation && opts[:'filter_by'] && !allowable_values.include?(opts[:'filter_by'])
436
- fail ArgumentError, "invalid value for \"filter_by\", must be one of #{allowable_values}"
437
- end
438
434
  # resource path
439
435
  local_var_path = '/Assets'
440
436
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Xero Files API
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #These endpoints are specific to Xero Files API
5
5
 
6
6
  Contact: api@xero.com
7
7
  Generated by: https://openapi-generator.tech
@@ -16,7 +16,7 @@ module XeroRuby
16
16
  def initialize(api_client = ApiClient.new)
17
17
  @api_client = api_client
18
18
  end
19
- # create a new association
19
+ # Creates a new file association
20
20
  # By passing in the appropriate options, you can create a new folder
21
21
  # @param xero_tenant_id [String] Xero identifier for Tenant
22
22
  # @param file_id [String] File id for single object
@@ -28,7 +28,7 @@ module XeroRuby
28
28
  data
29
29
  end
30
30
 
31
- # create a new association
31
+ # Creates a new file association
32
32
  # By passing in the appropriate options, you can create a new folder
33
33
  # @param xero_tenant_id [String] Xero identifier for Tenant
34
34
  # @param file_id [String] File id for single object
@@ -96,7 +96,7 @@ module XeroRuby
96
96
  return data, status_code, headers
97
97
  end
98
98
 
99
- # create a new folder
99
+ # Creates a new folder
100
100
  # By passing in the appropriate properties, you can create a new folder
101
101
  # @param xero_tenant_id [String] Xero identifier for Tenant
102
102
  # @param [Hash] opts the optional parameters
@@ -107,7 +107,7 @@ module XeroRuby
107
107
  data
108
108
  end
109
109
 
110
- # create a new folder
110
+ # Creates a new folder
111
111
  # By passing in the appropriate properties, you can create a new folder
112
112
  # @param xero_tenant_id [String] Xero identifier for Tenant
113
113
  # @param [Hash] opts the optional parameters
@@ -170,23 +170,23 @@ module XeroRuby
170
170
  return data, status_code, headers
171
171
  end
172
172
 
173
- # delete a file
173
+ # Deletes a specific file
174
174
  # Delete a specific file
175
175
  # @param xero_tenant_id [String] Xero identifier for Tenant
176
176
  # @param file_id [String] File id for single object
177
177
  # @param [Hash] opts the optional parameters
178
- # @return [FileResponse204]
178
+ # @return [nil]
179
179
  def delete_file(xero_tenant_id, file_id, opts = {})
180
- data, _status_code, _headers = delete_file_with_http_info(xero_tenant_id, file_id, opts)
181
- data
180
+ delete_file_with_http_info(xero_tenant_id, file_id, opts)
181
+ nil
182
182
  end
183
183
 
184
- # delete a file
184
+ # Deletes a specific file
185
185
  # Delete a specific file
186
186
  # @param xero_tenant_id [String] Xero identifier for Tenant
187
187
  # @param file_id [String] File id for single object
188
188
  # @param [Hash] opts the optional parameters
189
- # @return [Array<(FileResponse204, Integer, Hash)>] FileResponse204 data, response status code and response headers
189
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
190
190
  def delete_file_with_http_info(xero_tenant_id, file_id, opts = {})
191
191
  if @api_client.config.debugging
192
192
  @api_client.config.logger.debug 'Calling API: FilesApi.delete_file ...'
@@ -214,8 +214,6 @@ module XeroRuby
214
214
 
215
215
  # header parameters
216
216
  header_params = opts[:header_params] || {}
217
- # HTTP header 'Accept' (if needed)
218
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
219
217
  header_params[:'xero-tenant-id'] = xero_tenant_id
220
218
 
221
219
  # form parameters
@@ -225,7 +223,7 @@ module XeroRuby
225
223
  post_body = opts[:body]
226
224
 
227
225
  # return_type
228
- return_type = opts[:return_type] || 'FileResponse204'
226
+ return_type = opts[:return_type]
229
227
 
230
228
  # auth_names
231
229
  auth_names = opts[:auth_names] || ['OAuth2']
@@ -246,25 +244,25 @@ module XeroRuby
246
244
  return data, status_code, headers
247
245
  end
248
246
 
249
- # create a new association
247
+ # Deletes an existing file association
250
248
  # By passing in the appropriate options, you can create a new folder
251
249
  # @param xero_tenant_id [String] Xero identifier for Tenant
252
250
  # @param file_id [String] File id for single object
253
251
  # @param object_id [String] Object id for single object
254
252
  # @param [Hash] opts the optional parameters
255
- # @return [FileResponse204]
253
+ # @return [nil]
256
254
  def delete_file_association(xero_tenant_id, file_id, object_id, opts = {})
257
- data, _status_code, _headers = delete_file_association_with_http_info(xero_tenant_id, file_id, object_id, opts)
258
- data
255
+ delete_file_association_with_http_info(xero_tenant_id, file_id, object_id, opts)
256
+ nil
259
257
  end
260
258
 
261
- # create a new association
259
+ # Deletes an existing file association
262
260
  # By passing in the appropriate options, you can create a new folder
263
261
  # @param xero_tenant_id [String] Xero identifier for Tenant
264
262
  # @param file_id [String] File id for single object
265
263
  # @param object_id [String] Object id for single object
266
264
  # @param [Hash] opts the optional parameters
267
- # @return [Array<(FileResponse204, Integer, Hash)>] FileResponse204 data, response status code and response headers
265
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
268
266
  def delete_file_association_with_http_info(xero_tenant_id, file_id, object_id, opts = {})
269
267
  if @api_client.config.debugging
270
268
  @api_client.config.logger.debug 'Calling API: FilesApi.delete_file_association ...'
@@ -296,8 +294,6 @@ module XeroRuby
296
294
 
297
295
  # header parameters
298
296
  header_params = opts[:header_params] || {}
299
- # HTTP header 'Accept' (if needed)
300
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
301
297
  header_params[:'xero-tenant-id'] = xero_tenant_id
302
298
 
303
299
  # form parameters
@@ -307,7 +303,7 @@ module XeroRuby
307
303
  post_body = opts[:body]
308
304
 
309
305
  # return_type
310
- return_type = opts[:return_type] || 'FileResponse204'
306
+ return_type = opts[:return_type]
311
307
 
312
308
  # auth_names
313
309
  auth_names = opts[:auth_names] || ['OAuth2']
@@ -328,23 +324,23 @@ module XeroRuby
328
324
  return data, status_code, headers
329
325
  end
330
326
 
331
- # delete a folder
327
+ # Deletes a folder
332
328
  # By passing in the appropriate ID, you can delete a folder
333
329
  # @param xero_tenant_id [String] Xero identifier for Tenant
334
330
  # @param folder_id [String] Folder id for single object
335
331
  # @param [Hash] opts the optional parameters
336
- # @return [FileResponse204]
332
+ # @return [nil]
337
333
  def delete_folder(xero_tenant_id, folder_id, opts = {})
338
- data, _status_code, _headers = delete_folder_with_http_info(xero_tenant_id, folder_id, opts)
339
- data
334
+ delete_folder_with_http_info(xero_tenant_id, folder_id, opts)
335
+ nil
340
336
  end
341
337
 
342
- # delete a folder
338
+ # Deletes a folder
343
339
  # By passing in the appropriate ID, you can delete a folder
344
340
  # @param xero_tenant_id [String] Xero identifier for Tenant
345
341
  # @param folder_id [String] Folder id for single object
346
342
  # @param [Hash] opts the optional parameters
347
- # @return [Array<(FileResponse204, Integer, Hash)>] FileResponse204 data, response status code and response headers
343
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
348
344
  def delete_folder_with_http_info(xero_tenant_id, folder_id, opts = {})
349
345
  if @api_client.config.debugging
350
346
  @api_client.config.logger.debug 'Calling API: FilesApi.delete_folder ...'
@@ -372,8 +368,6 @@ module XeroRuby
372
368
 
373
369
  # header parameters
374
370
  header_params = opts[:header_params] || {}
375
- # HTTP header 'Accept' (if needed)
376
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
377
371
  header_params[:'xero-tenant-id'] = xero_tenant_id
378
372
 
379
373
  # form parameters
@@ -383,7 +377,7 @@ module XeroRuby
383
377
  post_body = opts[:body]
384
378
 
385
379
  # return_type
386
- return_type = opts[:return_type] || 'FileResponse204'
380
+ return_type = opts[:return_type]
387
381
 
388
382
  # auth_names
389
383
  auth_names = opts[:auth_names] || ['OAuth2']
@@ -404,7 +398,7 @@ module XeroRuby
404
398
  return data, status_code, headers
405
399
  end
406
400
 
407
- # searches files
401
+ # Retrieves an association object using a unique object ID
408
402
  # By passing in the appropriate options,
409
403
  # @param xero_tenant_id [String] Xero identifier for Tenant
410
404
  # @param object_id [String] Object id for single object
@@ -415,7 +409,7 @@ module XeroRuby
415
409
  data
416
410
  end
417
411
 
418
- # searches files
412
+ # Retrieves an association object using a unique object ID
419
413
  # By passing in the appropriate options,
420
414
  # @param xero_tenant_id [String] Xero identifier for Tenant
421
415
  # @param object_id [String] Object id for single object
@@ -480,7 +474,7 @@ module XeroRuby
480
474
  return data, status_code, headers
481
475
  end
482
476
 
483
- # searches for file by unique id
477
+ # Retrieves a file by a unique file ID
484
478
  # @param xero_tenant_id [String] Xero identifier for Tenant
485
479
  # @param file_id [String] File id for single object
486
480
  # @param [Hash] opts the optional parameters
@@ -490,7 +484,7 @@ module XeroRuby
490
484
  data
491
485
  end
492
486
 
493
- # searches for file by unique id
487
+ # Retrieves a file by a unique file ID
494
488
  # @param xero_tenant_id [String] Xero identifier for Tenant
495
489
  # @param file_id [String] File id for single object
496
490
  # @param [Hash] opts the optional parameters
@@ -554,7 +548,7 @@ module XeroRuby
554
548
  return data, status_code, headers
555
549
  end
556
550
 
557
- # searches files
551
+ # Retrieves a specific file associations
558
552
  # By passing in the appropriate options,
559
553
  # @param xero_tenant_id [String] Xero identifier for Tenant
560
554
  # @param file_id [String] File id for single object
@@ -565,7 +559,7 @@ module XeroRuby
565
559
  data
566
560
  end
567
561
 
568
- # searches files
562
+ # Retrieves a specific file associations
569
563
  # By passing in the appropriate options,
570
564
  # @param xero_tenant_id [String] Xero identifier for Tenant
571
565
  # @param file_id [String] File id for single object
@@ -630,7 +624,7 @@ module XeroRuby
630
624
  return data, status_code, headers
631
625
  end
632
626
 
633
- # searches files to retrieve the data
627
+ # Retrieves the content of a specific file
634
628
  # By passing in the appropriate options, retrieve data for specific file
635
629
  # @param xero_tenant_id [String] Xero identifier for Tenant
636
630
  # @param file_id [String] File id for single object
@@ -641,7 +635,7 @@ module XeroRuby
641
635
  data
642
636
  end
643
637
 
644
- # searches files to retrieve the data
638
+ # Retrieves the content of a specific file
645
639
  # By passing in the appropriate options, retrieve data for specific file
646
640
  # @param xero_tenant_id [String] Xero identifier for Tenant
647
641
  # @param file_id [String] File id for single object
@@ -706,7 +700,7 @@ module XeroRuby
706
700
  return data, status_code, headers
707
701
  end
708
702
 
709
- # searches files
703
+ # Retrieves files
710
704
  # @param xero_tenant_id [String] Xero identifier for Tenant
711
705
  # @param [Hash] opts the optional parameters
712
706
  # @option opts [Integer] :pagesize pass an optional page size value
@@ -718,7 +712,7 @@ module XeroRuby
718
712
  data
719
713
  end
720
714
 
721
- # searches files
715
+ # Retrieves files
722
716
  # @param xero_tenant_id [String] Xero identifier for Tenant
723
717
  # @param [Hash] opts the optional parameters
724
718
  # @option opts [Integer] :pagesize pass an optional page size value
@@ -795,7 +789,7 @@ module XeroRuby
795
789
  return data, status_code, headers
796
790
  end
797
791
 
798
- # searches specific folder by id
792
+ # Retrieves specific folder by using a unique folder ID
799
793
  # By passing in the appropriate ID, you can search for specific folder
800
794
  # @param xero_tenant_id [String] Xero identifier for Tenant
801
795
  # @param folder_id [String] Folder id for single object
@@ -806,7 +800,7 @@ module XeroRuby
806
800
  data
807
801
  end
808
802
 
809
- # searches specific folder by id
803
+ # Retrieves specific folder by using a unique folder ID
810
804
  # By passing in the appropriate ID, you can search for specific folder
811
805
  # @param xero_tenant_id [String] Xero identifier for Tenant
812
806
  # @param folder_id [String] Folder id for single object
@@ -871,7 +865,7 @@ module XeroRuby
871
865
  return data, status_code, headers
872
866
  end
873
867
 
874
- # searches folder
868
+ # Retrieves folders
875
869
  # By passing in the appropriate options, you can search for available folders
876
870
  # @param xero_tenant_id [String] Xero identifier for Tenant
877
871
  # @param [Hash] opts the optional parameters
@@ -882,7 +876,7 @@ module XeroRuby
882
876
  data
883
877
  end
884
878
 
885
- # searches folder
879
+ # Retrieves folders
886
880
  # By passing in the appropriate options, you can search for available folders
887
881
  # @param xero_tenant_id [String] Xero identifier for Tenant
888
882
  # @param [Hash] opts the optional parameters
@@ -948,7 +942,7 @@ module XeroRuby
948
942
  return data, status_code, headers
949
943
  end
950
944
 
951
- # searches inbox folder
945
+ # Retrieves inbox folder
952
946
  # Search for the user inbox
953
947
  # @param xero_tenant_id [String] Xero identifier for Tenant
954
948
  # @param [Hash] opts the optional parameters
@@ -958,7 +952,7 @@ module XeroRuby
958
952
  data
959
953
  end
960
954
 
961
- # searches inbox folder
955
+ # Retrieves inbox folder
962
956
  # Search for the user inbox
963
957
  # @param xero_tenant_id [String] Xero identifier for Tenant
964
958
  # @param [Hash] opts the optional parameters
@@ -1019,7 +1013,7 @@ module XeroRuby
1019
1013
  end
1020
1014
 
1021
1015
  # Update a file
1022
- # Update properties on a single file
1016
+ # Updates file properties of a single file
1023
1017
  # @param xero_tenant_id [String] Xero identifier for Tenant
1024
1018
  # @param file_id [String] File id for single object
1025
1019
  # @param [Hash] opts the optional parameters
@@ -1031,7 +1025,7 @@ module XeroRuby
1031
1025
  end
1032
1026
 
1033
1027
  # Update a file
1034
- # Update properties on a single file
1028
+ # Updates file properties of a single file
1035
1029
  # @param xero_tenant_id [String] Xero identifier for Tenant
1036
1030
  # @param file_id [String] File id for single object
1037
1031
  # @param [Hash] opts the optional parameters
@@ -1098,7 +1092,7 @@ module XeroRuby
1098
1092
  return data, status_code, headers
1099
1093
  end
1100
1094
 
1101
- # update folder
1095
+ # Updates an existing folder
1102
1096
  # By passing in the appropriate ID and properties, you can update a folder
1103
1097
  # @param xero_tenant_id [String] Xero identifier for Tenant
1104
1098
  # @param folder_id [String] Folder id for single object
@@ -1110,7 +1104,7 @@ module XeroRuby
1110
1104
  data
1111
1105
  end
1112
1106
 
1113
- # update folder
1107
+ # Updates an existing folder
1114
1108
  # By passing in the appropriate ID and properties, you can update a folder
1115
1109
  # @param xero_tenant_id [String] Xero identifier for Tenant
1116
1110
  # @param folder_id [String] Folder id for single object
@@ -1182,7 +1176,7 @@ module XeroRuby
1182
1176
  return data, status_code, headers
1183
1177
  end
1184
1178
 
1185
- # upload an File
1179
+ # Uploads a File
1186
1180
  # @param xero_tenant_id [String] Xero identifier for Tenant
1187
1181
  # @param [Hash] opts the optional parameters
1188
1182
  # @option opts [String] :folder_id pass an optional folder id to save file to specific folder
@@ -1196,7 +1190,7 @@ module XeroRuby
1196
1190
  data
1197
1191
  end
1198
1192
 
1199
- # upload an File
1193
+ # Uploads a File
1200
1194
  # @param xero_tenant_id [String] Xero identifier for Tenant
1201
1195
  # @param [Hash] opts the optional parameters
1202
1196
  # @option opts [String] :folder_id pass an optional folder id to save file to specific folder
@@ -1221,7 +1215,7 @@ module XeroRuby
1221
1215
 
1222
1216
  # query parameters
1223
1217
  query_params = opts[:query_params] || {}
1224
- query_params[:'folderId'] = opts[:'folder_id'] if !opts[:'folder_id'].nil?
1218
+ query_params[:'FolderId'] = opts[:'folder_id'] if !opts[:'folder_id'].nil?
1225
1219
 
1226
1220
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
1227
1221
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
@@ -1,5 +1,5 @@
1
1
  =begin
2
- #Xero Payroll AU
2
+ #Xero Payroll AU API
3
3
 
4
4
  #This is the Xero Payroll API for orgs in Australia region.
5
5
 
@@ -16,7 +16,7 @@ module XeroRuby
16
16
  def initialize(api_client = ApiClient.new)
17
17
  @api_client = api_client
18
18
  end
19
- # Use this method to create a payroll employee
19
+ # Creates a payroll employee
20
20
  # @param xero_tenant_id [String] Xero identifier for Tenant
21
21
  # @param employee [Array<Employee>]
22
22
  # @param [Hash] opts the optional parameters
@@ -26,7 +26,7 @@ module XeroRuby
26
26
  data
27
27
  end
28
28
 
29
- # Use this method to create a payroll employee
29
+ # Creates a payroll employee
30
30
  # @param xero_tenant_id [String] Xero identifier for Tenant
31
31
  # @param employee [Array<Employee>]
32
32
  # @param [Hash] opts the optional parameters
@@ -92,7 +92,7 @@ module XeroRuby
92
92
  return data, status_code, headers
93
93
  end
94
94
 
95
- # Use this method to create a Leave Application
95
+ # Creates a leave application
96
96
  # @param xero_tenant_id [String] Xero identifier for Tenant
97
97
  # @param leave_application [Array<LeaveApplication>]
98
98
  # @param [Hash] opts the optional parameters
@@ -102,7 +102,7 @@ module XeroRuby
102
102
  data
103
103
  end
104
104
 
105
- # Use this method to create a Leave Application
105
+ # Creates a leave application
106
106
  # @param xero_tenant_id [String] Xero identifier for Tenant
107
107
  # @param leave_application [Array<LeaveApplication>]
108
108
  # @param [Hash] opts the optional parameters
@@ -168,7 +168,7 @@ module XeroRuby
168
168
  return data, status_code, headers
169
169
  end
170
170
 
171
- # Use this method to create a Pay Item
171
+ # Creates a pay item
172
172
  # @param xero_tenant_id [String] Xero identifier for Tenant
173
173
  # @param pay_item [PayItem]
174
174
  # @param [Hash] opts the optional parameters
@@ -178,7 +178,7 @@ module XeroRuby
178
178
  data
179
179
  end
180
180
 
181
- # Use this method to create a Pay Item
181
+ # Creates a pay item
182
182
  # @param xero_tenant_id [String] Xero identifier for Tenant
183
183
  # @param pay_item [PayItem]
184
184
  # @param [Hash] opts the optional parameters
@@ -244,7 +244,7 @@ module XeroRuby
244
244
  return data, status_code, headers
245
245
  end
246
246
 
247
- # Use this method to create a PayRun
247
+ # Creates a pay run
248
248
  # @param xero_tenant_id [String] Xero identifier for Tenant
249
249
  # @param pay_run [Array<PayRun>]
250
250
  # @param [Hash] opts the optional parameters
@@ -254,7 +254,7 @@ module XeroRuby
254
254
  data
255
255
  end
256
256
 
257
- # Use this method to create a PayRun
257
+ # Creates a pay run
258
258
  # @param xero_tenant_id [String] Xero identifier for Tenant
259
259
  # @param pay_run [Array<PayRun>]
260
260
  # @param [Hash] opts the optional parameters
@@ -320,7 +320,7 @@ module XeroRuby
320
320
  return data, status_code, headers
321
321
  end
322
322
 
323
- # Use this method to create a Payroll Calendars
323
+ # Creates a Payroll Calendar
324
324
  # @param xero_tenant_id [String] Xero identifier for Tenant
325
325
  # @param payroll_calendar [Array<PayrollCalendar>]
326
326
  # @param [Hash] opts the optional parameters
@@ -330,7 +330,7 @@ module XeroRuby
330
330
  data
331
331
  end
332
332
 
333
- # Use this method to create a Payroll Calendars
333
+ # Creates a Payroll Calendar
334
334
  # @param xero_tenant_id [String] Xero identifier for Tenant
335
335
  # @param payroll_calendar [Array<PayrollCalendar>]
336
336
  # @param [Hash] opts the optional parameters
@@ -396,7 +396,7 @@ module XeroRuby
396
396
  return data, status_code, headers
397
397
  end
398
398
 
399
- # Use this method to create a super fund
399
+ # Creates a superfund
400
400
  # @param xero_tenant_id [String] Xero identifier for Tenant
401
401
  # @param super_fund [Array<SuperFund>]
402
402
  # @param [Hash] opts the optional parameters
@@ -406,7 +406,7 @@ module XeroRuby
406
406
  data
407
407
  end
408
408
 
409
- # Use this method to create a super fund
409
+ # Creates a superfund
410
410
  # @param xero_tenant_id [String] Xero identifier for Tenant
411
411
  # @param super_fund [Array<SuperFund>]
412
412
  # @param [Hash] opts the optional parameters
@@ -472,7 +472,7 @@ module XeroRuby
472
472
  return data, status_code, headers
473
473
  end
474
474
 
475
- # Use this method to create a timesheet
475
+ # Creates a timesheet
476
476
  # @param xero_tenant_id [String] Xero identifier for Tenant
477
477
  # @param timesheet [Array<Timesheet>]
478
478
  # @param [Hash] opts the optional parameters
@@ -482,7 +482,7 @@ module XeroRuby
482
482
  data
483
483
  end
484
484
 
485
- # Use this method to create a timesheet
485
+ # Creates a timesheet
486
486
  # @param xero_tenant_id [String] Xero identifier for Tenant
487
487
  # @param timesheet [Array<Timesheet>]
488
488
  # @param [Hash] opts the optional parameters
@@ -548,7 +548,7 @@ module XeroRuby
548
548
  return data, status_code, headers
549
549
  end
550
550
 
551
- # searches for an employee by unique id
551
+ # Retrieves an employee's detail by unique employee id
552
552
  # @param xero_tenant_id [String] Xero identifier for Tenant
553
553
  # @param employee_id [String] Employee id for single object
554
554
  # @param [Hash] opts the optional parameters
@@ -558,7 +558,7 @@ module XeroRuby
558
558
  data
559
559
  end
560
560
 
561
- # searches for an employee by unique id
561
+ # Retrieves an employee&#39;s detail by unique employee id
562
562
  # @param xero_tenant_id [String] Xero identifier for Tenant
563
563
  # @param employee_id [String] Employee id for single object
564
564
  # @param [Hash] opts the optional parameters
@@ -576,7 +576,7 @@ module XeroRuby
576
576
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollAuApi.get_employee"
577
577
  end
578
578
  # resource path
579
- local_var_path = '/Employees/{EmployeeId}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
579
+ local_var_path = '/Employees/{EmployeeID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
580
580
 
581
581
  # camelize keys of incoming `where` opts
582
582
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -622,7 +622,7 @@ module XeroRuby
622
622
  return data, status_code, headers
623
623
  end
624
624
 
625
- # searches employees
625
+ # Searches payroll employees
626
626
  # @param xero_tenant_id [String] Xero identifier for Tenant
627
627
  # @param [Hash] opts the optional parameters
628
628
  # @option opts [String] :if_modified_since Only records created or modified since this timestamp will be returned
@@ -635,7 +635,7 @@ module XeroRuby
635
635
  data
636
636
  end
637
637
 
638
- # searches employees
638
+ # Searches payroll employees
639
639
  # @param xero_tenant_id [String] Xero identifier for Tenant
640
640
  # @param [Hash] opts the optional parameters
641
641
  # @option opts [String] :if_modified_since Only records created or modified since this timestamp will be returned
@@ -702,7 +702,7 @@ module XeroRuby
702
702
  return data, status_code, headers
703
703
  end
704
704
 
705
- # searches for an Leave Application by unique id
705
+ # Retrieves a leave application by a unique leave application id
706
706
  # @param xero_tenant_id [String] Xero identifier for Tenant
707
707
  # @param leave_application_id [String] Leave Application id for single object
708
708
  # @param [Hash] opts the optional parameters
@@ -712,7 +712,7 @@ module XeroRuby
712
712
  data
713
713
  end
714
714
 
715
- # searches for an Leave Application by unique id
715
+ # Retrieves a leave application by a unique leave application id
716
716
  # @param xero_tenant_id [String] Xero identifier for Tenant
717
717
  # @param leave_application_id [String] Leave Application id for single object
718
718
  # @param [Hash] opts the optional parameters
@@ -730,7 +730,7 @@ module XeroRuby
730
730
  fail ArgumentError, "Missing the required parameter 'leave_application_id' when calling PayrollAuApi.get_leave_application"
731
731
  end
732
732
  # resource path
733
- local_var_path = '/LeaveApplications/{LeaveApplicationId}'.sub('{' + 'LeaveApplicationId' + '}', leave_application_id.to_s)
733
+ local_var_path = '/LeaveApplications/{LeaveApplicationID}'.sub('{' + 'LeaveApplicationID' + '}', leave_application_id.to_s)
734
734
 
735
735
  # camelize keys of incoming `where` opts
736
736
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -776,7 +776,7 @@ module XeroRuby
776
776
  return data, status_code, headers
777
777
  end
778
778
 
779
- # searches Leave Applications
779
+ # Retrieves leave applications
780
780
  # @param xero_tenant_id [String] Xero identifier for Tenant
781
781
  # @param [Hash] opts the optional parameters
782
782
  # @option opts [String] :if_modified_since Only records created or modified since this timestamp will be returned
@@ -789,7 +789,7 @@ module XeroRuby
789
789
  data
790
790
  end
791
791
 
792
- # searches Leave Applications
792
+ # Retrieves leave applications
793
793
  # @param xero_tenant_id [String] Xero identifier for Tenant
794
794
  # @param [Hash] opts the optional parameters
795
795
  # @option opts [String] :if_modified_since Only records created or modified since this timestamp will be returned
@@ -856,7 +856,7 @@ module XeroRuby
856
856
  return data, status_code, headers
857
857
  end
858
858
 
859
- # searches Pay Items
859
+ # Retrieves pay items
860
860
  # @param xero_tenant_id [String] Xero identifier for Tenant
861
861
  # @param [Hash] opts the optional parameters
862
862
  # @option opts [String] :if_modified_since Only records created or modified since this timestamp will be returned
@@ -869,7 +869,7 @@ module XeroRuby
869
869
  data
870
870
  end
871
871
 
872
- # searches Pay Items
872
+ # Retrieves pay items
873
873
  # @param xero_tenant_id [String] Xero identifier for Tenant
874
874
  # @param [Hash] opts the optional parameters
875
875
  # @option opts [String] :if_modified_since Only records created or modified since this timestamp will be returned
@@ -936,7 +936,7 @@ module XeroRuby
936
936
  return data, status_code, headers
937
937
  end
938
938
 
939
- # searches for an payrun by unique id
939
+ # Retrieves a pay run by using a unique pay run id
940
940
  # @param xero_tenant_id [String] Xero identifier for Tenant
941
941
  # @param pay_run_id [String] PayRun id for single object
942
942
  # @param [Hash] opts the optional parameters
@@ -946,7 +946,7 @@ module XeroRuby
946
946
  data
947
947
  end
948
948
 
949
- # searches for an payrun by unique id
949
+ # Retrieves a pay run by using a unique pay run id
950
950
  # @param xero_tenant_id [String] Xero identifier for Tenant
951
951
  # @param pay_run_id [String] PayRun id for single object
952
952
  # @param [Hash] opts the optional parameters
@@ -1010,7 +1010,7 @@ module XeroRuby
1010
1010
  return data, status_code, headers
1011
1011
  end
1012
1012
 
1013
- # searches PayRuns
1013
+ # Retrieves pay runs
1014
1014
  # @param xero_tenant_id [String] Xero identifier for Tenant
1015
1015
  # @param [Hash] opts the optional parameters
1016
1016
  # @option opts [String] :if_modified_since Only records created or modified since this timestamp will be returned
@@ -1023,7 +1023,7 @@ module XeroRuby
1023
1023
  data
1024
1024
  end
1025
1025
 
1026
- # searches PayRuns
1026
+ # Retrieves pay runs
1027
1027
  # @param xero_tenant_id [String] Xero identifier for Tenant
1028
1028
  # @param [Hash] opts the optional parameters
1029
1029
  # @option opts [String] :if_modified_since Only records created or modified since this timestamp will be returned
@@ -1090,7 +1090,7 @@ module XeroRuby
1090
1090
  return data, status_code, headers
1091
1091
  end
1092
1092
 
1093
- # searches Payroll Calendars
1093
+ # Retrieves payroll calendar by using a unique payroll calendar ID
1094
1094
  # @param xero_tenant_id [String] Xero identifier for Tenant
1095
1095
  # @param payroll_calendar_id [String] Payroll Calendar id for single object
1096
1096
  # @param [Hash] opts the optional parameters
@@ -1100,7 +1100,7 @@ module XeroRuby
1100
1100
  data
1101
1101
  end
1102
1102
 
1103
- # searches Payroll Calendars
1103
+ # Retrieves payroll calendar by using a unique payroll calendar ID
1104
1104
  # @param xero_tenant_id [String] Xero identifier for Tenant
1105
1105
  # @param payroll_calendar_id [String] Payroll Calendar id for single object
1106
1106
  # @param [Hash] opts the optional parameters
@@ -1164,7 +1164,7 @@ module XeroRuby
1164
1164
  return data, status_code, headers
1165
1165
  end
1166
1166
 
1167
- # searches Payroll Calendars
1167
+ # Retrieves payroll calendars
1168
1168
  # @param xero_tenant_id [String] Xero identifier for Tenant
1169
1169
  # @param [Hash] opts the optional parameters
1170
1170
  # @option opts [String] :if_modified_since Only records created or modified since this timestamp will be returned
@@ -1177,7 +1177,7 @@ module XeroRuby
1177
1177
  data
1178
1178
  end
1179
1179
 
1180
- # searches Payroll Calendars
1180
+ # Retrieves payroll calendars
1181
1181
  # @param xero_tenant_id [String] Xero identifier for Tenant
1182
1182
  # @param [Hash] opts the optional parameters
1183
1183
  # @option opts [String] :if_modified_since Only records created or modified since this timestamp will be returned
@@ -1244,7 +1244,7 @@ module XeroRuby
1244
1244
  return data, status_code, headers
1245
1245
  end
1246
1246
 
1247
- # searches for an payslip by unique id
1247
+ # Retrieves for a payslip by a unique payslip id
1248
1248
  # @param xero_tenant_id [String] Xero identifier for Tenant
1249
1249
  # @param payslip_id [String] Payslip id for single object
1250
1250
  # @param [Hash] opts the optional parameters
@@ -1254,7 +1254,7 @@ module XeroRuby
1254
1254
  data
1255
1255
  end
1256
1256
 
1257
- # searches for an payslip by unique id
1257
+ # Retrieves for a payslip by a unique payslip id
1258
1258
  # @param xero_tenant_id [String] Xero identifier for Tenant
1259
1259
  # @param payslip_id [String] Payslip id for single object
1260
1260
  # @param [Hash] opts the optional parameters
@@ -1318,7 +1318,7 @@ module XeroRuby
1318
1318
  return data, status_code, headers
1319
1319
  end
1320
1320
 
1321
- # retrieve settings
1321
+ # Retrieves payroll settings
1322
1322
  # @param xero_tenant_id [String] Xero identifier for Tenant
1323
1323
  # @param [Hash] opts the optional parameters
1324
1324
  # @return [SettingsObject]
@@ -1327,7 +1327,7 @@ module XeroRuby
1327
1327
  data
1328
1328
  end
1329
1329
 
1330
- # retrieve settings
1330
+ # Retrieves payroll settings
1331
1331
  # @param xero_tenant_id [String] Xero identifier for Tenant
1332
1332
  # @param [Hash] opts the optional parameters
1333
1333
  # @return [Array<(SettingsObject, Integer, Hash)>] SettingsObject data, response status code and response headers
@@ -1386,7 +1386,7 @@ module XeroRuby
1386
1386
  return data, status_code, headers
1387
1387
  end
1388
1388
 
1389
- # searches for an Superfund by unique id
1389
+ # Retrieves a superfund by using a unique superfund ID
1390
1390
  # @param xero_tenant_id [String] Xero identifier for Tenant
1391
1391
  # @param super_fund_id [String] Superfund id for single object
1392
1392
  # @param [Hash] opts the optional parameters
@@ -1396,7 +1396,7 @@ module XeroRuby
1396
1396
  data
1397
1397
  end
1398
1398
 
1399
- # searches for an Superfund by unique id
1399
+ # Retrieves a superfund by using a unique superfund ID
1400
1400
  # @param xero_tenant_id [String] Xero identifier for Tenant
1401
1401
  # @param super_fund_id [String] Superfund id for single object
1402
1402
  # @param [Hash] opts the optional parameters
@@ -1460,7 +1460,7 @@ module XeroRuby
1460
1460
  return data, status_code, headers
1461
1461
  end
1462
1462
 
1463
- # searches SuperfundProducts
1463
+ # Retrieves superfund products
1464
1464
  # @param xero_tenant_id [String] Xero identifier for Tenant
1465
1465
  # @param [Hash] opts the optional parameters
1466
1466
  # @option opts [String] :abn The ABN of the Regulated SuperFund
@@ -1471,7 +1471,7 @@ module XeroRuby
1471
1471
  data
1472
1472
  end
1473
1473
 
1474
- # searches SuperfundProducts
1474
+ # Retrieves superfund products
1475
1475
  # @param xero_tenant_id [String] Xero identifier for Tenant
1476
1476
  # @param [Hash] opts the optional parameters
1477
1477
  # @option opts [String] :abn The ABN of the Regulated SuperFund
@@ -1534,7 +1534,7 @@ module XeroRuby
1534
1534
  return data, status_code, headers
1535
1535
  end
1536
1536
 
1537
- # searches SuperFunds
1537
+ # Retrieves superfunds
1538
1538
  # @param xero_tenant_id [String] Xero identifier for Tenant
1539
1539
  # @param [Hash] opts the optional parameters
1540
1540
  # @option opts [String] :if_modified_since Only records created or modified since this timestamp will be returned
@@ -1547,7 +1547,7 @@ module XeroRuby
1547
1547
  data
1548
1548
  end
1549
1549
 
1550
- # searches SuperFunds
1550
+ # Retrieves superfunds
1551
1551
  # @param xero_tenant_id [String] Xero identifier for Tenant
1552
1552
  # @param [Hash] opts the optional parameters
1553
1553
  # @option opts [String] :if_modified_since Only records created or modified since this timestamp will be returned
@@ -1614,7 +1614,7 @@ module XeroRuby
1614
1614
  return data, status_code, headers
1615
1615
  end
1616
1616
 
1617
- # searches for an timesheet by unique id
1617
+ # Retrieves a timesheet by using a unique timesheet id
1618
1618
  # @param xero_tenant_id [String] Xero identifier for Tenant
1619
1619
  # @param timesheet_id [String] Timesheet id for single object
1620
1620
  # @param [Hash] opts the optional parameters
@@ -1624,7 +1624,7 @@ module XeroRuby
1624
1624
  data
1625
1625
  end
1626
1626
 
1627
- # searches for an timesheet by unique id
1627
+ # Retrieves a timesheet by using a unique timesheet id
1628
1628
  # @param xero_tenant_id [String] Xero identifier for Tenant
1629
1629
  # @param timesheet_id [String] Timesheet id for single object
1630
1630
  # @param [Hash] opts the optional parameters
@@ -1688,7 +1688,7 @@ module XeroRuby
1688
1688
  return data, status_code, headers
1689
1689
  end
1690
1690
 
1691
- # searches timesheets
1691
+ # Retrieves timesheets
1692
1692
  # @param xero_tenant_id [String] Xero identifier for Tenant
1693
1693
  # @param [Hash] opts the optional parameters
1694
1694
  # @option opts [String] :if_modified_since Only records created or modified since this timestamp will be returned
@@ -1701,7 +1701,7 @@ module XeroRuby
1701
1701
  data
1702
1702
  end
1703
1703
 
1704
- # searches timesheets
1704
+ # Retrieves timesheets
1705
1705
  # @param xero_tenant_id [String] Xero identifier for Tenant
1706
1706
  # @param [Hash] opts the optional parameters
1707
1707
  # @option opts [String] :if_modified_since Only records created or modified since this timestamp will be returned
@@ -1768,7 +1768,7 @@ module XeroRuby
1768
1768
  return data, status_code, headers
1769
1769
  end
1770
1770
 
1771
- # Update an Employee
1771
+ # Updates an employee's detail
1772
1772
  # Update properties on a single employee
1773
1773
  # @param xero_tenant_id [String] Xero identifier for Tenant
1774
1774
  # @param employee_id [String] Employee id for single object
@@ -1780,7 +1780,7 @@ module XeroRuby
1780
1780
  data
1781
1781
  end
1782
1782
 
1783
- # Update an Employee
1783
+ # Updates an employee&#39;s detail
1784
1784
  # Update properties on a single employee
1785
1785
  # @param xero_tenant_id [String] Xero identifier for Tenant
1786
1786
  # @param employee_id [String] Employee id for single object
@@ -1800,7 +1800,7 @@ module XeroRuby
1800
1800
  fail ArgumentError, "Missing the required parameter 'employee_id' when calling PayrollAuApi.update_employee"
1801
1801
  end
1802
1802
  # resource path
1803
- local_var_path = '/Employees/{EmployeeId}'.sub('{' + 'EmployeeId' + '}', employee_id.to_s)
1803
+ local_var_path = '/Employees/{EmployeeID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
1804
1804
 
1805
1805
  # camelize keys of incoming `where` opts
1806
1806
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -1848,7 +1848,7 @@ module XeroRuby
1848
1848
  return data, status_code, headers
1849
1849
  end
1850
1850
 
1851
- # Use this method to update a Leave Application
1851
+ # Updates a specific leave application
1852
1852
  # @param xero_tenant_id [String] Xero identifier for Tenant
1853
1853
  # @param leave_application_id [String] Leave Application id for single object
1854
1854
  # @param leave_application [Array<LeaveApplication>]
@@ -1859,7 +1859,7 @@ module XeroRuby
1859
1859
  data
1860
1860
  end
1861
1861
 
1862
- # Use this method to update a Leave Application
1862
+ # Updates a specific leave application
1863
1863
  # @param xero_tenant_id [String] Xero identifier for Tenant
1864
1864
  # @param leave_application_id [String] Leave Application id for single object
1865
1865
  # @param leave_application [Array<LeaveApplication>]
@@ -1882,7 +1882,7 @@ module XeroRuby
1882
1882
  fail ArgumentError, "Missing the required parameter 'leave_application' when calling PayrollAuApi.update_leave_application"
1883
1883
  end
1884
1884
  # resource path
1885
- local_var_path = '/LeaveApplications/{LeaveApplicationId}'.sub('{' + 'LeaveApplicationId' + '}', leave_application_id.to_s)
1885
+ local_var_path = '/LeaveApplications/{LeaveApplicationID}'.sub('{' + 'LeaveApplicationID' + '}', leave_application_id.to_s)
1886
1886
 
1887
1887
  # camelize keys of incoming `where` opts
1888
1888
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
@@ -1930,7 +1930,7 @@ module XeroRuby
1930
1930
  return data, status_code, headers
1931
1931
  end
1932
1932
 
1933
- # Update a PayRun
1933
+ # Updates a pay run
1934
1934
  # Update properties on a single PayRun
1935
1935
  # @param xero_tenant_id [String] Xero identifier for Tenant
1936
1936
  # @param pay_run_id [String] PayRun id for single object
@@ -1942,7 +1942,7 @@ module XeroRuby
1942
1942
  data
1943
1943
  end
1944
1944
 
1945
- # Update a PayRun
1945
+ # Updates a pay run
1946
1946
  # Update properties on a single PayRun
1947
1947
  # @param xero_tenant_id [String] Xero identifier for Tenant
1948
1948
  # @param pay_run_id [String] PayRun id for single object
@@ -2010,7 +2010,7 @@ module XeroRuby
2010
2010
  return data, status_code, headers
2011
2011
  end
2012
2012
 
2013
- # Update a Payslip
2013
+ # Updates a payslip
2014
2014
  # Update lines on a single payslips
2015
2015
  # @param xero_tenant_id [String] Xero identifier for Tenant
2016
2016
  # @param payslip_id [String] Payslip id for single object
@@ -2022,7 +2022,7 @@ module XeroRuby
2022
2022
  data
2023
2023
  end
2024
2024
 
2025
- # Update a Payslip
2025
+ # Updates a payslip
2026
2026
  # Update lines on a single payslips
2027
2027
  # @param xero_tenant_id [String] Xero identifier for Tenant
2028
2028
  # @param payslip_id [String] Payslip id for single object
@@ -2090,7 +2090,7 @@ module XeroRuby
2090
2090
  return data, status_code, headers
2091
2091
  end
2092
2092
 
2093
- # Update a Superfund
2093
+ # Updates a superfund
2094
2094
  # Update properties on a single Superfund
2095
2095
  # @param xero_tenant_id [String] Xero identifier for Tenant
2096
2096
  # @param super_fund_id [String] Superfund id for single object
@@ -2102,7 +2102,7 @@ module XeroRuby
2102
2102
  data
2103
2103
  end
2104
2104
 
2105
- # Update a Superfund
2105
+ # Updates a superfund
2106
2106
  # Update properties on a single Superfund
2107
2107
  # @param xero_tenant_id [String] Xero identifier for Tenant
2108
2108
  # @param super_fund_id [String] Superfund id for single object
@@ -2170,7 +2170,7 @@ module XeroRuby
2170
2170
  return data, status_code, headers
2171
2171
  end
2172
2172
 
2173
- # Update a Timesheet
2173
+ # Updates a timesheet
2174
2174
  # Update properties on a single timesheet
2175
2175
  # @param xero_tenant_id [String] Xero identifier for Tenant
2176
2176
  # @param timesheet_id [String] Timesheet id for single object
@@ -2182,7 +2182,7 @@ module XeroRuby
2182
2182
  data
2183
2183
  end
2184
2184
 
2185
- # Update a Timesheet
2185
+ # Updates a timesheet
2186
2186
  # Update properties on a single timesheet
2187
2187
  # @param xero_tenant_id [String] Xero identifier for Tenant
2188
2188
  # @param timesheet_id [String] Timesheet id for single object