xero-node 4.20.1 → 4.23.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: 2.22.4
+ * The version of the OpenAPI document: 2.25.0
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -19,6 +19,8 @@ import { Allocations } from '../model/accounting/allocations';
 import { Attachments } from '../model/accounting/attachments';
 import { BankTransactions } from '../model/accounting/bankTransactions';
 import { BankTransfers } from '../model/accounting/bankTransfers';
+import { BatchPaymentDelete } from '../model/accounting/batchPaymentDelete';
+import { BatchPaymentDeleteByUrlParam } from '../model/accounting/batchPaymentDeleteByUrlParam';
 import { BatchPayments } from '../model/accounting/batchPayments';
 import { BrandingThemes } from '../model/accounting/brandingThemes';
 import { Budgets } from '../model/accounting/budgets';
@@ -873,6 +875,21 @@ export declare class AccountingApi {
         response: http.IncomingMessage;
         body: HistoryRecords;
     }>;
+    /**
+     *
+     * @summary Creates one or more repeating invoice templates
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param repeatingInvoices RepeatingInvoices with an array of repeating invoice objects in body of request
+     * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
+     */
+    createRepeatingInvoices(xeroTenantId: string, repeatingInvoices: RepeatingInvoices, summarizeErrors?: boolean, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: RepeatingInvoices;
+    }>;
     /**
      *
      * @summary Creates one or more tax rates
@@ -930,6 +947,35 @@ export declare class AccountingApi {
         response: http.IncomingMessage;
         body: Accounts;
     }>;
+    /**
+     *
+     * @summary Updates a specific batch payment for invoices and credit notes
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param batchPaymentDelete
+     */
+    deleteBatchPayment(xeroTenantId: string, batchPaymentDelete: BatchPaymentDelete, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: BatchPayments;
+    }>;
+    /**
+     *
+     * @summary Updates a specific batch payment for invoices and credit notes
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param batchPaymentID Unique identifier for BatchPayment
+     * @param batchPaymentDeleteByUrlParam
+     */
+    deleteBatchPaymentByUrlParam(xeroTenantId: string, batchPaymentID: string, batchPaymentDeleteByUrlParam: BatchPaymentDeleteByUrlParam, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: BatchPayments;
+    }>;
     /**
      *
      * @summary Deletes a specific contact from a contact group using a unique contact Id
@@ -3385,6 +3431,21 @@ export declare class AccountingApi {
         response: http.IncomingMessage;
         body: Quotes;
     }>;
+    /**
+     *
+     * @summary Creates or deletes one or more repeating invoice templates
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param repeatingInvoices RepeatingInvoices with an array of repeating invoice objects in body of request
+     * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
+     */
+    updateOrCreateRepeatingInvoices(xeroTenantId: string, repeatingInvoices: RepeatingInvoices, summarizeErrors?: boolean, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: RepeatingInvoices;
+    }>;
     /**
      *
      * @summary Updates a specific purchase order
@@ -3479,6 +3540,21 @@ export declare class AccountingApi {
         response: http.IncomingMessage;
         body: Attachments;
     }>;
+    /**
+     *
+     * @summary Deletes a specific repeating invoice template
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param repeatingInvoiceID Unique identifier for a Repeating Invoice
+     * @param repeatingInvoices
+     */
+    updateRepeatingInvoice(xeroTenantId: string, repeatingInvoiceID: string, repeatingInvoices: RepeatingInvoices, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: RepeatingInvoices;
+    }>;
     /**
      *
      * @summary Updates a specific attachment from a specific repeating invoices by file name

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: 2.22.4
+ * The version of the OpenAPI document: 2.25.0
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -34,7 +34,7 @@ var AccountingApiApiKeys;
 class AccountingApi {
     constructor(basePathOrUsername, password, basePath) {
         this._basePath = defaultBasePath;
-        this.defaultHeaders = { 'user-agent': 'xero-node-4.20.1' };
+        this.defaultHeaders = { 'user-agent': 'xero-node-4.23.0' };
         this._useQuerystring = false;
         this.binaryHeaders = {};
         this.authentications = {
@@ -3950,6 +3950,73 @@ class AccountingApi {
             });
         });
     }
+    /**
+     *
+     * @summary Creates one or more repeating invoice templates
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param repeatingInvoices RepeatingInvoices with an array of repeating invoice objects in body of request
+     * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
+     */
+    createRepeatingInvoices(xeroTenantId, repeatingInvoices, summarizeErrors, options = { headers: {} }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = this.basePath + '/RepeatingInvoices';
+            let localVarQueryParameters = {};
+            let localVarHeaderParams = Object.assign({}, this.defaultHeaders);
+            let localVarFormParams = {};
+            // 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 createRepeatingInvoices.');
+            }
+            // verify required parameter 'repeatingInvoices' is not null or undefined
+            if (repeatingInvoices === null || repeatingInvoices === undefined) {
+                throw new Error('Required parameter repeatingInvoices was null or undefined when calling createRepeatingInvoices.');
+            }
+            if (summarizeErrors !== undefined) {
+                localVarQueryParameters['summarizeErrors'] = models_1.ObjectSerializer.serialize(summarizeErrors, "boolean");
+            }
+            localVarHeaderParams['xero-tenant-id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            Object.assign(localVarHeaderParams, options.headers);
+            let localVarUseFormData = false;
+            let localVarRequestOptions = {
+                method: 'PUT',
+                qs: localVarQueryParameters,
+                headers: localVarHeaderParams,
+                uri: localVarPath,
+                useQuerystring: this._useQuerystring,
+                json: true,
+                body: models_1.ObjectSerializer.serialize(repeatingInvoices, "RepeatingInvoices")
+            };
+            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.formData = localVarFormParams;
+                    }
+                    else {
+                        localVarRequestOptions.form = localVarFormParams;
+                    }
+                }
+                return new Promise((resolve, reject) => {
+                    localVarRequest(localVarRequestOptions, (error, response, body) => {
+                        if (error) {
+                            reject(error);
+                        }
+                        else {
+                            body = models_1.ObjectSerializer.deserialize(body, "RepeatingInvoices");
+                            if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                                resolve({ response: response, body: body });
+                            }
+                            else {
+                                reject({ response: response, body: body });
+                            }
+                        }
+                    });
+                });
+            });
+        });
+    }
     /**
      *
      * @summary Creates one or more tax rates
@@ -4208,6 +4275,138 @@ class AccountingApi {
             });
         });
     }
+    /**
+     *
+     * @summary Updates a specific batch payment for invoices and credit notes
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param batchPaymentDelete
+     */
+    deleteBatchPayment(xeroTenantId, batchPaymentDelete, options = { headers: {} }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = this.basePath + '/BatchPayments';
+            let localVarQueryParameters = {};
+            let localVarHeaderParams = Object.assign({}, this.defaultHeaders);
+            let localVarFormParams = {};
+            // 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 deleteBatchPayment.');
+            }
+            // verify required parameter 'batchPaymentDelete' is not null or undefined
+            if (batchPaymentDelete === null || batchPaymentDelete === undefined) {
+                throw new Error('Required parameter batchPaymentDelete was null or undefined when calling deleteBatchPayment.');
+            }
+            localVarHeaderParams['xero-tenant-id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            Object.assign(localVarHeaderParams, options.headers);
+            let localVarUseFormData = false;
+            let localVarRequestOptions = {
+                method: 'POST',
+                qs: localVarQueryParameters,
+                headers: localVarHeaderParams,
+                uri: localVarPath,
+                useQuerystring: this._useQuerystring,
+                json: true,
+                body: models_1.ObjectSerializer.serialize(batchPaymentDelete, "BatchPaymentDelete")
+            };
+            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.formData = localVarFormParams;
+                    }
+                    else {
+                        localVarRequestOptions.form = localVarFormParams;
+                    }
+                }
+                return new Promise((resolve, reject) => {
+                    localVarRequest(localVarRequestOptions, (error, response, body) => {
+                        if (error) {
+                            reject(error);
+                        }
+                        else {
+                            body = models_1.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 Updates a specific batch payment for invoices and credit notes
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param batchPaymentID Unique identifier for BatchPayment
+     * @param batchPaymentDeleteByUrlParam
+     */
+    deleteBatchPaymentByUrlParam(xeroTenantId, batchPaymentID, batchPaymentDeleteByUrlParam, options = { headers: {} }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = this.basePath + '/BatchPayments/{BatchPaymentID}'
+                .replace('{' + 'BatchPaymentID' + '}', encodeURIComponent(String(batchPaymentID)));
+            let localVarQueryParameters = {};
+            let localVarHeaderParams = Object.assign({}, this.defaultHeaders);
+            let localVarFormParams = {};
+            // 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 deleteBatchPaymentByUrlParam.');
+            }
+            // 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 deleteBatchPaymentByUrlParam.');
+            }
+            // verify required parameter 'batchPaymentDeleteByUrlParam' is not null or undefined
+            if (batchPaymentDeleteByUrlParam === null || batchPaymentDeleteByUrlParam === undefined) {
+                throw new Error('Required parameter batchPaymentDeleteByUrlParam was null or undefined when calling deleteBatchPaymentByUrlParam.');
+            }
+            localVarHeaderParams['xero-tenant-id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            Object.assign(localVarHeaderParams, options.headers);
+            let localVarUseFormData = false;
+            let localVarRequestOptions = {
+                method: 'POST',
+                qs: localVarQueryParameters,
+                headers: localVarHeaderParams,
+                uri: localVarPath,
+                useQuerystring: this._useQuerystring,
+                json: true,
+                body: models_1.ObjectSerializer.serialize(batchPaymentDeleteByUrlParam, "BatchPaymentDeleteByUrlParam")
+            };
+            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.formData = localVarFormParams;
+                    }
+                    else {
+                        localVarRequestOptions.form = localVarFormParams;
+                    }
+                }
+                return new Promise((resolve, reject) => {
+                    localVarRequest(localVarRequestOptions, (error, response, body) => {
+                        if (error) {
+                            reject(error);
+                        }
+                        else {
+                            body = models_1.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 Deletes a specific contact from a contact group using a unique contact Id
@@ -15411,6 +15610,73 @@ class AccountingApi {
             });
         });
     }
+    /**
+     *
+     * @summary Creates or deletes one or more repeating invoice templates
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param repeatingInvoices RepeatingInvoices with an array of repeating invoice objects in body of request
+     * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
+     */
+    updateOrCreateRepeatingInvoices(xeroTenantId, repeatingInvoices, summarizeErrors, options = { headers: {} }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = this.basePath + '/RepeatingInvoices';
+            let localVarQueryParameters = {};
+            let localVarHeaderParams = Object.assign({}, this.defaultHeaders);
+            let localVarFormParams = {};
+            // 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 updateOrCreateRepeatingInvoices.');
+            }
+            // verify required parameter 'repeatingInvoices' is not null or undefined
+            if (repeatingInvoices === null || repeatingInvoices === undefined) {
+                throw new Error('Required parameter repeatingInvoices was null or undefined when calling updateOrCreateRepeatingInvoices.');
+            }
+            if (summarizeErrors !== undefined) {
+                localVarQueryParameters['summarizeErrors'] = models_1.ObjectSerializer.serialize(summarizeErrors, "boolean");
+            }
+            localVarHeaderParams['xero-tenant-id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            Object.assign(localVarHeaderParams, options.headers);
+            let localVarUseFormData = false;
+            let localVarRequestOptions = {
+                method: 'POST',
+                qs: localVarQueryParameters,
+                headers: localVarHeaderParams,
+                uri: localVarPath,
+                useQuerystring: this._useQuerystring,
+                json: true,
+                body: models_1.ObjectSerializer.serialize(repeatingInvoices, "RepeatingInvoices")
+            };
+            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.formData = localVarFormParams;
+                    }
+                    else {
+                        localVarRequestOptions.form = localVarFormParams;
+                    }
+                }
+                return new Promise((resolve, reject) => {
+                    localVarRequest(localVarRequestOptions, (error, response, body) => {
+                        if (error) {
+                            reject(error);
+                        }
+                        else {
+                            body = models_1.ObjectSerializer.deserialize(body, "RepeatingInvoices");
+                            if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                                resolve({ response: response, body: body });
+                            }
+                            else {
+                                reject({ response: response, body: body });
+                            }
+                        }
+                    });
+                });
+            });
+        });
+    }
     /**
      *
      * @summary Updates a specific purchase order
@@ -15919,6 +16185,75 @@ class AccountingApi {
             });
         });
     }
+    /**
+     *
+     * @summary Deletes a specific repeating invoice template
+     * @param xeroTenantId Xero identifier for Tenant
+     * @param repeatingInvoiceID Unique identifier for a Repeating Invoice
+     * @param repeatingInvoices
+     */
+    updateRepeatingInvoice(xeroTenantId, repeatingInvoiceID, repeatingInvoices, options = { headers: {} }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = this.basePath + '/RepeatingInvoices/{RepeatingInvoiceID}'
+                .replace('{' + 'RepeatingInvoiceID' + '}', encodeURIComponent(String(repeatingInvoiceID)));
+            let localVarQueryParameters = {};
+            let localVarHeaderParams = Object.assign({}, this.defaultHeaders);
+            let localVarFormParams = {};
+            // 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 updateRepeatingInvoice.');
+            }
+            // verify required parameter 'repeatingInvoiceID' is not null or undefined
+            if (repeatingInvoiceID === null || repeatingInvoiceID === undefined) {
+                throw new Error('Required parameter repeatingInvoiceID was null or undefined when calling updateRepeatingInvoice.');
+            }
+            // verify required parameter 'repeatingInvoices' is not null or undefined
+            if (repeatingInvoices === null || repeatingInvoices === undefined) {
+                throw new Error('Required parameter repeatingInvoices was null or undefined when calling updateRepeatingInvoice.');
+            }
+            localVarHeaderParams['xero-tenant-id'] = models_1.ObjectSerializer.serialize(xeroTenantId, "string");
+            Object.assign(localVarHeaderParams, options.headers);
+            let localVarUseFormData = false;
+            let localVarRequestOptions = {
+                method: 'POST',
+                qs: localVarQueryParameters,
+                headers: localVarHeaderParams,
+                uri: localVarPath,
+                useQuerystring: this._useQuerystring,
+                json: true,
+                body: models_1.ObjectSerializer.serialize(repeatingInvoices, "RepeatingInvoices")
+            };
+            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.formData = localVarFormParams;
+                    }
+                    else {
+                        localVarRequestOptions.form = localVarFormParams;
+                    }
+                }
+                return new Promise((resolve, reject) => {
+                    localVarRequest(localVarRequestOptions, (error, response, body) => {
+                        if (error) {
+                            reject(error);
+                        }
+                        else {
+                            body = models_1.ObjectSerializer.deserialize(body, "RepeatingInvoices");
+                            if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                                resolve({ response: response, body: body });
+                            }
+                            else {
+                                reject({ response: response, body: body });
+                            }
+                        }
+                    });
+                });
+            });
+        });
+    }
     /**
      *
      * @summary Updates a specific attachment from a specific repeating invoices by file name