4.14.0

Implements the endpoints available in Xero's API spec.

Description

https://developer.xero.com/documentation/guides/how-to-guides/xero-app-store-subscriptions/

https://developer.xero.com/documentation/api/xero-app-store/subscriptions

Release Notes

Subscriptions endpoints enable you to query data about the users who have paid to subscribe to your application through Xero.

AppStoreAPI adds

• getSubscription

AppStore adds

• Subscription
• SubscriptionItem
• Plan
• Product
• Price
• ProblemDetails

---

Employee adds terminationReason
V Voluntary cessation
I Ill health
D Deceased
R Redundancy
F Dismissal
C Contract cessation
T Transfer

• PayrollCalendar adds reference_date

• Payment.rb adds bank_amount

Types of Changes

• New feature (non-breaking change that adds functionality)

4.13.0

Generated using Xero-OpenAPI spec v2.13.3

Implements OA2's client_credentials grant supported by Xero's Custom Connection feature 🥳

https://developer.xero.com/documentation/guides/oauth2/custom-connections/

This enables developers to create machine to machine interactions for a single Xero org.

4.12.0

Release for recent OAS changes: https://github.com/XeroAPI/Xero-OpenAPI/releases/tag/2.13.0

🚨 🚨 🚨 MINOR BREAKING CHANGE 🚨 🚨 🚨

1. summaryOnly?: boolean added to the getInvoices function

2. Future proofing GST and BAS Reports endpoints for NZ and AU orgs, or any orgs that get introduced reports without a restful endpoint and require /Reports/{uuid}

getReportBASorGSTList -> getReportsList
getReportBasOrGst -> getReportFromId

🚨 🚨 🚨 MINOR BREAKING CHANGE - END 🚨 🚨 🚨

3. Code sample docs for the 3 payroll api sets 🚀

4. Added Budgets endpoints

getBudget(xeroTenantId: string, budgetID: string, options: {headers: {...}})
getBudgets(xeroTenantId: string, iDs?: Array[string], dateTo?: string, dateFrom?: string, options: {headers: {...}})

5. incorporated backwards compatibility change for the token set import
   #517 thank you @ambroseus

4.11.3

1. fixes #484 - When a rate limit call hit 429 - the body was empty, and we were trying to JSON.parse and return the result. Now just return the body

2. Fixes #523 by Adding summaryOnly boolean option to getContacts

3. Few other odds and ends generated form recent OAS changes (enums, optional params, etc)

4.11.2

1. Regenerated docs with new branding
2. SDK built from version 2.10.3 of the OAS
3. A few updates to the payroll & Bankfeeds apis
4. Removed v3 of the docs for OAuth1.0a
5. • .2 fixed the headers to have the correct package version number

4.11.1

1. Rgenerated docs with new branding
2. SDK built from version 2.10.3 of the OAS
3. A few updates to the payroll & bankfeeds apis
4. Removed v3 of the docs for OAuth1.0a

4.11.0

replaces preinstall script with prepare script as previous release was causing errors on deployment

4.10.4

Updates dependencies to address dependabot alert

4.10.3

Generated using Xero-OpenAPI spec v2.10.0

Refactors XeroClient.ts apiCallback() params and check objects to leverage openid-client baked in CSRF.
Generates docs from new specs.

4.10.2

Resolves #421 by removing src/untyped.ts from the project, which was previously overwriting openid-client types for some devs.
Resolves #488 by ensuring all TokenSets are of valid TokenSet type per openid-client TokenSet class. Previously refreshWithRefreshToken was not getting a consistent TokenSet given it was coming directly from Xero identity without being passed through openid-client library. Also updated sample app and sdk readme to leverage built-in tokenSet.expired method