xero-node 17.0.0 → 19.0.0

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: 14.0.0
+ * The version of the OpenAPI document: 16.1.0
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -17,7 +17,9 @@ import { Allocation } from '../model/accounting/allocation';
 import { Allocations } from '../model/accounting/allocations';
 import { Attachments } from '../model/accounting/attachments';
 import { BankTransactions } from '../model/accounting/bankTransactions';
+import { BankTransferDeleteByUrlParam } from '../model/accounting/bankTransferDeleteByUrlParam';
 import { BankTransfers } from '../model/accounting/bankTransfers';
+import { BankTransfersDelete } from '../model/accounting/bankTransfersDelete';
 import { BatchPaymentDelete } from '../model/accounting/batchPaymentDelete';
 import { BatchPaymentDeleteByUrlParam } from '../model/accounting/batchPaymentDeleteByUrlParam';
 import { BatchPayments } from '../model/accounting/batchPayments';
@@ -986,6 +988,38 @@ export declare class AccountingApi {
         response: AxiosResponse;
         body: Accounts;
     }>;
+    /**
+     *
+     * @summary Deletes a specific bank transfer
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param bankTransferID Xero generated unique identifier for a bank transfer
+     * @param bankTransferDeleteByUrlParam
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+     */
+    deleteBankTransfer(xeroTenantId: string, bankTransferID: string, bankTransferDeleteByUrlParam: BankTransferDeleteByUrlParam, idempotencyKey?: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: AxiosResponse;
+        body: BankTransfers;
+    }>;
+    /**
+     *
+     * @summary Deletes one or more bank transfers
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param bankTransfersDelete BankTransfers with array of BankTransfer objects in request body
+     * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+     */
+    deleteBankTransfers(xeroTenantId: string, bankTransfersDelete: BankTransfersDelete, summarizeErrors?: boolean, idempotencyKey?: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: AxiosResponse;
+        body: BankTransfers;
+    }>;
     /**
      *
      * @summary Updates a specific batch payment for invoices and credit notes
@@ -1431,8 +1465,9 @@ export declare class AccountingApi {
      * @param ifModifiedSince Only records created or modified since this timestamp will be returned
      * @param where Filter by an any element
      * @param order Order by an any element
+     * @param includeDeleted e.g. includeDeleted&#x3D;true - Bank transfers with a status of DELETED will be included in the response
      */
-    getBankTransfers(xeroTenantId: string, ifModifiedSince?: Date, where?: string, order?: string, options?: {
+    getBankTransfers(xeroTenantId: string, ifModifiedSince?: Date, where?: string, order?: string, includeDeleted?: boolean, options?: {
         headers: {
             [name: string]: string;
         };

package/dist/gen/api/accountingApi.js

@@ -3,7 +3,7 @@
  * Xero Accounting API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 14.0.0
+ * The version of the OpenAPI document: 16.1.0
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -39,7 +39,7 @@ var AccountingApiApiKeys;
 class AccountingApi {
     constructor(basePathOrUsername, password, basePath) {
         this._basePath = defaultBasePath;
-        this.defaultHeaders = { 'user-agent': 'xero-node-17.0.0' };
+        this.defaultHeaders = { 'user-agent': 'xero-node-19.0.0' };
         this._useQuerystring = false;
         this.binaryHeaders = {};
         this.authentications = {
@@ -4750,6 +4750,162 @@ class AccountingApi {
             });
         });
     }
+    /**
+     *
+     * @summary Deletes a specific bank transfer
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param bankTransferID Xero generated unique identifier for a bank transfer
+     * @param bankTransferDeleteByUrlParam
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+     */
+    deleteBankTransfer(xeroTenantId_1, bankTransferID_1, bankTransferDeleteByUrlParam_1, idempotencyKey_1) {
+        return __awaiter(this, arguments, void 0, function* (xeroTenantId, bankTransferID, bankTransferDeleteByUrlParam, idempotencyKey, options = { headers: {} }) {
+            const localVarPath = this.basePath + '/BankTransfers/{BankTransferID}'
+                .replace('{' + 'BankTransferID' + '}', encodeURIComponent(String(bankTransferID)));
+            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 deleteBankTransfer.');
+            }
+            // verify required parameter 'bankTransferID' is not null or undefined
+            if (bankTransferID === null || bankTransferID === undefined) {
+                throw new Error('Required parameter bankTransferID was null or undefined when calling deleteBankTransfer.');
+            }
+            // verify required parameter 'bankTransferDeleteByUrlParam' is not null or undefined
+            if (bankTransferDeleteByUrlParam === null || bankTransferDeleteByUrlParam === undefined) {
+                throw new Error('Required parameter bankTransferDeleteByUrlParam was null or undefined when calling deleteBankTransfer.');
+            }
+            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(bankTransferDeleteByUrlParam, "BankTransferDeleteByUrlParam"),
+            };
+            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, "BankTransfers");
+                        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 one or more bank transfers
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param bankTransfersDelete BankTransfers with array of BankTransfer objects in request body
+     * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+     */
+    deleteBankTransfers(xeroTenantId_1, bankTransfersDelete_1, summarizeErrors_1, idempotencyKey_1) {
+        return __awaiter(this, arguments, void 0, function* (xeroTenantId, bankTransfersDelete, summarizeErrors, idempotencyKey, options = { headers: {} }) {
+            const localVarPath = this.basePath + '/BankTransfers';
+            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 deleteBankTransfers.');
+            }
+            // verify required parameter 'bankTransfersDelete' is not null or undefined
+            if (bankTransfersDelete === null || bankTransfersDelete === undefined) {
+                throw new Error('Required parameter bankTransfersDelete was null or undefined when calling deleteBankTransfers.');
+            }
+            if (summarizeErrors !== undefined) {
+                localVarQueryParameters['summarizeErrors'] = models_1.ObjectSerializer.serialize(summarizeErrors, "boolean");
+            }
+            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(bankTransfersDelete, "BankTransfersDelete"),
+            };
+            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, "BankTransfers");
+                        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 Updates a specific batch payment for invoices and credit notes
@@ -6986,9 +7142,10 @@ class AccountingApi {
      * @param ifModifiedSince Only records created or modified since this timestamp will be returned
      * @param where Filter by an any element
      * @param order Order by an any element
+     * @param includeDeleted e.g. includeDeleted&#x3D;true - Bank transfers with a status of DELETED will be included in the response
      */
-    getBankTransfers(xeroTenantId_1, ifModifiedSince_1, where_1, order_1) {
-        return __awaiter(this, arguments, void 0, function* (xeroTenantId, ifModifiedSince, where, order, options = { headers: {} }) {
+    getBankTransfers(xeroTenantId_1, ifModifiedSince_1, where_1, order_1, includeDeleted_1) {
+        return __awaiter(this, arguments, void 0, function* (xeroTenantId, ifModifiedSince, where, order, includeDeleted, options = { headers: {} }) {
             const localVarPath = this.basePath + '/BankTransfers';
             let localVarQueryParameters = {};
             let localVarHeaderParams = Object.assign({}, this.defaultHeaders);
@@ -7008,6 +7165,9 @@ class AccountingApi {
             if (order !== undefined) {
                 localVarQueryParameters['order'] = models_1.ObjectSerializer.serialize(order, "string");
             }
+            if (includeDeleted !== undefined) {
+                localVarQueryParameters['includeDeleted'] = models_1.ObjectSerializer.serialize(includeDeleted, "boolean");
+            }
             localVarHeaderParams['xero-tenant-id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
             localVarHeaderParams['If-Modified-Since'] = models_1.ObjectSerializer.serialize(ifModifiedSince, "Date");
             localVarHeaderParams['Accept'] = acceptHeadersFromSpec.join();