@emilgroup/accounting-sdk 1.34.1-beta.4 → 1.34.1-beta.40

package/api/financial-accounts-api.ts

@@ -28,6 +28,10 @@ import { CreateFinancialAccountResponseClass } from '../models';
 import { GetFinancialAccountResponseClass } from '../models';
 // @ts-ignore
 import { ListFinancialAccountsResponseClass } from '../models';
+// @ts-ignore
+import { UpdateFinancialAccountBodyDto } from '../models';
+// @ts-ignore
+import { UpdateFinancialAccountResponseClass } from '../models';
 /**
  * FinancialAccountsApi - axios parameter creator
  * @export
@@ -35,7 +39,7 @@ import { ListFinancialAccountsResponseClass } from '../models';
 export const FinancialAccountsApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * This will create an financial account in the database.     The financial account will be created with the provided name, type, and account number.     Optionally, you can provide a parent financial account ID to create a sub-account.  **Required Permissions**  \"accounting-management.financial-accounts.create\"
+         * This will create an financial account in the database.     The financial account will be created with the provided name, type, and account number.     Optionally, you can provide a parent financial account ID to create a sub-account.     A bank-category account may also name the connected bank account it books, via     linkedBankAccountCode; the bank account\'s IBAN is stored alongside it for display.  **Required Permissions**  \"accounting-management.financial-accounts.create\"
          * @summary Create the Financial Account
          * @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto 
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -184,11 +188,11 @@ export const FinancialAccountsApiAxiosParamCreator = function (configuration?: C
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
          * @param {string} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
-         * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>             <br/>             <i>Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type, status, isControlAccount, functionalCategory</i>
+         * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>             <br/>             <i>Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban</i>
          * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
          * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: id, createdAt, name, financialAccountNumber, description, functionalCategory, type</i>
          * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.<br/>       <br/>       
-         * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type, status, isControlAccount, functionalCategory</i>
+         * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -249,6 +253,57 @@ export const FinancialAccountsApiAxiosParamCreator = function (configuration?: C
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
 
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Updates name and description (always editable), financialAccountNumber (only while the account is not locked), isDefault (pool-category accounts only; cannot be unset), and linkedBankAccountCode (bank-category accounts only; send an empty string to unlink, omit to leave the link untouched). Linking stays editable once the account is locked, and applies to later postings only.  **Required Permissions**  \"accounting-management.financial-accounts.update\"
+         * @summary Update the Financial Account
+         * @param {string} code Unique identifier for the object.
+         * @param {UpdateFinancialAccountBodyDto} updateFinancialAccountBodyDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateFinancialAccount: async (code: string, updateFinancialAccountBodyDto: UpdateFinancialAccountBodyDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('updateFinancialAccount', 'code', code)
+            // verify required parameter 'updateFinancialAccountBodyDto' is not null or undefined
+            assertParamExists('updateFinancialAccount', 'updateFinancialAccountBodyDto', updateFinancialAccountBodyDto)
+            const localVarPath = `/accountingservice/v1/financial-accounts/{code}`
+                .replace(`{${"code"}}`, encodeURIComponent(String(code)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(updateFinancialAccountBodyDto, localVarRequestOptions, configuration)
+
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -265,7 +320,7 @@ export const FinancialAccountsApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = FinancialAccountsApiAxiosParamCreator(configuration)
     return {
         /**
-         * This will create an financial account in the database.     The financial account will be created with the provided name, type, and account number.     Optionally, you can provide a parent financial account ID to create a sub-account.  **Required Permissions**  \"accounting-management.financial-accounts.create\"
+         * This will create an financial account in the database.     The financial account will be created with the provided name, type, and account number.     Optionally, you can provide a parent financial account ID to create a sub-account.     A bank-category account may also name the connected bank account it books, via     linkedBankAccountCode; the bank account\'s IBAN is stored alongside it for display.  **Required Permissions**  \"accounting-management.financial-accounts.create\"
          * @summary Create the Financial Account
          * @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto 
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -307,11 +362,11 @@ export const FinancialAccountsApiFp = function(configuration?: Configuration) {
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
          * @param {string} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
-         * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;             &lt;br/&gt;             &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type, status, isControlAccount, functionalCategory&lt;/i&gt;
+         * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;             &lt;br/&gt;             &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban&lt;/i&gt;
          * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
          * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt, name, financialAccountNumber, description, functionalCategory, type&lt;/i&gt;
          * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       
-         * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type, status, isControlAccount, functionalCategory&lt;/i&gt;
+         * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -319,6 +374,19 @@ export const FinancialAccountsApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Updates name and description (always editable), financialAccountNumber (only while the account is not locked), isDefault (pool-category accounts only; cannot be unset), and linkedBankAccountCode (bank-category accounts only; send an empty string to unlink, omit to leave the link untouched). Linking stays editable once the account is locked, and applies to later postings only.  **Required Permissions**  \"accounting-management.financial-accounts.update\"
+         * @summary Update the Financial Account
+         * @param {string} code Unique identifier for the object.
+         * @param {UpdateFinancialAccountBodyDto} updateFinancialAccountBodyDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async updateFinancialAccount(code: string, updateFinancialAccountBodyDto: UpdateFinancialAccountBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateFinancialAccountResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.updateFinancialAccount(code, updateFinancialAccountBodyDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
     }
 };
 
@@ -330,7 +398,7 @@ export const FinancialAccountsApiFactory = function (configuration?: Configurati
     const localVarFp = FinancialAccountsApiFp(configuration)
     return {
         /**
-         * This will create an financial account in the database.     The financial account will be created with the provided name, type, and account number.     Optionally, you can provide a parent financial account ID to create a sub-account.  **Required Permissions**  \"accounting-management.financial-accounts.create\"
+         * This will create an financial account in the database.     The financial account will be created with the provided name, type, and account number.     Optionally, you can provide a parent financial account ID to create a sub-account.     A bank-category account may also name the connected bank account it books, via     linkedBankAccountCode; the bank account\'s IBAN is stored alongside it for display.  **Required Permissions**  \"accounting-management.financial-accounts.create\"
          * @summary Create the Financial Account
          * @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto 
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -369,17 +437,29 @@ export const FinancialAccountsApiFactory = function (configuration?: Configurati
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
          * @param {string} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
-         * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;             &lt;br/&gt;             &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type, status, isControlAccount, functionalCategory&lt;/i&gt;
+         * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;             &lt;br/&gt;             &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban&lt;/i&gt;
          * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
          * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt, name, financialAccountNumber, description, functionalCategory, type&lt;/i&gt;
          * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       
-         * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type, status, isControlAccount, functionalCategory&lt;/i&gt;
+         * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
         listFinancialAccounts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListFinancialAccountsResponseClass> {
             return localVarFp.listFinancialAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Updates name and description (always editable), financialAccountNumber (only while the account is not locked), isDefault (pool-category accounts only; cannot be unset), and linkedBankAccountCode (bank-category accounts only; send an empty string to unlink, omit to leave the link untouched). Linking stays editable once the account is locked, and applies to later postings only.  **Required Permissions**  \"accounting-management.financial-accounts.update\"
+         * @summary Update the Financial Account
+         * @param {string} code Unique identifier for the object.
+         * @param {UpdateFinancialAccountBodyDto} updateFinancialAccountBodyDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateFinancialAccount(code: string, updateFinancialAccountBodyDto: UpdateFinancialAccountBodyDto, authorization?: string, options?: any): AxiosPromise<UpdateFinancialAccountResponseClass> {
+            return localVarFp.updateFinancialAccount(code, updateFinancialAccountBodyDto, authorization, options).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -481,7 +561,7 @@ export interface FinancialAccountsApiListFinancialAccountsRequest {
     readonly pageToken?: string
 
     /**
-     * Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;             &lt;br/&gt;             &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type, status, isControlAccount, functionalCategory&lt;/i&gt;
+     * Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;             &lt;br/&gt;             &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban&lt;/i&gt;
      * @type {string}
      * @memberof FinancialAccountsApiListFinancialAccounts
      */
@@ -509,13 +589,41 @@ export interface FinancialAccountsApiListFinancialAccountsRequest {
     readonly expand?: string
 
     /**
-     * Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type, status, isControlAccount, functionalCategory&lt;/i&gt;
+     * Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type, status, isControlAccount, functionalCategory, linkedBankAccountCode, linkedBankAccountIban&lt;/i&gt;
      * @type {string}
      * @memberof FinancialAccountsApiListFinancialAccounts
      */
     readonly filters?: string
 }
 
+/**
+ * Request parameters for updateFinancialAccount operation in FinancialAccountsApi.
+ * @export
+ * @interface FinancialAccountsApiUpdateFinancialAccountRequest
+ */
+export interface FinancialAccountsApiUpdateFinancialAccountRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof FinancialAccountsApiUpdateFinancialAccount
+     */
+    readonly code: string
+
+    /**
+     * 
+     * @type {UpdateFinancialAccountBodyDto}
+     * @memberof FinancialAccountsApiUpdateFinancialAccount
+     */
+    readonly updateFinancialAccountBodyDto: UpdateFinancialAccountBodyDto
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof FinancialAccountsApiUpdateFinancialAccount
+     */
+    readonly authorization?: string
+}
+
 /**
  * FinancialAccountsApi - object-oriented interface
  * @export
@@ -524,7 +632,7 @@ export interface FinancialAccountsApiListFinancialAccountsRequest {
  */
 export class FinancialAccountsApi extends BaseAPI {
     /**
-     * This will create an financial account in the database.     The financial account will be created with the provided name, type, and account number.     Optionally, you can provide a parent financial account ID to create a sub-account.  **Required Permissions**  \"accounting-management.financial-accounts.create\"
+     * This will create an financial account in the database.     The financial account will be created with the provided name, type, and account number.     Optionally, you can provide a parent financial account ID to create a sub-account.     A bank-category account may also name the connected bank account it books, via     linkedBankAccountCode; the bank account\'s IBAN is stored alongside it for display.  **Required Permissions**  \"accounting-management.financial-accounts.create\"
      * @summary Create the Financial Account
      * @param {FinancialAccountsApiCreateFinancialAccountRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -570,4 +678,16 @@ export class FinancialAccountsApi extends BaseAPI {
     public listFinancialAccounts(requestParameters: FinancialAccountsApiListFinancialAccountsRequest = {}, options?: AxiosRequestConfig) {
         return FinancialAccountsApiFp(this.configuration).listFinancialAccounts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * Updates name and description (always editable), financialAccountNumber (only while the account is not locked), isDefault (pool-category accounts only; cannot be unset), and linkedBankAccountCode (bank-category accounts only; send an empty string to unlink, omit to leave the link untouched). Linking stays editable once the account is locked, and applies to later postings only.  **Required Permissions**  \"accounting-management.financial-accounts.update\"
+     * @summary Update the Financial Account
+     * @param {FinancialAccountsApiUpdateFinancialAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FinancialAccountsApi
+     */
+    public updateFinancialAccount(requestParameters: FinancialAccountsApiUpdateFinancialAccountRequest, options?: AxiosRequestConfig) {
+        return FinancialAccountsApiFp(this.configuration).updateFinancialAccount(requestParameters.code, requestParameters.updateFinancialAccountBodyDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
 }