xero-ruby 2.10.2 → 3.1.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (398) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +6 -6
  3. data/lib/xero-ruby.rb +4 -0
  4. data/lib/xero-ruby/api/accounting_api.rb +307 -151
  5. data/lib/xero-ruby/models/accounting/account.rb +13 -7
  6. data/lib/xero-ruby/models/accounting/accounts.rb +13 -7
  7. data/lib/xero-ruby/models/accounting/accounts_payable.rb +13 -7
  8. data/lib/xero-ruby/models/accounting/accounts_receivable.rb +13 -7
  9. data/lib/xero-ruby/models/accounting/action.rb +13 -7
  10. data/lib/xero-ruby/models/accounting/actions.rb +13 -7
  11. data/lib/xero-ruby/models/accounting/address.rb +13 -7
  12. data/lib/xero-ruby/models/accounting/address_for_organisation.rb +13 -7
  13. data/lib/xero-ruby/models/accounting/allocation.rb +13 -7
  14. data/lib/xero-ruby/models/accounting/allocations.rb +13 -7
  15. data/lib/xero-ruby/models/accounting/attachment.rb +13 -7
  16. data/lib/xero-ruby/models/accounting/attachments.rb +13 -7
  17. data/lib/xero-ruby/models/accounting/balance_details.rb +13 -7
  18. data/lib/xero-ruby/models/accounting/balances.rb +13 -7
  19. data/lib/xero-ruby/models/accounting/bank_transaction.rb +13 -7
  20. data/lib/xero-ruby/models/accounting/bank_transactions.rb +13 -7
  21. data/lib/xero-ruby/models/accounting/bank_transfer.rb +13 -7
  22. data/lib/xero-ruby/models/accounting/bank_transfers.rb +13 -7
  23. data/lib/xero-ruby/models/accounting/batch_payment.rb +13 -7
  24. data/lib/xero-ruby/models/accounting/batch_payment_details.rb +13 -7
  25. data/lib/xero-ruby/models/accounting/batch_payments.rb +13 -7
  26. data/lib/xero-ruby/models/accounting/bill.rb +13 -7
  27. data/lib/xero-ruby/models/accounting/branding_theme.rb +13 -7
  28. data/lib/xero-ruby/models/accounting/branding_themes.rb +13 -7
  29. data/lib/xero-ruby/models/accounting/budget.rb +327 -0
  30. data/lib/xero-ruby/models/accounting/budget_balance.rb +267 -0
  31. data/lib/xero-ruby/models/accounting/budget_line.rb +244 -0
  32. data/lib/xero-ruby/models/accounting/budgets.rb +224 -0
  33. data/lib/xero-ruby/models/accounting/cis_org_setting.rb +13 -7
  34. data/lib/xero-ruby/models/accounting/cis_org_settings.rb +13 -7
  35. data/lib/xero-ruby/models/accounting/cis_setting.rb +13 -7
  36. data/lib/xero-ruby/models/accounting/cis_settings.rb +13 -7
  37. data/lib/xero-ruby/models/accounting/contact.rb +13 -7
  38. data/lib/xero-ruby/models/accounting/contact_group.rb +13 -7
  39. data/lib/xero-ruby/models/accounting/contact_groups.rb +13 -7
  40. data/lib/xero-ruby/models/accounting/contact_person.rb +13 -7
  41. data/lib/xero-ruby/models/accounting/contacts.rb +13 -7
  42. data/lib/xero-ruby/models/accounting/conversion_balances.rb +13 -7
  43. data/lib/xero-ruby/models/accounting/conversion_date.rb +13 -7
  44. data/lib/xero-ruby/models/accounting/credit_note.rb +13 -7
  45. data/lib/xero-ruby/models/accounting/credit_notes.rb +13 -7
  46. data/lib/xero-ruby/models/accounting/currencies.rb +13 -7
  47. data/lib/xero-ruby/models/accounting/currency.rb +13 -7
  48. data/lib/xero-ruby/models/accounting/element.rb +13 -7
  49. data/lib/xero-ruby/models/accounting/employee.rb +13 -7
  50. data/lib/xero-ruby/models/accounting/employees.rb +13 -7
  51. data/lib/xero-ruby/models/accounting/error.rb +13 -7
  52. data/lib/xero-ruby/models/accounting/expense_claim.rb +13 -7
  53. data/lib/xero-ruby/models/accounting/expense_claims.rb +13 -7
  54. data/lib/xero-ruby/models/accounting/external_link.rb +13 -7
  55. data/lib/xero-ruby/models/accounting/history_record.rb +13 -7
  56. data/lib/xero-ruby/models/accounting/history_records.rb +13 -7
  57. data/lib/xero-ruby/models/accounting/import_summary.rb +13 -7
  58. data/lib/xero-ruby/models/accounting/import_summary_accounts.rb +13 -7
  59. data/lib/xero-ruby/models/accounting/import_summary_object.rb +13 -7
  60. data/lib/xero-ruby/models/accounting/import_summary_organisation.rb +13 -7
  61. data/lib/xero-ruby/models/accounting/invoice.rb +13 -7
  62. data/lib/xero-ruby/models/accounting/invoice_reminder.rb +13 -7
  63. data/lib/xero-ruby/models/accounting/invoice_reminders.rb +13 -7
  64. data/lib/xero-ruby/models/accounting/invoices.rb +13 -7
  65. data/lib/xero-ruby/models/accounting/item.rb +13 -7
  66. data/lib/xero-ruby/models/accounting/items.rb +13 -7
  67. data/lib/xero-ruby/models/accounting/journal.rb +13 -7
  68. data/lib/xero-ruby/models/accounting/journal_line.rb +13 -7
  69. data/lib/xero-ruby/models/accounting/journals.rb +13 -7
  70. data/lib/xero-ruby/models/accounting/line_item.rb +24 -8
  71. data/lib/xero-ruby/models/accounting/line_item_tracking.rb +13 -7
  72. data/lib/xero-ruby/models/accounting/linked_transaction.rb +13 -7
  73. data/lib/xero-ruby/models/accounting/linked_transactions.rb +13 -7
  74. data/lib/xero-ruby/models/accounting/manual_journal.rb +13 -7
  75. data/lib/xero-ruby/models/accounting/manual_journal_line.rb +13 -7
  76. data/lib/xero-ruby/models/accounting/manual_journals.rb +13 -7
  77. data/lib/xero-ruby/models/accounting/online_invoice.rb +13 -7
  78. data/lib/xero-ruby/models/accounting/online_invoices.rb +13 -7
  79. data/lib/xero-ruby/models/accounting/organisation.rb +13 -7
  80. data/lib/xero-ruby/models/accounting/organisations.rb +13 -7
  81. data/lib/xero-ruby/models/accounting/overpayment.rb +13 -7
  82. data/lib/xero-ruby/models/accounting/overpayments.rb +13 -7
  83. data/lib/xero-ruby/models/accounting/payment.rb +13 -7
  84. data/lib/xero-ruby/models/accounting/payment_delete.rb +13 -7
  85. data/lib/xero-ruby/models/accounting/payment_service.rb +13 -7
  86. data/lib/xero-ruby/models/accounting/payment_services.rb +13 -7
  87. data/lib/xero-ruby/models/accounting/payment_term.rb +13 -7
  88. data/lib/xero-ruby/models/accounting/payments.rb +13 -7
  89. data/lib/xero-ruby/models/accounting/phone.rb +13 -7
  90. data/lib/xero-ruby/models/accounting/prepayment.rb +26 -8
  91. data/lib/xero-ruby/models/accounting/prepayments.rb +13 -7
  92. data/lib/xero-ruby/models/accounting/purchase.rb +13 -7
  93. data/lib/xero-ruby/models/accounting/purchase_order.rb +13 -7
  94. data/lib/xero-ruby/models/accounting/purchase_orders.rb +13 -7
  95. data/lib/xero-ruby/models/accounting/quote.rb +13 -7
  96. data/lib/xero-ruby/models/accounting/quotes.rb +13 -7
  97. data/lib/xero-ruby/models/accounting/receipt.rb +13 -7
  98. data/lib/xero-ruby/models/accounting/receipts.rb +13 -7
  99. data/lib/xero-ruby/models/accounting/repeating_invoice.rb +13 -7
  100. data/lib/xero-ruby/models/accounting/repeating_invoices.rb +13 -7
  101. data/lib/xero-ruby/models/accounting/report.rb +14 -18
  102. data/lib/xero-ruby/models/accounting/report_attribute.rb +13 -7
  103. data/lib/xero-ruby/models/accounting/report_cell.rb +13 -7
  104. data/lib/xero-ruby/models/accounting/report_fields.rb +13 -7
  105. data/lib/xero-ruby/models/accounting/report_row.rb +13 -7
  106. data/lib/xero-ruby/models/accounting/report_rows.rb +13 -7
  107. data/lib/xero-ruby/models/accounting/report_with_row.rb +14 -8
  108. data/lib/xero-ruby/models/accounting/report_with_rows.rb +13 -7
  109. data/lib/xero-ruby/models/accounting/reports.rb +13 -7
  110. data/lib/xero-ruby/models/accounting/request_empty.rb +13 -7
  111. data/lib/xero-ruby/models/accounting/sales_tracking_category.rb +13 -7
  112. data/lib/xero-ruby/models/accounting/schedule.rb +13 -7
  113. data/lib/xero-ruby/models/accounting/setup.rb +13 -7
  114. data/lib/xero-ruby/models/accounting/tax_component.rb +13 -7
  115. data/lib/xero-ruby/models/accounting/tax_rate.rb +13 -7
  116. data/lib/xero-ruby/models/accounting/tax_rates.rb +13 -7
  117. data/lib/xero-ruby/models/accounting/ten_ninety_nine_contact.rb +13 -7
  118. data/lib/xero-ruby/models/accounting/tracking_categories.rb +13 -7
  119. data/lib/xero-ruby/models/accounting/tracking_category.rb +13 -7
  120. data/lib/xero-ruby/models/accounting/tracking_option.rb +13 -7
  121. data/lib/xero-ruby/models/accounting/tracking_options.rb +13 -7
  122. data/lib/xero-ruby/models/accounting/user.rb +13 -7
  123. data/lib/xero-ruby/models/accounting/users.rb +13 -7
  124. data/lib/xero-ruby/models/accounting/validation_error.rb +13 -7
  125. data/lib/xero-ruby/models/assets/asset.rb +13 -7
  126. data/lib/xero-ruby/models/assets/asset_type.rb +13 -7
  127. data/lib/xero-ruby/models/assets/assets.rb +13 -7
  128. data/lib/xero-ruby/models/assets/book_depreciation_detail.rb +13 -7
  129. data/lib/xero-ruby/models/assets/book_depreciation_setting.rb +13 -7
  130. data/lib/xero-ruby/models/assets/error.rb +13 -7
  131. data/lib/xero-ruby/models/assets/field_validation_errors_element.rb +13 -7
  132. data/lib/xero-ruby/models/assets/pagination.rb +13 -7
  133. data/lib/xero-ruby/models/assets/resource_validation_errors_element.rb +13 -7
  134. data/lib/xero-ruby/models/assets/setting.rb +13 -7
  135. data/lib/xero-ruby/models/files/association.rb +13 -7
  136. data/lib/xero-ruby/models/files/file_object.rb +13 -7
  137. data/lib/xero-ruby/models/files/files.rb +13 -7
  138. data/lib/xero-ruby/models/files/folder.rb +13 -7
  139. data/lib/xero-ruby/models/files/folders.rb +13 -7
  140. data/lib/xero-ruby/models/files/upload_object.rb +13 -7
  141. data/lib/xero-ruby/models/files/user.rb +13 -7
  142. data/lib/xero-ruby/models/payroll_au/account.rb +13 -7
  143. data/lib/xero-ruby/models/payroll_au/api_exception.rb +13 -7
  144. data/lib/xero-ruby/models/payroll_au/bank_account.rb +13 -7
  145. data/lib/xero-ruby/models/payroll_au/deduction_line.rb +13 -7
  146. data/lib/xero-ruby/models/payroll_au/deduction_type.rb +13 -7
  147. data/lib/xero-ruby/models/payroll_au/earnings_line.rb +13 -7
  148. data/lib/xero-ruby/models/payroll_au/earnings_rate.rb +13 -7
  149. data/lib/xero-ruby/models/payroll_au/employee.rb +13 -7
  150. data/lib/xero-ruby/models/payroll_au/employees.rb +13 -7
  151. data/lib/xero-ruby/models/payroll_au/home_address.rb +13 -7
  152. data/lib/xero-ruby/models/payroll_au/leave_accrual_line.rb +13 -7
  153. data/lib/xero-ruby/models/payroll_au/leave_application.rb +13 -7
  154. data/lib/xero-ruby/models/payroll_au/leave_applications.rb +13 -7
  155. data/lib/xero-ruby/models/payroll_au/leave_balance.rb +13 -7
  156. data/lib/xero-ruby/models/payroll_au/leave_earnings_line.rb +13 -7
  157. data/lib/xero-ruby/models/payroll_au/leave_line.rb +13 -7
  158. data/lib/xero-ruby/models/payroll_au/leave_lines.rb +13 -7
  159. data/lib/xero-ruby/models/payroll_au/leave_period.rb +13 -7
  160. data/lib/xero-ruby/models/payroll_au/leave_type.rb +13 -7
  161. data/lib/xero-ruby/models/payroll_au/opening_balances.rb +13 -7
  162. data/lib/xero-ruby/models/payroll_au/pay_item.rb +13 -7
  163. data/lib/xero-ruby/models/payroll_au/pay_items.rb +13 -7
  164. data/lib/xero-ruby/models/payroll_au/pay_run.rb +13 -7
  165. data/lib/xero-ruby/models/payroll_au/pay_runs.rb +13 -7
  166. data/lib/xero-ruby/models/payroll_au/pay_template.rb +13 -7
  167. data/lib/xero-ruby/models/payroll_au/payroll_calendar.rb +13 -7
  168. data/lib/xero-ruby/models/payroll_au/payroll_calendars.rb +13 -7
  169. data/lib/xero-ruby/models/payroll_au/payslip.rb +13 -7
  170. data/lib/xero-ruby/models/payroll_au/payslip_lines.rb +13 -7
  171. data/lib/xero-ruby/models/payroll_au/payslip_object.rb +13 -7
  172. data/lib/xero-ruby/models/payroll_au/payslip_summary.rb +13 -7
  173. data/lib/xero-ruby/models/payroll_au/payslips.rb +13 -7
  174. data/lib/xero-ruby/models/payroll_au/reimbursement_line.rb +13 -7
  175. data/lib/xero-ruby/models/payroll_au/reimbursement_lines.rb +13 -7
  176. data/lib/xero-ruby/models/payroll_au/reimbursement_type.rb +13 -7
  177. data/lib/xero-ruby/models/payroll_au/settings.rb +13 -7
  178. data/lib/xero-ruby/models/payroll_au/settings_object.rb +13 -7
  179. data/lib/xero-ruby/models/payroll_au/settings_tracking_categories.rb +13 -7
  180. data/lib/xero-ruby/models/payroll_au/settings_tracking_categories_employee_groups.rb +13 -7
  181. data/lib/xero-ruby/models/payroll_au/settings_tracking_categories_timesheet_categories.rb +13 -7
  182. data/lib/xero-ruby/models/payroll_au/super_fund.rb +13 -7
  183. data/lib/xero-ruby/models/payroll_au/super_fund_product.rb +13 -7
  184. data/lib/xero-ruby/models/payroll_au/super_fund_products.rb +13 -7
  185. data/lib/xero-ruby/models/payroll_au/super_funds.rb +13 -7
  186. data/lib/xero-ruby/models/payroll_au/super_line.rb +13 -7
  187. data/lib/xero-ruby/models/payroll_au/super_membership.rb +13 -7
  188. data/lib/xero-ruby/models/payroll_au/superannuation_line.rb +13 -7
  189. data/lib/xero-ruby/models/payroll_au/tax_declaration.rb +13 -7
  190. data/lib/xero-ruby/models/payroll_au/tax_line.rb +13 -7
  191. data/lib/xero-ruby/models/payroll_au/timesheet.rb +13 -7
  192. data/lib/xero-ruby/models/payroll_au/timesheet_line.rb +13 -7
  193. data/lib/xero-ruby/models/payroll_au/timesheet_object.rb +13 -7
  194. data/lib/xero-ruby/models/payroll_au/timesheets.rb +13 -7
  195. data/lib/xero-ruby/models/payroll_au/validation_error.rb +13 -7
  196. data/lib/xero-ruby/models/payroll_nz/account.rb +13 -7
  197. data/lib/xero-ruby/models/payroll_nz/accounts.rb +13 -7
  198. data/lib/xero-ruby/models/payroll_nz/address.rb +13 -7
  199. data/lib/xero-ruby/models/payroll_nz/bank_account.rb +13 -7
  200. data/lib/xero-ruby/models/payroll_nz/benefit.rb +13 -7
  201. data/lib/xero-ruby/models/payroll_nz/deduction.rb +13 -7
  202. data/lib/xero-ruby/models/payroll_nz/deduction_line.rb +13 -7
  203. data/lib/xero-ruby/models/payroll_nz/deduction_object.rb +13 -7
  204. data/lib/xero-ruby/models/payroll_nz/deductions.rb +13 -7
  205. data/lib/xero-ruby/models/payroll_nz/earnings_line.rb +13 -7
  206. data/lib/xero-ruby/models/payroll_nz/earnings_order.rb +13 -7
  207. data/lib/xero-ruby/models/payroll_nz/earnings_order_object.rb +13 -7
  208. data/lib/xero-ruby/models/payroll_nz/earnings_orders.rb +13 -7
  209. data/lib/xero-ruby/models/payroll_nz/earnings_rate.rb +13 -7
  210. data/lib/xero-ruby/models/payroll_nz/earnings_rate_object.rb +13 -7
  211. data/lib/xero-ruby/models/payroll_nz/earnings_rates.rb +13 -7
  212. data/lib/xero-ruby/models/payroll_nz/earnings_template.rb +13 -7
  213. data/lib/xero-ruby/models/payroll_nz/earnings_template_object.rb +13 -7
  214. data/lib/xero-ruby/models/payroll_nz/employee.rb +13 -7
  215. data/lib/xero-ruby/models/payroll_nz/employee_earnings_templates.rb +13 -7
  216. data/lib/xero-ruby/models/payroll_nz/employee_leave.rb +13 -7
  217. data/lib/xero-ruby/models/payroll_nz/employee_leave_balance.rb +13 -7
  218. data/lib/xero-ruby/models/payroll_nz/employee_leave_balances.rb +13 -7
  219. data/lib/xero-ruby/models/payroll_nz/employee_leave_object.rb +13 -7
  220. data/lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb +13 -7
  221. data/lib/xero-ruby/models/payroll_nz/employee_leave_setup_object.rb +13 -7
  222. data/lib/xero-ruby/models/payroll_nz/employee_leave_type.rb +13 -7
  223. data/lib/xero-ruby/models/payroll_nz/employee_leave_type_object.rb +13 -7
  224. data/lib/xero-ruby/models/payroll_nz/employee_leave_types.rb +13 -7
  225. data/lib/xero-ruby/models/payroll_nz/employee_leaves.rb +13 -7
  226. data/lib/xero-ruby/models/payroll_nz/employee_object.rb +13 -7
  227. data/lib/xero-ruby/models/payroll_nz/employee_opening_balance.rb +13 -7
  228. data/lib/xero-ruby/models/payroll_nz/employee_opening_balances_object.rb +13 -7
  229. data/lib/xero-ruby/models/payroll_nz/employee_pay_template.rb +13 -7
  230. data/lib/xero-ruby/models/payroll_nz/employee_pay_template_object.rb +13 -7
  231. data/lib/xero-ruby/models/payroll_nz/employee_pay_templates.rb +13 -7
  232. data/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_balance.rb +13 -7
  233. data/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_balance_object.rb +13 -7
  234. data/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_summary.rb +13 -7
  235. data/lib/xero-ruby/models/payroll_nz/employee_statutory_leaves_summaries.rb +13 -7
  236. data/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leave.rb +13 -7
  237. data/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leave_object.rb +13 -7
  238. data/lib/xero-ruby/models/payroll_nz/employee_statutory_sick_leaves.rb +13 -7
  239. data/lib/xero-ruby/models/payroll_nz/employee_tax.rb +13 -7
  240. data/lib/xero-ruby/models/payroll_nz/employee_tax_object.rb +13 -7
  241. data/lib/xero-ruby/models/payroll_nz/employees.rb +13 -7
  242. data/lib/xero-ruby/models/payroll_nz/employment.rb +13 -7
  243. data/lib/xero-ruby/models/payroll_nz/employment_object.rb +13 -7
  244. data/lib/xero-ruby/models/payroll_nz/gross_earnings_history.rb +13 -7
  245. data/lib/xero-ruby/models/payroll_nz/invalid_field.rb +13 -7
  246. data/lib/xero-ruby/models/payroll_nz/leave_accrual_line.rb +13 -7
  247. data/lib/xero-ruby/models/payroll_nz/leave_earnings_line.rb +13 -7
  248. data/lib/xero-ruby/models/payroll_nz/leave_period.rb +13 -7
  249. data/lib/xero-ruby/models/payroll_nz/leave_periods.rb +13 -7
  250. data/lib/xero-ruby/models/payroll_nz/leave_type.rb +13 -7
  251. data/lib/xero-ruby/models/payroll_nz/leave_type_object.rb +13 -7
  252. data/lib/xero-ruby/models/payroll_nz/leave_types.rb +13 -7
  253. data/lib/xero-ruby/models/payroll_nz/pagination.rb +13 -7
  254. data/lib/xero-ruby/models/payroll_nz/pay_run.rb +13 -7
  255. data/lib/xero-ruby/models/payroll_nz/pay_run_calendar.rb +13 -7
  256. data/lib/xero-ruby/models/payroll_nz/pay_run_calendar_object.rb +13 -7
  257. data/lib/xero-ruby/models/payroll_nz/pay_run_calendars.rb +13 -7
  258. data/lib/xero-ruby/models/payroll_nz/pay_run_object.rb +13 -7
  259. data/lib/xero-ruby/models/payroll_nz/pay_runs.rb +13 -7
  260. data/lib/xero-ruby/models/payroll_nz/pay_slip.rb +13 -7
  261. data/lib/xero-ruby/models/payroll_nz/pay_slip_object.rb +13 -7
  262. data/lib/xero-ruby/models/payroll_nz/pay_slips.rb +13 -7
  263. data/lib/xero-ruby/models/payroll_nz/payment_line.rb +13 -7
  264. data/lib/xero-ruby/models/payroll_nz/payment_method.rb +13 -7
  265. data/lib/xero-ruby/models/payroll_nz/payment_method_object.rb +13 -7
  266. data/lib/xero-ruby/models/payroll_nz/problem.rb +13 -7
  267. data/lib/xero-ruby/models/payroll_nz/reimbursement.rb +13 -7
  268. data/lib/xero-ruby/models/payroll_nz/reimbursement_line.rb +13 -7
  269. data/lib/xero-ruby/models/payroll_nz/reimbursement_object.rb +13 -7
  270. data/lib/xero-ruby/models/payroll_nz/reimbursements.rb +13 -7
  271. data/lib/xero-ruby/models/payroll_nz/salary_and_wage.rb +13 -7
  272. data/lib/xero-ruby/models/payroll_nz/salary_and_wage_object.rb +13 -7
  273. data/lib/xero-ruby/models/payroll_nz/salary_and_wages.rb +13 -7
  274. data/lib/xero-ruby/models/payroll_nz/settings.rb +13 -7
  275. data/lib/xero-ruby/models/payroll_nz/statutory_deduction.rb +13 -7
  276. data/lib/xero-ruby/models/payroll_nz/statutory_deduction_line.rb +13 -7
  277. data/lib/xero-ruby/models/payroll_nz/statutory_deduction_object.rb +13 -7
  278. data/lib/xero-ruby/models/payroll_nz/statutory_deductions.rb +13 -7
  279. data/lib/xero-ruby/models/payroll_nz/superannuation_line.rb +13 -7
  280. data/lib/xero-ruby/models/payroll_nz/superannuation_object.rb +13 -7
  281. data/lib/xero-ruby/models/payroll_nz/superannuations.rb +13 -7
  282. data/lib/xero-ruby/models/payroll_nz/tax_line.rb +13 -7
  283. data/lib/xero-ruby/models/payroll_nz/tax_settings.rb +13 -7
  284. data/lib/xero-ruby/models/payroll_nz/timesheet.rb +13 -7
  285. data/lib/xero-ruby/models/payroll_nz/timesheet_earnings_line.rb +13 -7
  286. data/lib/xero-ruby/models/payroll_nz/timesheet_line.rb +13 -7
  287. data/lib/xero-ruby/models/payroll_nz/timesheet_line_object.rb +13 -7
  288. data/lib/xero-ruby/models/payroll_nz/timesheet_object.rb +13 -7
  289. data/lib/xero-ruby/models/payroll_nz/timesheets.rb +13 -7
  290. data/lib/xero-ruby/models/payroll_nz/tracking_categories.rb +13 -7
  291. data/lib/xero-ruby/models/payroll_nz/tracking_category.rb +13 -7
  292. data/lib/xero-ruby/models/payroll_uk/account.rb +13 -7
  293. data/lib/xero-ruby/models/payroll_uk/accounts.rb +13 -7
  294. data/lib/xero-ruby/models/payroll_uk/address.rb +13 -7
  295. data/lib/xero-ruby/models/payroll_uk/bank_account.rb +13 -7
  296. data/lib/xero-ruby/models/payroll_uk/benefit.rb +13 -7
  297. data/lib/xero-ruby/models/payroll_uk/benefit_line.rb +13 -7
  298. data/lib/xero-ruby/models/payroll_uk/benefit_object.rb +13 -7
  299. data/lib/xero-ruby/models/payroll_uk/benefits.rb +13 -7
  300. data/lib/xero-ruby/models/payroll_uk/court_order_line.rb +13 -7
  301. data/lib/xero-ruby/models/payroll_uk/deduction.rb +13 -7
  302. data/lib/xero-ruby/models/payroll_uk/deduction_line.rb +13 -7
  303. data/lib/xero-ruby/models/payroll_uk/deduction_object.rb +13 -7
  304. data/lib/xero-ruby/models/payroll_uk/deductions.rb +13 -7
  305. data/lib/xero-ruby/models/payroll_uk/earnings_line.rb +13 -7
  306. data/lib/xero-ruby/models/payroll_uk/earnings_order.rb +13 -7
  307. data/lib/xero-ruby/models/payroll_uk/earnings_order_object.rb +13 -7
  308. data/lib/xero-ruby/models/payroll_uk/earnings_orders.rb +13 -7
  309. data/lib/xero-ruby/models/payroll_uk/earnings_rate.rb +16 -9
  310. data/lib/xero-ruby/models/payroll_uk/earnings_rate_object.rb +13 -7
  311. data/lib/xero-ruby/models/payroll_uk/earnings_rates.rb +13 -7
  312. data/lib/xero-ruby/models/payroll_uk/earnings_template.rb +13 -7
  313. data/lib/xero-ruby/models/payroll_uk/earnings_template_object.rb +13 -7
  314. data/lib/xero-ruby/models/payroll_uk/employee.rb +13 -7
  315. data/lib/xero-ruby/models/payroll_uk/employee_leave.rb +13 -7
  316. data/lib/xero-ruby/models/payroll_uk/employee_leave_balance.rb +13 -7
  317. data/lib/xero-ruby/models/payroll_uk/employee_leave_balances.rb +13 -7
  318. data/lib/xero-ruby/models/payroll_uk/employee_leave_object.rb +13 -7
  319. data/lib/xero-ruby/models/payroll_uk/employee_leave_type.rb +13 -7
  320. data/lib/xero-ruby/models/payroll_uk/employee_leave_type_object.rb +13 -7
  321. data/lib/xero-ruby/models/payroll_uk/employee_leave_types.rb +13 -7
  322. data/lib/xero-ruby/models/payroll_uk/employee_leaves.rb +13 -7
  323. data/lib/xero-ruby/models/payroll_uk/employee_object.rb +13 -7
  324. data/lib/xero-ruby/models/payroll_uk/employee_opening_balances.rb +13 -7
  325. data/lib/xero-ruby/models/payroll_uk/employee_opening_balances_object.rb +13 -7
  326. data/lib/xero-ruby/models/payroll_uk/employee_pay_template.rb +13 -7
  327. data/lib/xero-ruby/models/payroll_uk/employee_pay_template_object.rb +13 -7
  328. data/lib/xero-ruby/models/payroll_uk/employee_pay_templates.rb +13 -7
  329. data/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_balance.rb +13 -7
  330. data/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_balance_object.rb +13 -7
  331. data/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_summary.rb +13 -7
  332. data/lib/xero-ruby/models/payroll_uk/employee_statutory_leaves_summaries.rb +13 -7
  333. data/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb +13 -7
  334. data/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave_object.rb +13 -7
  335. data/lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leaves.rb +13 -7
  336. data/lib/xero-ruby/models/payroll_uk/employee_tax.rb +13 -7
  337. data/lib/xero-ruby/models/payroll_uk/employee_tax_object.rb +13 -7
  338. data/lib/xero-ruby/models/payroll_uk/employees.rb +13 -7
  339. data/lib/xero-ruby/models/payroll_uk/employment.rb +13 -7
  340. data/lib/xero-ruby/models/payroll_uk/employment_object.rb +13 -7
  341. data/lib/xero-ruby/models/payroll_uk/invalid_field.rb +13 -7
  342. data/lib/xero-ruby/models/payroll_uk/leave_accrual_line.rb +13 -7
  343. data/lib/xero-ruby/models/payroll_uk/leave_earnings_line.rb +13 -7
  344. data/lib/xero-ruby/models/payroll_uk/leave_period.rb +13 -7
  345. data/lib/xero-ruby/models/payroll_uk/leave_periods.rb +13 -7
  346. data/lib/xero-ruby/models/payroll_uk/leave_type.rb +13 -7
  347. data/lib/xero-ruby/models/payroll_uk/leave_type_object.rb +13 -7
  348. data/lib/xero-ruby/models/payroll_uk/leave_types.rb +13 -7
  349. data/lib/xero-ruby/models/payroll_uk/pagination.rb +13 -7
  350. data/lib/xero-ruby/models/payroll_uk/pay_run.rb +13 -7
  351. data/lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb +13 -7
  352. data/lib/xero-ruby/models/payroll_uk/pay_run_calendar_object.rb +13 -7
  353. data/lib/xero-ruby/models/payroll_uk/pay_run_calendars.rb +13 -7
  354. data/lib/xero-ruby/models/payroll_uk/pay_run_object.rb +13 -7
  355. data/lib/xero-ruby/models/payroll_uk/pay_runs.rb +13 -7
  356. data/lib/xero-ruby/models/payroll_uk/payment_line.rb +13 -7
  357. data/lib/xero-ruby/models/payroll_uk/payment_method.rb +13 -7
  358. data/lib/xero-ruby/models/payroll_uk/payment_method_object.rb +13 -7
  359. data/lib/xero-ruby/models/payroll_uk/payslip.rb +13 -7
  360. data/lib/xero-ruby/models/payroll_uk/payslip_object.rb +13 -7
  361. data/lib/xero-ruby/models/payroll_uk/payslips.rb +13 -7
  362. data/lib/xero-ruby/models/payroll_uk/problem.rb +13 -7
  363. data/lib/xero-ruby/models/payroll_uk/reimbursement.rb +13 -7
  364. data/lib/xero-ruby/models/payroll_uk/reimbursement_line.rb +13 -7
  365. data/lib/xero-ruby/models/payroll_uk/reimbursement_object.rb +13 -7
  366. data/lib/xero-ruby/models/payroll_uk/reimbursements.rb +13 -7
  367. data/lib/xero-ruby/models/payroll_uk/salary_and_wage.rb +13 -7
  368. data/lib/xero-ruby/models/payroll_uk/salary_and_wage_object.rb +13 -7
  369. data/lib/xero-ruby/models/payroll_uk/salary_and_wages.rb +13 -7
  370. data/lib/xero-ruby/models/payroll_uk/settings.rb +13 -7
  371. data/lib/xero-ruby/models/payroll_uk/statutory_deduction.rb +13 -7
  372. data/lib/xero-ruby/models/payroll_uk/tax_line.rb +13 -7
  373. data/lib/xero-ruby/models/payroll_uk/timesheet.rb +13 -7
  374. data/lib/xero-ruby/models/payroll_uk/timesheet_earnings_line.rb +13 -7
  375. data/lib/xero-ruby/models/payroll_uk/timesheet_line.rb +13 -7
  376. data/lib/xero-ruby/models/payroll_uk/timesheet_line_object.rb +13 -7
  377. data/lib/xero-ruby/models/payroll_uk/timesheet_object.rb +13 -7
  378. data/lib/xero-ruby/models/payroll_uk/timesheets.rb +13 -7
  379. data/lib/xero-ruby/models/payroll_uk/tracking_categories.rb +13 -7
  380. data/lib/xero-ruby/models/payroll_uk/tracking_category.rb +13 -7
  381. data/lib/xero-ruby/models/projects/amount.rb +13 -7
  382. data/lib/xero-ruby/models/projects/error.rb +13 -7
  383. data/lib/xero-ruby/models/projects/pagination.rb +13 -7
  384. data/lib/xero-ruby/models/projects/project.rb +13 -7
  385. data/lib/xero-ruby/models/projects/project_create_or_update.rb +13 -7
  386. data/lib/xero-ruby/models/projects/project_patch.rb +13 -7
  387. data/lib/xero-ruby/models/projects/project_user.rb +13 -7
  388. data/lib/xero-ruby/models/projects/project_users.rb +13 -7
  389. data/lib/xero-ruby/models/projects/projects.rb +13 -7
  390. data/lib/xero-ruby/models/projects/task.rb +13 -7
  391. data/lib/xero-ruby/models/projects/task_create_or_update.rb +13 -7
  392. data/lib/xero-ruby/models/projects/tasks.rb +13 -7
  393. data/lib/xero-ruby/models/projects/time_entries.rb +13 -7
  394. data/lib/xero-ruby/models/projects/time_entry.rb +13 -7
  395. data/lib/xero-ruby/models/projects/time_entry_create_or_update.rb +13 -7
  396. data/lib/xero-ruby/version.rb +2 -2
  397. data/spec/helper_methods_spec.rb +28 -0
  398. metadata +9 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: aaa8295ee798049a210f04184b5a9bd47e6c6d06b5f5e7a7197a021ca997cdf0
4
- data.tar.gz: 8048f7bc8f95742fbdf1804ed40ea6325c3f87e54d2454cea05f1c444d45558d
3
+ metadata.gz: d9d0112cb2d0bb0b563d0f702794ac288faf75c964faefd7276c09bbed1ca70b
4
+ data.tar.gz: 2ed673b2a449037d1bfb0d132ad84eeac7a814412e127b5d00a8694735288d56
5
5
  SHA512:
6
- metadata.gz: e469a609bad593d2a26dfe78a8864c7a9a067b8c2b26ae707a910a6de4c53b8a368daaff62dd3adea72159a7467cc0025d31eba39b728c00829a45329756dc3c
7
- data.tar.gz: 01d586c5e99f4ecc8bea4551d44604c09e0bb3890c8756935bc9a6905b8c5b6cf86e4aeef39c2b0d2666e44b1ff5017d6812c809629c9bdc26585fd37d944cc9
6
+ metadata.gz: 131b39dff4cc85df48f3a872d1dbbd3a7f3cdd5bb1808f88de897b4ae394b8ccc14549be94b5d51f66ef029713521e9447041a6f767ae0b954bffb6261972729
7
+ data.tar.gz: 6311ad42dbddb39939fe10d9a2c9ee6e8ad9b0c4e83cd5976d1b86ff8b7db11b991890e050d9f0dcce2d39a72e4b4fd8f57a970dcc4845c7bc373feb2d6590d0
data/README.md CHANGED
@@ -23,9 +23,6 @@ We have two sample apps showing SDK usage:
23
23
  * Login to your Xero developer [/myapps](https://developer.xero.com/myapps) dashboard & create an API application
24
24
  * Copy the credentials from your API app and store/access them using a secure ENV variable strategy
25
25
  * Resaearch and include the [neccesary scopes](https://developer.xero.com/documentation/oauth2/scopes) for your app's functionality as a space-seperated list, ex. "`SCOPES="openid profile email accounting.transactions accounting.settings"`"
26
-
27
-
28
-
29
26
  ## Installation
30
27
  To install this gem to your project:
31
28
  ```
@@ -115,10 +112,10 @@ Both the `id_token` & `access_token` are JWT's, and can be decoded to see additi
115
112
  After the initial user interaction you can simply setup a xero_client by passing the whole token_set to the client.
116
113
  ```ruby
117
114
  xero_client.set_token_set(user.token_set)
118
- # or set it and refresh in same go
115
+
119
116
  xero_client.refresh_token_set(user.token_set)
120
117
  ```
121
- This sets the access_token on the client returns either the existing, or newly refreshed `token_set`. You should save in your database for the next time you need to connect to Xero's AP and repeat the process. Assuming you keep your connection live at least once per 60 days, you can persist infinite API connection assuming the user does not revoke your API access.
118
+ This sets the access_token on the client, and returns a refreshed `token_set` that you should save in your datastore for the next time you need to connect to Xero's API.
122
119
  ## Token Helpers
123
120
  ```ruby
124
121
  xero_client.token_set
@@ -228,10 +225,13 @@ accounts = xero_client.accounting_api.get_accounts(tenant_id).accounts
228
225
  invoices = { invoices: [{ type: XeroRuby::Accounting::Invoice::ACCREC, contact: { contact_id: contacts[0].contact_id }, line_items: [{ description: "Big Agency", quantity: BigDecimal("2.0"), unit_amount: BigDecimal("50.99"), account_code: "600", tax_type: XeroRuby::Accounting::TaxType::NONE }], date: "2019-03-11", due_date: "2018-12-10", reference: "Website Design", status: XeroRuby::Accounting::Invoice::DRAFT }]}
229
226
  invoice = xero_client.accounting_api.create_invoices(tenant_id, invoices).invoices.first
230
227
 
231
- # display out all the serialized data as a hash
228
+ # display out all the serialized data as a snake_case hash
232
229
  puts invoices.to_attributes
233
230
  => {type: 'ACCREC', line_items: [...]}
234
231
 
232
+ puts invoices.to_hash(downcase: false)
233
+ => {'Type': 'ACCREC', 'LineItems': [...]}
234
+
235
235
  # Create History
236
236
  payment = xero_client.accounting_api.get_payments(tenant_id).payments.first
237
237
  history_records = { history_records: [{ details: "This payment now has some History!" }]}
data/lib/xero-ruby.rb CHANGED
@@ -349,6 +349,10 @@ require 'xero-ruby/models/accounting/batch_payments'
349
349
  require 'xero-ruby/models/accounting/bill'
350
350
  require 'xero-ruby/models/accounting/branding_theme'
351
351
  require 'xero-ruby/models/accounting/branding_themes'
352
+ require 'xero-ruby/models/accounting/budget'
353
+ require 'xero-ruby/models/accounting/budget_balance'
354
+ require 'xero-ruby/models/accounting/budget_line'
355
+ require 'xero-ruby/models/accounting/budgets'
352
356
  require 'xero-ruby/models/accounting/cis_org_setting'
353
357
  require 'xero-ruby/models/accounting/cis_org_settings'
354
358
  require 'xero-ruby/models/accounting/cis_setting'
@@ -7018,6 +7018,159 @@ module XeroRuby
7018
7018
  return data, status_code, headers
7019
7019
  end
7020
7020
 
7021
+ # Retrieves a specific budgets, which includes budget lines
7022
+ # @param xero_tenant_id [String] Xero identifier for Tenant
7023
+ # @param budget_id [String] Unique identifier for Budgets
7024
+ # @param [Hash] opts the optional parameters
7025
+ # @return [Budgets]
7026
+ def get_budget(xero_tenant_id, budget_id, opts = {})
7027
+ data, _status_code, _headers = get_budget_with_http_info(xero_tenant_id, budget_id, opts)
7028
+ data
7029
+ end
7030
+
7031
+ # Retrieves a specific budgets, which includes budget lines
7032
+ # @param xero_tenant_id [String] Xero identifier for Tenant
7033
+ # @param budget_id [String] Unique identifier for Budgets
7034
+ # @param [Hash] opts the optional parameters
7035
+ # @return [Array<(Budgets, Integer, Hash)>] Budgets data, response status code and response headers
7036
+ def get_budget_with_http_info(xero_tenant_id, budget_id, options = {})
7037
+ opts = options.dup
7038
+ if @api_client.config.debugging
7039
+ @api_client.config.logger.debug 'Calling API: AccountingApi.get_budget ...'
7040
+ end
7041
+ # verify the required parameter 'xero_tenant_id' is set
7042
+ if @api_client.config.client_side_validation && xero_tenant_id.nil?
7043
+ fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_budget"
7044
+ end
7045
+ # verify the required parameter 'budget_id' is set
7046
+ if @api_client.config.client_side_validation && budget_id.nil?
7047
+ fail ArgumentError, "Missing the required parameter 'budget_id' when calling AccountingApi.get_budget"
7048
+ end
7049
+ # resource path
7050
+ local_var_path = '/Budgets/{BudgetID}'.sub('{' + 'BudgetID' + '}', budget_id.to_s)
7051
+
7052
+ # camelize keys of incoming `where` opts
7053
+ opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
7054
+
7055
+ # query parameters
7056
+ query_params = opts[:query_params] || {}
7057
+
7058
+ # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
7059
+ query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
7060
+ query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
7061
+
7062
+ # header parameters
7063
+ header_params = opts[:header_params] || {}
7064
+ # HTTP header 'Accept' (if needed)
7065
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7066
+ header_params[:'xero-tenant-id'] = xero_tenant_id
7067
+
7068
+ # form parameters
7069
+ form_params = opts[:form_params] || {}
7070
+
7071
+ # http body (model)
7072
+ post_body = opts[:body]
7073
+
7074
+ # return_type
7075
+ return_type = opts[:return_type] || 'Budgets'
7076
+
7077
+ # auth_names
7078
+ auth_names = opts[:auth_names] || ['OAuth2']
7079
+
7080
+ new_options = opts.merge(
7081
+ :header_params => header_params,
7082
+ :query_params => query_params,
7083
+ :form_params => form_params,
7084
+ :body => post_body,
7085
+ :auth_names => auth_names,
7086
+ :return_type => return_type
7087
+ )
7088
+
7089
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, "AccountingApi", new_options)
7090
+ if @api_client.config.debugging
7091
+ @api_client.config.logger.debug "API called: AccountingApi#get_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7092
+ end
7093
+ return data, status_code, headers
7094
+ end
7095
+
7096
+ # Retrieve a list of budgets
7097
+ # @param xero_tenant_id [String] Xero identifier for Tenant
7098
+ # @param [Hash] opts the optional parameters
7099
+ # @option opts [Array<String>] :i_ds Filter by BudgetID. Allows you to retrieve a specific individual budget.
7100
+ # @option opts [Date] :date_to Filter by start date
7101
+ # @option opts [Date] :date_from Filter by end date
7102
+ # @return [Budgets]
7103
+ def get_budgets(xero_tenant_id, opts = {})
7104
+ data, _status_code, _headers = get_budgets_with_http_info(xero_tenant_id, opts)
7105
+ data
7106
+ end
7107
+
7108
+ # Retrieve a list of budgets
7109
+ # @param xero_tenant_id [String] Xero identifier for Tenant
7110
+ # @param [Hash] opts the optional parameters
7111
+ # @option opts [Array<String>] :i_ds Filter by BudgetID. Allows you to retrieve a specific individual budget.
7112
+ # @option opts [Date] :date_to Filter by start date
7113
+ # @option opts [Date] :date_from Filter by end date
7114
+ # @return [Array<(Budgets, Integer, Hash)>] Budgets data, response status code and response headers
7115
+ def get_budgets_with_http_info(xero_tenant_id, options = {})
7116
+ opts = options.dup
7117
+ if @api_client.config.debugging
7118
+ @api_client.config.logger.debug 'Calling API: AccountingApi.get_budgets ...'
7119
+ end
7120
+ # verify the required parameter 'xero_tenant_id' is set
7121
+ if @api_client.config.client_side_validation && xero_tenant_id.nil?
7122
+ fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_budgets"
7123
+ end
7124
+ # resource path
7125
+ local_var_path = '/Budgets'
7126
+
7127
+ # camelize keys of incoming `where` opts
7128
+ opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
7129
+
7130
+ # query parameters
7131
+ query_params = opts[:query_params] || {}
7132
+ query_params[:'IDs'] = @api_client.build_collection_param(opts[:'i_ds'], :csv) if !opts[:'i_ds'].nil?
7133
+ query_params[:'DateTo'] = opts[:'date_to'] if !opts[:'date_to'].nil?
7134
+ query_params[:'DateFrom'] = opts[:'date_from'] if !opts[:'date_from'].nil?
7135
+
7136
+ # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
7137
+ query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
7138
+ query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
7139
+
7140
+ # header parameters
7141
+ header_params = opts[:header_params] || {}
7142
+ # HTTP header 'Accept' (if needed)
7143
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7144
+ header_params[:'xero-tenant-id'] = xero_tenant_id
7145
+
7146
+ # form parameters
7147
+ form_params = opts[:form_params] || {}
7148
+
7149
+ # http body (model)
7150
+ post_body = opts[:body]
7151
+
7152
+ # return_type
7153
+ return_type = opts[:return_type] || 'Budgets'
7154
+
7155
+ # auth_names
7156
+ auth_names = opts[:auth_names] || ['OAuth2']
7157
+
7158
+ new_options = opts.merge(
7159
+ :header_params => header_params,
7160
+ :query_params => query_params,
7161
+ :form_params => form_params,
7162
+ :body => post_body,
7163
+ :auth_names => auth_names,
7164
+ :return_type => return_type
7165
+ )
7166
+
7167
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, "AccountingApi", new_options)
7168
+ if @api_client.config.debugging
7169
+ @api_client.config.logger.debug "API called: AccountingApi#get_budgets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7170
+ end
7171
+ return data, status_code, headers
7172
+ end
7173
+
7021
7174
  # Retrieves a specific contacts in a Xero organisation using a unique contact Id
7022
7175
  # @param xero_tenant_id [String] Xero identifier for Tenant
7023
7176
  # @param contact_id [String] Unique identifier for a Contact
@@ -7569,7 +7722,7 @@ module XeroRuby
7569
7722
  return data, status_code, headers
7570
7723
  end
7571
7724
 
7572
- # Retrieves the contact Id and name of all the contacts in a contact group
7725
+ # Retrieves the contact Id and name of each contact group
7573
7726
  # @param xero_tenant_id [String] Xero identifier for Tenant
7574
7727
  # @param [Hash] opts the optional parameters
7575
7728
  # @option opts [String] :where Filter by an any element
@@ -7580,7 +7733,7 @@ module XeroRuby
7580
7733
  data
7581
7734
  end
7582
7735
 
7583
- # Retrieves the contact Id and name of all the contacts in a contact group
7736
+ # Retrieves the contact Id and name of each contact group
7584
7737
  # @param xero_tenant_id [String] Xero identifier for Tenant
7585
7738
  # @param [Hash] opts the optional parameters
7586
7739
  # @option opts [String] :where Filter by an any element
@@ -7728,7 +7881,7 @@ module XeroRuby
7728
7881
  # @option opts [Array<String>] :i_ds Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call.
7729
7882
  # @option opts [Integer] :page e.g. page&#x3D;1 - Up to 100 contacts will be returned in a single API call.
7730
7883
  # @option opts [Boolean] :include_archived e.g. includeArchived&#x3D;true - Contacts with a status of ARCHIVED will be included in the response
7731
- # @option opts [Boolean] :summary_only Use summaryOnly&#x3D;true in GET Contacts endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (default to false)
7884
+ # @option opts [Boolean] :summary_only Use summaryOnly&#x3D;true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (default to false)
7732
7885
  # @return [Contacts]
7733
7886
  def get_contacts(xero_tenant_id, opts = {})
7734
7887
  data, _status_code, _headers = get_contacts_with_http_info(xero_tenant_id, opts)
@@ -7744,7 +7897,7 @@ module XeroRuby
7744
7897
  # @option opts [Array<String>] :i_ds Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call.
7745
7898
  # @option opts [Integer] :page e.g. page&#x3D;1 - Up to 100 contacts will be returned in a single API call.
7746
7899
  # @option opts [Boolean] :include_archived e.g. includeArchived&#x3D;true - Contacts with a status of ARCHIVED will be included in the response
7747
- # @option opts [Boolean] :summary_only Use summaryOnly&#x3D;true in GET Contacts endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.
7900
+ # @option opts [Boolean] :summary_only Use summaryOnly&#x3D;true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.
7748
7901
  # @return [Array<(Contacts, Integer, Hash)>] Contacts data, response status code and response headers
7749
7902
  def get_contacts_with_http_info(xero_tenant_id, options = {})
7750
7903
  opts = options.dup
@@ -9390,6 +9543,7 @@ module XeroRuby
9390
9543
  # @option opts [Boolean] :include_archived e.g. includeArchived&#x3D;true - Invoices with a status of ARCHIVED will be included in the response
9391
9544
  # @option opts [Boolean] :created_by_my_app When set to true you&#39;ll only retrieve Invoices created by your app
9392
9545
  # @option opts [Integer] :unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
9546
+ # @option opts [Boolean] :summary_only Use summaryOnly&#x3D;true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (default to false)
9393
9547
  # @return [Invoices]
9394
9548
  def get_invoices(xero_tenant_id, opts = {})
9395
9549
  data, _status_code, _headers = get_invoices_with_http_info(xero_tenant_id, opts)
@@ -9410,6 +9564,7 @@ module XeroRuby
9410
9564
  # @option opts [Boolean] :include_archived e.g. includeArchived&#x3D;true - Invoices with a status of ARCHIVED will be included in the response
9411
9565
  # @option opts [Boolean] :created_by_my_app When set to true you&#39;ll only retrieve Invoices created by your app
9412
9566
  # @option opts [Integer] :unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
9567
+ # @option opts [Boolean] :summary_only Use summaryOnly&#x3D;true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.
9413
9568
  # @return [Array<(Invoices, Integer, Hash)>] Invoices data, response status code and response headers
9414
9569
  def get_invoices_with_http_info(xero_tenant_id, options = {})
9415
9570
  opts = options.dup
@@ -9438,6 +9593,7 @@ module XeroRuby
9438
9593
  query_params[:'includeArchived'] = opts[:'include_archived'] if !opts[:'include_archived'].nil?
9439
9594
  query_params[:'createdByMyApp'] = opts[:'created_by_my_app'] if !opts[:'created_by_my_app'].nil?
9440
9595
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
9596
+ query_params[:'summaryOnly'] = opts[:'summary_only'] if !opts[:'summary_only'].nil?
9441
9597
 
9442
9598
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
9443
9599
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
@@ -13913,150 +14069,6 @@ module XeroRuby
13913
14069
  return data, status_code, headers
13914
14070
  end
13915
14071
 
13916
- # Retrieves a specific report for BAS using a unique report Id (only valid for AU orgs)
13917
- # @param xero_tenant_id [String] Xero identifier for Tenant
13918
- # @param report_id [String] Unique identifier for a Report
13919
- # @param [Hash] opts the optional parameters
13920
- # @return [ReportWithRows]
13921
- def get_report_ba_sor_gst(xero_tenant_id, report_id, opts = {})
13922
- data, _status_code, _headers = get_report_ba_sor_gst_with_http_info(xero_tenant_id, report_id, opts)
13923
- data
13924
- end
13925
-
13926
- # Retrieves a specific report for BAS using a unique report Id (only valid for AU orgs)
13927
- # @param xero_tenant_id [String] Xero identifier for Tenant
13928
- # @param report_id [String] Unique identifier for a Report
13929
- # @param [Hash] opts the optional parameters
13930
- # @return [Array<(ReportWithRows, Integer, Hash)>] ReportWithRows data, response status code and response headers
13931
- def get_report_ba_sor_gst_with_http_info(xero_tenant_id, report_id, options = {})
13932
- opts = options.dup
13933
- if @api_client.config.debugging
13934
- @api_client.config.logger.debug 'Calling API: AccountingApi.get_report_ba_sor_gst ...'
13935
- end
13936
- # verify the required parameter 'xero_tenant_id' is set
13937
- if @api_client.config.client_side_validation && xero_tenant_id.nil?
13938
- fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_report_ba_sor_gst"
13939
- end
13940
- # verify the required parameter 'report_id' is set
13941
- if @api_client.config.client_side_validation && report_id.nil?
13942
- fail ArgumentError, "Missing the required parameter 'report_id' when calling AccountingApi.get_report_ba_sor_gst"
13943
- end
13944
- # resource path
13945
- local_var_path = '/Reports/{ReportID}'.sub('{' + 'ReportID' + '}', report_id.to_s)
13946
-
13947
- # camelize keys of incoming `where` opts
13948
- opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
13949
-
13950
- # query parameters
13951
- query_params = opts[:query_params] || {}
13952
-
13953
- # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
13954
- query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
13955
- query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
13956
-
13957
- # header parameters
13958
- header_params = opts[:header_params] || {}
13959
- # HTTP header 'Accept' (if needed)
13960
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
13961
- header_params[:'xero-tenant-id'] = xero_tenant_id
13962
-
13963
- # form parameters
13964
- form_params = opts[:form_params] || {}
13965
-
13966
- # http body (model)
13967
- post_body = opts[:body]
13968
-
13969
- # return_type
13970
- return_type = opts[:return_type] || 'ReportWithRows'
13971
-
13972
- # auth_names
13973
- auth_names = opts[:auth_names] || ['OAuth2']
13974
-
13975
- new_options = opts.merge(
13976
- :header_params => header_params,
13977
- :query_params => query_params,
13978
- :form_params => form_params,
13979
- :body => post_body,
13980
- :auth_names => auth_names,
13981
- :return_type => return_type
13982
- )
13983
-
13984
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, "AccountingApi", new_options)
13985
- if @api_client.config.debugging
13986
- @api_client.config.logger.debug "API called: AccountingApi#get_report_ba_sor_gst\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
13987
- end
13988
- return data, status_code, headers
13989
- end
13990
-
13991
- # Retrieves report for BAS (only valid for AU orgs)
13992
- # @param xero_tenant_id [String] Xero identifier for Tenant
13993
- # @param [Hash] opts the optional parameters
13994
- # @return [ReportWithRows]
13995
- def get_report_ba_sor_gst_list(xero_tenant_id, opts = {})
13996
- data, _status_code, _headers = get_report_ba_sor_gst_list_with_http_info(xero_tenant_id, opts)
13997
- data
13998
- end
13999
-
14000
- # Retrieves report for BAS (only valid for AU orgs)
14001
- # @param xero_tenant_id [String] Xero identifier for Tenant
14002
- # @param [Hash] opts the optional parameters
14003
- # @return [Array<(ReportWithRows, Integer, Hash)>] ReportWithRows data, response status code and response headers
14004
- def get_report_ba_sor_gst_list_with_http_info(xero_tenant_id, options = {})
14005
- opts = options.dup
14006
- if @api_client.config.debugging
14007
- @api_client.config.logger.debug 'Calling API: AccountingApi.get_report_ba_sor_gst_list ...'
14008
- end
14009
- # verify the required parameter 'xero_tenant_id' is set
14010
- if @api_client.config.client_side_validation && xero_tenant_id.nil?
14011
- fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_report_ba_sor_gst_list"
14012
- end
14013
- # resource path
14014
- local_var_path = '/Reports'
14015
-
14016
- # camelize keys of incoming `where` opts
14017
- opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
14018
-
14019
- # query parameters
14020
- query_params = opts[:query_params] || {}
14021
-
14022
- # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
14023
- query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
14024
- query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
14025
-
14026
- # header parameters
14027
- header_params = opts[:header_params] || {}
14028
- # HTTP header 'Accept' (if needed)
14029
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
14030
- header_params[:'xero-tenant-id'] = xero_tenant_id
14031
-
14032
- # form parameters
14033
- form_params = opts[:form_params] || {}
14034
-
14035
- # http body (model)
14036
- post_body = opts[:body]
14037
-
14038
- # return_type
14039
- return_type = opts[:return_type] || 'ReportWithRows'
14040
-
14041
- # auth_names
14042
- auth_names = opts[:auth_names] || ['OAuth2']
14043
-
14044
- new_options = opts.merge(
14045
- :header_params => header_params,
14046
- :query_params => query_params,
14047
- :form_params => form_params,
14048
- :body => post_body,
14049
- :auth_names => auth_names,
14050
- :return_type => return_type
14051
- )
14052
-
14053
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, "AccountingApi", new_options)
14054
- if @api_client.config.debugging
14055
- @api_client.config.logger.debug "API called: AccountingApi#get_report_ba_sor_gst_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
14056
- end
14057
- return data, status_code, headers
14058
- end
14059
-
14060
14072
  # Retrieves report for balancesheet
14061
14073
  # @param xero_tenant_id [String] Xero identifier for Tenant
14062
14074
  # @param [Hash] opts the optional parameters
@@ -14230,7 +14242,7 @@ module XeroRuby
14230
14242
  # @param xero_tenant_id [String] Xero identifier for Tenant
14231
14243
  # @param [Hash] opts the optional parameters
14232
14244
  # @option opts [Date] :date The date for the Bank Summary report e.g. 2018-03-31
14233
- # @option opts [Integer] :period The number of periods to compare (integer between 1 and 12)
14245
+ # @option opts [Integer] :periods The number of periods to compare (integer between 1 and 12)
14234
14246
  # @option opts [Integer] :timeframe The period size to compare to (1&#x3D;month, 3&#x3D;quarter, 12&#x3D;year)
14235
14247
  # @return [ReportWithRows]
14236
14248
  def get_report_budget_summary(xero_tenant_id, opts = {})
@@ -14242,7 +14254,7 @@ module XeroRuby
14242
14254
  # @param xero_tenant_id [String] Xero identifier for Tenant
14243
14255
  # @param [Hash] opts the optional parameters
14244
14256
  # @option opts [Date] :date The date for the Bank Summary report e.g. 2018-03-31
14245
- # @option opts [Integer] :period The number of periods to compare (integer between 1 and 12)
14257
+ # @option opts [Integer] :periods The number of periods to compare (integer between 1 and 12)
14246
14258
  # @option opts [Integer] :timeframe The period size to compare to (1&#x3D;month, 3&#x3D;quarter, 12&#x3D;year)
14247
14259
  # @return [Array<(ReportWithRows, Integer, Hash)>] ReportWithRows data, response status code and response headers
14248
14260
  def get_report_budget_summary_with_http_info(xero_tenant_id, options = {})
@@ -14263,7 +14275,7 @@ module XeroRuby
14263
14275
  # query parameters
14264
14276
  query_params = opts[:query_params] || {}
14265
14277
  query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?
14266
- query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
14278
+ query_params[:'periods'] = opts[:'periods'] if !opts[:'periods'].nil?
14267
14279
  query_params[:'timeframe'] = opts[:'timeframe'] if !opts[:'timeframe'].nil?
14268
14280
 
14269
14281
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
@@ -14376,6 +14388,81 @@ module XeroRuby
14376
14388
  return data, status_code, headers
14377
14389
  end
14378
14390
 
14391
+ # Retrieves a specific report using a unique ReportID
14392
+ # @param xero_tenant_id [String] Xero identifier for Tenant
14393
+ # @param report_id [String] Unique identifier for a Report
14394
+ # @param [Hash] opts the optional parameters
14395
+ # @return [ReportWithRows]
14396
+ def get_report_from_id(xero_tenant_id, report_id, opts = {})
14397
+ data, _status_code, _headers = get_report_from_id_with_http_info(xero_tenant_id, report_id, opts)
14398
+ data
14399
+ end
14400
+
14401
+ # Retrieves a specific report using a unique ReportID
14402
+ # @param xero_tenant_id [String] Xero identifier for Tenant
14403
+ # @param report_id [String] Unique identifier for a Report
14404
+ # @param [Hash] opts the optional parameters
14405
+ # @return [Array<(ReportWithRows, Integer, Hash)>] ReportWithRows data, response status code and response headers
14406
+ def get_report_from_id_with_http_info(xero_tenant_id, report_id, options = {})
14407
+ opts = options.dup
14408
+ if @api_client.config.debugging
14409
+ @api_client.config.logger.debug 'Calling API: AccountingApi.get_report_from_id ...'
14410
+ end
14411
+ # verify the required parameter 'xero_tenant_id' is set
14412
+ if @api_client.config.client_side_validation && xero_tenant_id.nil?
14413
+ fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_report_from_id"
14414
+ end
14415
+ # verify the required parameter 'report_id' is set
14416
+ if @api_client.config.client_side_validation && report_id.nil?
14417
+ fail ArgumentError, "Missing the required parameter 'report_id' when calling AccountingApi.get_report_from_id"
14418
+ end
14419
+ # resource path
14420
+ local_var_path = '/Reports/{ReportID}'.sub('{' + 'ReportID' + '}', report_id.to_s)
14421
+
14422
+ # camelize keys of incoming `where` opts
14423
+ opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
14424
+
14425
+ # query parameters
14426
+ query_params = opts[:query_params] || {}
14427
+
14428
+ # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
14429
+ query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
14430
+ query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
14431
+
14432
+ # header parameters
14433
+ header_params = opts[:header_params] || {}
14434
+ # HTTP header 'Accept' (if needed)
14435
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
14436
+ header_params[:'xero-tenant-id'] = xero_tenant_id
14437
+
14438
+ # form parameters
14439
+ form_params = opts[:form_params] || {}
14440
+
14441
+ # http body (model)
14442
+ post_body = opts[:body]
14443
+
14444
+ # return_type
14445
+ return_type = opts[:return_type] || 'ReportWithRows'
14446
+
14447
+ # auth_names
14448
+ auth_names = opts[:auth_names] || ['OAuth2']
14449
+
14450
+ new_options = opts.merge(
14451
+ :header_params => header_params,
14452
+ :query_params => query_params,
14453
+ :form_params => form_params,
14454
+ :body => post_body,
14455
+ :auth_names => auth_names,
14456
+ :return_type => return_type
14457
+ )
14458
+
14459
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, "AccountingApi", new_options)
14460
+ if @api_client.config.debugging
14461
+ @api_client.config.logger.debug "API called: AccountingApi#get_report_from_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
14462
+ end
14463
+ return data, status_code, headers
14464
+ end
14465
+
14379
14466
  # Retrieves report for profit and loss
14380
14467
  # @param xero_tenant_id [String] Xero identifier for Tenant
14381
14468
  # @param [Hash] opts the optional parameters
@@ -14626,6 +14713,75 @@ module XeroRuby
14626
14713
  return data, status_code, headers
14627
14714
  end
14628
14715
 
14716
+ # Retrieves a list of the organistaions unique reports that require a uuid to fetch
14717
+ # @param xero_tenant_id [String] Xero identifier for Tenant
14718
+ # @param [Hash] opts the optional parameters
14719
+ # @return [ReportWithRows]
14720
+ def get_reports_list(xero_tenant_id, opts = {})
14721
+ data, _status_code, _headers = get_reports_list_with_http_info(xero_tenant_id, opts)
14722
+ data
14723
+ end
14724
+
14725
+ # Retrieves a list of the organistaions unique reports that require a uuid to fetch
14726
+ # @param xero_tenant_id [String] Xero identifier for Tenant
14727
+ # @param [Hash] opts the optional parameters
14728
+ # @return [Array<(ReportWithRows, Integer, Hash)>] ReportWithRows data, response status code and response headers
14729
+ def get_reports_list_with_http_info(xero_tenant_id, options = {})
14730
+ opts = options.dup
14731
+ if @api_client.config.debugging
14732
+ @api_client.config.logger.debug 'Calling API: AccountingApi.get_reports_list ...'
14733
+ end
14734
+ # verify the required parameter 'xero_tenant_id' is set
14735
+ if @api_client.config.client_side_validation && xero_tenant_id.nil?
14736
+ fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_reports_list"
14737
+ end
14738
+ # resource path
14739
+ local_var_path = '/Reports'
14740
+
14741
+ # camelize keys of incoming `where` opts
14742
+ opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
14743
+
14744
+ # query parameters
14745
+ query_params = opts[:query_params] || {}
14746
+
14747
+ # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
14748
+ query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
14749
+ query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
14750
+
14751
+ # header parameters
14752
+ header_params = opts[:header_params] || {}
14753
+ # HTTP header 'Accept' (if needed)
14754
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
14755
+ header_params[:'xero-tenant-id'] = xero_tenant_id
14756
+
14757
+ # form parameters
14758
+ form_params = opts[:form_params] || {}
14759
+
14760
+ # http body (model)
14761
+ post_body = opts[:body]
14762
+
14763
+ # return_type
14764
+ return_type = opts[:return_type] || 'ReportWithRows'
14765
+
14766
+ # auth_names
14767
+ auth_names = opts[:auth_names] || ['OAuth2']
14768
+
14769
+ new_options = opts.merge(
14770
+ :header_params => header_params,
14771
+ :query_params => query_params,
14772
+ :form_params => form_params,
14773
+ :body => post_body,
14774
+ :auth_names => auth_names,
14775
+ :return_type => return_type
14776
+ )
14777
+
14778
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, "AccountingApi", new_options)
14779
+ if @api_client.config.debugging
14780
+ @api_client.config.logger.debug "API called: AccountingApi#get_reports_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
14781
+ end
14782
+ return data, status_code, headers
14783
+ end
14784
+
14629
14785
  # Retrieves tax rates
14630
14786
  # @param xero_tenant_id [String] Xero identifier for Tenant
14631
14787
  # @param [Hash] opts the optional parameters