xero-node 8.0.0 → 9.1.0

package/dist/gen/api/payrollNZApi.js

@@ -3,7 +3,7 @@
  * Xero Payroll NZ
  * This is the Xero Payroll API for orgs in the NZ region.
  *
- * The version of the OpenAPI document: 5.0.0
+ * The version of the OpenAPI document: 6.1.1
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -38,7 +38,7 @@ var PayrollNzApiApiKeys;
 class PayrollNzApi {
     constructor(basePathOrUsername, password, basePath) {
         this._basePath = defaultBasePath;
-        this.defaultHeaders = { 'user-agent': 'xero-node-8.0.0' };
+        this.defaultHeaders = { 'user-agent': 'xero-node-9.1.0' };
         this._useQuerystring = false;
         this.binaryHeaders = {};
         this.authentications = {
@@ -377,7 +377,7 @@ class PayrollNzApi {
      */
     createEmployeeEarningsTemplate(xeroTenantId, employeeID, earningsTemplate, idempotencyKey, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
-            const localVarPath = this.basePath + '/Employees/{EmployeeID}/PayTemplates/earnings'
+            const localVarPath = this.basePath + '/Employees/{EmployeeID}/PayTemplates/Earnings'
                 .replace('{' + 'EmployeeID' + '}', encodeURIComponent(String(employeeID)));
             let localVarQueryParameters = {};
             let localVarHeaderParams = Object.assign({}, this.defaultHeaders);
@@ -535,7 +535,7 @@ class PayrollNzApi {
      */
     createEmployeeLeaveSetup(xeroTenantId, employeeID, employeeLeaveSetup, idempotencyKey, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
-            const localVarPath = this.basePath + '/Employees/{EmployeeID}/leaveSetup'
+            const localVarPath = this.basePath + '/Employees/{EmployeeID}/LeaveSetup'
                 .replace('{' + 'EmployeeID' + '}', encodeURIComponent(String(employeeID)));
             let localVarQueryParameters = {};
             let localVarHeaderParams = Object.assign({}, this.defaultHeaders);
@@ -693,7 +693,7 @@ class PayrollNzApi {
      */
     createEmployeeOpeningBalances(xeroTenantId, employeeID, employeeOpeningBalance, idempotencyKey, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
-            const localVarPath = this.basePath + '/Employees/{EmployeeID}/openingBalances'
+            const localVarPath = this.basePath + '/Employees/{EmployeeID}/OpeningBalances'
                 .replace('{' + 'EmployeeID' + '}', encodeURIComponent(String(employeeID)));
             let localVarQueryParameters = {};
             let localVarHeaderParams = Object.assign({}, this.defaultHeaders);
@@ -920,6 +920,85 @@ class PayrollNzApi {
             });
         });
     }
+    /**
+     *
+     * @summary Creates an employee working pattern
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param employeeID Employee id for single object
+     * @param employeeWorkingPatternWithWorkingWeeksRequest
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+     */
+    createEmployeeWorkingPattern(xeroTenantId, employeeID, employeeWorkingPatternWithWorkingWeeksRequest, idempotencyKey, options = { headers: {} }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = this.basePath + '/Employees/{EmployeeID}/Working-Patterns'
+                .replace('{' + 'EmployeeID' + '}', encodeURIComponent(String(employeeID)));
+            let localVarQueryParameters = {};
+            let localVarHeaderParams = Object.assign({}, this.defaultHeaders);
+            let localVarFormParams = {};
+            let acceptHeadersFromSpec = [
+                "application/json"
+            ];
+            const isBufferType = acceptHeadersFromSpec.includes("application/pdf") || acceptHeadersFromSpec.includes("application/octet-stream") || acceptHeadersFromSpec.includes("application/jpg");
+            const responseTypeOption = isBufferType ? "arraybuffer" : "json";
+            // 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 createEmployeeWorkingPattern.');
+            }
+            // verify required parameter 'employeeID' is not null or undefined
+            if (employeeID === null || employeeID === undefined) {
+                throw new Error('Required parameter employeeID was null or undefined when calling createEmployeeWorkingPattern.');
+            }
+            // verify required parameter 'employeeWorkingPatternWithWorkingWeeksRequest' is not null or undefined
+            if (employeeWorkingPatternWithWorkingWeeksRequest === null || employeeWorkingPatternWithWorkingWeeksRequest === undefined) {
+                throw new Error('Required parameter employeeWorkingPatternWithWorkingWeeksRequest was null or undefined when calling createEmployeeWorkingPattern.');
+            }
+            localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            localVarHeaderParams['Idempotency-Key'] = models_1.ObjectSerializer.serialize(idempotencyKey, "string");
+            localVarHeaderParams['Accept'] = acceptHeadersFromSpec.join();
+            Object.assign(localVarHeaderParams, options.headers);
+            let localVarUseFormData = false;
+            let localVarRequestOptions = {
+                method: 'POST',
+                params: localVarQueryParameters,
+                headers: localVarHeaderParams,
+                url: localVarPath,
+                responseType: responseTypeOption,
+                data: models_1.ObjectSerializer.serialize(employeeWorkingPatternWithWorkingWeeksRequest, "EmployeeWorkingPatternWithWorkingWeeksRequest"),
+            };
+            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) {
+                        localVarRequestOptions.data = localVarFormParams;
+                        localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarRequestOptions.headers), { 'Content-Type': 'multipart/form-data' });
+                    }
+                    else {
+                        localVarRequestOptions.data = localVarFormParams;
+                        localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarRequestOptions.headers), { 'content-type': 'application/x-www-form-urlencoded' });
+                    }
+                }
+                return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+                    let body = null;
+                    try {
+                        const response = yield (0, axios_1.default)(localVarRequestOptions);
+                        body = models_1.ObjectSerializer.deserialize(response.data, "EmployeeWorkingPatternWithWorkingWeeksObject");
+                        if (response.status && response.status >= 200 && response.status <= 299) {
+                            resolve({ response: response, body: body });
+                        }
+                        else {
+                            reject({ response: response, body: body });
+                        }
+                    }
+                    catch (error) {
+                        const errorResponse = new ApiError_1.ApiError(error);
+                        reject(JSON.stringify(errorResponse.generateError()));
+                    }
+                }));
+            });
+        });
+    }
     /**
      *
      * @summary Creates an employment detail for a specific employee
@@ -1082,7 +1161,7 @@ class PayrollNzApi {
      */
     createMultipleEmployeeEarningsTemplate(xeroTenantId, employeeID, earningsTemplate, idempotencyKey, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
-            const localVarPath = this.basePath + '/Employees/{EmployeeID}/paytemplateearnings'
+            const localVarPath = this.basePath + '/Employees/{EmployeeID}/PayTemplateEarnings'
                 .replace('{' + 'EmployeeID' + '}', encodeURIComponent(String(employeeID)));
             let localVarQueryParameters = {};
             let localVarHeaderParams = Object.assign({}, this.defaultHeaders);
@@ -1604,7 +1683,7 @@ class PayrollNzApi {
      */
     deleteEmployeeEarningsTemplate(xeroTenantId, employeeID, payTemplateEarningID, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
-            const localVarPath = this.basePath + '/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}'
+            const localVarPath = this.basePath + '/Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID}'
                 .replace('{' + 'EmployeeID' + '}', encodeURIComponent(String(employeeID)))
                 .replace('{' + 'PayTemplateEarningID' + '}', encodeURIComponent(String(payTemplateEarningID)));
             let localVarQueryParameters = {};
@@ -1829,6 +1908,84 @@ class PayrollNzApi {
             });
         });
     }
+    /**
+     *
+     * @summary deletes employee\'s working patterns
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param employeeID Employee id for single object
+     * @param employeeWorkingPatternID Employee working pattern id for single object
+     */
+    deleteEmployeeWorkingPattern(xeroTenantId, employeeID, employeeWorkingPatternID, options = { headers: {} }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = this.basePath + '/Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID}'
+                .replace('{' + 'EmployeeID' + '}', encodeURIComponent(String(employeeID)))
+                .replace('{' + 'EmployeeWorkingPatternID' + '}', encodeURIComponent(String(employeeWorkingPatternID)));
+            let localVarQueryParameters = {};
+            let localVarHeaderParams = Object.assign({}, this.defaultHeaders);
+            let localVarFormParams = {};
+            let acceptHeadersFromSpec = [
+                "application/json"
+            ];
+            const isBufferType = acceptHeadersFromSpec.includes("application/pdf") || acceptHeadersFromSpec.includes("application/octet-stream") || acceptHeadersFromSpec.includes("application/jpg");
+            const responseTypeOption = isBufferType ? "arraybuffer" : "json";
+            // 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 deleteEmployeeWorkingPattern.');
+            }
+            // verify required parameter 'employeeID' is not null or undefined
+            if (employeeID === null || employeeID === undefined) {
+                throw new Error('Required parameter employeeID was null or undefined when calling deleteEmployeeWorkingPattern.');
+            }
+            // verify required parameter 'employeeWorkingPatternID' is not null or undefined
+            if (employeeWorkingPatternID === null || employeeWorkingPatternID === undefined) {
+                throw new Error('Required parameter employeeWorkingPatternID was null or undefined when calling deleteEmployeeWorkingPattern.');
+            }
+            localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            localVarHeaderParams['Accept'] = acceptHeadersFromSpec.join();
+            Object.assign(localVarHeaderParams, options.headers);
+            let localVarUseFormData = false;
+            let localVarRequestOptions = {
+                method: 'DELETE',
+                params: localVarQueryParameters,
+                headers: localVarHeaderParams,
+                url: localVarPath,
+                responseType: responseTypeOption,
+                data: {},
+            };
+            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) {
+                        localVarRequestOptions.data = localVarFormParams;
+                        localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarRequestOptions.headers), { 'Content-Type': 'multipart/form-data' });
+                    }
+                    else {
+                        localVarRequestOptions.data = localVarFormParams;
+                        localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarRequestOptions.headers), { 'content-type': 'application/x-www-form-urlencoded' });
+                    }
+                }
+                return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+                    let body = null;
+                    try {
+                        const response = yield (0, axios_1.default)(localVarRequestOptions);
+                        body = models_1.ObjectSerializer.deserialize(response.data, "EmployeeLeaveObject");
+                        if (response.status && response.status >= 200 && response.status <= 299) {
+                            resolve({ response: response, body: body });
+                        }
+                        else {
+                            reject({ response: response, body: body });
+                        }
+                    }
+                    catch (error) {
+                        const errorResponse = new ApiError_1.ApiError(error);
+                        reject(JSON.stringify(errorResponse.generateError()));
+                    }
+                }));
+            });
+        });
+    }
     /**
      *
      * @summary Deletes a timesheet
@@ -2639,7 +2796,7 @@ class PayrollNzApi {
      */
     getEmployeeOpeningBalances(xeroTenantId, employeeID, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
-            const localVarPath = this.basePath + '/Employees/{EmployeeID}/openingBalances'
+            const localVarPath = this.basePath + '/Employees/{EmployeeID}/OpeningBalances'
                 .replace('{' + 'EmployeeID' + '}', encodeURIComponent(String(employeeID)));
             let localVarQueryParameters = {};
             let localVarHeaderParams = Object.assign({}, this.defaultHeaders);
@@ -3073,6 +3230,156 @@ class PayrollNzApi {
             });
         });
     }
+    /**
+     *
+     * @summary Retrieves employee\'s working patterns
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param employeeID Employee id for single object
+     * @param employeeWorkingPatternID Employee working pattern id for single object
+     */
+    getEmployeeWorkingPattern(xeroTenantId, employeeID, employeeWorkingPatternID, options = { headers: {} }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = this.basePath + '/Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID}'
+                .replace('{' + 'EmployeeID' + '}', encodeURIComponent(String(employeeID)))
+                .replace('{' + 'EmployeeWorkingPatternID' + '}', encodeURIComponent(String(employeeWorkingPatternID)));
+            let localVarQueryParameters = {};
+            let localVarHeaderParams = Object.assign({}, this.defaultHeaders);
+            let localVarFormParams = {};
+            let acceptHeadersFromSpec = [
+                "application/json"
+            ];
+            const isBufferType = acceptHeadersFromSpec.includes("application/pdf") || acceptHeadersFromSpec.includes("application/octet-stream") || acceptHeadersFromSpec.includes("application/jpg");
+            const responseTypeOption = isBufferType ? "arraybuffer" : "json";
+            // 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 getEmployeeWorkingPattern.');
+            }
+            // verify required parameter 'employeeID' is not null or undefined
+            if (employeeID === null || employeeID === undefined) {
+                throw new Error('Required parameter employeeID was null or undefined when calling getEmployeeWorkingPattern.');
+            }
+            // verify required parameter 'employeeWorkingPatternID' is not null or undefined
+            if (employeeWorkingPatternID === null || employeeWorkingPatternID === undefined) {
+                throw new Error('Required parameter employeeWorkingPatternID was null or undefined when calling getEmployeeWorkingPattern.');
+            }
+            localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            localVarHeaderParams['Accept'] = acceptHeadersFromSpec.join();
+            Object.assign(localVarHeaderParams, options.headers);
+            let localVarUseFormData = false;
+            let localVarRequestOptions = {
+                method: 'GET',
+                params: localVarQueryParameters,
+                headers: localVarHeaderParams,
+                url: localVarPath,
+                responseType: responseTypeOption,
+                data: {},
+            };
+            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) {
+                        localVarRequestOptions.data = localVarFormParams;
+                        localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarRequestOptions.headers), { 'Content-Type': 'multipart/form-data' });
+                    }
+                    else {
+                        localVarRequestOptions.data = localVarFormParams;
+                        localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarRequestOptions.headers), { 'content-type': 'application/x-www-form-urlencoded' });
+                    }
+                }
+                return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+                    let body = null;
+                    try {
+                        const response = yield (0, axios_1.default)(localVarRequestOptions);
+                        body = models_1.ObjectSerializer.deserialize(response.data, "EmployeeWorkingPatternWithWorkingWeeksObject");
+                        if (response.status && response.status >= 200 && response.status <= 299) {
+                            resolve({ response: response, body: body });
+                        }
+                        else {
+                            reject({ response: response, body: body });
+                        }
+                    }
+                    catch (error) {
+                        const errorResponse = new ApiError_1.ApiError(error);
+                        reject(JSON.stringify(errorResponse.generateError()));
+                    }
+                }));
+            });
+        });
+    }
+    /**
+     *
+     * @summary Retrieves employee\'s working patterns
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param employeeID Employee id for single object
+     */
+    getEmployeeWorkingPatterns(xeroTenantId, employeeID, options = { headers: {} }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = this.basePath + '/Employees/{EmployeeID}/Working-Patterns'
+                .replace('{' + 'EmployeeID' + '}', encodeURIComponent(String(employeeID)));
+            let localVarQueryParameters = {};
+            let localVarHeaderParams = Object.assign({}, this.defaultHeaders);
+            let localVarFormParams = {};
+            let acceptHeadersFromSpec = [
+                "application/json"
+            ];
+            const isBufferType = acceptHeadersFromSpec.includes("application/pdf") || acceptHeadersFromSpec.includes("application/octet-stream") || acceptHeadersFromSpec.includes("application/jpg");
+            const responseTypeOption = isBufferType ? "arraybuffer" : "json";
+            // 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 getEmployeeWorkingPatterns.');
+            }
+            // verify required parameter 'employeeID' is not null or undefined
+            if (employeeID === null || employeeID === undefined) {
+                throw new Error('Required parameter employeeID was null or undefined when calling getEmployeeWorkingPatterns.');
+            }
+            localVarHeaderParams['Xero-Tenant-Id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            localVarHeaderParams['Accept'] = acceptHeadersFromSpec.join();
+            Object.assign(localVarHeaderParams, options.headers);
+            let localVarUseFormData = false;
+            let localVarRequestOptions = {
+                method: 'GET',
+                params: localVarQueryParameters,
+                headers: localVarHeaderParams,
+                url: localVarPath,
+                responseType: responseTypeOption,
+                data: {},
+            };
+            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) {
+                        localVarRequestOptions.data = localVarFormParams;
+                        localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarRequestOptions.headers), { 'Content-Type': 'multipart/form-data' });
+                    }
+                    else {
+                        localVarRequestOptions.data = localVarFormParams;
+                        localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarRequestOptions.headers), { 'content-type': 'application/x-www-form-urlencoded' });
+                    }
+                }
+                return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+                    let body = null;
+                    try {
+                        const response = yield (0, axios_1.default)(localVarRequestOptions);
+                        body = models_1.ObjectSerializer.deserialize(response.data, "EmployeeWorkingPatternsObject");
+                        if (response.status && response.status >= 200 && response.status <= 299) {
+                            resolve({ response: response, body: body });
+                        }
+                        else {
+                            reject({ response: response, body: body });
+                        }
+                    }
+                    catch (error) {
+                        const errorResponse = new ApiError_1.ApiError(error);
+                        reject(JSON.stringify(errorResponse.generateError()));
+                    }
+                }));
+            });
+        });
+    }
     /**
      *
      * @summary Retrieves employees
@@ -4615,7 +4922,7 @@ class PayrollNzApi {
      */
     updateEmployeeEarningsTemplate(xeroTenantId, employeeID, payTemplateEarningID, earningsTemplate, idempotencyKey, options = { headers: {} }) {
         return __awaiter(this, void 0, void 0, function* () {
-            const localVarPath = this.basePath + '/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}'
+            const localVarPath = this.basePath + '/Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID}'
                 .replace('{' + 'EmployeeID' + '}', encodeURIComponent(String(employeeID)))
                 .replace('{' + 'PayTemplateEarningID' + '}', encodeURIComponent(String(payTemplateEarningID)));
             let localVarQueryParameters = {};