xero-ruby 2.3.0 → 2.3.1

Sign up to get free protection for your applications and to get access to all the features.
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,25 +0,0 @@
1
- # XeroRuby::PayrollUk::TimesheetLine
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **timesheet_line_id** | **String** | The Xero identifier for a Timesheet Line | [optional]
8
- **date** | **Date** | The Date that this Timesheet Line is for (YYYY-MM-DD) |
9
- **earnings_rate_id** | **String** | The Xero identifier for the Earnings Rate that the Timesheet is for |
10
- **tracking_item_id** | **String** | The Xero identifier for the Tracking Item that the Timesheet is for | [optional]
11
- **number_of_units** | **Float** | The Number of Units of the Timesheet Line |
12
-
13
- ## Code Sample
14
-
15
- ```ruby
16
- require 'XeroRuby::PayrollUk'
17
-
18
- instance = XeroRuby::PayrollUk::TimesheetLine.new(timesheet_line_id: null,
19
- date: null,
20
- earnings_rate_id: null,
21
- tracking_item_id: null,
22
- number_of_units: null)
23
- ```
24
-
25
-
@@ -1,21 +0,0 @@
1
- # XeroRuby::PayrollUk::TimesheetLineObject
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **pagination** | [**Pagination**](Pagination.md) | | [optional]
8
- **problem** | [**Problem**](Problem.md) | | [optional]
9
- **timesheet_line** | [**TimesheetLine**](TimesheetLine.md) | | [optional]
10
-
11
- ## Code Sample
12
-
13
- ```ruby
14
- require 'XeroRuby::PayrollUk'
15
-
16
- instance = XeroRuby::PayrollUk::TimesheetLineObject.new(pagination: null,
17
- problem: null,
18
- timesheet_line: null)
19
- ```
20
-
21
-
@@ -1,21 +0,0 @@
1
- # XeroRuby::PayrollUk::TimesheetObject
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **pagination** | [**Pagination**](Pagination.md) | | [optional]
8
- **problem** | [**Problem**](Problem.md) | | [optional]
9
- **timesheet** | [**Timesheet**](Timesheet.md) | | [optional]
10
-
11
- ## Code Sample
12
-
13
- ```ruby
14
- require 'XeroRuby::PayrollUk'
15
-
16
- instance = XeroRuby::PayrollUk::TimesheetObject.new(pagination: null,
17
- problem: null,
18
- timesheet: null)
19
- ```
20
-
21
-
@@ -1,21 +0,0 @@
1
- # XeroRuby::PayrollUk::Timesheets
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **pagination** | [**Pagination**](Pagination.md) | | [optional]
8
- **problem** | [**Problem**](Problem.md) | | [optional]
9
- **timesheets** | [**Array<Timesheet>**](Timesheet.md) | | [optional]
10
-
11
- ## Code Sample
12
-
13
- ```ruby
14
- require 'XeroRuby::PayrollUk'
15
-
16
- instance = XeroRuby::PayrollUk::Timesheets.new(pagination: null,
17
- problem: null,
18
- timesheets: null)
19
- ```
20
-
21
-
@@ -1,21 +0,0 @@
1
- # XeroRuby::PayrollUk::TrackingCategories
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **pagination** | [**Pagination**](Pagination.md) | | [optional]
8
- **problem** | [**Problem**](Problem.md) | | [optional]
9
- **tracking_categories** | [**TrackingCategory**](TrackingCategory.md) | | [optional]
10
-
11
- ## Code Sample
12
-
13
- ```ruby
14
- require 'XeroRuby::PayrollUk'
15
-
16
- instance = XeroRuby::PayrollUk::TrackingCategories.new(pagination: null,
17
- problem: null,
18
- tracking_categories: null)
19
- ```
20
-
21
-
@@ -1,19 +0,0 @@
1
- # XeroRuby::PayrollUk::TrackingCategory
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **employee_groups_tracking_category_id** | **String** | The Xero identifier for Employee groups tracking category. | [optional]
8
- **timesheet_tracking_category_id** | **String** | The Xero identifier for Timesheet tracking category. | [optional]
9
-
10
- ## Code Sample
11
-
12
- ```ruby
13
- require 'XeroRuby::PayrollUk'
14
-
15
- instance = XeroRuby::PayrollUk::TrackingCategory.new(employee_groups_tracking_category_id: null,
16
- timesheet_tracking_category_id: null)
17
- ```
18
-
19
-
@@ -1,19 +0,0 @@
1
- # XeroRuby::Projects::Amount
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **currency** | [**CurrencyCode**](CurrencyCode.md) | | [optional]
8
- **value** | **BigDecimal** | | [optional]
9
-
10
- ## Code Sample
11
-
12
- ```ruby
13
- require 'XeroRuby::Projects'
14
-
15
- instance = XeroRuby::Projects::Amount.new(currency: null,
16
- value: 1.0)
17
- ```
18
-
19
-
@@ -1,16 +0,0 @@
1
- # XeroRuby::Projects::ChargeType
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
-
8
- ## Code Sample
9
-
10
- ```ruby
11
- require 'XeroRuby::Projects'
12
-
13
- instance = XeroRuby::Projects::ChargeType.new()
14
- ```
15
-
16
-
@@ -1,16 +0,0 @@
1
- # XeroRuby::Projects::CurrencyCode
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
-
8
- ## Code Sample
9
-
10
- ```ruby
11
- require 'XeroRuby::Projects'
12
-
13
- instance = XeroRuby::Projects::CurrencyCode.new()
14
- ```
15
-
16
-
@@ -1,19 +0,0 @@
1
- # XeroRuby::Projects::Error
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **message** | **String** | Exception message | [optional]
8
- **model_state** | [**Object**](.md) | Array of Elements of validation Errors | [optional]
9
-
10
- ## Code Sample
11
-
12
- ```ruby
13
- require 'XeroRuby::Projects'
14
-
15
- instance = XeroRuby::Projects::Error.new(message: null,
16
- model_state: null)
17
- ```
18
-
19
-
@@ -1,23 +0,0 @@
1
- # XeroRuby::Projects::Pagination
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **page** | **Integer** | Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. | [optional]
8
- **page_size** | **Integer** | Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. | [optional]
9
- **page_count** | **Integer** | Number of pages available | [optional]
10
- **item_count** | **Integer** | Number of items returned | [optional]
11
-
12
- ## Code Sample
13
-
14
- ```ruby
15
- require 'XeroRuby::Projects'
16
-
17
- instance = XeroRuby::Projects::Pagination.new(page: 1,
18
- page_size: 10,
19
- page_count: 1,
20
- item_count: 2)
21
- ```
22
-
23
-
@@ -1,59 +0,0 @@
1
- # XeroRuby::Projects::Project
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **project_id** | **String** | Identifier of the project. | [optional]
8
- **contact_id** | **String** | Identifier of the contact this project was created for. | [optional]
9
- **name** | **String** | Name of the project. |
10
- **currency_code** | [**CurrencyCode**](CurrencyCode.md) | | [optional]
11
- **minutes_logged** | **Integer** | A total of minutes logged against all tasks on the Project. | [optional]
12
- **total_task_amount** | [**Amount**](Amount.md) | | [optional]
13
- **total_expense_amount** | [**Amount**](Amount.md) | | [optional]
14
- **estimate_amount** | [**Amount**](Amount.md) | | [optional]
15
- **minutes_to_be_invoiced** | **Integer** | Minutes which have not been invoiced across all chargeable tasks in the project. | [optional]
16
- **task_amount_to_be_invoiced** | [**Amount**](Amount.md) | | [optional]
17
- **task_amount_invoiced** | [**Amount**](Amount.md) | | [optional]
18
- **expense_amount_to_be_invoiced** | [**Amount**](Amount.md) | | [optional]
19
- **expense_amount_invoiced** | [**Amount**](Amount.md) | | [optional]
20
- **project_amount_invoiced** | [**Amount**](Amount.md) | | [optional]
21
- **deposit** | [**Amount**](Amount.md) | | [optional]
22
- **deposit_applied** | [**Amount**](Amount.md) | | [optional]
23
- **credit_note_amount** | [**Amount**](Amount.md) | | [optional]
24
- **deadline_utc** | **DateTime** | Deadline for the project. UTC Date Time in ISO-8601 format. | [optional]
25
- **total_invoiced** | [**Amount**](Amount.md) | | [optional]
26
- **total_to_be_invoiced** | [**Amount**](Amount.md) | | [optional]
27
- **estimate** | [**Amount**](Amount.md) | | [optional]
28
- **status** | [**ProjectStatus**](ProjectStatus.md) | | [optional]
29
-
30
- ## Code Sample
31
-
32
- ```ruby
33
- require 'XeroRuby::Projects'
34
-
35
- instance = XeroRuby::Projects::Project.new(project_id: 254553fa-2be8-4991-bd5e-70a97ea12ef8,
36
- contact_id: 01234567-89ab-cdef-0123-456789abcdef,
37
- name: New Kitchen,
38
- currency_code: null,
39
- minutes_logged: 0,
40
- total_task_amount: null,
41
- total_expense_amount: null,
42
- estimate_amount: null,
43
- minutes_to_be_invoiced: 0,
44
- task_amount_to_be_invoiced: null,
45
- task_amount_invoiced: null,
46
- expense_amount_to_be_invoiced: null,
47
- expense_amount_invoiced: null,
48
- project_amount_invoiced: null,
49
- deposit: null,
50
- deposit_applied: null,
51
- credit_note_amount: null,
52
- deadline_utc: 2019-12-10T12:59:59Z,
53
- total_invoiced: null,
54
- total_to_be_invoiced: null,
55
- estimate: null,
56
- status: null)
57
- ```
58
-
59
-
@@ -1,953 +0,0 @@
1
- # XeroRuby::Projects::ProjectApi
2
-
3
- All URIs are relative to *https://api.xero.com/projects.xro/2.0*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_project**](ProjectApi.md#create_project) | **POST** /projects | create one or more new projects
8
- [**create_time_entry**](ProjectApi.md#create_time_entry) | **POST** /projects/{projectId}/time | Allows you to create a task
9
- [**delete_time_entry**](ProjectApi.md#delete_time_entry) | **DELETE** /projects/{projectId}/time/{timeEntryId} | Allows you to delete a time entry
10
- [**get_project**](ProjectApi.md#get_project) | **GET** /projects/{projectId} | Allows you to retrieve a single project
11
- [**get_project_users**](ProjectApi.md#get_project_users) | **GET** /projectsusers | list all project users
12
- [**get_projects**](ProjectApi.md#get_projects) | **GET** /projects | list all projects
13
- [**get_task**](ProjectApi.md#get_task) | **GET** /projects/{projectId}/tasks/{taskId} | Allows you to retrieve a single project
14
- [**get_tasks**](ProjectApi.md#get_tasks) | **GET** /projects/{projectId}/tasks | Allows you to retrieve a single project
15
- [**get_time_entries**](ProjectApi.md#get_time_entries) | **GET** /projects/{projectId}/time | Allows you to retrieve the time entries associated with a specific project
16
- [**get_time_entry**](ProjectApi.md#get_time_entry) | **GET** /projects/{projectId}/time/{timeEntryId} | Allows you to get a single time entry in a project
17
- [**patch_project**](ProjectApi.md#patch_project) | **PATCH** /projects/{projectId} | creates a project for the specified contact
18
- [**update_project**](ProjectApi.md#update_project) | **PUT** /projects/{projectId} | update a specific project
19
- [**update_time_entry**](ProjectApi.md#update_time_entry) | **PUT** /projects/{projectId}/time/{timeEntryId} | Allows you to update time entry in a project
20
-
21
-
22
-
23
- ## create_project
24
-
25
- > Project create_project(xero_tenant_id, project_create_or_update)
26
-
27
- create one or more new projects
28
-
29
- ### Example
30
-
31
- ```ruby
32
- # load the gem
33
- require 'xero-ruby'
34
-
35
- creds = {
36
- client_id: ENV['CLIENT_ID'],
37
- client_secret: ENV['CLIENT_SECRET'],
38
- redirect_uri: ENV['REDIRECT_URI'],
39
- scopes: ENV['SCOPES']
40
- }
41
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
42
-
43
- token_set = fetch_valid_token_set(user) # example
44
-
45
- xero_client.refresh_token_set(token_set)
46
-
47
- # You need to namespace your api method call to one of the following api sets
48
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
49
-
50
- api_instance = xero_client.<api_set>
51
-
52
-
53
-
54
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
55
- project_create_or_update = { "contactId":"00000000-0000-0000-000-000000000000", "name":"New Kitchen", "deadlineUtc":"2019-12-10T12:59:59Z", "estimateAmount":"99.99" } # ProjectCreateOrUpdate | Create a new project with ProjectCreateOrUpdate object
56
- begin
57
- #create one or more new projects
58
- result = api_instance.create_project(xero_tenant_id, project_create_or_update)
59
- p result
60
- rescue XeroRuby::Projects::ApiError => e
61
- puts "Exception when calling ProjectApi->create_project: #{e}"
62
- end
63
- ```
64
-
65
- ### Parameters
66
-
67
-
68
- Name | Type | Description | Notes
69
- ------------- | ------------- | ------------- | -------------
70
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
71
- **project_create_or_update** | [**ProjectCreateOrUpdate**](ProjectCreateOrUpdate.md)| Create a new project with ProjectCreateOrUpdate object |
72
-
73
- ### Return type
74
-
75
- [**Project**](Project.md)
76
-
77
- ### Authorization
78
-
79
- [OAuth2](../README.md#OAuth2)
80
-
81
- ### HTTP request headers
82
-
83
- - **Content-Type**: application/json
84
- - **Accept**: application/json
85
-
86
-
87
- ## create_time_entry
88
-
89
- > TimeEntry create_time_entry(xero_tenant_id, project_id, time_entry_create_or_update)
90
-
91
- Allows you to create a task
92
-
93
- Allows you to create a specific task
94
-
95
- ### Example
96
-
97
- ```ruby
98
- # load the gem
99
- require 'xero-ruby'
100
-
101
- creds = {
102
- client_id: ENV['CLIENT_ID'],
103
- client_secret: ENV['CLIENT_SECRET'],
104
- redirect_uri: ENV['REDIRECT_URI'],
105
- scopes: ENV['SCOPES']
106
- }
107
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
108
-
109
- token_set = fetch_valid_token_set(user) # example
110
-
111
- xero_client.refresh_token_set(token_set)
112
-
113
- # You need to namespace your api method call to one of the following api sets
114
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
115
-
116
- api_instance = xero_client.<api_set>
117
-
118
-
119
-
120
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
121
- project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint
122
- time_entry_create_or_update = { "userId":"740add2a-a703-4b8a-a670-1093919c2040", "taskId":"7be77337-feec-4458-bb1b-dbaa5a4aafce", "dateUtc":"2020-02-26T15:00:00Z", "duration":30, "description":"My description" } # TimeEntryCreateOrUpdate | The time entry object you are creating
123
- begin
124
- #Allows you to create a task
125
- result = api_instance.create_time_entry(xero_tenant_id, project_id, time_entry_create_or_update)
126
- p result
127
- rescue XeroRuby::Projects::ApiError => e
128
- puts "Exception when calling ProjectApi->create_time_entry: #{e}"
129
- end
130
- ```
131
-
132
- ### Parameters
133
-
134
-
135
- Name | Type | Description | Notes
136
- ------------- | ------------- | ------------- | -------------
137
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
138
- **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint |
139
- **time_entry_create_or_update** | [**TimeEntryCreateOrUpdate**](TimeEntryCreateOrUpdate.md)| The time entry object you are creating |
140
-
141
- ### Return type
142
-
143
- [**TimeEntry**](TimeEntry.md)
144
-
145
- ### Authorization
146
-
147
- [OAuth2](../README.md#OAuth2)
148
-
149
- ### HTTP request headers
150
-
151
- - **Content-Type**: application/json
152
- - **Accept**: application/json
153
-
154
-
155
- ## delete_time_entry
156
-
157
- > delete_time_entry(xero_tenant_id, project_id, time_entry_id)
158
-
159
- Allows you to delete a time entry
160
-
161
- Allows you to delete a specific time entry
162
-
163
- ### Example
164
-
165
- ```ruby
166
- # load the gem
167
- require 'xero-ruby'
168
-
169
- creds = {
170
- client_id: ENV['CLIENT_ID'],
171
- client_secret: ENV['CLIENT_SECRET'],
172
- redirect_uri: ENV['REDIRECT_URI'],
173
- scopes: ENV['SCOPES']
174
- }
175
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
176
-
177
- token_set = fetch_valid_token_set(user) # example
178
-
179
- xero_client.refresh_token_set(token_set)
180
-
181
- # You need to namespace your api method call to one of the following api sets
182
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
183
-
184
- api_instance = xero_client.<api_set>
185
-
186
-
187
-
188
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
189
- project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint
190
- time_entry_id = 'time_entry_id_example' # String | You can specify an individual task by appending the id to the endpoint
191
- begin
192
- #Allows you to delete a time entry
193
- api_instance.delete_time_entry(xero_tenant_id, project_id, time_entry_id)
194
- rescue XeroRuby::Projects::ApiError => e
195
- puts "Exception when calling ProjectApi->delete_time_entry: #{e}"
196
- end
197
- ```
198
-
199
- ### Parameters
200
-
201
-
202
- Name | Type | Description | Notes
203
- ------------- | ------------- | ------------- | -------------
204
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
205
- **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint |
206
- **time_entry_id** | [**String**](.md)| You can specify an individual task by appending the id to the endpoint |
207
-
208
- ### Return type
209
-
210
- nil (empty response body)
211
-
212
- ### Authorization
213
-
214
- [OAuth2](../README.md#OAuth2)
215
-
216
- ### HTTP request headers
217
-
218
- - **Content-Type**: Not defined
219
- - **Accept**: Not defined
220
-
221
-
222
- ## get_project
223
-
224
- > Project get_project(xero_tenant_id, project_id)
225
-
226
- Allows you to retrieve a single project
227
-
228
- Allows you to retrieve a specific project
229
-
230
- ### Example
231
-
232
- ```ruby
233
- # load the gem
234
- require 'xero-ruby'
235
-
236
- creds = {
237
- client_id: ENV['CLIENT_ID'],
238
- client_secret: ENV['CLIENT_SECRET'],
239
- redirect_uri: ENV['REDIRECT_URI'],
240
- scopes: ENV['SCOPES']
241
- }
242
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
243
-
244
- token_set = fetch_valid_token_set(user) # example
245
-
246
- xero_client.refresh_token_set(token_set)
247
-
248
- # You need to namespace your api method call to one of the following api sets
249
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
250
-
251
- api_instance = xero_client.<api_set>
252
-
253
-
254
-
255
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
256
- project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint
257
- begin
258
- #Allows you to retrieve a single project
259
- result = api_instance.get_project(xero_tenant_id, project_id)
260
- p result
261
- rescue XeroRuby::Projects::ApiError => e
262
- puts "Exception when calling ProjectApi->get_project: #{e}"
263
- end
264
- ```
265
-
266
- ### Parameters
267
-
268
-
269
- Name | Type | Description | Notes
270
- ------------- | ------------- | ------------- | -------------
271
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
272
- **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint |
273
-
274
- ### Return type
275
-
276
- [**Project**](Project.md)
277
-
278
- ### Authorization
279
-
280
- [OAuth2](../README.md#OAuth2)
281
-
282
- ### HTTP request headers
283
-
284
- - **Content-Type**: Not defined
285
- - **Accept**: application/json
286
-
287
-
288
- ## get_project_users
289
-
290
- > ProjectUsers get_project_users(xero_tenant_id, opts)
291
-
292
- list all project users
293
-
294
- Allows you to retrieve the users on a projects.
295
-
296
- ### Example
297
-
298
- ```ruby
299
- # load the gem
300
- require 'xero-ruby'
301
-
302
- creds = {
303
- client_id: ENV['CLIENT_ID'],
304
- client_secret: ENV['CLIENT_SECRET'],
305
- redirect_uri: ENV['REDIRECT_URI'],
306
- scopes: ENV['SCOPES']
307
- }
308
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
309
-
310
- token_set = fetch_valid_token_set(user) # example
311
-
312
- xero_client.refresh_token_set(token_set)
313
-
314
- # You need to namespace your api method call to one of the following api sets
315
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
316
-
317
- api_instance = xero_client.<api_set>
318
-
319
-
320
-
321
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
322
- opts = {
323
- page: 1, # Integer | set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0.
324
-
325
- page_size: 50 # Integer | Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500.
326
- }
327
-
328
- begin
329
- #list all project users
330
- result = api_instance.get_project_users(xero_tenant_id, opts)
331
- p result
332
- rescue XeroRuby::Projects::ApiError => e
333
- puts "Exception when calling ProjectApi->get_project_users: #{e}"
334
- end
335
- ```
336
-
337
- ### Parameters
338
-
339
-
340
- Name | Type | Description | Notes
341
- ------------- | ------------- | ------------- | -------------
342
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
343
- **page** | **Integer**| set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. | [optional] [default to 1]
344
- **page_size** | **Integer**| Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. | [optional] [default to 50]
345
-
346
- ### Return type
347
-
348
- [**ProjectUsers**](ProjectUsers.md)
349
-
350
- ### Authorization
351
-
352
- [OAuth2](../README.md#OAuth2)
353
-
354
- ### HTTP request headers
355
-
356
- - **Content-Type**: Not defined
357
- - **Accept**: application/json
358
-
359
-
360
- ## get_projects
361
-
362
- > Projects get_projects(xero_tenant_id, opts)
363
-
364
- list all projects
365
-
366
- Allows you to retrieve, create and update projects.
367
-
368
- ### Example
369
-
370
- ```ruby
371
- # load the gem
372
- require 'xero-ruby'
373
-
374
- creds = {
375
- client_id: ENV['CLIENT_ID'],
376
- client_secret: ENV['CLIENT_SECRET'],
377
- redirect_uri: ENV['REDIRECT_URI'],
378
- scopes: ENV['SCOPES']
379
- }
380
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
381
-
382
- token_set = fetch_valid_token_set(user) # example
383
-
384
- xero_client.refresh_token_set(token_set)
385
-
386
- # You need to namespace your api method call to one of the following api sets
387
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
388
-
389
- api_instance = xero_client.<api_set>
390
-
391
-
392
-
393
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
394
- opts = {
395
- project_ids: ['project_ids_example'], # Array<String> | Search for all projects that match a comma separated list of projectIds
396
-
397
- contact_id: 'contact_id_example', # String | Filter for projects for a specific contact
398
-
399
- states: 'states_example', # String | Filter for projects in a particular state (INPROGRESS or CLOSED)
400
-
401
- page: 1, # Integer | set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0.
402
-
403
- page_size: 50 # Integer | Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500.
404
- }
405
-
406
- begin
407
- #list all projects
408
- result = api_instance.get_projects(xero_tenant_id, opts)
409
- p result
410
- rescue XeroRuby::Projects::ApiError => e
411
- puts "Exception when calling ProjectApi->get_projects: #{e}"
412
- end
413
- ```
414
-
415
- ### Parameters
416
-
417
-
418
- Name | Type | Description | Notes
419
- ------------- | ------------- | ------------- | -------------
420
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
421
- **project_ids** | [**Array&lt;String&gt;**](String.md)| Search for all projects that match a comma separated list of projectIds | [optional]
422
- **contact_id** | [**String**](.md)| Filter for projects for a specific contact | [optional]
423
- **states** | **String**| Filter for projects in a particular state (INPROGRESS or CLOSED) | [optional]
424
- **page** | **Integer**| set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. | [optional] [default to 1]
425
- **page_size** | **Integer**| Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. | [optional] [default to 50]
426
-
427
- ### Return type
428
-
429
- [**Projects**](Projects.md)
430
-
431
- ### Authorization
432
-
433
- [OAuth2](../README.md#OAuth2)
434
-
435
- ### HTTP request headers
436
-
437
- - **Content-Type**: Not defined
438
- - **Accept**: application/json
439
-
440
-
441
- ## get_task
442
-
443
- > Task get_task(xero_tenant_id, project_id, task_id)
444
-
445
- Allows you to retrieve a single project
446
-
447
- Allows you to retrieve a specific project
448
-
449
- ### Example
450
-
451
- ```ruby
452
- # load the gem
453
- require 'xero-ruby'
454
-
455
- creds = {
456
- client_id: ENV['CLIENT_ID'],
457
- client_secret: ENV['CLIENT_SECRET'],
458
- redirect_uri: ENV['REDIRECT_URI'],
459
- scopes: ENV['SCOPES']
460
- }
461
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
462
-
463
- token_set = fetch_valid_token_set(user) # example
464
-
465
- xero_client.refresh_token_set(token_set)
466
-
467
- # You need to namespace your api method call to one of the following api sets
468
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
469
-
470
- api_instance = xero_client.<api_set>
471
-
472
-
473
-
474
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
475
- project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint
476
- task_id = 'task_id_example' # String | You can specify an individual task by appending the taskId to the endpoint, i.e. GET https://.../tasks/{taskId}
477
- begin
478
- #Allows you to retrieve a single project
479
- result = api_instance.get_task(xero_tenant_id, project_id, task_id)
480
- p result
481
- rescue XeroRuby::Projects::ApiError => e
482
- puts "Exception when calling ProjectApi->get_task: #{e}"
483
- end
484
- ```
485
-
486
- ### Parameters
487
-
488
-
489
- Name | Type | Description | Notes
490
- ------------- | ------------- | ------------- | -------------
491
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
492
- **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint |
493
- **task_id** | [**String**](.md)| You can specify an individual task by appending the taskId to the endpoint, i.e. GET https://.../tasks/{taskId} |
494
-
495
- ### Return type
496
-
497
- [**Task**](Task.md)
498
-
499
- ### Authorization
500
-
501
- [OAuth2](../README.md#OAuth2)
502
-
503
- ### HTTP request headers
504
-
505
- - **Content-Type**: Not defined
506
- - **Accept**: application/json
507
-
508
-
509
- ## get_tasks
510
-
511
- > Tasks get_tasks(xero_tenant_id, project_id, opts)
512
-
513
- Allows you to retrieve a single project
514
-
515
- Allows you to retrieve a specific project
516
-
517
- ### Example
518
-
519
- ```ruby
520
- # load the gem
521
- require 'xero-ruby'
522
-
523
- creds = {
524
- client_id: ENV['CLIENT_ID'],
525
- client_secret: ENV['CLIENT_SECRET'],
526
- redirect_uri: ENV['REDIRECT_URI'],
527
- scopes: ENV['SCOPES']
528
- }
529
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
530
-
531
- token_set = fetch_valid_token_set(user) # example
532
-
533
- xero_client.refresh_token_set(token_set)
534
-
535
- # You need to namespace your api method call to one of the following api sets
536
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
537
-
538
- api_instance = xero_client.<api_set>
539
-
540
-
541
-
542
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
543
- project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint
544
- opts = {
545
- page: 1, # Integer | Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0.
546
-
547
- page_size: 10, # Integer | Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500.
548
-
549
- task_ids: 'task_ids_example' # String | taskIdsSearch for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskId},{taskId}
550
- }
551
-
552
- begin
553
- #Allows you to retrieve a single project
554
- result = api_instance.get_tasks(xero_tenant_id, project_id, opts)
555
- p result
556
- rescue XeroRuby::Projects::ApiError => e
557
- puts "Exception when calling ProjectApi->get_tasks: #{e}"
558
- end
559
- ```
560
-
561
- ### Parameters
562
-
563
-
564
- Name | Type | Description | Notes
565
- ------------- | ------------- | ------------- | -------------
566
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
567
- **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint |
568
- **page** | **Integer**| Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. | [optional]
569
- **page_size** | **Integer**| Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. | [optional]
570
- **task_ids** | **String**| taskIdsSearch for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds&#x3D;{taskId},{taskId} | [optional]
571
-
572
- ### Return type
573
-
574
- [**Tasks**](Tasks.md)
575
-
576
- ### Authorization
577
-
578
- [OAuth2](../README.md#OAuth2)
579
-
580
- ### HTTP request headers
581
-
582
- - **Content-Type**: Not defined
583
- - **Accept**: application/json
584
-
585
-
586
- ## get_time_entries
587
-
588
- > TimeEntries get_time_entries(xero_tenant_id, project_id, opts)
589
-
590
- Allows you to retrieve the time entries associated with a specific project
591
-
592
- Allows you to retrieve the time entries associated with a specific project
593
-
594
- ### Example
595
-
596
- ```ruby
597
- # load the gem
598
- require 'xero-ruby'
599
-
600
- creds = {
601
- client_id: ENV['CLIENT_ID'],
602
- client_secret: ENV['CLIENT_SECRET'],
603
- redirect_uri: ENV['REDIRECT_URI'],
604
- scopes: ENV['SCOPES']
605
- }
606
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
607
-
608
- token_set = fetch_valid_token_set(user) # example
609
-
610
- xero_client.refresh_token_set(token_set)
611
-
612
- # You need to namespace your api method call to one of the following api sets
613
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
614
-
615
- api_instance = xero_client.<api_set>
616
-
617
-
618
-
619
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
620
- project_id = 'project_id_example' # String | Identifier of the project, that the task (which the time entry is logged against) belongs to.
621
- opts = {
622
- user_id: 'user_id_example', # String | The xero user identifier of the person who logged time.
623
-
624
- task_id: 'task_id_example', # String | Identifier of the task that time entry is logged against.
625
-
626
- invoice_id: 'invoice_id_example', # String | Finds all time entries for this invoice.
627
-
628
- contact_id: 'contact_id_example', # String | Finds all time entries for this contact identifier.
629
-
630
- page: 1, # Integer | Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0.
631
-
632
- page_size: 10, # Integer | Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500.
633
-
634
- states: ['states_example'], # Array<String> | Comma-separated list of states to find. Will find all time entries that are in the status of whatever’s specified.
635
-
636
- is_chargeable: true, # Boolean | Finds all time entries which relate to tasks with the charge type `TIME` or `FIXED`.
637
-
638
- date_after_utc: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | ISO 8601 UTC date. Finds all time entries on or after this date filtered on the `dateUtc` field.
639
-
640
- date_before_utc: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | ISO 8601 UTC date. Finds all time entries on or before this date filtered on the `dateUtc` field.
641
- }
642
-
643
- begin
644
- #Allows you to retrieve the time entries associated with a specific project
645
- result = api_instance.get_time_entries(xero_tenant_id, project_id, opts)
646
- p result
647
- rescue XeroRuby::Projects::ApiError => e
648
- puts "Exception when calling ProjectApi->get_time_entries: #{e}"
649
- end
650
- ```
651
-
652
- ### Parameters
653
-
654
-
655
- Name | Type | Description | Notes
656
- ------------- | ------------- | ------------- | -------------
657
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
658
- **project_id** | [**String**](.md)| Identifier of the project, that the task (which the time entry is logged against) belongs to. |
659
- **user_id** | [**String**](.md)| The xero user identifier of the person who logged time. | [optional]
660
- **task_id** | [**String**](.md)| Identifier of the task that time entry is logged against. | [optional]
661
- **invoice_id** | [**String**](.md)| Finds all time entries for this invoice. | [optional]
662
- **contact_id** | [**String**](.md)| Finds all time entries for this contact identifier. | [optional]
663
- **page** | **Integer**| Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0. | [optional]
664
- **page_size** | **Integer**| Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500. | [optional]
665
- **states** | [**Array&lt;String&gt;**](String.md)| Comma-separated list of states to find. Will find all time entries that are in the status of whatever’s specified. | [optional]
666
- **is_chargeable** | **Boolean**| Finds all time entries which relate to tasks with the charge type &#x60;TIME&#x60; or &#x60;FIXED&#x60;. | [optional]
667
- **date_after_utc** | **DateTime**| ISO 8601 UTC date. Finds all time entries on or after this date filtered on the &#x60;dateUtc&#x60; field. | [optional]
668
- **date_before_utc** | **DateTime**| ISO 8601 UTC date. Finds all time entries on or before this date filtered on the &#x60;dateUtc&#x60; field. | [optional]
669
-
670
- ### Return type
671
-
672
- [**TimeEntries**](TimeEntries.md)
673
-
674
- ### Authorization
675
-
676
- [OAuth2](../README.md#OAuth2)
677
-
678
- ### HTTP request headers
679
-
680
- - **Content-Type**: Not defined
681
- - **Accept**: application/json
682
-
683
-
684
- ## get_time_entry
685
-
686
- > TimeEntry get_time_entry(xero_tenant_id, project_id, time_entry_id)
687
-
688
- Allows you to get a single time entry in a project
689
-
690
- Allows you to upget a single time entry in a project
691
-
692
- ### Example
693
-
694
- ```ruby
695
- # load the gem
696
- require 'xero-ruby'
697
-
698
- creds = {
699
- client_id: ENV['CLIENT_ID'],
700
- client_secret: ENV['CLIENT_SECRET'],
701
- redirect_uri: ENV['REDIRECT_URI'],
702
- scopes: ENV['SCOPES']
703
- }
704
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
705
-
706
- token_set = fetch_valid_token_set(user) # example
707
-
708
- xero_client.refresh_token_set(token_set)
709
-
710
- # You need to namespace your api method call to one of the following api sets
711
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
712
-
713
- api_instance = xero_client.<api_set>
714
-
715
-
716
-
717
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
718
- project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint
719
- time_entry_id = 'time_entry_id_example' # String | You can specify an individual time entry by appending the id to the endpoint
720
- begin
721
- #Allows you to get a single time entry in a project
722
- result = api_instance.get_time_entry(xero_tenant_id, project_id, time_entry_id)
723
- p result
724
- rescue XeroRuby::Projects::ApiError => e
725
- puts "Exception when calling ProjectApi->get_time_entry: #{e}"
726
- end
727
- ```
728
-
729
- ### Parameters
730
-
731
-
732
- Name | Type | Description | Notes
733
- ------------- | ------------- | ------------- | -------------
734
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
735
- **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint |
736
- **time_entry_id** | [**String**](.md)| You can specify an individual time entry by appending the id to the endpoint |
737
-
738
- ### Return type
739
-
740
- [**TimeEntry**](TimeEntry.md)
741
-
742
- ### Authorization
743
-
744
- [OAuth2](../README.md#OAuth2)
745
-
746
- ### HTTP request headers
747
-
748
- - **Content-Type**: Not defined
749
- - **Accept**: application/json
750
-
751
-
752
- ## patch_project
753
-
754
- > patch_project(xero_tenant_id, project_id, project_patch)
755
-
756
- creates a project for the specified contact
757
-
758
- Allows you to update a specific projects.
759
-
760
- ### Example
761
-
762
- ```ruby
763
- # load the gem
764
- require 'xero-ruby'
765
-
766
- creds = {
767
- client_id: ENV['CLIENT_ID'],
768
- client_secret: ENV['CLIENT_SECRET'],
769
- redirect_uri: ENV['REDIRECT_URI'],
770
- scopes: ENV['SCOPES']
771
- }
772
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
773
-
774
- token_set = fetch_valid_token_set(user) # example
775
-
776
- xero_client.refresh_token_set(token_set)
777
-
778
- # You need to namespace your api method call to one of the following api sets
779
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
780
-
781
- api_instance = xero_client.<api_set>
782
-
783
-
784
-
785
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
786
- project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint
787
- project_patch = { "status": "INPROGRESS" } # ProjectPatch | Update the status of an existing Project
788
- begin
789
- #creates a project for the specified contact
790
- api_instance.patch_project(xero_tenant_id, project_id, project_patch)
791
- rescue XeroRuby::Projects::ApiError => e
792
- puts "Exception when calling ProjectApi->patch_project: #{e}"
793
- end
794
- ```
795
-
796
- ### Parameters
797
-
798
-
799
- Name | Type | Description | Notes
800
- ------------- | ------------- | ------------- | -------------
801
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
802
- **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint |
803
- **project_patch** | [**ProjectPatch**](ProjectPatch.md)| Update the status of an existing Project |
804
-
805
- ### Return type
806
-
807
- nil (empty response body)
808
-
809
- ### Authorization
810
-
811
- [OAuth2](../README.md#OAuth2)
812
-
813
- ### HTTP request headers
814
-
815
- - **Content-Type**: application/json
816
- - **Accept**: application/json
817
-
818
-
819
- ## update_project
820
-
821
- > update_project(xero_tenant_id, project_id, project_create_or_update)
822
-
823
- update a specific project
824
-
825
- Allows you to update a specific projects.
826
-
827
- ### Example
828
-
829
- ```ruby
830
- # load the gem
831
- require 'xero-ruby'
832
-
833
- creds = {
834
- client_id: ENV['CLIENT_ID'],
835
- client_secret: ENV['CLIENT_SECRET'],
836
- redirect_uri: ENV['REDIRECT_URI'],
837
- scopes: ENV['SCOPES']
838
- }
839
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
840
-
841
- token_set = fetch_valid_token_set(user) # example
842
-
843
- xero_client.refresh_token_set(token_set)
844
-
845
- # You need to namespace your api method call to one of the following api sets
846
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
847
-
848
- api_instance = xero_client.<api_set>
849
-
850
-
851
-
852
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
853
- project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint
854
- project_create_or_update = { "name": "New Kitchen", "deadlineUtc": "2017-04-23T18:25:43.511Z", "estimateAmount": 99.99 } # ProjectCreateOrUpdate | Request of type ProjectCreateOrUpdate
855
- begin
856
- #update a specific project
857
- api_instance.update_project(xero_tenant_id, project_id, project_create_or_update)
858
- rescue XeroRuby::Projects::ApiError => e
859
- puts "Exception when calling ProjectApi->update_project: #{e}"
860
- end
861
- ```
862
-
863
- ### Parameters
864
-
865
-
866
- Name | Type | Description | Notes
867
- ------------- | ------------- | ------------- | -------------
868
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
869
- **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint |
870
- **project_create_or_update** | [**ProjectCreateOrUpdate**](ProjectCreateOrUpdate.md)| Request of type ProjectCreateOrUpdate |
871
-
872
- ### Return type
873
-
874
- nil (empty response body)
875
-
876
- ### Authorization
877
-
878
- [OAuth2](../README.md#OAuth2)
879
-
880
- ### HTTP request headers
881
-
882
- - **Content-Type**: application/json
883
- - **Accept**: application/json
884
-
885
-
886
- ## update_time_entry
887
-
888
- > update_time_entry(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update)
889
-
890
- Allows you to update time entry in a project
891
-
892
- Allows you to update time entry in a project
893
-
894
- ### Example
895
-
896
- ```ruby
897
- # load the gem
898
- require 'xero-ruby'
899
-
900
- creds = {
901
- client_id: ENV['CLIENT_ID'],
902
- client_secret: ENV['CLIENT_SECRET'],
903
- redirect_uri: ENV['REDIRECT_URI'],
904
- scopes: ENV['SCOPES']
905
- }
906
- xero_client = XeroRuby::ApiClient.new(credentials: creds)
907
-
908
- token_set = fetch_valid_token_set(user) # example
909
-
910
- xero_client.refresh_token_set(token_set)
911
-
912
- # You need to namespace your api method call to one of the following api sets
913
- # [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api]
914
-
915
- api_instance = xero_client.<api_set>
916
-
917
-
918
-
919
- xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
920
- project_id = 'project_id_example' # String | You can specify an individual project by appending the projectId to the endpoint
921
- time_entry_id = 'time_entry_id_example' # String | You can specify an individual time entry by appending the id to the endpoint
922
- time_entry_create_or_update = { "userId":"740add2a-a703-4b8a-a670-1093919c2040", "taskId":"7be77337-feec-4458-bb1b-dbaa5a4aafce", "dateUtc":"2020-02-27T15:00:00Z", "duration":45, "description":"My UPDATED description" } # TimeEntryCreateOrUpdate | The time entry object you are updating
923
- begin
924
- #Allows you to update time entry in a project
925
- api_instance.update_time_entry(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update)
926
- rescue XeroRuby::Projects::ApiError => e
927
- puts "Exception when calling ProjectApi->update_time_entry: #{e}"
928
- end
929
- ```
930
-
931
- ### Parameters
932
-
933
-
934
- Name | Type | Description | Notes
935
- ------------- | ------------- | ------------- | -------------
936
- **xero_tenant_id** | **String**| Xero identifier for Tenant |
937
- **project_id** | [**String**](.md)| You can specify an individual project by appending the projectId to the endpoint |
938
- **time_entry_id** | [**String**](.md)| You can specify an individual time entry by appending the id to the endpoint |
939
- **time_entry_create_or_update** | [**TimeEntryCreateOrUpdate**](TimeEntryCreateOrUpdate.md)| The time entry object you are updating |
940
-
941
- ### Return type
942
-
943
- nil (empty response body)
944
-
945
- ### Authorization
946
-
947
- [OAuth2](../README.md#OAuth2)
948
-
949
- ### HTTP request headers
950
-
951
- - **Content-Type**: application/json
952
- - **Accept**: Not defined
953
-