Merge pull request #597 from XeroAPI/xero-node-4.26.0

tnzzz · web-flow · commit c6528d7f1007 · 2022-09-02T09:54:04.000+12:00
generates xero-node 4.26.0 from OAS 2.28.1
diff --git a/docs/accounting/index.html b/docs/accounting/index.html
@@ -6070,7 +6070,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>4.25.0</li>
+              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>4.26.0</li>
               <li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
               <li data-group="Accounting" data-name="createAccount" class="">
                 <a href="#api-Accounting-createAccount">createAccount</a>
@@ -6324,6 +6324,9 @@
               <li data-group="Accounting" data-name="getBankTransfers" class="">
                 <a href="#api-Accounting-getBankTransfers">getBankTransfers</a>
               </li>
+              <li data-group="Accounting" data-name="getBatchPayment" class="">
+                <a href="#api-Accounting-getBatchPayment">getBatchPayment</a>
+              </li>
               <li data-group="Accounting" data-name="getBatchPaymentHistory" class="">
                 <a href="#api-Accounting-getBatchPaymentHistory">getBatchPaymentHistory</a>
               </li>
@@ -19852,6 +19855,124 @@ <h2>Parameters</h2>
         </div>
     </div>
 </td>
+</tr>
+
+                  </table>
+                </article>
+              </div>
+              <hr>
+              <div id="api-Accounting-getBatchPayment">
+                <article id="api-Accounting-getBatchPayment-0" data-group="User" data-name="getBatchPayment" data-version="0">
+                  <div class="pull-left">
+                    <h1>getBatchPayment</h1>
+                    <p>Retrieves a specific batch payment using a unique batch payment Id</p>
+                  </div>
+                  <div class="pull-right"></div>
+                  <div class="clearfix"></div>
+                  <p></p>
+                  <p class="marked"></p>
+                  <p></p>
+                  <br />
+                  <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/BatchPayments/{BatchPaymentID}</span></code></pre>
+                  <p>
+                  <h3>Usage and SDK Samples</h3>
+                  </p>
+                  <ul class="nav nav-tabs nav-tabs-examples">
+                    <!-- *****REPLACE***** comment out the other languages <li> -->
+                    <li class=""><a href="#examples-Accounting-getBatchPayment-0-javascript">Node</a></li>
+                  </ul>
+                  <div class="tab-content">
+                    <!-- *****REPLACE***** comment out the other languages tab-pane -->
+                    <div class="tab-pane" id="examples-Accounting-getBatchPayment-0-javascript">
+                      <pre class="prettyprint"><code class="language-javascript">await xero.setTokenSet(tokenSet);
+
+const xeroTenantId = 'YOUR_XERO_TENANT_ID';
+const batchPaymentID = '00000000-0000-0000-0000-000000000000';
+
+try {
+  const response = await xero.accountingApi.getBatchPayment(xeroTenantId, batchPaymentID);
+  console.log(response.body || response.response.statusCode)
+} catch (err) {
+  const error = JSON.stringify(err.response.body, null, 2)
+  console.log(`Status Code: ${err.response.statusCode} => ${error}`);
+}</code></pre>
+                    </div>
+                  </div>
+                  <h2>Scopes</h2>
+                  <table>
+                    
+                    <tr>
+                      <td>accounting.transactions</td>
+                      <td>Grant read-write access to bank transactions, credit notes, invoices, repeating invoices</td>
+                    </tr>
+                    
+                    <tr>
+                      <td>accounting.transactions.read</td>
+                      <td>Grant read-only access to invoices</td>
+                    </tr>
+                    
+                  </table>
+                  <h2>Parameters</h2>
+                  <div class="methodsubtabletitle">Path parameters</div>
+                  <table id="methodsubtable">
+                    <tr>
+                      <th width="150px">Name</th>
+                      <th>Description</th>
+                    </tr>
+                    <tr><td style="width:150px;">BatchPaymentID<span style="color:red;">*</span></td>
+<td>
+
+
+    <div id="d2e199_getBatchPayment_batchPaymentID">
+        <div class="json-schema-view">
+            <div class="primitive">
+                <span class="type">
+                    UUID
+                </span>
+                    <span class="format">
+                        (uuid)
+                    </span>
+
+                    <div class="inner description marked">
+Unique identifier for BatchPayment
+                    </div>
+            </div>
+                <div class="inner required">
+                    Required
+                </div>
+        </div>
+    </div>
+</td>
+</tr>
+
+                  </table>
+                  <div class="methodsubtabletitle">Header parameters</div>
+                  <table id="methodsubtable">
+                    <tr>
+                      <th width="150px">Name</th>
+                      <th>Description</th>
+                    </tr>
+                    <tr><td style="width:150px;">xero-tenant-id<span style="color:red;">*</span></td>
+<td>
+
+
+    <div id="d2e199_getBatchPayment_xeroTenantId">
+        <div class="json-schema-view">
+            <div class="primitive">
+                <span class="type">
+                    String
+                </span>
+
+                    <div class="inner description marked">
+Xero identifier for Tenant
+                    </div>
+            </div>
+                <div class="inner required">
+                    Required
+                </div>
+        </div>
+    </div>
+</td>
 </tr>
 
                   </table>
diff --git a/docs/appstore/index.html b/docs/appstore/index.html
@@ -1142,7 +1142,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="AppStore"><strong>VSN: </strong>4.25.0</li>
+              <li class="nav-header" data-group="AppStore"><strong>VSN: </strong>4.26.0</li>
               <li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
               <li data-group="AppStore" data-name="getSubscription" class="">
                 <a href="#api-AppStore-getSubscription">getSubscription</a>
diff --git a/docs/assets/index.html b/docs/assets/index.html
@@ -1393,7 +1393,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Asset"><strong>VSN: </strong>4.25.0</li>
+              <li class="nav-header" data-group="Asset"><strong>VSN: </strong>4.26.0</li>
               <li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
               <li data-group="Asset" data-name="createAsset" class="">
                 <a href="#api-Asset-createAsset">createAsset</a>
diff --git a/docs/bankfeeds/index.html b/docs/bankfeeds/index.html
@@ -1269,7 +1269,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="BankFeeds"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="BankFeeds"><strong>VSN: </strong>4.25.0</li>
+              <li class="nav-header" data-group="BankFeeds"><strong>VSN: </strong>4.26.0</li>
               <li class="nav-header" data-group="BankFeeds"><a href="#api-BankFeeds">Methods</a></li>
               <li data-group="BankFeeds" data-name="createFeedConnections" class="">
                 <a href="#api-BankFeeds-createFeedConnections">createFeedConnections</a>
diff --git a/docs/files/index.html b/docs/files/index.html
@@ -1156,7 +1156,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Files"><strong>VSN: </strong>4.25.0</li>
+              <li class="nav-header" data-group="Files"><strong>VSN: </strong>4.26.0</li>
               <li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
               <li data-group="Files" data-name="createFileAssociation" class="">
                 <a href="#api-Files-createFileAssociation">createFileAssociation</a>
diff --git a/docs/finance/index.html b/docs/finance/index.html
@@ -2719,7 +2719,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Finance"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Finance"><strong>VSN: </strong>4.25.0</li>
+              <li class="nav-header" data-group="Finance"><strong>VSN: </strong>4.26.0</li>
               <li class="nav-header" data-group="Finance"><a href="#api-Finance">Methods</a></li>
               <li data-group="Finance" data-name="getAccountingActivityAccountUsage" class="">
                 <a href="#api-Finance-getAccountingActivityAccountUsage">getAccountingActivityAccountUsage</a>
diff --git a/docs/payroll-au/index.html b/docs/payroll-au/index.html
@@ -3275,7 +3275,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="PayrollAu"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>4.25.0</li>
+              <li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>4.26.0</li>
               <li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
               <li data-group="PayrollAu" data-name="createEmployee" class="">
                 <a href="#api-PayrollAu-createEmployee">createEmployee</a>
diff --git a/docs/payroll-nz/index.html b/docs/payroll-nz/index.html
@@ -3839,7 +3839,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>4.25.0</li>
+              <li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>4.26.0</li>
               <li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li>
               <li data-group="PayrollNz" data-name="approveTimesheet" class="">
                 <a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a>
diff --git a/docs/payroll-uk/index.html b/docs/payroll-uk/index.html
@@ -3511,7 +3511,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="PayrollUk"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>4.25.0</li>
+              <li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>4.26.0</li>
               <li class="nav-header" data-group="PayrollUk"><a href="#api-PayrollUk">Methods</a></li>
               <li data-group="PayrollUk" data-name="approveTimesheet" class="">
                 <a href="#api-PayrollUk-approveTimesheet">approveTimesheet</a>
diff --git a/docs/projects/index.html b/docs/projects/index.html
@@ -1463,7 +1463,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Project"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Project"><strong>VSN: </strong>4.25.0</li>
+              <li class="nav-header" data-group="Project"><strong>VSN: </strong>4.26.0</li>
               <li class="nav-header" data-group="Project"><a href="#api-Project">Methods</a></li>
               <li data-group="Project" data-name="createProject" class="">
                 <a href="#api-Project-createProject">createProject</a>
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "xero-node",
-  "version": "4.25.0",
+  "version": "4.26.0",
   "description": "Xero NodeJS OAuth 2.0 client for xero-node",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
diff --git a/src/gen/api/accountingApi.ts b/src/gen/api/accountingApi.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: 2.27.0
+ * The version of the OpenAPI document: 2.28.1
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -83,7 +83,7 @@ export enum AccountingApiApiKeys {
 
 export class AccountingApi {
     protected _basePath = defaultBasePath;
-    protected defaultHeaders : any = {'user-agent': 'xero-node-4.25.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-4.26.0'};
     protected _useQuerystring : boolean = false;
     protected binaryHeaders : any = {};
 
@@ -6408,6 +6408,71 @@ export class AccountingApi {
             });
         });
     }
+    /**
+     * 
+     * @summary Retrieves a specific batch payment using a unique batch payment Id
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param batchPaymentID Unique identifier for BatchPayment
+     */     
+    public async getBatchPayment (xeroTenantId: string, batchPaymentID: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: BatchPayments;  }> {
+        const localVarPath = this.basePath + '/BatchPayments/{BatchPaymentID}'
+            .replace('{' + 'BatchPaymentID' + '}', encodeURIComponent(String(batchPaymentID)));
+        let localVarQueryParameters: any = {};
+        let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
+        let localVarFormParams: any = {};
+
+        // verify required parameter 'xeroTenantId' is not null or undefined
+        if (xeroTenantId === null || xeroTenantId === undefined) {
+            throw new Error('Required parameter xeroTenantId was null or undefined when calling getBatchPayment.');
+        }
+
+        // verify required parameter 'batchPaymentID' is not null or undefined
+        if (batchPaymentID === null || batchPaymentID === undefined) {
+            throw new Error('Required parameter batchPaymentID was null or undefined when calling getBatchPayment.');
+        }
+
+        localVarHeaderParams['xero-tenant-id'] = ObjectSerializer.serialize(xeroTenantId, "string");
+
+        (<any>Object).assign(localVarHeaderParams, options.headers);
+        let localVarUseFormData = false;
+
+        let localVarRequestOptions: localVarRequest.Options = {
+            method: 'GET',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            json: true,
+        };
+
+        let authenticationPromise = Promise.resolve();
+        authenticationPromise = authenticationPromise.then(() => this.authentications.OAuth2.applyToRequest(localVarRequestOptions));
+
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+        return authenticationPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    (<any>localVarRequestOptions).formData = localVarFormParams;
+                } else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+            return new Promise<{ response: http.IncomingMessage; body: BatchPayments;  }>((resolve, reject) => {
+                localVarRequest(localVarRequestOptions, (error, response, body) => {
+                    if (error) {
+                        reject(error);
+                    } else {
+                        body = ObjectSerializer.deserialize(body, "BatchPayments");
+                        if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve({ response: response, body: body });
+                        } else {
+                            reject({ response: response, body: body });
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * 
      * @summary Retrieves history from a specific batch payment
diff --git a/src/gen/api/appStoreApi.ts b/src/gen/api/appStoreApi.ts
@@ -2,7 +2,7 @@
  * Xero AppStore API
  * These endpoints are for Xero Partners to interact with the App Store Billing platform
  *
- * The version of the OpenAPI document: 2.27.0
+ * The version of the OpenAPI document: 2.28.1
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -32,7 +32,7 @@ export enum AppStoreApiApiKeys {
 
 export class AppStoreApi {
     protected _basePath = defaultBasePath;
-    protected defaultHeaders : any = {'user-agent': 'xero-node-4.25.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-4.26.0'};
     protected _useQuerystring : boolean = false;
     protected binaryHeaders : any = {};
 
diff --git a/src/gen/api/assetApi.ts b/src/gen/api/assetApi.ts
@@ -2,7 +2,7 @@
  * Xero Assets API
  * The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc.
  *
- * The version of the OpenAPI document: 2.27.0
+ * The version of the OpenAPI document: 2.28.1
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -35,7 +35,7 @@ export enum AssetApiApiKeys {
 
 export class AssetApi {
     protected _basePath = defaultBasePath;
-    protected defaultHeaders : any = {'user-agent': 'xero-node-4.25.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-4.26.0'};
     protected _useQuerystring : boolean = false;
     protected binaryHeaders : any = {};
 
diff --git a/src/gen/api/bankfeedsApi.ts b/src/gen/api/bankfeedsApi.ts
@@ -2,7 +2,7 @@
  * Xero Bank Feeds API
  * The Bank Feeds API is a closed API that is only available to financial institutions that have an established financial services partnership with Xero. If you\'re an existing financial services partner that wants access, contact your local Partner Manager. If you\'re a financial institution who wants to provide bank feeds to your business customers, contact us to become a financial services partner.
  *
- * The version of the OpenAPI document: 2.27.0
+ * The version of the OpenAPI document: 2.28.1
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -34,7 +34,7 @@ export enum BankFeedsApiApiKeys {
 
 export class BankFeedsApi {
     protected _basePath = defaultBasePath;
-    protected defaultHeaders : any = {'user-agent': 'xero-node-4.25.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-4.26.0'};
     protected _useQuerystring : boolean = false;
     protected binaryHeaders : any = {};
 
diff --git a/src/gen/api/filesApi.ts b/src/gen/api/filesApi.ts
diff --git a/src/gen/api/financeApi.ts b/src/gen/api/financeApi.ts
diff --git a/src/gen/api/payrollAUApi.ts b/src/gen/api/payrollAUApi.ts
diff --git a/src/gen/api/payrollNZApi.ts b/src/gen/api/payrollNZApi.ts
diff --git a/src/gen/api/payrollUKApi.ts b/src/gen/api/payrollUKApi.ts
diff --git a/src/gen/api/projectApi.ts b/src/gen/api/projectApi.ts
