xero-ruby 2.3.0 → 2.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (442) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -0
  3. data/lib/xero-ruby/version.rb +1 -1
  4. metadata +2 -440
  5. data/CODE_OF_CONDUCT.md +0 -76
  6. data/CONTRIBUTING.md +0 -82
  7. data/Gemfile +0 -9
  8. data/LICENSE +0 -21
  9. data/Rakefile +0 -10
  10. data/build_notes.md +0 -52
  11. data/docs/accounting/Account.md +0 -55
  12. data/docs/accounting/AccountType.md +0 -16
  13. data/docs/accounting/AccountingApi.md +0 -15245
  14. data/docs/accounting/Accounts.md +0 -17
  15. data/docs/accounting/AccountsPayable.md +0 -19
  16. data/docs/accounting/AccountsReceivable.md +0 -19
  17. data/docs/accounting/Action.md +0 -19
  18. data/docs/accounting/Actions.md +0 -17
  19. data/docs/accounting/Address.md +0 -35
  20. data/docs/accounting/Allocation.md +0 -31
  21. data/docs/accounting/Allocations.md +0 -17
  22. data/docs/accounting/Attachment.md +0 -27
  23. data/docs/accounting/Attachments.md +0 -17
  24. data/docs/accounting/Balances.md +0 -19
  25. data/docs/accounting/BankTransaction.md +0 -59
  26. data/docs/accounting/BankTransactions.md +0 -17
  27. data/docs/accounting/BankTransfer.md +0 -37
  28. data/docs/accounting/BankTransfers.md +0 -17
  29. data/docs/accounting/BatchPayment.md +0 -47
  30. data/docs/accounting/BatchPaymentDetails.md +0 -25
  31. data/docs/accounting/BatchPayments.md +0 -17
  32. data/docs/accounting/Bill.md +0 -19
  33. data/docs/accounting/BrandingTheme.md +0 -27
  34. data/docs/accounting/BrandingThemes.md +0 -17
  35. data/docs/accounting/CISOrgSetting.md +0 -21
  36. data/docs/accounting/CISSetting.md +0 -19
  37. data/docs/accounting/CISSettings.md +0 -17
  38. data/docs/accounting/Contact.md +0 -93
  39. data/docs/accounting/ContactGroup.md +0 -23
  40. data/docs/accounting/ContactGroups.md +0 -17
  41. data/docs/accounting/ContactPerson.md +0 -23
  42. data/docs/accounting/Contacts.md +0 -17
  43. data/docs/accounting/CountryCode.md +0 -16
  44. data/docs/accounting/CreditNote.md +0 -67
  45. data/docs/accounting/CreditNotes.md +0 -17
  46. data/docs/accounting/Currencies.md +0 -17
  47. data/docs/accounting/Currency.md +0 -19
  48. data/docs/accounting/CurrencyCode.md +0 -16
  49. data/docs/accounting/Element.md +0 -31
  50. data/docs/accounting/Employee.md +0 -31
  51. data/docs/accounting/Employees.md +0 -17
  52. data/docs/accounting/Error.md +0 -23
  53. data/docs/accounting/ExpenseClaim.md +0 -39
  54. data/docs/accounting/ExpenseClaims.md +0 -17
  55. data/docs/accounting/ExternalLink.md +0 -21
  56. data/docs/accounting/HistoryRecord.md +0 -23
  57. data/docs/accounting/HistoryRecords.md +0 -17
  58. data/docs/accounting/Invoice.md +0 -93
  59. data/docs/accounting/InvoiceReminder.md +0 -17
  60. data/docs/accounting/InvoiceReminders.md +0 -17
  61. data/docs/accounting/Invoices.md +0 -17
  62. data/docs/accounting/Item.md +0 -47
  63. data/docs/accounting/Items.md +0 -17
  64. data/docs/accounting/Journal.md +0 -31
  65. data/docs/accounting/JournalLine.md +0 -39
  66. data/docs/accounting/Journals.md +0 -17
  67. data/docs/accounting/LineAmountTypes.md +0 -16
  68. data/docs/accounting/LineItem.md +0 -41
  69. data/docs/accounting/LineItemTracking.md +0 -23
  70. data/docs/accounting/LinkedTransaction.md +0 -37
  71. data/docs/accounting/LinkedTransactions.md +0 -17
  72. data/docs/accounting/ManualJournal.md +0 -43
  73. data/docs/accounting/ManualJournalLine.md +0 -31
  74. data/docs/accounting/ManualJournals.md +0 -17
  75. data/docs/accounting/OnlineInvoice.md +0 -17
  76. data/docs/accounting/OnlineInvoices.md +0 -17
  77. data/docs/accounting/Organisation.md +0 -81
  78. data/docs/accounting/Organisations.md +0 -17
  79. data/docs/accounting/Overpayment.md +0 -53
  80. data/docs/accounting/Overpayments.md +0 -17
  81. data/docs/accounting/Payment.md +0 -63
  82. data/docs/accounting/PaymentDelete.md +0 -17
  83. data/docs/accounting/PaymentService.md +0 -27
  84. data/docs/accounting/PaymentServices.md +0 -17
  85. data/docs/accounting/PaymentTerm.md +0 -19
  86. data/docs/accounting/PaymentTermType.md +0 -16
  87. data/docs/accounting/Payments.md +0 -17
  88. data/docs/accounting/Phone.md +0 -23
  89. data/docs/accounting/Prepayment.md +0 -53
  90. data/docs/accounting/Prepayments.md +0 -17
  91. data/docs/accounting/Purchase.md +0 -23
  92. data/docs/accounting/PurchaseOrder.md +0 -71
  93. data/docs/accounting/PurchaseOrders.md +0 -17
  94. data/docs/accounting/Quote.md +0 -63
  95. data/docs/accounting/QuoteLineAmountTypes.md +0 -16
  96. data/docs/accounting/QuoteStatusCodes.md +0 -16
  97. data/docs/accounting/Quotes.md +0 -17
  98. data/docs/accounting/Receipt.md +0 -51
  99. data/docs/accounting/Receipts.md +0 -17
  100. data/docs/accounting/RepeatingInvoice.md +0 -47
  101. data/docs/accounting/RepeatingInvoices.md +0 -17
  102. data/docs/accounting/Report.md +0 -29
  103. data/docs/accounting/ReportAttribute.md +0 -19
  104. data/docs/accounting/ReportCell.md +0 -19
  105. data/docs/accounting/ReportFields.md +0 -21
  106. data/docs/accounting/ReportRow.md +0 -21
  107. data/docs/accounting/ReportRows.md +0 -23
  108. data/docs/accounting/ReportWithRow.md +0 -33
  109. data/docs/accounting/ReportWithRows.md +0 -17
  110. data/docs/accounting/Reports.md +0 -17
  111. data/docs/accounting/RequestEmpty.md +0 -17
  112. data/docs/accounting/RowType.md +0 -16
  113. data/docs/accounting/SalesTrackingCategory.md +0 -19
  114. data/docs/accounting/Schedule.md +0 -29
  115. data/docs/accounting/TaxComponent.md +0 -23
  116. data/docs/accounting/TaxRate.md +0 -39
  117. data/docs/accounting/TaxRates.md +0 -17
  118. data/docs/accounting/TaxType.md +0 -16
  119. data/docs/accounting/TenNinetyNineContact.md +0 -59
  120. data/docs/accounting/TimeZone.md +0 -16
  121. data/docs/accounting/TrackingCategories.md +0 -17
  122. data/docs/accounting/TrackingCategory.md +0 -27
  123. data/docs/accounting/TrackingOption.md +0 -23
  124. data/docs/accounting/TrackingOptions.md +0 -17
  125. data/docs/accounting/User.md +0 -29
  126. data/docs/accounting/Users.md +0 -17
  127. data/docs/accounting/ValidationError.md +0 -17
  128. data/docs/assets/Asset.md +0 -45
  129. data/docs/assets/AssetApi.md +0 -426
  130. data/docs/assets/AssetStatus.md +0 -16
  131. data/docs/assets/AssetStatusQueryParam.md +0 -16
  132. data/docs/assets/AssetType.md +0 -29
  133. data/docs/assets/Assets.md +0 -19
  134. data/docs/assets/BookDepreciationDetail.md +0 -29
  135. data/docs/assets/BookDepreciationSetting.md +0 -31
  136. data/docs/assets/Error.md +0 -25
  137. data/docs/assets/FieldValidationErrorsElement.md +0 -27
  138. data/docs/assets/Pagination.md +0 -23
  139. data/docs/assets/ResourceValidationErrorsElement.md +0 -25
  140. data/docs/assets/Setting.md +0 -31
  141. data/docs/files/Association.md +0 -23
  142. data/docs/files/FileObject.md +0 -31
  143. data/docs/files/FileResponse204.md +0 -17
  144. data/docs/files/Files.md +0 -23
  145. data/docs/files/FilesApi.md +0 -1116
  146. data/docs/files/Folder.md +0 -25
  147. data/docs/files/Folders.md +0 -17
  148. data/docs/files/InlineObject.md +0 -23
  149. data/docs/files/ObjectGroup.md +0 -16
  150. data/docs/files/ObjectType.md +0 -16
  151. data/docs/files/User.md +0 -29
  152. data/docs/payroll_au/APIException.md +0 -21
  153. data/docs/payroll_au/Account.md +0 -23
  154. data/docs/payroll_au/AccountType.md +0 -16
  155. data/docs/payroll_au/AllowanceType.md +0 -16
  156. data/docs/payroll_au/BankAccount.md +0 -27
  157. data/docs/payroll_au/CalendarType.md +0 -16
  158. data/docs/payroll_au/DeductionLine.md +0 -25
  159. data/docs/payroll_au/DeductionType.md +0 -33
  160. data/docs/payroll_au/DeductionTypeCalculationType.md +0 -16
  161. data/docs/payroll_au/EarningsLine.md +0 -33
  162. data/docs/payroll_au/EarningsRate.md +0 -49
  163. data/docs/payroll_au/EarningsRateCalculationType.md +0 -16
  164. data/docs/payroll_au/EarningsType.md +0 -16
  165. data/docs/payroll_au/Employee.md +0 -77
  166. data/docs/payroll_au/EmployeeStatus.md +0 -16
  167. data/docs/payroll_au/Employees.md +0 -17
  168. data/docs/payroll_au/EmploymentBasis.md +0 -16
  169. data/docs/payroll_au/EmploymentTerminationPaymentType.md +0 -16
  170. data/docs/payroll_au/EntitlementFinalPayPayoutType.md +0 -16
  171. data/docs/payroll_au/HomeAddress.md +0 -27
  172. data/docs/payroll_au/LeaveAccrualLine.md +0 -21
  173. data/docs/payroll_au/LeaveApplication.md +0 -35
  174. data/docs/payroll_au/LeaveApplications.md +0 -17
  175. data/docs/payroll_au/LeaveBalance.md +0 -23
  176. data/docs/payroll_au/LeaveEarningsLine.md +0 -21
  177. data/docs/payroll_au/LeaveLine.md +0 -31
  178. data/docs/payroll_au/LeaveLineCalculationType.md +0 -16
  179. data/docs/payroll_au/LeaveLines.md +0 -17
  180. data/docs/payroll_au/LeavePeriod.md +0 -23
  181. data/docs/payroll_au/LeavePeriodStatus.md +0 -16
  182. data/docs/payroll_au/LeaveType.md +0 -33
  183. data/docs/payroll_au/LeaveTypeContributionType.md +0 -16
  184. data/docs/payroll_au/ManualTaxType.md +0 -16
  185. data/docs/payroll_au/OpeningBalances.md +0 -29
  186. data/docs/payroll_au/PayItem.md +0 -23
  187. data/docs/payroll_au/PayItems.md +0 -17
  188. data/docs/payroll_au/PayRun.md +0 -47
  189. data/docs/payroll_au/PayRunStatus.md +0 -16
  190. data/docs/payroll_au/PayRuns.md +0 -17
  191. data/docs/payroll_au/PayTemplate.md +0 -25
  192. data/docs/payroll_au/PaymentFrequencyType.md +0 -16
  193. data/docs/payroll_au/PayrollAuApi.md +0 -2018
  194. data/docs/payroll_au/PayrollCalendar.md +0 -29
  195. data/docs/payroll_au/PayrollCalendars.md +0 -17
  196. data/docs/payroll_au/Payslip.md +0 -53
  197. data/docs/payroll_au/PayslipLines.md +0 -31
  198. data/docs/payroll_au/PayslipObject.md +0 -17
  199. data/docs/payroll_au/PayslipSummary.md +0 -39
  200. data/docs/payroll_au/Payslips.md +0 -17
  201. data/docs/payroll_au/RateType.md +0 -16
  202. data/docs/payroll_au/ReimbursementLine.md +0 -23
  203. data/docs/payroll_au/ReimbursementLines.md +0 -17
  204. data/docs/payroll_au/ReimbursementType.md +0 -25
  205. data/docs/payroll_au/ResidencyStatus.md +0 -16
  206. data/docs/payroll_au/Settings.md +0 -21
  207. data/docs/payroll_au/SettingsObject.md +0 -17
  208. data/docs/payroll_au/SettingsTrackingCategories.md +0 -19
  209. data/docs/payroll_au/SettingsTrackingCategoriesEmployeeGroups.md +0 -19
  210. data/docs/payroll_au/SettingsTrackingCategoriesTimesheetCategories.md +0 -19
  211. data/docs/payroll_au/State.md +0 -16
  212. data/docs/payroll_au/SuperFund.md +0 -41
  213. data/docs/payroll_au/SuperFundProduct.md +0 -23
  214. data/docs/payroll_au/SuperFundProducts.md +0 -17
  215. data/docs/payroll_au/SuperFundType.md +0 -16
  216. data/docs/payroll_au/SuperFunds.md +0 -17
  217. data/docs/payroll_au/SuperLine.md +0 -31
  218. data/docs/payroll_au/SuperMembership.md +0 -21
  219. data/docs/payroll_au/SuperannuationCalculationType.md +0 -16
  220. data/docs/payroll_au/SuperannuationContributionType.md +0 -16
  221. data/docs/payroll_au/SuperannuationLine.md +0 -33
  222. data/docs/payroll_au/TFNExemptionType.md +0 -16
  223. data/docs/payroll_au/TaxDeclaration.md +0 -47
  224. data/docs/payroll_au/TaxLine.md +0 -27
  225. data/docs/payroll_au/Timesheet.md +0 -33
  226. data/docs/payroll_au/TimesheetLine.md +0 -23
  227. data/docs/payroll_au/TimesheetObject.md +0 -17
  228. data/docs/payroll_au/TimesheetStatus.md +0 -16
  229. data/docs/payroll_au/Timesheets.md +0 -17
  230. data/docs/payroll_au/ValidationError.md +0 -17
  231. data/docs/payroll_nz/Account.md +0 -23
  232. data/docs/payroll_nz/Accounts.md +0 -17
  233. data/docs/payroll_nz/Address.md +0 -27
  234. data/docs/payroll_nz/BankAccount.md +0 -31
  235. data/docs/payroll_nz/Benefit.md +0 -35
  236. data/docs/payroll_nz/Deduction.md +0 -27
  237. data/docs/payroll_nz/DeductionLine.md +0 -25
  238. data/docs/payroll_nz/DeductionObject.md +0 -21
  239. data/docs/payroll_nz/Deductions.md +0 -21
  240. data/docs/payroll_nz/EarningsLine.md +0 -35
  241. data/docs/payroll_nz/EarningsOrder.md +0 -25
  242. data/docs/payroll_nz/EarningsOrderObject.md +0 -21
  243. data/docs/payroll_nz/EarningsOrders.md +0 -21
  244. data/docs/payroll_nz/EarningsRate.md +0 -35
  245. data/docs/payroll_nz/EarningsRateObject.md +0 -21
  246. data/docs/payroll_nz/EarningsRates.md +0 -21
  247. data/docs/payroll_nz/EarningsTemplate.md +0 -27
  248. data/docs/payroll_nz/EarningsTemplateObject.md +0 -21
  249. data/docs/payroll_nz/Employee.md +0 -43
  250. data/docs/payroll_nz/EmployeeEarningsTemplates.md +0 -21
  251. data/docs/payroll_nz/EmployeeLeave.md +0 -29
  252. data/docs/payroll_nz/EmployeeLeaveBalance.md +0 -23
  253. data/docs/payroll_nz/EmployeeLeaveBalances.md +0 -21
  254. data/docs/payroll_nz/EmployeeLeaveObject.md +0 -21
  255. data/docs/payroll_nz/EmployeeLeaveSetup.md +0 -29
  256. data/docs/payroll_nz/EmployeeLeaveSetupObject.md +0 -21
  257. data/docs/payroll_nz/EmployeeLeaveType.md +0 -35
  258. data/docs/payroll_nz/EmployeeLeaveTypeObject.md +0 -21
  259. data/docs/payroll_nz/EmployeeLeaveTypes.md +0 -21
  260. data/docs/payroll_nz/EmployeeLeaves.md +0 -21
  261. data/docs/payroll_nz/EmployeeObject.md +0 -21
  262. data/docs/payroll_nz/EmployeeOpeningBalance.md +0 -23
  263. data/docs/payroll_nz/EmployeeOpeningBalancesObject.md +0 -21
  264. data/docs/payroll_nz/EmployeePayTemplate.md +0 -19
  265. data/docs/payroll_nz/EmployeePayTemplateObject.md +0 -21
  266. data/docs/payroll_nz/EmployeePayTemplates.md +0 -21
  267. data/docs/payroll_nz/EmployeeStatutoryLeaveBalance.md +0 -21
  268. data/docs/payroll_nz/EmployeeStatutoryLeaveBalanceObject.md +0 -21
  269. data/docs/payroll_nz/EmployeeStatutoryLeaveSummary.md +0 -29
  270. data/docs/payroll_nz/EmployeeStatutoryLeavesSummaries.md +0 -21
  271. data/docs/payroll_nz/EmployeeStatutorySickLeave.md +0 -47
  272. data/docs/payroll_nz/EmployeeStatutorySickLeaveObject.md +0 -21
  273. data/docs/payroll_nz/EmployeeStatutorySickLeaves.md +0 -21
  274. data/docs/payroll_nz/EmployeeTax.md +0 -47
  275. data/docs/payroll_nz/EmployeeTaxObject.md +0 -21
  276. data/docs/payroll_nz/Employees.md +0 -21
  277. data/docs/payroll_nz/Employment.md +0 -21
  278. data/docs/payroll_nz/EmploymentObject.md +0 -21
  279. data/docs/payroll_nz/GrossEarningsHistory.md +0 -19
  280. data/docs/payroll_nz/InvalidField.md +0 -19
  281. data/docs/payroll_nz/LeaveAccrualLine.md +0 -19
  282. data/docs/payroll_nz/LeaveEarningsLine.md +0 -35
  283. data/docs/payroll_nz/LeavePeriod.md +0 -23
  284. data/docs/payroll_nz/LeavePeriods.md +0 -21
  285. data/docs/payroll_nz/LeaveType.md +0 -27
  286. data/docs/payroll_nz/LeaveTypeObject.md +0 -21
  287. data/docs/payroll_nz/LeaveTypes.md +0 -21
  288. data/docs/payroll_nz/Pagination.md +0 -23
  289. data/docs/payroll_nz/PayRun.md +0 -39
  290. data/docs/payroll_nz/PayRunCalendar.md +0 -29
  291. data/docs/payroll_nz/PayRunCalendarObject.md +0 -21
  292. data/docs/payroll_nz/PayRunCalendars.md +0 -21
  293. data/docs/payroll_nz/PayRunObject.md +0 -21
  294. data/docs/payroll_nz/PayRuns.md +0 -21
  295. data/docs/payroll_nz/PaySlip.md +0 -75
  296. data/docs/payroll_nz/PaySlipObject.md +0 -21
  297. data/docs/payroll_nz/PaySlips.md +0 -21
  298. data/docs/payroll_nz/PaymentLine.md +0 -25
  299. data/docs/payroll_nz/PaymentMethod.md +0 -19
  300. data/docs/payroll_nz/PaymentMethodObject.md +0 -21
  301. data/docs/payroll_nz/PayrollNzApi.md +0 -4544
  302. data/docs/payroll_nz/Problem.md +0 -27
  303. data/docs/payroll_nz/Reimbursement.md +0 -33
  304. data/docs/payroll_nz/ReimbursementLine.md +0 -25
  305. data/docs/payroll_nz/ReimbursementObject.md +0 -21
  306. data/docs/payroll_nz/Reimbursements.md +0 -21
  307. data/docs/payroll_nz/SalaryAndWage.md +0 -35
  308. data/docs/payroll_nz/SalaryAndWageObject.md +0 -21
  309. data/docs/payroll_nz/SalaryAndWages.md +0 -21
  310. data/docs/payroll_nz/Settings.md +0 -21
  311. data/docs/payroll_nz/StatutoryDeduction.md +0 -25
  312. data/docs/payroll_nz/StatutoryDeductionCategory.md +0 -16
  313. data/docs/payroll_nz/StatutoryDeductionLine.md +0 -23
  314. data/docs/payroll_nz/StatutoryDeductionObject.md +0 -21
  315. data/docs/payroll_nz/StatutoryDeductions.md +0 -21
  316. data/docs/payroll_nz/SuperannuationLine.md +0 -27
  317. data/docs/payroll_nz/SuperannuationObject.md +0 -21
  318. data/docs/payroll_nz/Superannuations.md +0 -21
  319. data/docs/payroll_nz/TaxCode.md +0 -16
  320. data/docs/payroll_nz/TaxLine.md +0 -25
  321. data/docs/payroll_nz/TaxSettings.md +0 -27
  322. data/docs/payroll_nz/Timesheet.md +0 -33
  323. data/docs/payroll_nz/TimesheetEarningsLine.md +0 -35
  324. data/docs/payroll_nz/TimesheetLine.md +0 -25
  325. data/docs/payroll_nz/TimesheetLineObject.md +0 -21
  326. data/docs/payroll_nz/TimesheetObject.md +0 -21
  327. data/docs/payroll_nz/Timesheets.md +0 -21
  328. data/docs/payroll_nz/TrackingCategories.md +0 -21
  329. data/docs/payroll_nz/TrackingCategory.md +0 -19
  330. data/docs/payroll_uk/Account.md +0 -23
  331. data/docs/payroll_uk/Accounts.md +0 -17
  332. data/docs/payroll_uk/Address.md +0 -25
  333. data/docs/payroll_uk/BankAccount.md +0 -21
  334. data/docs/payroll_uk/Benefit.md +0 -43
  335. data/docs/payroll_uk/BenefitLine.md +0 -25
  336. data/docs/payroll_uk/BenefitObject.md +0 -21
  337. data/docs/payroll_uk/Benefits.md +0 -21
  338. data/docs/payroll_uk/CourtOrderLine.md +0 -19
  339. data/docs/payroll_uk/Deduction.md +0 -47
  340. data/docs/payroll_uk/DeductionLine.md +0 -23
  341. data/docs/payroll_uk/DeductionObject.md +0 -21
  342. data/docs/payroll_uk/Deductions.md +0 -21
  343. data/docs/payroll_uk/EarningsLine.md +0 -33
  344. data/docs/payroll_uk/EarningsOrder.md +0 -25
  345. data/docs/payroll_uk/EarningsOrderObject.md +0 -21
  346. data/docs/payroll_uk/EarningsOrders.md +0 -21
  347. data/docs/payroll_uk/EarningsRate.md +0 -35
  348. data/docs/payroll_uk/EarningsRateObject.md +0 -21
  349. data/docs/payroll_uk/EarningsRates.md +0 -21
  350. data/docs/payroll_uk/EarningsTemplate.md +0 -27
  351. data/docs/payroll_uk/EarningsTemplateObject.md +0 -21
  352. data/docs/payroll_uk/Employee.md +0 -45
  353. data/docs/payroll_uk/EmployeeLeave.md +0 -29
  354. data/docs/payroll_uk/EmployeeLeaveBalance.md +0 -23
  355. data/docs/payroll_uk/EmployeeLeaveBalances.md +0 -21
  356. data/docs/payroll_uk/EmployeeLeaveObject.md +0 -21
  357. data/docs/payroll_uk/EmployeeLeaveType.md +0 -27
  358. data/docs/payroll_uk/EmployeeLeaveTypeObject.md +0 -21
  359. data/docs/payroll_uk/EmployeeLeaveTypes.md +0 -21
  360. data/docs/payroll_uk/EmployeeLeaves.md +0 -21
  361. data/docs/payroll_uk/EmployeeObject.md +0 -21
  362. data/docs/payroll_uk/EmployeeOpeningBalances.md +0 -27
  363. data/docs/payroll_uk/EmployeeOpeningBalancesObject.md +0 -21
  364. data/docs/payroll_uk/EmployeePayTemplate.md +0 -19
  365. data/docs/payroll_uk/EmployeePayTemplateObject.md +0 -21
  366. data/docs/payroll_uk/EmployeePayTemplates.md +0 -21
  367. data/docs/payroll_uk/EmployeeStatutoryLeaveBalance.md +0 -21
  368. data/docs/payroll_uk/EmployeeStatutoryLeaveBalanceObject.md +0 -21
  369. data/docs/payroll_uk/EmployeeStatutoryLeaveSummary.md +0 -29
  370. data/docs/payroll_uk/EmployeeStatutoryLeavesSummaries.md +0 -21
  371. data/docs/payroll_uk/EmployeeStatutorySickLeave.md +0 -47
  372. data/docs/payroll_uk/EmployeeStatutorySickLeaveObject.md +0 -21
  373. data/docs/payroll_uk/EmployeeStatutorySickLeaves.md +0 -21
  374. data/docs/payroll_uk/EmployeeTax.md +0 -37
  375. data/docs/payroll_uk/EmployeeTaxObject.md +0 -21
  376. data/docs/payroll_uk/Employees.md +0 -21
  377. data/docs/payroll_uk/Employment.md +0 -23
  378. data/docs/payroll_uk/EmploymentObject.md +0 -21
  379. data/docs/payroll_uk/InvalidField.md +0 -19
  380. data/docs/payroll_uk/LeaveAccrualLine.md +0 -19
  381. data/docs/payroll_uk/LeaveEarningsLine.md +0 -27
  382. data/docs/payroll_uk/LeavePeriod.md +0 -23
  383. data/docs/payroll_uk/LeavePeriods.md +0 -21
  384. data/docs/payroll_uk/LeaveType.md +0 -31
  385. data/docs/payroll_uk/LeaveTypeObject.md +0 -21
  386. data/docs/payroll_uk/LeaveTypes.md +0 -21
  387. data/docs/payroll_uk/Pagination.md +0 -23
  388. data/docs/payroll_uk/PayRun.md +0 -39
  389. data/docs/payroll_uk/PayRunCalendar.md +0 -29
  390. data/docs/payroll_uk/PayRunCalendarObject.md +0 -21
  391. data/docs/payroll_uk/PayRunCalendars.md +0 -21
  392. data/docs/payroll_uk/PayRunObject.md +0 -21
  393. data/docs/payroll_uk/PayRuns.md +0 -21
  394. data/docs/payroll_uk/PaymentLine.md +0 -25
  395. data/docs/payroll_uk/PaymentMethod.md +0 -19
  396. data/docs/payroll_uk/PaymentMethodObject.md +0 -21
  397. data/docs/payroll_uk/PayrollUkApi.md +0 -4683
  398. data/docs/payroll_uk/Payslip.md +0 -69
  399. data/docs/payroll_uk/PayslipObject.md +0 -21
  400. data/docs/payroll_uk/Payslips.md +0 -21
  401. data/docs/payroll_uk/Problem.md +0 -27
  402. data/docs/payroll_uk/Reimbursement.md +0 -23
  403. data/docs/payroll_uk/ReimbursementLine.md +0 -21
  404. data/docs/payroll_uk/ReimbursementObject.md +0 -21
  405. data/docs/payroll_uk/Reimbursements.md +0 -21
  406. data/docs/payroll_uk/SalaryAndWage.md +0 -33
  407. data/docs/payroll_uk/SalaryAndWageObject.md +0 -21
  408. data/docs/payroll_uk/SalaryAndWages.md +0 -21
  409. data/docs/payroll_uk/Settings.md +0 -21
  410. data/docs/payroll_uk/StatutoryDeduction.md +0 -25
  411. data/docs/payroll_uk/StatutoryDeductionCategory.md +0 -16
  412. data/docs/payroll_uk/TaxLine.md +0 -27
  413. data/docs/payroll_uk/Timesheet.md +0 -33
  414. data/docs/payroll_uk/TimesheetEarningsLine.md +0 -27
  415. data/docs/payroll_uk/TimesheetLine.md +0 -25
  416. data/docs/payroll_uk/TimesheetLineObject.md +0 -21
  417. data/docs/payroll_uk/TimesheetObject.md +0 -21
  418. data/docs/payroll_uk/Timesheets.md +0 -21
  419. data/docs/payroll_uk/TrackingCategories.md +0 -21
  420. data/docs/payroll_uk/TrackingCategory.md +0 -19
  421. data/docs/projects/Amount.md +0 -19
  422. data/docs/projects/ChargeType.md +0 -16
  423. data/docs/projects/CurrencyCode.md +0 -16
  424. data/docs/projects/Error.md +0 -19
  425. data/docs/projects/Pagination.md +0 -23
  426. data/docs/projects/Project.md +0 -59
  427. data/docs/projects/ProjectApi.md +0 -953
  428. data/docs/projects/ProjectCreateOrUpdate.md +0 -23
  429. data/docs/projects/ProjectPatch.md +0 -17
  430. data/docs/projects/ProjectStatus.md +0 -16
  431. data/docs/projects/ProjectUser.md +0 -21
  432. data/docs/projects/ProjectUsers.md +0 -19
  433. data/docs/projects/Projects.md +0 -19
  434. data/docs/projects/Task.md +0 -45
  435. data/docs/projects/TaskCreateOrUpdate.md +0 -23
  436. data/docs/projects/Tasks.md +0 -19
  437. data/docs/projects/TimeEntries.md +0 -19
  438. data/docs/projects/TimeEntry.md +0 -33
  439. data/docs/projects/TimeEntryCreateOrUpdate.md +0 -25
  440. data/git_push.sh +0 -55
  441. data/xero-ruby.gem +0 -0
  442. data/xero-ruby.gemspec +0 -38
@@ -1,16 +0,0 @@
1
- # XeroRuby::Assets::AssetStatus
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
-
8
- ## Code Sample
9
-
10
- ```ruby
11
- require 'XeroRuby::Assets'
12
-
13
- instance = XeroRuby::Assets::AssetStatus.new()
14
- ```
15
-
16
-
@@ -1,16 +0,0 @@
1
- # XeroRuby::Assets::AssetStatusQueryParam
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
-
8
- ## Code Sample
9
-
10
- ```ruby
11
- require 'XeroRuby::Assets'
12
-
13
- instance = XeroRuby::Assets::AssetStatusQueryParam.new()
14
- ```
15
-
16
-
@@ -1,29 +0,0 @@
1
- # XeroRuby::Assets::AssetType
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **asset_type_id** | **String** | Xero generated unique identifier for asset types | [optional]
8
- **asset_type_name** | **String** | The name of the asset type |
9
- **fixed_asset_account_id** | **String** | The asset account for fixed assets of this type | [optional]
10
- **depreciation_expense_account_id** | **String** | The expense account for the depreciation of fixed assets of this type | [optional]
11
- **accumulated_depreciation_account_id** | **String** | The account for accumulated depreciation of fixed assets of this type | [optional]
12
- **book_depreciation_setting** | [**BookDepreciationSetting**](BookDepreciationSetting.md) | |
13
- **locks** | **Integer** | All asset types that have accumulated depreciation for any assets that use them are deemed ‘locked’ and cannot be removed. | [optional]
14
-
15
- ## Code Sample
16
-
17
- ```ruby
18
- require 'XeroRuby::Assets'
19
-
20
- instance = XeroRuby::Assets::AssetType.new(asset_type_id: 5da209c5-5e19-4a43-b925-71b776c49ced,
21
- asset_type_name: Computer Equipment,
22
- fixed_asset_account_id: 24e260f1-bfc4-4766-ad7f-8a8ce01de879,
23
- depreciation_expense_account_id: b23fc79b-d66b-44b0-a240-e138e086fcbc,
24
- accumulated_depreciation_account_id: ca4c6b39-4f4f-43e8-98da-5e1f350a6694,
25
- book_depreciation_setting: null,
26
- locks: 33)
27
- ```
28
-
29
-
@@ -1,19 +0,0 @@
1
- # XeroRuby::Assets::Assets
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **pagination** | [**Pagination**](Pagination.md) | | [optional]
8
- **items** | [**Array<Asset>**](Asset.md) | | [optional]
9
-
10
- ## Code Sample
11
-
12
- ```ruby
13
- require 'XeroRuby::Assets'
14
-
15
- instance = XeroRuby::Assets::Assets.new(pagination: null,
16
- items: null)
17
- ```
18
-
19
-
@@ -1,29 +0,0 @@
1
- # XeroRuby::Assets::BookDepreciationDetail
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **current_capital_gain** | **BigDecimal** | When an asset is disposed, this will be the sell price minus the purchase price if a profit was made. | [optional]
8
- **current_gain_loss** | **BigDecimal** | When an asset is disposed, this will be the lowest one of sell price or purchase price, minus the current book value. | [optional]
9
- **depreciation_start_date** | **Date** | YYYY-MM-DD | [optional]
10
- **cost_limit** | **BigDecimal** | The value of the asset you want to depreciate, if this is less than the cost of the asset. | [optional]
11
- **residual_value** | **BigDecimal** | The value of the asset remaining when you've fully depreciated it. | [optional]
12
- **prior_accum_depreciation_amount** | **BigDecimal** | All depreciation prior to the current financial year. | [optional]
13
- **current_accum_depreciation_amount** | **BigDecimal** | All depreciation occurring in the current financial year. | [optional]
14
-
15
- ## Code Sample
16
-
17
- ```ruby
18
- require 'XeroRuby::Assets'
19
-
20
- instance = XeroRuby::Assets::BookDepreciationDetail.new(current_capital_gain: 5.25,
21
- current_gain_loss: 10.5,
22
- depreciation_start_date: null,
23
- cost_limit: 9000.0,
24
- residual_value: 10000.0,
25
- prior_accum_depreciation_amount: 0.45,
26
- current_accum_depreciation_amount: 5.0)
27
- ```
28
-
29
-
@@ -1,31 +0,0 @@
1
- # XeroRuby::Assets::BookDepreciationSetting
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **depreciation_method** | **String** | The method of depreciation applied to this asset. See Depreciation Methods | [optional]
8
- **averaging_method** | **String** | The method of averaging applied to this asset. See Averaging Methods | [optional]
9
- **depreciation_rate** | **BigDecimal** | The rate of depreciation (e.g. 0.05) | [optional]
10
- **effective_life_years** | **Integer** | Effective life of the asset in years (e.g. 5) | [optional]
11
- **depreciation_calculation_method** | **String** | See Depreciation Calculation Methods | [optional]
12
- **depreciable_object_id** | **String** | Unique Xero identifier for the depreciable object | [optional]
13
- **depreciable_object_type** | **String** | The type of asset object | [optional]
14
- **book_effective_date_of_change_id** | **String** | Unique Xero identifier for the effective date change | [optional]
15
-
16
- ## Code Sample
17
-
18
- ```ruby
19
- require 'XeroRuby::Assets'
20
-
21
- instance = XeroRuby::Assets::BookDepreciationSetting.new(depreciation_method: StraightLine,
22
- averaging_method: ActualDays,
23
- depreciation_rate: 0.05,
24
- effective_life_years: 5,
25
- depreciation_calculation_method: None,
26
- depreciable_object_id: 68f17094-af97-4f1b-b36b-013b45b6ad3c,
27
- depreciable_object_type: Asset,
28
- book_effective_date_of_change_id: 68f17094-af97-4f1b-b36b-013b45b6ad3c)
29
- ```
30
-
31
-
@@ -1,25 +0,0 @@
1
- # XeroRuby::Assets::Error
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **resource_validation_errors** | [**Array<ResourceValidationErrorsElement>**](ResourceValidationErrorsElement.md) | Array of elements of resource validation errors | [optional]
8
- **field_validation_errors** | [**Array<FieldValidationErrorsElement>**](FieldValidationErrorsElement.md) | Array of elements of field validation errors | [optional]
9
- **type** | **String** | The internal type of error, not accessible externally | [optional]
10
- **title** | **String** | Title of the error | [optional]
11
- **detail** | **String** | Detail of the error | [optional]
12
-
13
- ## Code Sample
14
-
15
- ```ruby
16
- require 'XeroRuby::Assets'
17
-
18
- instance = XeroRuby::Assets::Error.new(resource_validation_errors: null,
19
- field_validation_errors: null,
20
- type: null,
21
- title: null,
22
- detail: null)
23
- ```
24
-
25
-
@@ -1,27 +0,0 @@
1
- # XeroRuby::Assets::FieldValidationErrorsElement
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **field_name** | **String** | The field name of the erroneous field | [optional]
8
- **value_provided** | **String** | The provided value | [optional]
9
- **localised_message** | **String** | Explaination of the field validation error | [optional]
10
- **type** | **String** | Internal type of the field validation error message | [optional]
11
- **title** | **String** | Title of the field validation error | [optional]
12
- **detail** | **String** | Detail of the field validation error | [optional]
13
-
14
- ## Code Sample
15
-
16
- ```ruby
17
- require 'XeroRuby::Assets'
18
-
19
- instance = XeroRuby::Assets::FieldValidationErrorsElement.new(field_name: null,
20
- value_provided: null,
21
- localised_message: null,
22
- type: null,
23
- title: null,
24
- detail: null)
25
- ```
26
-
27
-
@@ -1,23 +0,0 @@
1
- # XeroRuby::Assets::Pagination
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **page** | **Integer** | | [optional]
8
- **page_size** | **Integer** | | [optional]
9
- **page_count** | **Integer** | | [optional]
10
- **item_count** | **Integer** | | [optional]
11
-
12
- ## Code Sample
13
-
14
- ```ruby
15
- require 'XeroRuby::Assets'
16
-
17
- instance = XeroRuby::Assets::Pagination.new(page: 1,
18
- page_size: 10,
19
- page_count: 1,
20
- item_count: 2)
21
- ```
22
-
23
-
@@ -1,25 +0,0 @@
1
- # XeroRuby::Assets::ResourceValidationErrorsElement
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **resource_name** | **String** | The field name of the erroneous field | [optional]
8
- **localised_message** | **String** | Explaination of the resource validation error | [optional]
9
- **type** | **String** | Internal type of the resource error message | [optional]
10
- **title** | **String** | Title of the resource validation error | [optional]
11
- **detail** | **String** | Detail of the resource validation error | [optional]
12
-
13
- ## Code Sample
14
-
15
- ```ruby
16
- require 'XeroRuby::Assets'
17
-
18
- instance = XeroRuby::Assets::ResourceValidationErrorsElement.new(resource_name: null,
19
- localised_message: null,
20
- type: null,
21
- title: null,
22
- detail: null)
23
- ```
24
-
25
-
@@ -1,31 +0,0 @@
1
- # XeroRuby::Assets::Setting
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **asset_number_prefix** | **String** | The prefix used for fixed asset numbers (“FA-” by default) | [optional]
8
- **asset_number_sequence** | **String** | The next available sequence number | [optional]
9
- **asset_start_date** | **Date** | The date depreciation calculations started on registered fixed assets in Xero | [optional]
10
- **last_depreciation_date** | **Date** | The last depreciation date | [optional]
11
- **default_gain_on_disposal_account_id** | **String** | Default account that gains are posted to | [optional]
12
- **default_loss_on_disposal_account_id** | **String** | Default account that losses are posted to | [optional]
13
- **default_capital_gain_on_disposal_account_id** | **String** | Default account that capital gains are posted to | [optional]
14
- **opt_in_for_tax** | **Boolean** | opt in for tax calculation | [optional]
15
-
16
- ## Code Sample
17
-
18
- ```ruby
19
- require 'XeroRuby::Assets'
20
-
21
- instance = XeroRuby::Assets::Setting.new(asset_number_prefix: FA-,
22
- asset_number_sequence: 0022,
23
- asset_start_date: null,
24
- last_depreciation_date: null,
25
- default_gain_on_disposal_account_id: 346ddb97-739a-4274-b43b-66aa3218d17c,
26
- default_loss_on_disposal_account_id: 1b798541-24e2-4855-9309-c023a0b576f3,
27
- default_capital_gain_on_disposal_account_id: 6d6a0bdb-e118-45d8-a023-2ad617ec1cb7,
28
- opt_in_for_tax: false)
29
- ```
30
-
31
-
@@ -1,23 +0,0 @@
1
- # XeroRuby::Files::Association
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **file_id** | **String** | The unique identifier of the file | [optional]
8
- **object_id** | **String** | The identifier of the object that the file is being associated with (e.g. InvoiceID, BankTransactionID, ContactID) | [optional]
9
- **object_group** | [**ObjectGroup**](ObjectGroup.md) | | [optional]
10
- **object_type** | [**ObjectType**](ObjectType.md) | | [optional]
11
-
12
- ## Code Sample
13
-
14
- ```ruby
15
- require 'XeroRuby::Files'
16
-
17
- instance = XeroRuby::Files::Association.new(file_id: null,
18
- object_id: null,
19
- object_group: null,
20
- object_type: null)
21
- ```
22
-
23
-
@@ -1,31 +0,0 @@
1
- # XeroRuby::Files::FileObject
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **name** | **String** | TODO | [optional]
8
- **mime_type** | **String** | TODO | [optional]
9
- **size** | **Integer** | TODO | [optional]
10
- **created_date_utc** | **DateTime** | TODO | [optional]
11
- **updated_date_utc** | **DateTime** | TODO | [optional]
12
- **user** | [**User**](User.md) | | [optional]
13
- **id** | **String** | TODO | [optional]
14
- **folder_id** | **String** | TODO | [optional]
15
-
16
- ## Code Sample
17
-
18
- ```ruby
19
- require 'XeroRuby::Files'
20
-
21
- instance = XeroRuby::Files::FileObject.new(name: File2.jpg,
22
- mime_type: image/jpeg,
23
- size: 3615,
24
- created_date_utc: null,
25
- updated_date_utc: null,
26
- user: null,
27
- id: d290f1ee-6c54-4b01-90e6-d701748f0851,
28
- folder_id: 0f8ccf21-7267-4268-9167-a1e2c40c84c8)
29
- ```
30
-
31
-
@@ -1,17 +0,0 @@
1
- # XeroRuby::Files::FileResponse204
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **status** | **String** | Status response for 204 no content | [optional]
8
-
9
- ## Code Sample
10
-
11
- ```ruby
12
- require 'XeroRuby::Files'
13
-
14
- instance = XeroRuby::Files::FileResponse204.new(status: null)
15
- ```
16
-
17
-
@@ -1,23 +0,0 @@
1
- # XeroRuby::Files::Files
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **total_count** | **Integer** | | [optional]
8
- **page** | **Integer** | | [optional]
9
- **per_page** | **Integer** | | [optional]
10
- **items** | [**Array<FileObject>**](FileObject.md) | | [optional]
11
-
12
- ## Code Sample
13
-
14
- ```ruby
15
- require 'XeroRuby::Files'
16
-
17
- instance = XeroRuby::Files::Files.new(total_count: 2,
18
- page: 1,
19
- per_page: 50,
20
- items: null)
21
- ```
22
-
23
-
@@ -1,1116 +0,0 @@
1
- # XeroRuby::Files::FilesApi
2
-
3
- All URIs are relative to *https://api.xero.com/files.xro/1.0*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_file_association**](FilesApi.md#create_file_association) | **POST** /Files/{FileId}/Associations | create a new association
8
- [**create_folder**](FilesApi.md#create_folder) | **POST** /Folders | create a new folder
9
- [**delete_file**](FilesApi.md#delete_file) | **DELETE** /Files/{FileId} | delete a file
10
- [**delete_file_association**](FilesApi.md#delete_file_association) | **DELETE** /Files/{FileId}/Associations/{ObjectId} | create a new association
11
- [**delete_folder**](FilesApi.md#delete_folder) | **DELETE** /Folders/{FolderId} | delete a folder
12
- [**get_associations_by_object**](FilesApi.md#get_associations_by_object) | **GET** /Associations/{ObjectId} | searches files
13
- [**get_file**](FilesApi.md#get_file) | **GET** /Files/{FileId} | searches for file by unique id
14
- [**get_file_associations**](FilesApi.md#get_file_associations) | **GET** /Files/{FileId}/Associations | searches files
15
- [**get_file_content**](FilesApi.md#get_file_content) | **GET** /Files/{FileId}/Content | searches files to retrieve the data
16
- [**get_files**](FilesApi.md#get_files) | **GET** /Files | searches files
17
- [**get_folder**](FilesApi.md#get_folder) | **GET** /Folders/{FolderId} | searches specific folder by id
18
- [**get_folders**](FilesApi.md#get_folders) | **GET** /Folders | searches folder
19
- [**get_inbox**](FilesApi.md#get_inbox) | **GET** /Inbox | searches inbox folder
20
- [**update_file**](FilesApi.md#update_file) | **PUT** /Files/{FileId} | Update a file
21
- [**update_folder**](FilesApi.md#update_folder) | **PUT** /Folders/{FolderId} | update folder
22
- [**upload_file**](FilesApi.md#upload_file) | **POST** /Files | upload an File
23
-
24
-
25
-
26
- ## create_file_association
27
-
28
- > Association create_file_association(xero_tenant_id, file_id, opts)
29
-
30
- create a new association
31
-
32
- By passing in the appropriate options, you can create a new folder
33
-
34
- ### Example
35
-
36
- ```ruby
37
- # load the gem
38
- require 'xero-ruby'
39
-
40
- creds = {
41
- client_id: ENV['CLIENT_ID'],
42
- client_secret: ENV['CLIENT_SECRET'],
43
- redirect_uri: ENV['REDIRECT_URI'],
44
- scopes: ENV['SCOPES']
45
- }
46
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
47
-
48
- token_set = fetch_valid_token_set(user) # example
49
-
50
- xero_client.refresh_token_set(token_set)
51
-
52
- # You need to namespace your api method call to one of the following api sets
53
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
54
-
55
- api_instance = xero_client.<api_set>
56
-
57
-
58
-
59
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
60
- file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | File id for single object
61
- opts = {
62
- association: XeroRuby::Files::Association.new # Association |
63
- }
64
-
65
- begin
66
- #create a new association
67
- result = api_instance.create_file_association(xero_tenant_id, file_id, opts)
68
- p result
69
- rescue XeroRuby::Files::ApiError => e
70
- puts "Exception when calling FilesApi->create_file_association: #{e}"
71
- end
72
- ```
73
-
74
- ### Parameters
75
-
76
-
77
- Name | Type | Description | Notes
78
- ------------- | ------------- | ------------- | -------------
79
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
80
- **file_id** | [**String**](.md)| File id for single object |
81
- **association** | [**Association**](Association.md)| | [optional]
82
-
83
- ### Return type
84
-
85
- [**Association**](Association.md)
86
-
87
- ### Authorization
88
-
89
- [OAuth2](../README.md#OAuth2)
90
-
91
- ### HTTP request headers
92
-
93
- - **Content-Type**: application/json
94
- - **Accept**: application/json
95
-
96
-
97
- ## create_folder
98
-
99
- > Folder create_folder(xero_tenant_id, opts)
100
-
101
- create a new folder
102
-
103
- By passing in the appropriate properties, you can create a new folder
104
-
105
- ### Example
106
-
107
- ```ruby
108
- # load the gem
109
- require 'xero-ruby'
110
-
111
- creds = {
112
- client_id: ENV['CLIENT_ID'],
113
- client_secret: ENV['CLIENT_SECRET'],
114
- redirect_uri: ENV['REDIRECT_URI'],
115
- scopes: ENV['SCOPES']
116
- }
117
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
118
-
119
- token_set = fetch_valid_token_set(user) # example
120
-
121
- xero_client.refresh_token_set(token_set)
122
-
123
- # You need to namespace your api method call to one of the following api sets
124
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
125
-
126
- api_instance = xero_client.<api_set>
127
-
128
-
129
-
130
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
131
- opts = {
132
- folder: XeroRuby::Files::Folder.new # Folder |
133
- }
134
-
135
- begin
136
- #create a new folder
137
- result = api_instance.create_folder(xero_tenant_id, opts)
138
- p result
139
- rescue XeroRuby::Files::ApiError => e
140
- puts "Exception when calling FilesApi->create_folder: #{e}"
141
- end
142
- ```
143
-
144
- ### Parameters
145
-
146
-
147
- Name | Type | Description | Notes
148
- ------------- | ------------- | ------------- | -------------
149
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
150
- **folder** | [**Folder**](Folder.md)| | [optional]
151
-
152
- ### Return type
153
-
154
- [**Folder**](Folder.md)
155
-
156
- ### Authorization
157
-
158
- [OAuth2](../README.md#OAuth2)
159
-
160
- ### HTTP request headers
161
-
162
- - **Content-Type**: application/json
163
- - **Accept**: application/json
164
-
165
-
166
- ## delete_file
167
-
168
- > FileResponse204 delete_file(xero_tenant_id, file_id)
169
-
170
- delete a file
171
-
172
- Delete a specific file
173
-
174
- ### Example
175
-
176
- ```ruby
177
- # load the gem
178
- require 'xero-ruby'
179
-
180
- creds = {
181
- client_id: ENV['CLIENT_ID'],
182
- client_secret: ENV['CLIENT_SECRET'],
183
- redirect_uri: ENV['REDIRECT_URI'],
184
- scopes: ENV['SCOPES']
185
- }
186
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
187
-
188
- token_set = fetch_valid_token_set(user) # example
189
-
190
- xero_client.refresh_token_set(token_set)
191
-
192
- # You need to namespace your api method call to one of the following api sets
193
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
194
-
195
- api_instance = xero_client.<api_set>
196
-
197
-
198
-
199
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
200
- file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | File id for single object
201
- begin
202
- #delete a file
203
- result = api_instance.delete_file(xero_tenant_id, file_id)
204
- p result
205
- rescue XeroRuby::Files::ApiError => e
206
- puts "Exception when calling FilesApi->delete_file: #{e}"
207
- end
208
- ```
209
-
210
- ### Parameters
211
-
212
-
213
- Name | Type | Description | Notes
214
- ------------- | ------------- | ------------- | -------------
215
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
216
- **file_id** | [**String**](.md)| File id for single object |
217
-
218
- ### Return type
219
-
220
- [**FileResponse204**](FileResponse204.md)
221
-
222
- ### Authorization
223
-
224
- [OAuth2](../README.md#OAuth2)
225
-
226
- ### HTTP request headers
227
-
228
- - **Content-Type**: Not defined
229
- - **Accept**: application/json
230
-
231
-
232
- ## delete_file_association
233
-
234
- > FileResponse204 delete_file_association(xero_tenant_id, file_id, object_id)
235
-
236
- create a new association
237
-
238
- By passing in the appropriate options, you can create a new folder
239
-
240
- ### Example
241
-
242
- ```ruby
243
- # load the gem
244
- require 'xero-ruby'
245
-
246
- creds = {
247
- client_id: ENV['CLIENT_ID'],
248
- client_secret: ENV['CLIENT_SECRET'],
249
- redirect_uri: ENV['REDIRECT_URI'],
250
- scopes: ENV['SCOPES']
251
- }
252
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
253
-
254
- token_set = fetch_valid_token_set(user) # example
255
-
256
- xero_client.refresh_token_set(token_set)
257
-
258
- # You need to namespace your api method call to one of the following api sets
259
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
260
-
261
- api_instance = xero_client.<api_set>
262
-
263
-
264
-
265
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
266
- file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | File id for single object
267
- object_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Object id for single object
268
- begin
269
- #create a new association
270
- result = api_instance.delete_file_association(xero_tenant_id, file_id, object_id)
271
- p result
272
- rescue XeroRuby::Files::ApiError => e
273
- puts "Exception when calling FilesApi->delete_file_association: #{e}"
274
- end
275
- ```
276
-
277
- ### Parameters
278
-
279
-
280
- Name | Type | Description | Notes
281
- ------------- | ------------- | ------------- | -------------
282
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
283
- **file_id** | [**String**](.md)| File id for single object |
284
- **object_id** | [**String**](.md)| Object id for single object |
285
-
286
- ### Return type
287
-
288
- [**FileResponse204**](FileResponse204.md)
289
-
290
- ### Authorization
291
-
292
- [OAuth2](../README.md#OAuth2)
293
-
294
- ### HTTP request headers
295
-
296
- - **Content-Type**: Not defined
297
- - **Accept**: application/json
298
-
299
-
300
- ## delete_folder
301
-
302
- > FileResponse204 delete_folder(xero_tenant_id, folder_id)
303
-
304
- delete a folder
305
-
306
- By passing in the appropriate ID, you can delete a folder
307
-
308
- ### Example
309
-
310
- ```ruby
311
- # load the gem
312
- require 'xero-ruby'
313
-
314
- creds = {
315
- client_id: ENV['CLIENT_ID'],
316
- client_secret: ENV['CLIENT_SECRET'],
317
- redirect_uri: ENV['REDIRECT_URI'],
318
- scopes: ENV['SCOPES']
319
- }
320
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
321
-
322
- token_set = fetch_valid_token_set(user) # example
323
-
324
- xero_client.refresh_token_set(token_set)
325
-
326
- # You need to namespace your api method call to one of the following api sets
327
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
328
-
329
- api_instance = xero_client.<api_set>
330
-
331
-
332
-
333
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
334
- folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Folder id for single object
335
- begin
336
- #delete a folder
337
- result = api_instance.delete_folder(xero_tenant_id, folder_id)
338
- p result
339
- rescue XeroRuby::Files::ApiError => e
340
- puts "Exception when calling FilesApi->delete_folder: #{e}"
341
- end
342
- ```
343
-
344
- ### Parameters
345
-
346
-
347
- Name | Type | Description | Notes
348
- ------------- | ------------- | ------------- | -------------
349
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
350
- **folder_id** | [**String**](.md)| Folder id for single object |
351
-
352
- ### Return type
353
-
354
- [**FileResponse204**](FileResponse204.md)
355
-
356
- ### Authorization
357
-
358
- [OAuth2](../README.md#OAuth2)
359
-
360
- ### HTTP request headers
361
-
362
- - **Content-Type**: Not defined
363
- - **Accept**: application/json
364
-
365
-
366
- ## get_associations_by_object
367
-
368
- > Array&lt;Association&gt; get_associations_by_object(xero_tenant_id, object_id)
369
-
370
- searches files
371
-
372
- By passing in the appropriate options,
373
-
374
- ### Example
375
-
376
- ```ruby
377
- # load the gem
378
- require 'xero-ruby'
379
-
380
- creds = {
381
- client_id: ENV['CLIENT_ID'],
382
- client_secret: ENV['CLIENT_SECRET'],
383
- redirect_uri: ENV['REDIRECT_URI'],
384
- scopes: ENV['SCOPES']
385
- }
386
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
387
-
388
- token_set = fetch_valid_token_set(user) # example
389
-
390
- xero_client.refresh_token_set(token_set)
391
-
392
- # You need to namespace your api method call to one of the following api sets
393
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
394
-
395
- api_instance = xero_client.<api_set>
396
-
397
-
398
-
399
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
400
- object_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Object id for single object
401
- begin
402
- #searches files
403
- result = api_instance.get_associations_by_object(xero_tenant_id, object_id)
404
- p result
405
- rescue XeroRuby::Files::ApiError => e
406
- puts "Exception when calling FilesApi->get_associations_by_object: #{e}"
407
- end
408
- ```
409
-
410
- ### Parameters
411
-
412
-
413
- Name | Type | Description | Notes
414
- ------------- | ------------- | ------------- | -------------
415
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
416
- **object_id** | [**String**](.md)| Object id for single object |
417
-
418
- ### Return type
419
-
420
- [**Array&lt;Association&gt;**](Association.md)
421
-
422
- ### Authorization
423
-
424
- [OAuth2](../README.md#OAuth2)
425
-
426
- ### HTTP request headers
427
-
428
- - **Content-Type**: Not defined
429
- - **Accept**: application/json
430
-
431
-
432
- ## get_file
433
-
434
- > FileObject get_file(xero_tenant_id, file_id)
435
-
436
- searches for file by unique id
437
-
438
- ### Example
439
-
440
- ```ruby
441
- # load the gem
442
- require 'xero-ruby'
443
-
444
- creds = {
445
- client_id: ENV['CLIENT_ID'],
446
- client_secret: ENV['CLIENT_SECRET'],
447
- redirect_uri: ENV['REDIRECT_URI'],
448
- scopes: ENV['SCOPES']
449
- }
450
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
451
-
452
- token_set = fetch_valid_token_set(user) # example
453
-
454
- xero_client.refresh_token_set(token_set)
455
-
456
- # You need to namespace your api method call to one of the following api sets
457
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
458
-
459
- api_instance = xero_client.<api_set>
460
-
461
-
462
-
463
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
464
- file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | File id for single object
465
- begin
466
- #searches for file by unique id
467
- result = api_instance.get_file(xero_tenant_id, file_id)
468
- p result
469
- rescue XeroRuby::Files::ApiError => e
470
- puts "Exception when calling FilesApi->get_file: #{e}"
471
- end
472
- ```
473
-
474
- ### Parameters
475
-
476
-
477
- Name | Type | Description | Notes
478
- ------------- | ------------- | ------------- | -------------
479
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
480
- **file_id** | [**String**](.md)| File id for single object |
481
-
482
- ### Return type
483
-
484
- [**FileObject**](FileObject.md)
485
-
486
- ### Authorization
487
-
488
- [OAuth2](../README.md#OAuth2)
489
-
490
- ### HTTP request headers
491
-
492
- - **Content-Type**: Not defined
493
- - **Accept**: application/json
494
-
495
-
496
- ## get_file_associations
497
-
498
- > Array&lt;Association&gt; get_file_associations(xero_tenant_id, file_id)
499
-
500
- searches files
501
-
502
- By passing in the appropriate options,
503
-
504
- ### Example
505
-
506
- ```ruby
507
- # load the gem
508
- require 'xero-ruby'
509
-
510
- creds = {
511
- client_id: ENV['CLIENT_ID'],
512
- client_secret: ENV['CLIENT_SECRET'],
513
- redirect_uri: ENV['REDIRECT_URI'],
514
- scopes: ENV['SCOPES']
515
- }
516
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
517
-
518
- token_set = fetch_valid_token_set(user) # example
519
-
520
- xero_client.refresh_token_set(token_set)
521
-
522
- # You need to namespace your api method call to one of the following api sets
523
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
524
-
525
- api_instance = xero_client.<api_set>
526
-
527
-
528
-
529
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
530
- file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | File id for single object
531
- begin
532
- #searches files
533
- result = api_instance.get_file_associations(xero_tenant_id, file_id)
534
- p result
535
- rescue XeroRuby::Files::ApiError => e
536
- puts "Exception when calling FilesApi->get_file_associations: #{e}"
537
- end
538
- ```
539
-
540
- ### Parameters
541
-
542
-
543
- Name | Type | Description | Notes
544
- ------------- | ------------- | ------------- | -------------
545
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
546
- **file_id** | [**String**](.md)| File id for single object |
547
-
548
- ### Return type
549
-
550
- [**Array&lt;Association&gt;**](Association.md)
551
-
552
- ### Authorization
553
-
554
- [OAuth2](../README.md#OAuth2)
555
-
556
- ### HTTP request headers
557
-
558
- - **Content-Type**: Not defined
559
- - **Accept**: application/json
560
-
561
-
562
- ## get_file_content
563
-
564
- > File get_file_content(xero_tenant_id, file_id)
565
-
566
- searches files to retrieve the data
567
-
568
- By passing in the appropriate options, retrieve data for specific file
569
-
570
- ### Example
571
-
572
- ```ruby
573
- # load the gem
574
- require 'xero-ruby'
575
-
576
- creds = {
577
- client_id: ENV['CLIENT_ID'],
578
- client_secret: ENV['CLIENT_SECRET'],
579
- redirect_uri: ENV['REDIRECT_URI'],
580
- scopes: ENV['SCOPES']
581
- }
582
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
583
-
584
- token_set = fetch_valid_token_set(user) # example
585
-
586
- xero_client.refresh_token_set(token_set)
587
-
588
- # You need to namespace your api method call to one of the following api sets
589
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
590
-
591
- api_instance = xero_client.<api_set>
592
-
593
-
594
-
595
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
596
- file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | File id for single object
597
- begin
598
- #searches files to retrieve the data
599
- result = api_instance.get_file_content(xero_tenant_id, file_id)
600
- p result
601
- rescue XeroRuby::Files::ApiError => e
602
- puts "Exception when calling FilesApi->get_file_content: #{e}"
603
- end
604
- ```
605
-
606
- ### Parameters
607
-
608
-
609
- Name | Type | Description | Notes
610
- ------------- | ------------- | ------------- | -------------
611
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
612
- **file_id** | [**String**](.md)| File id for single object |
613
-
614
- ### Return type
615
-
616
- **File**
617
-
618
- ### Authorization
619
-
620
- [OAuth2](../README.md#OAuth2)
621
-
622
- ### HTTP request headers
623
-
624
- - **Content-Type**: Not defined
625
- - **Accept**: application/octet-stream
626
-
627
-
628
- ## get_files
629
-
630
- > Files get_files(xero_tenant_id, opts)
631
-
632
- searches files
633
-
634
- ### Example
635
-
636
- ```ruby
637
- # load the gem
638
- require 'xero-ruby'
639
-
640
- creds = {
641
- client_id: ENV['CLIENT_ID'],
642
- client_secret: ENV['CLIENT_SECRET'],
643
- redirect_uri: ENV['REDIRECT_URI'],
644
- scopes: ENV['SCOPES']
645
- }
646
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
647
-
648
- token_set = fetch_valid_token_set(user) # example
649
-
650
- xero_client.refresh_token_set(token_set)
651
-
652
- # You need to namespace your api method call to one of the following api sets
653
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
654
-
655
- api_instance = xero_client.<api_set>
656
-
657
-
658
-
659
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
660
- opts = {
661
- pagesize: 50, # Integer | pass an optional page size value
662
-
663
- page: 2, # Integer | number of records to skip for pagination
664
-
665
- sort: 'CreatedDateUTC DESC' # String | values to sort by
666
- }
667
-
668
- begin
669
- #searches files
670
- result = api_instance.get_files(xero_tenant_id, opts)
671
- p result
672
- rescue XeroRuby::Files::ApiError => e
673
- puts "Exception when calling FilesApi->get_files: #{e}"
674
- end
675
- ```
676
-
677
- ### Parameters
678
-
679
-
680
- Name | Type | Description | Notes
681
- ------------- | ------------- | ------------- | -------------
682
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
683
- **pagesize** | **Integer**| pass an optional page size value | [optional]
684
- **page** | **Integer**| number of records to skip for pagination | [optional]
685
- **sort** | **String**| values to sort by | [optional]
686
-
687
- ### Return type
688
-
689
- [**Files**](Files.md)
690
-
691
- ### Authorization
692
-
693
- [OAuth2](../README.md#OAuth2)
694
-
695
- ### HTTP request headers
696
-
697
- - **Content-Type**: Not defined
698
- - **Accept**: application/json
699
-
700
-
701
- ## get_folder
702
-
703
- > Folder get_folder(xero_tenant_id, folder_id)
704
-
705
- searches specific folder by id
706
-
707
- By passing in the appropriate ID, you can search for specific folder
708
-
709
- ### Example
710
-
711
- ```ruby
712
- # load the gem
713
- require 'xero-ruby'
714
-
715
- creds = {
716
- client_id: ENV['CLIENT_ID'],
717
- client_secret: ENV['CLIENT_SECRET'],
718
- redirect_uri: ENV['REDIRECT_URI'],
719
- scopes: ENV['SCOPES']
720
- }
721
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
722
-
723
- token_set = fetch_valid_token_set(user) # example
724
-
725
- xero_client.refresh_token_set(token_set)
726
-
727
- # You need to namespace your api method call to one of the following api sets
728
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
729
-
730
- api_instance = xero_client.<api_set>
731
-
732
-
733
-
734
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
735
- folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Folder id for single object
736
- begin
737
- #searches specific folder by id
738
- result = api_instance.get_folder(xero_tenant_id, folder_id)
739
- p result
740
- rescue XeroRuby::Files::ApiError => e
741
- puts "Exception when calling FilesApi->get_folder: #{e}"
742
- end
743
- ```
744
-
745
- ### Parameters
746
-
747
-
748
- Name | Type | Description | Notes
749
- ------------- | ------------- | ------------- | -------------
750
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
751
- **folder_id** | [**String**](.md)| Folder id for single object |
752
-
753
- ### Return type
754
-
755
- [**Folder**](Folder.md)
756
-
757
- ### Authorization
758
-
759
- [OAuth2](../README.md#OAuth2)
760
-
761
- ### HTTP request headers
762
-
763
- - **Content-Type**: Not defined
764
- - **Accept**: application/json
765
-
766
-
767
- ## get_folders
768
-
769
- > Array&lt;Folder&gt; get_folders(xero_tenant_id, opts)
770
-
771
- searches folder
772
-
773
- By passing in the appropriate options, you can search for available folders
774
-
775
- ### Example
776
-
777
- ```ruby
778
- # load the gem
779
- require 'xero-ruby'
780
-
781
- creds = {
782
- client_id: ENV['CLIENT_ID'],
783
- client_secret: ENV['CLIENT_SECRET'],
784
- redirect_uri: ENV['REDIRECT_URI'],
785
- scopes: ENV['SCOPES']
786
- }
787
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
788
-
789
- token_set = fetch_valid_token_set(user) # example
790
-
791
- xero_client.refresh_token_set(token_set)
792
-
793
- # You need to namespace your api method call to one of the following api sets
794
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
795
-
796
- api_instance = xero_client.<api_set>
797
-
798
-
799
-
800
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
801
- opts = {
802
- sort: 'CreatedDateUTC DESC' # String | values to sort by
803
- }
804
-
805
- begin
806
- #searches folder
807
- result = api_instance.get_folders(xero_tenant_id, opts)
808
- p result
809
- rescue XeroRuby::Files::ApiError => e
810
- puts "Exception when calling FilesApi->get_folders: #{e}"
811
- end
812
- ```
813
-
814
- ### Parameters
815
-
816
-
817
- Name | Type | Description | Notes
818
- ------------- | ------------- | ------------- | -------------
819
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
820
- **sort** | **String**| values to sort by | [optional]
821
-
822
- ### Return type
823
-
824
- [**Array&lt;Folder&gt;**](Folder.md)
825
-
826
- ### Authorization
827
-
828
- [OAuth2](../README.md#OAuth2)
829
-
830
- ### HTTP request headers
831
-
832
- - **Content-Type**: Not defined
833
- - **Accept**: application/json
834
-
835
-
836
- ## get_inbox
837
-
838
- > Folder get_inbox(xero_tenant_id)
839
-
840
- searches inbox folder
841
-
842
- Search for the user inbox
843
-
844
- ### Example
845
-
846
- ```ruby
847
- # load the gem
848
- require 'xero-ruby'
849
-
850
- creds = {
851
- client_id: ENV['CLIENT_ID'],
852
- client_secret: ENV['CLIENT_SECRET'],
853
- redirect_uri: ENV['REDIRECT_URI'],
854
- scopes: ENV['SCOPES']
855
- }
856
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
857
-
858
- token_set = fetch_valid_token_set(user) # example
859
-
860
- xero_client.refresh_token_set(token_set)
861
-
862
- # You need to namespace your api method call to one of the following api sets
863
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
864
-
865
- api_instance = xero_client.<api_set>
866
-
867
-
868
-
869
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
870
- begin
871
- #searches inbox folder
872
- result = api_instance.get_inbox(xero_tenant_id)
873
- p result
874
- rescue XeroRuby::Files::ApiError => e
875
- puts "Exception when calling FilesApi->get_inbox: #{e}"
876
- end
877
- ```
878
-
879
- ### Parameters
880
-
881
-
882
- Name | Type | Description | Notes
883
- ------------- | ------------- | ------------- | -------------
884
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
885
-
886
- ### Return type
887
-
888
- [**Folder**](Folder.md)
889
-
890
- ### Authorization
891
-
892
- [OAuth2](../README.md#OAuth2)
893
-
894
- ### HTTP request headers
895
-
896
- - **Content-Type**: Not defined
897
- - **Accept**: application/json
898
-
899
-
900
- ## update_file
901
-
902
- > FileObject update_file(xero_tenant_id, file_id, opts)
903
-
904
- Update a file
905
-
906
- Update properties on a single file
907
-
908
- ### Example
909
-
910
- ```ruby
911
- # load the gem
912
- require 'xero-ruby'
913
-
914
- creds = {
915
- client_id: ENV['CLIENT_ID'],
916
- client_secret: ENV['CLIENT_SECRET'],
917
- redirect_uri: ENV['REDIRECT_URI'],
918
- scopes: ENV['SCOPES']
919
- }
920
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
921
-
922
- token_set = fetch_valid_token_set(user) # example
923
-
924
- xero_client.refresh_token_set(token_set)
925
-
926
- # You need to namespace your api method call to one of the following api sets
927
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
928
-
929
- api_instance = xero_client.<api_set>
930
-
931
-
932
-
933
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
934
- file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | File id for single object
935
- opts = {
936
- file_object: XeroRuby::Files::FileObject.new # FileObject |
937
- }
938
-
939
- begin
940
- #Update a file
941
- result = api_instance.update_file(xero_tenant_id, file_id, opts)
942
- p result
943
- rescue XeroRuby::Files::ApiError => e
944
- puts "Exception when calling FilesApi->update_file: #{e}"
945
- end
946
- ```
947
-
948
- ### Parameters
949
-
950
-
951
- Name | Type | Description | Notes
952
- ------------- | ------------- | ------------- | -------------
953
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
954
- **file_id** | [**String**](.md)| File id for single object |
955
- **file_object** | [**FileObject**](FileObject.md)| | [optional]
956
-
957
- ### Return type
958
-
959
- [**FileObject**](FileObject.md)
960
-
961
- ### Authorization
962
-
963
- [OAuth2](../README.md#OAuth2)
964
-
965
- ### HTTP request headers
966
-
967
- - **Content-Type**: application/json
968
- - **Accept**: application/json
969
-
970
-
971
- ## update_folder
972
-
973
- > Folder update_folder(xero_tenant_id, folder_id, folder)
974
-
975
- update folder
976
-
977
- By passing in the appropriate ID and properties, you can update a folder
978
-
979
- ### Example
980
-
981
- ```ruby
982
- # load the gem
983
- require 'xero-ruby'
984
-
985
- creds = {
986
- client_id: ENV['CLIENT_ID'],
987
- client_secret: ENV['CLIENT_SECRET'],
988
- redirect_uri: ENV['REDIRECT_URI'],
989
- scopes: ENV['SCOPES']
990
- }
991
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
992
-
993
- token_set = fetch_valid_token_set(user) # example
994
-
995
- xero_client.refresh_token_set(token_set)
996
-
997
- # You need to namespace your api method call to one of the following api sets
998
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
999
-
1000
- api_instance = xero_client.<api_set>
1001
-
1002
-
1003
-
1004
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
1005
- folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Folder id for single object
1006
- folder = XeroRuby::Files::Folder.new # Folder |
1007
- begin
1008
- #update folder
1009
- result = api_instance.update_folder(xero_tenant_id, folder_id, folder)
1010
- p result
1011
- rescue XeroRuby::Files::ApiError => e
1012
- puts "Exception when calling FilesApi->update_folder: #{e}"
1013
- end
1014
- ```
1015
-
1016
- ### Parameters
1017
-
1018
-
1019
- Name | Type | Description | Notes
1020
- ------------- | ------------- | ------------- | -------------
1021
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
1022
- **folder_id** | [**String**](.md)| Folder id for single object |
1023
- **folder** | [**Folder**](Folder.md)| |
1024
-
1025
- ### Return type
1026
-
1027
- [**Folder**](Folder.md)
1028
-
1029
- ### Authorization
1030
-
1031
- [OAuth2](../README.md#OAuth2)
1032
-
1033
- ### HTTP request headers
1034
-
1035
- - **Content-Type**: application/json
1036
- - **Accept**: application/json
1037
-
1038
-
1039
- ## upload_file
1040
-
1041
- > FileObject upload_file(xero_tenant_id, opts)
1042
-
1043
- upload an File
1044
-
1045
- ### Example
1046
-
1047
- ```ruby
1048
- # load the gem
1049
- require 'xero-ruby'
1050
-
1051
- creds = {
1052
- client_id: ENV['CLIENT_ID'],
1053
- client_secret: ENV['CLIENT_SECRET'],
1054
- redirect_uri: ENV['REDIRECT_URI'],
1055
- scopes: ENV['SCOPES']
1056
- }
1057
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
1058
-
1059
- token_set = fetch_valid_token_set(user) # example
1060
-
1061
- xero_client.refresh_token_set(token_set)
1062
-
1063
- # You need to namespace your api method call to one of the following api sets
1064
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
1065
-
1066
- api_instance = xero_client.<api_set>
1067
-
1068
-
1069
-
1070
- xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
1071
- opts = {
1072
- folder_id: '4ff1e5cc-9835-40d5-bb18-09fdb118db9c', # String | pass an optional folder id to save file to specific folder
1073
-
1074
- body: 'body_example', # String |
1075
-
1076
- name: 'name_example', # String | exact name of the file you are uploading
1077
-
1078
- filename: 'filename_example', # String |
1079
-
1080
- mime_type: 'mime_type_example' # String |
1081
- }
1082
-
1083
- begin
1084
- #upload an File
1085
- result = api_instance.upload_file(xero_tenant_id, opts)
1086
- p result
1087
- rescue XeroRuby::Files::ApiError => e
1088
- puts "Exception when calling FilesApi->upload_file: #{e}"
1089
- end
1090
- ```
1091
-
1092
- ### Parameters
1093
-
1094
-
1095
- Name | Type | Description | Notes
1096
- ------------- | ------------- | ------------- | -------------
1097
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
1098
- **folder_id** | [**String**](.md)| pass an optional folder id to save file to specific folder | [optional]
1099
- **body** | **String**| | [optional]
1100
- **name** | **String**| exact name of the file you are uploading | [optional]
1101
- **filename** | **String**| | [optional]
1102
- **mime_type** | **String**| | [optional]
1103
-
1104
- ### Return type
1105
-
1106
- [**FileObject**](FileObject.md)
1107
-
1108
- ### Authorization
1109
-
1110
- [OAuth2](../README.md#OAuth2)
1111
-
1112
- ### HTTP request headers
1113
-
1114
- - **Content-Type**: multipart/form-data
1115
- - **Accept**: application/json
1116
-