Merge pull request #632 from XeroAPI/xero-node-4.33.0

generates xero-node 4.33.0 from OAS 2.36.0
XeroAPI · Feb 16, 2023 · e26224e · e26224e
2 parents 271d8ed + 58856a7
commit e26224e
Show file tree

Hide file tree

Showing 28 changed files with 373 additions and 35 deletions.
diff --git a/docs/accounting/index.html b/docs/accounting/index.html
@@ -6075,7 +6075,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.32.0</li>
+              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>4.33.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>

diff --git a/docs/appstore/index.html b/docs/appstore/index.html
@@ -1242,7 +1242,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.32.0</li>
+              <li class="nav-header" data-group="AppStore"><strong>VSN: </strong>4.33.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.32.0</li>
+              <li class="nav-header" data-group="Asset"><strong>VSN: </strong>4.33.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.32.0</li>
+              <li class="nav-header" data-group="BankFeeds"><strong>VSN: </strong>4.33.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.32.0</li>
+              <li class="nav-header" data-group="Files"><strong>VSN: </strong>4.33.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>
@@ -1176,6 +1176,9 @@
               <li data-group="Files" data-name="getAssociationsByObject" class="">
                 <a href="#api-Files-getAssociationsByObject">getAssociationsByObject</a>
               </li>
+              <li data-group="Files" data-name="getAssociationsCount" class="">
+                <a href="#api-Files-getAssociationsCount">getAssociationsCount</a>
+              </li>
               <li data-group="Files" data-name="getFile" class="">
                 <a href="#api-Files-getFile">getFile</a>
               </li>
@@ -1858,7 +1861,7 @@ <h1>getAssociationsByObject</h1>
                   <div class="pull-right"></div>
                   <div class="clearfix"></div>
                   <p></p>
-                  <p class="marked">By passing in the appropriate options,</p>
+                  <p class="marked">By passing in the appropriate options, you can retrieve an association</p>
                   <p></p>
                   <br />
                   <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/Associations/{ObjectId}</span></code></pre>
@@ -1961,6 +1964,124 @@ <h2>Parameters</h2>
         </div>
     </div>
 </td>
+</tr>
+
+                  </table>
+                </article>
+              </div>
+              <hr>
+              <div id="api-Files-getAssociationsCount">
+                <article id="api-Files-getAssociationsCount-0" data-group="User" data-name="getAssociationsCount" data-version="0">
+                  <div class="pull-left">
+                    <h1>getAssociationsCount</h1>
+                    <p>Retrieves a count of associations for a list of objects.</p>
+                  </div>
+                  <div class="pull-right"></div>
+                  <div class="clearfix"></div>
+                  <p></p>
+                  <p class="marked">By passing in the appropriate options, you can retrieve the association count for objects</p>
+                  <p></p>
+                  <br />
+                  <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/Associations/Count</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-Files-getAssociationsCount-0-javascript">Node</a></li>
+                  </ul>
+                  <div class="tab-content">
+                    <!-- *****REPLACE***** comment out the other languages tab-pane -->
+                    <div class="tab-pane" id="examples-Files-getAssociationsCount-0-javascript">
+                      <pre class="prettyprint"><code class="language-javascript">await xero.setTokenSet(tokenSet);
+
+const xeroTenantId = 'YOUR_XERO_TENANT_ID';
+const objectIds = [];
+
+try {
+  const response = await xero.accountingApi.getAssociationsCount(xeroTenantId, objectIds);
+  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>files</td>
+                      <td>Grant read-write access to files and folders</td>
+                    </tr>
+
+                    <tr>
+                      <td>files.read</td>
+                      <td>Grant read-only access to files and folders</td>
+                    </tr>
+
+                  </table>
+                  <h2>Parameters</h2>
+                  <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_getAssociationsCount_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>
+                  <div class="methodsubtabletitle">Query parameters</div>
+                  <table id="methodsubtable">
+                    <tr>
+                      <th width="150px">Name</th>
+                      <th>Description</th>
+                    </tr>
+                    <tr><td style="width:150px;">ObjectIds<span style="color:red;">*</span></td>
+<td>
+
+
+    <div id="d2e199_getAssociationsCount_objectIds">
+        <div class="json-schema-view">
+            <div class="primitive">
+                <span class="type">
+                    array[UUID]
+                </span>
+                    <span class="format">
+                        (uuid)
+                    </span>
+
+                    <div class="inner description marked">
+A comma-separated list of object ids
+                    </div>
+            </div>
+                <div class="inner required">
+                    Required
+                </div>
+        </div>
+    </div>
+</td>
 </tr>
 
                   </table>

diff --git a/docs/finance/index.html b/docs/finance/index.html
@@ -2735,7 +2735,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.32.0</li>
+              <li class="nav-header" data-group="Finance"><strong>VSN: </strong>4.33.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
@@ -1606,6 +1606,9 @@
       "description" : "The Description of the Leave",
       "example" : "My leave"
     },
+    "PayOutType" : {
+      "$ref" : "#/components/schemas/PayOutType"
+    },
     "LeavePeriods" : {
       "type" : "array",
       "items" : {
@@ -1702,6 +1705,9 @@
       "format" : "double",
       "example" : 2.5,
       "x-is-money" : true
+    },
+    "PayOutType" : {
+      "$ref" : "#/components/schemas/PayOutType"
     }
   },
   "description" : ""
@@ -1931,6 +1937,52 @@
       "items" : {
         "$ref" : "#/components/schemas/LeaveLine"
       }
+    },
+    "PaidLeaveEarningsLines" : {
+      "type" : "array",
+      "items" : {
+        "$ref" : "#/components/schemas/PaidLeaveEarningsLine"
+      }
+    }
+  },
+  "description" : ""
+};
+      defs["PaidLeaveEarningsLine"] = {
+  "title" : "",
+  "required" : [ "Amount", "LeaveTypeID" ],
+  "type" : "object",
+  "properties" : {
+    "LeaveTypeID" : {
+      "type" : "string",
+      "description" : "Xero leave type identifier",
+      "format" : "uuid",
+      "example" : "742998cb-7584-4ecf-aa88-d694f59c50f9"
+    },
+    "Amount" : {
+      "type" : "number",
+      "description" : "Paid leave amount",
+      "format" : "double",
+      "example" : 500.0,
+      "x-is-money" : true
+    },
+    "SGCAppliedLeaveLoadingAmount" : {
+      "type" : "number",
+      "description" : "The amount of leave loading applied for the leave type that is subject to Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories",
+      "format" : "double",
+      "example" : 50.0,
+      "x-is-money" : true
+    },
+    "SGCExemptedLeaveLoadingAmount" : {
+      "type" : "number",
+      "description" : "The amount of leave loading applied for the leave type that is exempt from Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories",
+      "format" : "double",
+      "example" : 60.0,
+      "x-is-money" : true
+    },
+    "ResetSTPCategorisation" : {
+      "type" : "boolean",
+      "description" : "Reset the STP categorisations for the leave type. *Only applicable for Leave Types with Annual Leave Categories",
+      "example" : true
     }
   },
   "description" : ""
@@ -1976,6 +2028,12 @@
   },
   "description" : "",
   "x-isObjectArray" : true
+};
+      defs["PayOutType"] = {
+  "title" : "",
+  "type" : "string",
+  "description" : "How the requested leave will be paid out, e.g. cashed out.",
+  "enum" : [ "DEFAULT", "CASHED_OUT" ]
 };
       defs["PayRun"] = {
   "title" : "",
@@ -3355,7 +3413,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.32.0</li>
+              <li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>4.33.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.32.0</li>
+              <li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>4.33.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.32.0</li>
+              <li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>4.33.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.32.0</li>
+              <li class="nav-header" data-group="Project"><strong>VSN: </strong>4.33.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.32.0",
+  "version": "4.33.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.35.0
+ * The version of the OpenAPI document: 2.36.0
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -82,7 +82,7 @@ export enum AccountingApiApiKeys {
 
 export class AccountingApi {
     protected _basePath = defaultBasePath;
-    protected defaultHeaders : any = {'user-agent': 'xero-node-4.32.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-4.33.0'};
     protected _useQuerystring : boolean = false;
     protected binaryHeaders : any = {};
 

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.35.0
+ * The version of the OpenAPI document: 2.36.0
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -36,7 +36,7 @@ export enum AppStoreApiApiKeys {
 
 export class AppStoreApi {
     protected _basePath = defaultBasePath;
-    protected defaultHeaders : any = {'user-agent': 'xero-node-4.32.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-4.33.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.35.0
+ * The version of the OpenAPI document: 2.36.0
  * Contact: [email protected]
  *
  * 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.32.0'};
+    protected defaultHeaders : any = {'user-agent': 'xero-node-4.33.0'};
     protected _useQuerystring : boolean = false;
     protected binaryHeaders : any = {};