xero-node 4.35.0 → 4.36.0

package/dist/gen/api/payrollAUApi.js

@@ -3,7 +3,7 @@
  * Xero Payroll AU API
  * This is the Xero Payroll API for orgs in Australia region.
  *
- * The version of the OpenAPI document: 2.38.0
+ * The version of the OpenAPI document: 2.40.0
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -34,7 +34,7 @@ var PayrollAuApiApiKeys;
 class PayrollAuApi {
     constructor(basePathOrUsername, password, basePath) {
         this._basePath = defaultBasePath;
-        this.defaultHeaders = { 'user-agent': 'xero-node-4.35.0' };
+        this.defaultHeaders = { 'user-agent': 'xero-node-4.36.0' };
         this._useQuerystring = false;
         this.binaryHeaders = {};
         this.authentications = {
@@ -75,8 +75,9 @@ class PayrollAuApi {
      * @summary Approve a requested leave application by a unique leave application id
      * @param xeroTenantId Xero identifier for Tenant
      * @param leaveApplicationID Leave Application id for single object
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    approveLeaveApplication(xeroTenantId, leaveApplicationID, options = { headers: {} }) {
+    approveLeaveApplication(xeroTenantId, leaveApplicationID, idempotencyKey, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
             const localVarPath = this.basePath + '/LeaveApplications/{LeaveApplicationID}/approve'
                 .replace('{' + 'LeaveApplicationID' + '}', encodeURIComponent(String(leaveApplicationID)));
@@ -92,6 +93,7 @@ class PayrollAuApi {
                 throw new Error('Required parameter leaveApplicationID was null or undefined when calling approveLeaveApplication.');
             }
             localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            localVarHeaderParams['Idempotency-Key'] = models_1.ObjectSerializer.serialize(idempotencyKey, "string");
             Object.assign(localVarHeaderParams, options.headers);
             let localVarUseFormData = false;
             let localVarRequestOptions = {
@@ -138,8 +140,9 @@ class PayrollAuApi {
      * @summary Creates a payroll employee
      * @param xeroTenantId Xero identifier for Tenant
      * @param employee
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEmployee(xeroTenantId, employee, options = { headers: {} }) {
+    createEmployee(xeroTenantId, employee, idempotencyKey, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
             const localVarPath = this.basePath + '/Employees';
             let localVarQueryParameters = {};
@@ -154,6 +157,7 @@ class PayrollAuApi {
                 throw new Error('Required parameter employee was null or undefined when calling createEmployee.');
             }
             localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            localVarHeaderParams['Idempotency-Key'] = models_1.ObjectSerializer.serialize(idempotencyKey, "string");
             Object.assign(localVarHeaderParams, options.headers);
             let localVarUseFormData = false;
             let localVarRequestOptions = {
@@ -201,8 +205,9 @@ class PayrollAuApi {
      * @summary Creates a leave application
      * @param xeroTenantId Xero identifier for Tenant
      * @param leaveApplication
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createLeaveApplication(xeroTenantId, leaveApplication, options = { headers: {} }) {
+    createLeaveApplication(xeroTenantId, leaveApplication, idempotencyKey, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
             const localVarPath = this.basePath + '/LeaveApplications';
             let localVarQueryParameters = {};
@@ -217,6 +222,7 @@ class PayrollAuApi {
                 throw new Error('Required parameter leaveApplication was null or undefined when calling createLeaveApplication.');
             }
             localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            localVarHeaderParams['Idempotency-Key'] = models_1.ObjectSerializer.serialize(idempotencyKey, "string");
             Object.assign(localVarHeaderParams, options.headers);
             let localVarUseFormData = false;
             let localVarRequestOptions = {
@@ -264,8 +270,9 @@ class PayrollAuApi {
      * @summary Creates a pay item
      * @param xeroTenantId Xero identifier for Tenant
      * @param payItem
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createPayItem(xeroTenantId, payItem, options = { headers: {} }) {
+    createPayItem(xeroTenantId, payItem, idempotencyKey, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
             const localVarPath = this.basePath + '/PayItems';
             let localVarQueryParameters = {};
@@ -280,6 +287,7 @@ class PayrollAuApi {
                 throw new Error('Required parameter payItem was null or undefined when calling createPayItem.');
             }
             localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            localVarHeaderParams['Idempotency-Key'] = models_1.ObjectSerializer.serialize(idempotencyKey, "string");
             Object.assign(localVarHeaderParams, options.headers);
             let localVarUseFormData = false;
             let localVarRequestOptions = {
@@ -327,8 +335,9 @@ class PayrollAuApi {
      * @summary Creates a pay run
      * @param xeroTenantId Xero identifier for Tenant
      * @param payRun
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createPayRun(xeroTenantId, payRun, options = { headers: {} }) {
+    createPayRun(xeroTenantId, payRun, idempotencyKey, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
             const localVarPath = this.basePath + '/PayRuns';
             let localVarQueryParameters = {};
@@ -343,6 +352,7 @@ class PayrollAuApi {
                 throw new Error('Required parameter payRun was null or undefined when calling createPayRun.');
             }
             localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            localVarHeaderParams['Idempotency-Key'] = models_1.ObjectSerializer.serialize(idempotencyKey, "string");
             Object.assign(localVarHeaderParams, options.headers);
             let localVarUseFormData = false;
             let localVarRequestOptions = {
@@ -390,8 +400,9 @@ class PayrollAuApi {
      * @summary Creates a Payroll Calendar
      * @param xeroTenantId Xero identifier for Tenant
      * @param payrollCalendar
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createPayrollCalendar(xeroTenantId, payrollCalendar, options = { headers: {} }) {
+    createPayrollCalendar(xeroTenantId, payrollCalendar, idempotencyKey, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
             const localVarPath = this.basePath + '/PayrollCalendars';
             let localVarQueryParameters = {};
@@ -406,6 +417,7 @@ class PayrollAuApi {
                 throw new Error('Required parameter payrollCalendar was null or undefined when calling createPayrollCalendar.');
             }
             localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            localVarHeaderParams['Idempotency-Key'] = models_1.ObjectSerializer.serialize(idempotencyKey, "string");
             Object.assign(localVarHeaderParams, options.headers);
             let localVarUseFormData = false;
             let localVarRequestOptions = {
@@ -453,8 +465,9 @@ class PayrollAuApi {
      * @summary Creates a superfund
      * @param xeroTenantId Xero identifier for Tenant
      * @param superFund
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createSuperfund(xeroTenantId, superFund, options = { headers: {} }) {
+    createSuperfund(xeroTenantId, superFund, idempotencyKey, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
             const localVarPath = this.basePath + '/Superfunds';
             let localVarQueryParameters = {};
@@ -469,6 +482,7 @@ class PayrollAuApi {
                 throw new Error('Required parameter superFund was null or undefined when calling createSuperfund.');
             }
             localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            localVarHeaderParams['Idempotency-Key'] = models_1.ObjectSerializer.serialize(idempotencyKey, "string");
             Object.assign(localVarHeaderParams, options.headers);
             let localVarUseFormData = false;
             let localVarRequestOptions = {
@@ -516,8 +530,9 @@ class PayrollAuApi {
      * @summary Creates a timesheet
      * @param xeroTenantId Xero identifier for Tenant
      * @param timesheet
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createTimesheet(xeroTenantId, timesheet, options = { headers: {} }) {
+    createTimesheet(xeroTenantId, timesheet, idempotencyKey, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
             const localVarPath = this.basePath + '/Timesheets';
             let localVarQueryParameters = {};
@@ -532,6 +547,7 @@ class PayrollAuApi {
                 throw new Error('Required parameter timesheet was null or undefined when calling createTimesheet.');
             }
             localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            localVarHeaderParams['Idempotency-Key'] = models_1.ObjectSerializer.serialize(idempotencyKey, "string");
             Object.assign(localVarHeaderParams, options.headers);
             let localVarUseFormData = false;
             let localVarRequestOptions = {
@@ -1710,8 +1726,9 @@ class PayrollAuApi {
      * @summary Reject a leave application by a unique leave application id
      * @param xeroTenantId Xero identifier for Tenant
      * @param leaveApplicationID Leave Application id for single object
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    rejectLeaveApplication(xeroTenantId, leaveApplicationID, options = { headers: {} }) {
+    rejectLeaveApplication(xeroTenantId, leaveApplicationID, idempotencyKey, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
             const localVarPath = this.basePath + '/LeaveApplications/{LeaveApplicationID}/reject'
                 .replace('{' + 'LeaveApplicationID' + '}', encodeURIComponent(String(leaveApplicationID)));
@@ -1727,6 +1744,7 @@ class PayrollAuApi {
                 throw new Error('Required parameter leaveApplicationID was null or undefined when calling rejectLeaveApplication.');
             }
             localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            localVarHeaderParams['Idempotency-Key'] = models_1.ObjectSerializer.serialize(idempotencyKey, "string");
             Object.assign(localVarHeaderParams, options.headers);
             let localVarUseFormData = false;
             let localVarRequestOptions = {
@@ -1773,9 +1791,10 @@ class PayrollAuApi {
      * @summary Updates an employee\'s detail
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      * @param employee
      */
-    updateEmployee(xeroTenantId, employeeID, employee, options = { headers: {} }) {
+    updateEmployee(xeroTenantId, employeeID, idempotencyKey, employee, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
             const localVarPath = this.basePath + '/Employees/{EmployeeID}'
                 .replace('{' + 'EmployeeID' + '}', encodeURIComponent(String(employeeID)));
@@ -1791,6 +1810,7 @@ class PayrollAuApi {
                 throw new Error('Required parameter employeeID was null or undefined when calling updateEmployee.');
             }
             localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            localVarHeaderParams['Idempotency-Key'] = models_1.ObjectSerializer.serialize(idempotencyKey, "string");
             Object.assign(localVarHeaderParams, options.headers);
             let localVarUseFormData = false;
             let localVarRequestOptions = {
@@ -1839,8 +1859,9 @@ class PayrollAuApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param leaveApplicationID Leave Application id for single object
      * @param leaveApplication
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateLeaveApplication(xeroTenantId, leaveApplicationID, leaveApplication, options = { headers: {} }) {
+    updateLeaveApplication(xeroTenantId, leaveApplicationID, leaveApplication, idempotencyKey, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
             const localVarPath = this.basePath + '/LeaveApplications/{LeaveApplicationID}'
                 .replace('{' + 'LeaveApplicationID' + '}', encodeURIComponent(String(leaveApplicationID)));
@@ -1860,6 +1881,7 @@ class PayrollAuApi {
                 throw new Error('Required parameter leaveApplication was null or undefined when calling updateLeaveApplication.');
             }
             localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            localVarHeaderParams['Idempotency-Key'] = models_1.ObjectSerializer.serialize(idempotencyKey, "string");
             Object.assign(localVarHeaderParams, options.headers);
             let localVarUseFormData = false;
             let localVarRequestOptions = {
@@ -1907,9 +1929,10 @@ class PayrollAuApi {
      * @summary Updates a pay run
      * @param xeroTenantId Xero identifier for Tenant
      * @param payRunID PayRun id for single object
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      * @param payRun
      */
-    updatePayRun(xeroTenantId, payRunID, payRun, options = { headers: {} }) {
+    updatePayRun(xeroTenantId, payRunID, idempotencyKey, payRun, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
             const localVarPath = this.basePath + '/PayRuns/{PayRunID}'
                 .replace('{' + 'PayRunID' + '}', encodeURIComponent(String(payRunID)));
@@ -1925,6 +1948,7 @@ class PayrollAuApi {
                 throw new Error('Required parameter payRunID was null or undefined when calling updatePayRun.');
             }
             localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            localVarHeaderParams['Idempotency-Key'] = models_1.ObjectSerializer.serialize(idempotencyKey, "string");
             Object.assign(localVarHeaderParams, options.headers);
             let localVarUseFormData = false;
             let localVarRequestOptions = {
@@ -1972,9 +1996,10 @@ class PayrollAuApi {
      * @summary Updates a payslip
      * @param xeroTenantId Xero identifier for Tenant
      * @param payslipID Payslip id for single object
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      * @param payslipLines
      */
-    updatePayslip(xeroTenantId, payslipID, payslipLines, options = { headers: {} }) {
+    updatePayslip(xeroTenantId, payslipID, idempotencyKey, payslipLines, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
             const localVarPath = this.basePath + '/Payslip/{PayslipID}'
                 .replace('{' + 'PayslipID' + '}', encodeURIComponent(String(payslipID)));
@@ -1990,6 +2015,7 @@ class PayrollAuApi {
                 throw new Error('Required parameter payslipID was null or undefined when calling updatePayslip.');
             }
             localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            localVarHeaderParams['Idempotency-Key'] = models_1.ObjectSerializer.serialize(idempotencyKey, "string");
             Object.assign(localVarHeaderParams, options.headers);
             let localVarUseFormData = false;
             let localVarRequestOptions = {
@@ -2037,9 +2063,10 @@ class PayrollAuApi {
      * @summary Updates a superfund
      * @param xeroTenantId Xero identifier for Tenant
      * @param superFundID Superfund id for single object
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      * @param superFund
      */
-    updateSuperfund(xeroTenantId, superFundID, superFund, options = { headers: {} }) {
+    updateSuperfund(xeroTenantId, superFundID, idempotencyKey, superFund, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
             const localVarPath = this.basePath + '/Superfunds/{SuperFundID}'
                 .replace('{' + 'SuperFundID' + '}', encodeURIComponent(String(superFundID)));
@@ -2055,6 +2082,7 @@ class PayrollAuApi {
                 throw new Error('Required parameter superFundID was null or undefined when calling updateSuperfund.');
             }
             localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            localVarHeaderParams['Idempotency-Key'] = models_1.ObjectSerializer.serialize(idempotencyKey, "string");
             Object.assign(localVarHeaderParams, options.headers);
             let localVarUseFormData = false;
             let localVarRequestOptions = {
@@ -2102,9 +2130,10 @@ class PayrollAuApi {
      * @summary Updates a timesheet
      * @param xeroTenantId Xero identifier for Tenant
      * @param timesheetID Timesheet id for single object
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      * @param timesheet
      */
-    updateTimesheet(xeroTenantId, timesheetID, timesheet, options = { headers: {} }) {
+    updateTimesheet(xeroTenantId, timesheetID, idempotencyKey, timesheet, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
             const localVarPath = this.basePath + '/Timesheets/{TimesheetID}'
                 .replace('{' + 'TimesheetID' + '}', encodeURIComponent(String(timesheetID)));
@@ -2120,6 +2149,7 @@ class PayrollAuApi {
                 throw new Error('Required parameter timesheetID was null or undefined when calling updateTimesheet.');
             }
             localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            localVarHeaderParams['Idempotency-Key'] = models_1.ObjectSerializer.serialize(idempotencyKey, "string");
             Object.assign(localVarHeaderParams, options.headers);
             let localVarUseFormData = false;
             let localVarRequestOptions = {