xero-node 5.0.1 → 6.0.0

package/README.md

@@ -51,7 +51,7 @@ Sample apps can get you started quickly with simple auth flows and advanced usag
 | [`custom-connections-starter`](https://github.com/XeroAPI/xero-node-custom-connections-starter) | Basic app showing Custom Connections - a Xero [premium option](https://developer.xero.com/documentation/guides/oauth2/custom-connections) for building M2M integrations to a single org | <img src="https://i.imgur.com/HoQHLuq.png" alt="drawing" width="300"/>
 | [`xero-node-sso-app`](https://github.com/XeroAPI/xero-node-sso-app) | App showing Xero Single Sign On - as well as basic setup and usage of the Xero App Store `appStoreApi.getSubscription` endpoint | <img src="https://i.imgur.com/4NGowZz.png" alt="drawing" width="300"/>
 | [`xero-node-sso-form`](https://github.com/XeroAPI/xero-node-sso-form) | App showing Sign up with Xero to Lead | <img src="https://raw.githubusercontent.com/XeroAPI/xero-node-sso-form/main/public/images/ssu-demo-screenshot.png" alt="drawing" width="300"/>
- 
+
 <hr>
 
 ## Xero Account Requirements
@@ -128,7 +128,7 @@ Example Token Set JSON:
 ```
 
 ---
-## Custom Connections 
+## Custom Connections
 
 Custom Connections are a Xero [premium option](https://developer.xero.com/documentation/oauth2/custom-connections) used for building M2M integrations to a single organisation. A custom connection uses OAuth2.0's [`client_credentials`](https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/) grant which eliminates the step of exchanging the temporary code for a token set.
 
@@ -154,9 +154,9 @@ Because Custom Connections are only valid for a single organisation you don't ne
 
 ---
 
-## App Store Subscriptions 
+## App Store Subscriptions
 
-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.
+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/xero-app-store/app-partner-guides/xero-app-store-subscriptions) endpoints.
 
 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.
 
@@ -187,7 +187,7 @@ console.log(subscriptionRequest.body)
   id: '03bc74f2-1237-4477-b782-2dfb1a6d8b21',
   organisationId: '79e8b2e5-c63d-4dce-888f-e0f3e9eac647',
   plans: [
-    Plan {
+     {
       id: '6abc26f3-9390-4194-8b25-ce8b9942fda9',
       name: 'Small',
       status: 'ACTIVE',
@@ -203,7 +203,7 @@ console.log(subscriptionRequest.body)
           id: '9586421f-7325-4493-bac9-d93be06a6a38',
           name: '',
           type: 'FIXED'
-        },      
+        },
         startDate: 2021-08-02T20:08:58.772Z,
         testMode: true
 
@@ -418,7 +418,7 @@ Note that you should set the query param to undefined instead of null if you wis
 const purchaseOrders = xero.accountingApi.getPurchaseOrders(tenant.tenantId, null, null, '2021-01-01', '2021-04-25', null, 1);
 
 // http://api-oauth2.xero.com/api.xro/2.0/PurchaseOrders?Status=&DateFrom=2008-01-01&DateTo=2021-04-25&order=&page=1
-// "Status=&" is breaking the above query 
+// "Status=&" is breaking the above query
 // purchaseOrders will be an empty array
 
 const purchaseOrders = xero.accountingApi.getPurchaseOrders(tenant.tenantId, undefined, undefined, '2021-01-01', '2021-04-25', undefined, 1);
@@ -438,7 +438,7 @@ When xero.buildConsentUrl is called we call openid-client authorizationUrl metho
 RPError: state mismatch, expected user=1234, got: user=666
 ```
 ###  JWT Verification Using Xero-Node
-JWT verification of both the `access_token` and `id_token` are baked into the openid-client library we leverage. When `xero.apiCallback` is called, openid-client `validateJARM` is triggered which also invokes `validateJWT`. If openid-client fails to validate the JWT signature it will throw an error. 
+JWT verification of both the `access_token` and `id_token` are baked into the openid-client library we leverage. When `xero.apiCallback` is called, openid-client `validateJARM` is triggered which also invokes `validateJWT`. If openid-client fails to validate the JWT signature it will throw an error.
 
 ---
 ## Contributing
@@ -455,11 +455,11 @@ We do our best to keep OS industry `semver` standards, but we can make mistakes!
 
 ## Participating in Xero’s developer community
 
-This SDK is one of a number of SDK’s that the Xero Developer team builds and maintains. We are grateful for all the contributions that the community makes. 
+This SDK is one of a number of SDK’s that the Xero Developer team builds and maintains. We are grateful for all the contributions that the community makes.
 
 Here are a few things you should be aware of as a contributor:
 * Xero has adopted the Contributor Covenant [Code of Conduct](https://github.com/XeroAPI/xero-node/blob/master/CODE_OF_CONDUCT.md), we expect all contributors in our community to adhere to it
-* If you raise an issue then please make sure to fill out the github issue template, doing so helps us help you 
+* If you raise an issue then please make sure to fill out the github issue template, doing so helps us help you
 * You’re welcome to raise PRs. As our SDKs are generated we may use your code in the core SDK build instead of merging your code
 * We have a [contribution guide](https://github.com/XeroAPI/xero-node/blob/master/CONTRIBUTING.md) for you to follow when contributing to this SDK
 * Curious about how we generate our SDK’s? Have a [read of our process](https://devblog.xero.com/building-sdks-for-the-future-b79ff726dfd6) and have a look at our [OpenAPISpec](https://github.com/XeroAPI/Xero-OpenAPI)

package/dist/gen/api/accountingApi.d.ts

@@ -2,7 +2,7 @@
  * Xero Accounting API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 3.0.0
+ * The version of the OpenAPI document: 3.0.3
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -11,6 +11,7 @@
  */
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import fs = require('fs');
 import { Account } from '../model/accounting/account';
 import { Accounts } from '../model/accounting/accounts';
@@ -67,6 +68,7 @@ import { TrackingOptions } from '../model/accounting/trackingOptions';
 import { Users } from '../model/accounting/users';
 import { Authentication } from '../model/accounting/models';
 import { AxiosResponse } from 'axios';
+import { Readable } from "stream";
 import { OAuth } from '../model/accounting/models';
 export declare enum AccountingApiApiKeys {
 }
@@ -110,7 +112,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createAccountAttachmentByFileName(xeroTenantId: string, accountID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    createAccountAttachmentByFileName(xeroTenantId: string, accountID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -127,7 +129,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createBankTransactionAttachmentByFileName(xeroTenantId: string, bankTransactionID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    createBankTransactionAttachmentByFileName(xeroTenantId: string, bankTransactionID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -191,7 +193,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createBankTransferAttachmentByFileName(xeroTenantId: string, bankTransferID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    createBankTransferAttachmentByFileName(xeroTenantId: string, bankTransferID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -271,7 +273,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createContactAttachmentByFileName(xeroTenantId: string, contactID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    createContactAttachmentByFileName(xeroTenantId: string, contactID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -369,7 +371,7 @@ export declare class AccountingApi {
      * @param includeOnline Allows an attachment to be seen by the end customer within their online invoice
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createCreditNoteAttachmentByFileName(xeroTenantId: string, creditNoteID: string, fileName: string, body: fs.ReadStream, includeOnline?: boolean, idempotencyKey?: string, options?: {
+    createCreditNoteAttachmentByFileName(xeroTenantId: string, creditNoteID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, includeOnline?: boolean, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -482,7 +484,7 @@ export declare class AccountingApi {
      * @param includeOnline Allows an attachment to be seen by the end customer within their online invoice
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createInvoiceAttachmentByFileName(xeroTenantId: string, invoiceID: string, fileName: string, body: fs.ReadStream, includeOnline?: boolean, idempotencyKey?: string, options?: {
+    createInvoiceAttachmentByFileName(xeroTenantId: string, invoiceID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, includeOnline?: boolean, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -580,7 +582,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createManualJournalAttachmentByFileName(xeroTenantId: string, manualJournalID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    createManualJournalAttachmentByFileName(xeroTenantId: string, manualJournalID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -757,7 +759,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createPurchaseOrderAttachmentByFileName(xeroTenantId: string, purchaseOrderID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    createPurchaseOrderAttachmentByFileName(xeroTenantId: string, purchaseOrderID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -806,7 +808,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createQuoteAttachmentByFileName(xeroTenantId: string, quoteID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    createQuoteAttachmentByFileName(xeroTenantId: string, quoteID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -871,7 +873,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createReceiptAttachmentByFileName(xeroTenantId: string, receiptID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    createReceiptAttachmentByFileName(xeroTenantId: string, receiptID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -904,7 +906,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createRepeatingInvoiceAttachmentByFileName(xeroTenantId: string, repeatingInvoiceID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    createRepeatingInvoiceAttachmentByFileName(xeroTenantId: string, repeatingInvoiceID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -3058,15 +3060,28 @@ export declare class AccountingApi {
         response: AxiosResponse;
         body: ReportWithRows;
     }>;
+    /**
+     *
+     * @summary Retrieves a specific tax rate according to given TaxType code
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param taxType A valid TaxType code
+     */
+    getTaxRateByTaxType(xeroTenantId: string, taxType: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: AxiosResponse;
+        body: TaxRates;
+    }>;
     /**
      *
      * @summary Retrieves tax rates
      * @param xeroTenantId Xero identifier for Tenant
      * @param where Filter by an any element
      * @param order Order by an any element
-     * @param taxType Filter by tax type
      */
-    getTaxRates(xeroTenantId: string, where?: string, order?: string, taxType?: string, options?: {
+    getTaxRates(xeroTenantId: string, where?: string, order?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -3174,7 +3189,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateAccountAttachmentByFileName(xeroTenantId: string, accountID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    updateAccountAttachmentByFileName(xeroTenantId: string, accountID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -3208,7 +3223,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateBankTransactionAttachmentByFileName(xeroTenantId: string, bankTransactionID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    updateBankTransactionAttachmentByFileName(xeroTenantId: string, bankTransactionID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -3224,7 +3239,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateBankTransferAttachmentByFileName(xeroTenantId: string, bankTransferID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    updateBankTransferAttachmentByFileName(xeroTenantId: string, bankTransferID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -3256,7 +3271,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateContactAttachmentByFileName(xeroTenantId: string, contactID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    updateContactAttachmentByFileName(xeroTenantId: string, contactID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -3306,7 +3321,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateCreditNoteAttachmentByFileName(xeroTenantId: string, creditNoteID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    updateCreditNoteAttachmentByFileName(xeroTenantId: string, creditNoteID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -3356,7 +3371,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateInvoiceAttachmentByFileName(xeroTenantId: string, invoiceID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    updateInvoiceAttachmentByFileName(xeroTenantId: string, invoiceID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -3422,7 +3437,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateManualJournalAttachmentByFileName(xeroTenantId: string, manualJournalID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    updateManualJournalAttachmentByFileName(xeroTenantId: string, manualJournalID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -3619,7 +3634,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updatePurchaseOrderAttachmentByFileName(xeroTenantId: string, purchaseOrderID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    updatePurchaseOrderAttachmentByFileName(xeroTenantId: string, purchaseOrderID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -3652,7 +3667,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateQuoteAttachmentByFileName(xeroTenantId: string, quoteID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    updateQuoteAttachmentByFileName(xeroTenantId: string, quoteID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -3686,7 +3701,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateReceiptAttachmentByFileName(xeroTenantId: string, receiptID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    updateReceiptAttachmentByFileName(xeroTenantId: string, receiptID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -3719,7 +3734,7 @@ export declare class AccountingApi {
      * @param body Byte array of file in body of request
      * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateRepeatingInvoiceAttachmentByFileName(xeroTenantId: string, repeatingInvoiceID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
+    updateRepeatingInvoiceAttachmentByFileName(xeroTenantId: string, repeatingInvoiceID: string, fileName: string, body: fs.ReadStream | Readable | Buffer, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };