xero-ruby 3.2.1 → 3.6.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (229) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +70 -1
  3. data/lib/xero-ruby/api/accounting_api.rb +11 -2
  4. data/lib/xero-ruby/api/app_store_api.rb +87 -0
  5. data/lib/xero-ruby/api/finance_api.rb +866 -0
  6. data/lib/xero-ruby/api/payroll_au_api.rb +14 -14
  7. data/lib/xero-ruby/api/payroll_nz_api.rb +18 -12
  8. data/lib/xero-ruby/api/payroll_uk_api.rb +14 -2
  9. data/lib/xero-ruby/api_client.rb +21 -3
  10. data/lib/xero-ruby/configuration.rb +4 -0
  11. data/lib/xero-ruby/models/accounting/account.rb +34 -34
  12. data/lib/xero-ruby/models/accounting/account_type.rb +22 -22
  13. data/lib/xero-ruby/models/accounting/action.rb +2 -2
  14. data/lib/xero-ruby/models/accounting/address.rb +2 -2
  15. data/lib/xero-ruby/models/accounting/address_for_organisation.rb +3 -3
  16. data/lib/xero-ruby/models/accounting/bank_transaction.rb +11 -11
  17. data/lib/xero-ruby/models/accounting/bank_transfer.rb +35 -1
  18. data/lib/xero-ruby/models/accounting/batch_payment.rb +4 -4
  19. data/lib/xero-ruby/models/accounting/branding_theme.rb +1 -1
  20. data/lib/xero-ruby/models/accounting/budget.rb +2 -2
  21. data/lib/xero-ruby/models/accounting/budget_balance.rb +2 -2
  22. data/lib/xero-ruby/models/accounting/contact.rb +89 -4
  23. data/lib/xero-ruby/models/accounting/contact_group.rb +2 -2
  24. data/lib/xero-ruby/models/accounting/country_code.rb +240 -240
  25. data/lib/xero-ruby/models/accounting/credit_note.rb +8 -8
  26. data/lib/xero-ruby/models/accounting/currency_code.rb +166 -166
  27. data/lib/xero-ruby/models/accounting/employee.rb +4 -4
  28. data/lib/xero-ruby/models/accounting/expense_claim.rb +5 -5
  29. data/lib/xero-ruby/models/accounting/external_link.rb +5 -5
  30. data/lib/xero-ruby/models/accounting/invoice.rb +14 -14
  31. data/lib/xero-ruby/models/accounting/journal.rb +25 -25
  32. data/lib/xero-ruby/models/accounting/line_amount_types.rb +3 -3
  33. data/lib/xero-ruby/models/accounting/linked_transaction.rb +8 -8
  34. data/lib/xero-ruby/models/accounting/manual_journal.rb +5 -5
  35. data/lib/xero-ruby/models/accounting/organisation.rb +70 -70
  36. data/lib/xero-ruby/models/accounting/overpayment.rb +6 -6
  37. data/lib/xero-ruby/models/accounting/payment.rb +21 -11
  38. data/lib/xero-ruby/models/accounting/payment_term_type.rb +4 -4
  39. data/lib/xero-ruby/models/accounting/phone.rb +5 -5
  40. data/lib/xero-ruby/models/accounting/prepayment.rb +7 -7
  41. data/lib/xero-ruby/models/accounting/purchase_order.rb +5 -5
  42. data/lib/xero-ruby/models/accounting/quote_line_amount_types.rb +3 -3
  43. data/lib/xero-ruby/models/accounting/quote_status_codes.rb +6 -6
  44. data/lib/xero-ruby/models/accounting/receipt.rb +5 -5
  45. data/lib/xero-ruby/models/accounting/repeating_invoice.rb +5 -5
  46. data/lib/xero-ruby/models/accounting/report.rb +1 -1
  47. data/lib/xero-ruby/models/accounting/row_type.rb +4 -4
  48. data/lib/xero-ruby/models/accounting/schedule.rb +8 -8
  49. data/lib/xero-ruby/models/accounting/tax_rate.rb +78 -78
  50. data/lib/xero-ruby/models/accounting/tax_type.rb +59 -59
  51. data/lib/xero-ruby/models/accounting/time_zone.rb +109 -108
  52. data/lib/xero-ruby/models/accounting/tracking_category.rb +3 -3
  53. data/lib/xero-ruby/models/accounting/tracking_option.rb +3 -3
  54. data/lib/xero-ruby/models/accounting/user.rb +7 -7
  55. data/lib/xero-ruby/models/app_store/plan.rb +311 -0
  56. data/lib/xero-ruby/models/app_store/price.rb +257 -0
  57. data/lib/xero-ruby/models/app_store/problem_details.rb +272 -0
  58. data/lib/xero-ruby/models/app_store/product.rb +288 -0
  59. data/lib/xero-ruby/models/app_store/subscription.rb +361 -0
  60. data/lib/xero-ruby/models/app_store/subscription_item.rb +344 -0
  61. data/lib/xero-ruby/models/assets/asset_status.rb +3 -3
  62. data/lib/xero-ruby/models/assets/asset_status_query_param.rb +3 -3
  63. data/lib/xero-ruby/models/assets/book_depreciation_setting.rb +11 -11
  64. data/lib/xero-ruby/models/files/object_group.rb +12 -11
  65. data/lib/xero-ruby/models/files/object_type.rb +56 -55
  66. data/lib/xero-ruby/models/finance/account_usage.rb +342 -0
  67. data/lib/xero-ruby/models/finance/account_usage_response.rb +254 -0
  68. data/lib/xero-ruby/models/finance/balance_sheet_account_detail.rb +262 -0
  69. data/lib/xero-ruby/models/finance/balance_sheet_account_group.rb +234 -0
  70. data/lib/xero-ruby/models/finance/balance_sheet_account_type.rb +244 -0
  71. data/lib/xero-ruby/models/finance/balance_sheet_response.rb +252 -0
  72. data/lib/xero-ruby/models/finance/bank_statement_response.rb +232 -0
  73. data/lib/xero-ruby/models/finance/cash_account_response.rb +262 -0
  74. data/lib/xero-ruby/models/finance/cash_balance.rb +242 -0
  75. data/lib/xero-ruby/models/finance/cash_validation_response.rb +262 -0
  76. data/lib/xero-ruby/models/finance/cashflow_account.rb +282 -0
  77. data/lib/xero-ruby/models/finance/cashflow_activity.rb +244 -0
  78. data/lib/xero-ruby/models/finance/cashflow_response.rb +254 -0
  79. data/lib/xero-ruby/models/finance/cashflow_type.rb +244 -0
  80. data/lib/xero-ruby/models/finance/contact_detail.rb +274 -0
  81. data/lib/xero-ruby/models/finance/contact_total_detail.rb +242 -0
  82. data/lib/xero-ruby/models/finance/contact_total_other.rb +252 -0
  83. data/lib/xero-ruby/models/finance/current_statement_response.rb +272 -0
  84. data/lib/xero-ruby/models/finance/data_source_response.rb +362 -0
  85. data/lib/xero-ruby/models/finance/history_record_response.rb +262 -0
  86. data/lib/xero-ruby/models/finance/income_by_contact_response.rb +284 -0
  87. data/lib/xero-ruby/models/finance/lock_history_model.rb +242 -0
  88. data/lib/xero-ruby/models/finance/lock_history_response.rb +244 -0
  89. data/lib/xero-ruby/models/finance/manual_journal_total.rb +222 -0
  90. data/lib/xero-ruby/models/finance/pnl_account.rb +272 -0
  91. data/lib/xero-ruby/models/finance/pnl_account_class.rb +234 -0
  92. data/lib/xero-ruby/models/finance/pnl_account_type.rb +244 -0
  93. data/lib/xero-ruby/models/finance/practice_response.rb +262 -0
  94. data/lib/xero-ruby/models/finance/problem.rb +252 -0
  95. data/lib/xero-ruby/models/finance/problem_type.rb +39 -0
  96. data/lib/xero-ruby/models/finance/profit_and_loss_response.rb +262 -0
  97. data/lib/xero-ruby/models/finance/report_history_model.rb +242 -0
  98. data/lib/xero-ruby/models/finance/report_history_response.rb +244 -0
  99. data/lib/xero-ruby/models/finance/statement_balance_response.rb +232 -0
  100. data/lib/xero-ruby/models/finance/statement_lines_response.rb +382 -0
  101. data/lib/xero-ruby/models/finance/total_detail.rb +242 -0
  102. data/lib/xero-ruby/models/finance/total_other.rb +242 -0
  103. data/lib/xero-ruby/models/finance/trial_balance_account.rb +312 -0
  104. data/lib/xero-ruby/models/finance/trial_balance_entry.rb +232 -0
  105. data/lib/xero-ruby/models/finance/trial_balance_movement.rb +252 -0
  106. data/lib/xero-ruby/models/finance/trial_balance_response.rb +244 -0
  107. data/lib/xero-ruby/models/finance/user_activities_response.rb +244 -0
  108. data/lib/xero-ruby/models/finance/user_response.rb +336 -0
  109. data/lib/xero-ruby/models/payroll_au/account_type.rb +23 -23
  110. data/lib/xero-ruby/models/payroll_au/allowance_category.rb +41 -0
  111. data/lib/xero-ruby/models/payroll_au/allowance_type.rb +10 -7
  112. data/lib/xero-ruby/models/payroll_au/calendar_type.rb +6 -6
  113. data/lib/xero-ruby/models/payroll_au/deduction_type.rb +3 -3
  114. data/lib/xero-ruby/models/payroll_au/deduction_type_calculation_type.rb +3 -3
  115. data/lib/xero-ruby/models/payroll_au/earnings_rate.rb +14 -4
  116. data/lib/xero-ruby/models/payroll_au/earnings_rate_calculation_type.rb +3 -3
  117. data/lib/xero-ruby/models/payroll_au/earnings_type.rb +12 -10
  118. data/lib/xero-ruby/models/payroll_au/employee.rb +34 -5
  119. data/lib/xero-ruby/models/payroll_au/employee_status.rb +2 -2
  120. data/lib/xero-ruby/models/payroll_au/employment_basis.rb +5 -5
  121. data/lib/xero-ruby/models/payroll_au/employment_termination_payment_type.rb +2 -2
  122. data/lib/xero-ruby/models/payroll_au/entitlement_final_pay_payout_type.rb +2 -2
  123. data/lib/xero-ruby/models/payroll_au/leave_line_calculation_type.rb +5 -5
  124. data/lib/xero-ruby/models/payroll_au/leave_period_status.rb +2 -2
  125. data/lib/xero-ruby/models/payroll_au/leave_type_contribution_type.rb +4 -4
  126. data/lib/xero-ruby/models/payroll_au/manual_tax_type.rb +6 -5
  127. data/lib/xero-ruby/models/payroll_au/pay_run_status.rb +2 -2
  128. data/lib/xero-ruby/models/payroll_au/payment_frequency_type.rb +7 -7
  129. data/lib/xero-ruby/models/payroll_au/payroll_calendar.rb +11 -1
  130. data/lib/xero-ruby/models/payroll_au/rate_type.rb +3 -3
  131. data/lib/xero-ruby/models/payroll_au/residency_status.rb +3 -3
  132. data/lib/xero-ruby/models/payroll_au/state.rb +8 -8
  133. data/lib/xero-ruby/models/payroll_au/super_fund_type.rb +2 -2
  134. data/lib/xero-ruby/models/payroll_au/superannuation_calculation_type.rb +3 -3
  135. data/lib/xero-ruby/models/payroll_au/superannuation_contribution_type.rb +4 -4
  136. data/lib/xero-ruby/models/payroll_au/tfn_exemption_type.rb +4 -4
  137. data/lib/xero-ruby/models/payroll_au/timesheet_status.rb +5 -5
  138. data/lib/xero-ruby/models/payroll_nz/account.rb +4 -4
  139. data/lib/xero-ruby/models/payroll_nz/bank_account.rb +2 -2
  140. data/lib/xero-ruby/models/payroll_nz/benefit.rb +5 -5
  141. data/lib/xero-ruby/models/payroll_nz/calendar_type.rb +7 -7
  142. data/lib/xero-ruby/models/payroll_nz/deduction.rb +4 -4
  143. data/lib/xero-ruby/models/payroll_nz/earnings_rate.rb +18 -18
  144. data/lib/xero-ruby/models/payroll_nz/employee.rb +2 -2
  145. data/lib/xero-ruby/models/payroll_nz/employee_leave_type.rb +4 -4
  146. data/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_balance.rb +6 -6
  147. data/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_summary.rb +8 -8
  148. data/lib/xero-ruby/models/payroll_nz/employee_tax.rb +5 -5
  149. data/lib/xero-ruby/models/payroll_nz/leave_period.rb +2 -2
  150. data/lib/xero-ruby/models/payroll_nz/pay_run.rb +5 -5
  151. data/lib/xero-ruby/models/payroll_nz/pay_slip.rb +3 -3
  152. data/lib/xero-ruby/models/payroll_nz/payment_method.rb +3 -3
  153. data/lib/xero-ruby/models/payroll_nz/reimbursement.rb +8 -8
  154. data/lib/xero-ruby/models/payroll_nz/salary_and_wage.rb +5 -5
  155. data/lib/xero-ruby/models/payroll_nz/statutory_deduction_category.rb +11 -11
  156. data/lib/xero-ruby/models/payroll_nz/tax_code.rb +19 -19
  157. data/lib/xero-ruby/models/payroll_nz/tax_settings.rb +2 -2
  158. data/lib/xero-ruby/models/payroll_nz/timesheet.rb +4 -4
  159. data/lib/xero-ruby/models/payroll_uk/account.rb +7 -7
  160. data/lib/xero-ruby/models/payroll_uk/benefit.rb +4 -4
  161. data/lib/xero-ruby/models/payroll_uk/deduction.rb +12 -12
  162. data/lib/xero-ruby/models/payroll_uk/earnings_rate.rb +28 -28
  163. data/lib/xero-ruby/models/payroll_uk/employee.rb +2 -2
  164. data/lib/xero-ruby/models/payroll_uk/employee_leave_type.rb +4 -4
  165. data/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_balance.rb +6 -6
  166. data/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_summary.rb +8 -8
  167. data/lib/xero-ruby/models/payroll_uk/employment.rb +8 -8
  168. data/lib/xero-ruby/models/payroll_uk/leave_period.rb +2 -2
  169. data/lib/xero-ruby/models/payroll_uk/pay_run.rb +11 -11
  170. data/lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb +6 -6
  171. data/lib/xero-ruby/models/payroll_uk/payment_method.rb +3 -3
  172. data/lib/xero-ruby/models/payroll_uk/payslip.rb +3 -3
  173. data/lib/xero-ruby/models/payroll_uk/salary_and_wage.rb +5 -5
  174. data/lib/xero-ruby/models/payroll_uk/statutory_deduction_category.rb +14 -14
  175. data/lib/xero-ruby/models/payroll_uk/timesheet.rb +3 -3
  176. data/lib/xero-ruby/models/projects/charge_type.rb +3 -3
  177. data/lib/xero-ruby/models/projects/currency_code.rb +164 -164
  178. data/lib/xero-ruby/models/projects/project_status.rb +2 -2
  179. data/lib/xero-ruby/models/projects/task.rb +3 -3
  180. data/lib/xero-ruby/models/projects/time_entry.rb +3 -3
  181. data/lib/xero-ruby/version.rb +2 -2
  182. data/lib/xero-ruby.rb +52 -0
  183. data/spec/api_client_spec.rb +3 -0
  184. data/spec/app_store/api/app_store_api_spec.rb +45 -0
  185. data/spec/app_store/models/plan_spec.rb +62 -0
  186. data/spec/app_store/models/price_spec.rb +52 -0
  187. data/spec/app_store/models/problem_details_spec.rb +70 -0
  188. data/spec/app_store/models/product_spec.rb +56 -0
  189. data/spec/app_store/models/subscription_item_spec.rb +70 -0
  190. data/spec/app_store/models/subscription_spec.rb +82 -0
  191. data/spec/configuration_spec.rb +1 -0
  192. data/spec/finance/api/finance_api_spec.rb +156 -0
  193. data/spec/finance/models/account_usage_response_spec.rb +58 -0
  194. data/spec/finance/models/account_usage_spec.rb +112 -0
  195. data/spec/finance/models/balance_sheet_account_detail_spec.rb +64 -0
  196. data/spec/finance/models/balance_sheet_account_group_spec.rb +46 -0
  197. data/spec/finance/models/balance_sheet_account_type_spec.rb +52 -0
  198. data/spec/finance/models/balance_sheet_response_spec.rb +58 -0
  199. data/spec/finance/models/bank_statement_response_spec.rb +46 -0
  200. data/spec/finance/models/cash_account_response_spec.rb +64 -0
  201. data/spec/finance/models/cash_balance_spec.rb +52 -0
  202. data/spec/finance/models/cash_validation_response_spec.rb +64 -0
  203. data/spec/finance/models/cashflow_account_spec.rb +76 -0
  204. data/spec/finance/models/cashflow_activity_spec.rb +52 -0
  205. data/spec/finance/models/cashflow_response_spec.rb +58 -0
  206. data/spec/finance/models/cashflow_type_spec.rb +52 -0
  207. data/spec/finance/models/current_statement_response_spec.rb +70 -0
  208. data/spec/finance/models/data_source_response_spec.rb +124 -0
  209. data/spec/finance/models/history_record_response_spec.rb +64 -0
  210. data/spec/finance/models/lock_history_model_spec.rb +52 -0
  211. data/spec/finance/models/lock_history_response_spec.rb +52 -0
  212. data/spec/finance/models/pnl_account_class_spec.rb +46 -0
  213. data/spec/finance/models/pnl_account_spec.rb +70 -0
  214. data/spec/finance/models/pnl_account_type_spec.rb +52 -0
  215. data/spec/finance/models/practice_response_spec.rb +64 -0
  216. data/spec/finance/models/problem_spec.rb +58 -0
  217. data/spec/finance/models/problem_type_spec.rb +34 -0
  218. data/spec/finance/models/profit_and_loss_response_spec.rb +64 -0
  219. data/spec/finance/models/report_history_model_spec.rb +52 -0
  220. data/spec/finance/models/report_history_response_spec.rb +52 -0
  221. data/spec/finance/models/statement_balance_response_spec.rb +46 -0
  222. data/spec/finance/models/statement_lines_response_spec.rb +136 -0
  223. data/spec/finance/models/trial_balance_account_spec.rb +94 -0
  224. data/spec/finance/models/trial_balance_entry_spec.rb +46 -0
  225. data/spec/finance/models/trial_balance_movement_spec.rb +58 -0
  226. data/spec/finance/models/trial_balance_response_spec.rb +52 -0
  227. data/spec/finance/models/user_activities_response_spec.rb +52 -0
  228. data/spec/finance/models/user_response_spec.rb +106 -0
  229. metadata +143 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fcc8e88d077eb5b42f9a9c8a206ce6c7fb62589e7179932764a70cc28c3f821a
4
- data.tar.gz: 8c25945749aaca49892462186f749701255022d05ea498645a3b1e59c10a5e52
3
+ metadata.gz: 471817aae937985bd56abe5d70a1e3d078c24e2d87971205e30c1583a05c3e37
4
+ data.tar.gz: 70990d160ea9bdaac183acd06eaab41e0b680525b386b2c1411cf33ec3fbef9a
5
5
  SHA512:
6
- metadata.gz: 4196ec14ceaa6179bbbedb856b447e7af947ba96e4af24ab8130835af5660a8e6787fbf3261c3f6c5c605d0f81436559bd37e1e0a7252bab42feb752f4634d31
7
- data.tar.gz: c99e89b1f45563b72023ad5d5ceb3632fe5661068ad5ee89d672194fca72ddccbb1967d9f9796098d12ff9b649f03dfa5b26d3eb08b3daf756bef0e3a7f3fe5f
6
+ metadata.gz: 5f47679440b82e924e68da60d26fbb6d7062c47ef026272be763740ad826392781d7dd260a04b5e139d09de2a54336c0602c51746df819554e2a625f8fdf7dbd
7
+ data.tar.gz: 353ca2bcb1d9395d5d68fdb3474ab1c86f54f9474bd8b5135616c3469173683c927d2bea4cfd5a457dae2ab1ee4caf34ff6c9adac81c7f219e8dba3e4f1298fe
data/README.md CHANGED
@@ -4,7 +4,7 @@
4
4
  [![Github stars](https://img.shields.io/github/stars/XeroAPI/xero-ruby.svg)](https://github.com/XeroAPI/xero-ruby/stargazers)
5
5
  ![total downloads](https://ruby-gem-downloads-badge.herokuapp.com/xero-ruby?type=total)
6
6
 
7
- The xero-ruby SDK makes it easy for developers to access Xero's APIs in their Ruby code, and build robust applications and software using small business & general ledget accounting data.
7
+ The xero-ruby SDK makes it easy for developers to access Xero's APIs in their Ruby code, and build robust applications and software using small business & general ledger accounting data.
8
8
  # Table of Contents
9
9
  - [API Client documentation](#api-client-documentation)
10
10
  - [Sample Applications](#sample-applications)
@@ -13,6 +13,7 @@ The xero-ruby SDK makes it easy for developers to access Xero's APIs in their Ru
13
13
  - [Configuration](#configuration)
14
14
  - [Authentication](#authentication)
15
15
  - [Custom Connections](#custom-connections)
16
+ - [App Store Subscriptions](#app-store-subscriptions)
16
17
  - [API Clients](#api-clients)
17
18
  - [Helper Methods](#helper-methods)
18
19
  - [Usage Examples](#usage-examples)
@@ -46,6 +47,7 @@ Sample apps can get you started quickly with simple auth flows to advanced usage
46
47
  | [`xero-ruby-oauth2-starter`](https://github.com/XeroAPI/Xero-ruby-oauth2-starter) | A Sinatra application showing the basic getting started code to work with the sdk | <img src="https://i.imgur.com/9H4F98M.png" alt="drawing" width="300"/>
47
48
  | [`xero-ruby-oauth2-app`](https://github.com/XeroAPI/Xero-ruby-oauth2-app) | Complete rails app with +95% of api set examples, complex filters, pagination, and user/token management in postgres | <img src="https://i.imgur.com/XsAp9Ww.png" alt="drawing" width="500"/>
48
49
  | [`xero-ruby-custom-connections-starter`](https://github.com/XeroAPI/xero-ruby-custom-connections-starter) | A getting started Sinatra app showing Custom Connections - a Xero [premium option](https://developer.xero.com/documentation/oauth2/custom-connections) for building M2M integrations to a single org | <img src="https://i.imgur.com/YEkScui.png" alt="drawing" width="300"/>
50
+ | [`xero-ruby-sso-form`](https://github.com/XeroAPI/xero-ruby-sso-form) | A basic Sinatra app showing how to implement SSU to Lead | <img src="https://i.imgur.com/Nf95GVd.png" alt="drawing" width="300"/>
49
51
 
50
52
  <hr>
51
53
 
@@ -155,6 +157,73 @@ Because Custom Connections are only valid for a single organisation you don't ne
155
157
  However - due to the nature of how our SDK's are generated from our OpenAPI spec, the parameter remains which requires you to pass an empty string for now to use the SDK with a Custom Connection.
156
158
 
157
159
  ---
160
+
161
+ ## App Store Subscriptions
162
+
163
+ If you are implementing subscriptions to participate in Xero's App Store you will need to setup [App Store subscriptions](https://developer.xero.com/documentation/guides/how-to-guides/xero-app-store-referrals/) endpoints.
164
+
165
+ When a plan is successfully purchased, the user is redirected back to the URL specified in the setup process. The Xero App Store appends the subscription Id to this URL so you can immediately determine what plan the user has subscribed to through the subscriptions API.
166
+
167
+ With your app credentials you can create a client via `client_credentials` grant_type with the `marketplace.billing` scope. This unique access_token will allow you to query any functions in `appStoreApi`. Client Credentials tokens to query app store endpoints will only work for apps that have completed the App Store on-boarding process.
168
+
169
+ ```ruby
170
+ // => /post-purchase-url?subscriptionId=03bc74f2-1237-4477-b782-2dfb1a6d8b21
171
+
172
+ subscription_id = params[:subscriptionId]
173
+
174
+ xero_app_store_client ||= XeroRuby::ApiClient.new(credentials: {
175
+ client_id: ENV['CLIENT_ID'],
176
+ client_secret: ENV['CLIENT_SECRET'],
177
+ grant_type: 'client_credentials'
178
+ scopes: ['marketplace.billing']
179
+ })
180
+
181
+ xero_app_store_client.get_client_credentials_token
182
+
183
+ @subscription = xero_app_store_client.app_store_api.get_subscription(subscription_id)
184
+
185
+ puts @subscription.to_attributes
186
+ {
187
+ :current_period_end => Thu, 02 Sep 2021 14:08:58 +0000,
188
+ :id => "03bc74f2-1237-4477-b782-2dfb1a6d8b21",
189
+ :organisation_id => "79e8b2e5-c63d-4dce-888f-e0f3e9eac647",
190
+ :plans => [
191
+ {
192
+ :id => "6abc26f3-9390-4194-8b25-ce8b9942fda9",
193
+ :name => "Small",
194
+ :status => "ACTIVE",
195
+ :subscription_items => [
196
+ {
197
+ :id => "834cff4c-b753-4de2-9e7a-3451e14fa17a",
198
+ :price => {
199
+ :amount => 0.1e0,
200
+ :currency => "NZD",
201
+ :id => "2310de92-c7c0-4bcb-b972-fb7612177bc7"
202
+ },
203
+ :product => {
204
+ :id => "9586421f-7325-4493-bac9-d93be06a6a38",
205
+ :name => "",
206
+ :type => "FIXED"
207
+ },
208
+ :start_date => Mon, 02 Aug 2021 14:08:58 +0000,
209
+ :test_mode => true
210
+ }
211
+ ]
212
+ }
213
+ ],
214
+ :start_date => Mon, 02 Aug 2021 14:08:58 +0000,
215
+ :status => "ACTIVE",
216
+ :test_mode => true
217
+ }
218
+ ```
219
+ You should use this subscription data to provision user access/permissions to your application.
220
+ ### App Store Subscription Webhooks
221
+
222
+ In additon to a subscription Id being passed through the URL, when a purchase or an upgrade takes place you will be notified via a webhook. You can then use the subscription Id in the webhook payload to query the AppStore endpoints and determine what plan the user purchased, upgraded, downgraded or cancelled.
223
+
224
+ Refer to Xero's documenation to learn more about setting up and receiving webhooks.
225
+ > https://developer.xero.com/documentation/guides/webhooks/overview/
226
+
158
227
  ## API Clients
159
228
  You can access the different API sets and their available methods through the following:
160
229
 
@@ -7018,20 +7018,24 @@ module XeroRuby
7018
7018
  return data, status_code, headers
7019
7019
  end
7020
7020
 
7021
- # Retrieves a specific budgets, which includes budget lines
7021
+ # Retrieves a specific budget, which includes budget lines
7022
7022
  # @param xero_tenant_id [String] Xero identifier for Tenant
7023
7023
  # @param budget_id [String] Unique identifier for Budgets
7024
7024
  # @param [Hash] opts the optional parameters
7025
+ # @option opts [Date] :date_to Filter by start date
7026
+ # @option opts [Date] :date_from Filter by end date
7025
7027
  # @return [Budgets]
7026
7028
  def get_budget(xero_tenant_id, budget_id, opts = {})
7027
7029
  data, _status_code, _headers = get_budget_with_http_info(xero_tenant_id, budget_id, opts)
7028
7030
  data
7029
7031
  end
7030
7032
 
7031
- # Retrieves a specific budgets, which includes budget lines
7033
+ # Retrieves a specific budget, which includes budget lines
7032
7034
  # @param xero_tenant_id [String] Xero identifier for Tenant
7033
7035
  # @param budget_id [String] Unique identifier for Budgets
7034
7036
  # @param [Hash] opts the optional parameters
7037
+ # @option opts [Date] :date_to Filter by start date
7038
+ # @option opts [Date] :date_from Filter by end date
7035
7039
  # @return [Array<(Budgets, Integer, Hash)>] Budgets data, response status code and response headers
7036
7040
  def get_budget_with_http_info(xero_tenant_id, budget_id, options = {})
7037
7041
  opts = options.dup
@@ -7054,6 +7058,8 @@ module XeroRuby
7054
7058
 
7055
7059
  # query parameters
7056
7060
  query_params = opts[:query_params] || {}
7061
+ query_params[:'DateTo'] = opts[:'date_to'] if !opts[:'date_to'].nil?
7062
+ query_params[:'DateFrom'] = opts[:'date_from'] if !opts[:'date_from'].nil?
7057
7063
 
7058
7064
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
7059
7065
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
@@ -7882,6 +7888,7 @@ module XeroRuby
7882
7888
  # @option opts [Integer] :page e.g. page&#x3D;1 - Up to 100 contacts will be returned in a single API call.
7883
7889
  # @option opts [Boolean] :include_archived e.g. includeArchived&#x3D;true - Contacts with a status of ARCHIVED will be included in the response
7884
7890
  # @option opts [Boolean] :summary_only Use summaryOnly&#x3D;true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (default to false)
7891
+ # @option opts [String] :search_term Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.
7885
7892
  # @return [Contacts]
7886
7893
  def get_contacts(xero_tenant_id, opts = {})
7887
7894
  data, _status_code, _headers = get_contacts_with_http_info(xero_tenant_id, opts)
@@ -7898,6 +7905,7 @@ module XeroRuby
7898
7905
  # @option opts [Integer] :page e.g. page&#x3D;1 - Up to 100 contacts will be returned in a single API call.
7899
7906
  # @option opts [Boolean] :include_archived e.g. includeArchived&#x3D;true - Contacts with a status of ARCHIVED will be included in the response
7900
7907
  # @option opts [Boolean] :summary_only Use summaryOnly&#x3D;true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.
7908
+ # @option opts [String] :search_term Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.
7901
7909
  # @return [Array<(Contacts, Integer, Hash)>] Contacts data, response status code and response headers
7902
7910
  def get_contacts_with_http_info(xero_tenant_id, options = {})
7903
7911
  opts = options.dup
@@ -7922,6 +7930,7 @@ module XeroRuby
7922
7930
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
7923
7931
  query_params[:'includeArchived'] = opts[:'include_archived'] if !opts[:'include_archived'].nil?
7924
7932
  query_params[:'summaryOnly'] = opts[:'summary_only'] if !opts[:'summary_only'].nil?
7933
+ query_params[:'searchTerm'] = opts[:'search_term'] if !opts[:'search_term'].nil?
7925
7934
 
7926
7935
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
7927
7936
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
@@ -0,0 +1,87 @@
1
+ =begin
2
+ #Xero AppStore API
3
+
4
+ #These endpoints are for Xero Partners to interact with the App Store Billing platform
5
+
6
+ Contact: api@xero.com
7
+ Generated by: https://openapi-generator.tech
8
+ OpenAPI Generator version: 4.3.1
9
+
10
+ =end
11
+
12
+ module XeroRuby
13
+ class AppStoreApi
14
+ attr_accessor :api_client
15
+
16
+ def initialize(api_client = ApiClient.new)
17
+ @api_client = api_client
18
+ end
19
+ # Retrieves a subscription for a given subscriptionId
20
+ # @param subscription_id [String] Unique identifier for Subscription object
21
+ # @param [Hash] opts the optional parameters
22
+ # @return [Subscription]
23
+ def get_subscription(subscription_id, opts = {})
24
+ data, _status_code, _headers = get_subscription_with_http_info(subscription_id, opts)
25
+ data
26
+ end
27
+
28
+ # Retrieves a subscription for a given subscriptionId
29
+ # @param subscription_id [String] Unique identifier for Subscription object
30
+ # @param [Hash] opts the optional parameters
31
+ # @return [Array<(Subscription, Integer, Hash)>] Subscription data, response status code and response headers
32
+ def get_subscription_with_http_info(subscription_id, options = {})
33
+ opts = options.dup
34
+ if @api_client.config.debugging
35
+ @api_client.config.logger.debug 'Calling API: AppStoreApi.get_subscription ...'
36
+ end
37
+ # verify the required parameter 'subscription_id' is set
38
+ if @api_client.config.client_side_validation && subscription_id.nil?
39
+ fail ArgumentError, "Missing the required parameter 'subscription_id' when calling AppStoreApi.get_subscription"
40
+ end
41
+ # resource path
42
+ local_var_path = '/subscriptions/{subscriptionId}'.sub('{' + 'subscriptionId' + '}', subscription_id.to_s)
43
+
44
+ # camelize keys of incoming `where` opts
45
+ opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
46
+
47
+ # query parameters
48
+ query_params = opts[:query_params] || {}
49
+
50
+ # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
51
+ query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
52
+ query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
53
+
54
+ # header parameters
55
+ header_params = opts[:header_params] || {}
56
+ # HTTP header 'Accept' (if needed)
57
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
58
+
59
+ # form parameters
60
+ form_params = opts[:form_params] || {}
61
+
62
+ # http body (model)
63
+ post_body = opts[:body]
64
+
65
+ # return_type
66
+ return_type = opts[:return_type] || 'Subscription'
67
+
68
+ # auth_names
69
+ auth_names = opts[:auth_names] || ['OAuth2']
70
+
71
+ new_options = opts.merge(
72
+ :header_params => header_params,
73
+ :query_params => query_params,
74
+ :form_params => form_params,
75
+ :body => post_body,
76
+ :auth_names => auth_names,
77
+ :return_type => return_type
78
+ )
79
+
80
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, "AppStoreApi", new_options)
81
+ if @api_client.config.debugging
82
+ @api_client.config.logger.debug "API called: AppStoreApi#get_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
83
+ end
84
+ return data, status_code, headers
85
+ end
86
+ end
87
+ end