@emilgroup/accounting-sdk-node 1.19.0 → 1.20.0

package/dist/api/financial-accounts-api.d.ts

@@ -0,0 +1,327 @@
+/**
+ * EMIL AccountingService
+ * The EMIL AccountingService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreateFinancialAccountRequestDto } from '../models';
+import { CreateFinancialAccountResponseClass } from '../models';
+import { GetFinancialAccountResponseClass } from '../models';
+import { ListFinancialAccountsResponseClass } from '../models';
+/**
+ * FinancialAccountsApi - axios parameter creator
+ * @export
+ */
+export declare const FinancialAccountsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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.accounts.create\"
+     * @summary Create the Financial Account
+     * @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createFinancialAccount: (createFinancialAccountRequestDto: CreateFinancialAccountRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.  **Required Permissions**  \"accounting-management.accounts.delete\"
+     * @summary Delete the Financial Account
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteFinancialAccount: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code      that was returned when you created it and Emil Api will return the corresponding Financial Account information.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary Retrieve the Financial Account
+     * @param {string} code Unique identifier for the object.
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFinancialAccount: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of Financial Accounts you have previously created.          The Financial Accounts are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary List Financial Accounts
+     * @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&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&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&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?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * FinancialAccountsApi - functional programming interface
+ * @export
+ */
+export declare const FinancialAccountsApiFp: (configuration?: Configuration) => {
+    /**
+     * 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.accounts.create\"
+     * @summary Create the Financial Account
+     * @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createFinancialAccount(createFinancialAccountRequestDto: CreateFinancialAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFinancialAccountResponseClass>>;
+    /**
+     * Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.  **Required Permissions**  \"accounting-management.accounts.delete\"
+     * @summary Delete the Financial Account
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteFinancialAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code      that was returned when you created it and Emil Api will return the corresponding Financial Account information.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary Retrieve the Financial Account
+     * @param {string} code Unique identifier for the object.
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFinancialAccount(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFinancialAccountResponseClass>>;
+    /**
+     * Returns a list of Financial Accounts you have previously created.          The Financial Accounts are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary List Financial Accounts
+     * @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&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&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&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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialAccountsResponseClass>>;
+};
+/**
+ * FinancialAccountsApi - factory interface
+ * @export
+ */
+export declare const FinancialAccountsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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.accounts.create\"
+     * @summary Create the Financial Account
+     * @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createFinancialAccount(createFinancialAccountRequestDto: CreateFinancialAccountRequestDto, authorization?: string, options?: any): AxiosPromise<CreateFinancialAccountResponseClass>;
+    /**
+     * Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.  **Required Permissions**  \"accounting-management.accounts.delete\"
+     * @summary Delete the Financial Account
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteFinancialAccount(code: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code      that was returned when you created it and Emil Api will return the corresponding Financial Account information.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary Retrieve the Financial Account
+     * @param {string} code Unique identifier for the object.
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFinancialAccount(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetFinancialAccountResponseClass>;
+    /**
+     * Returns a list of Financial Accounts you have previously created.          The Financial Accounts are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary List Financial Accounts
+     * @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&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&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&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>;
+};
+/**
+ * Request parameters for createFinancialAccount operation in FinancialAccountsApi.
+ * @export
+ * @interface FinancialAccountsApiCreateFinancialAccountRequest
+ */
+export interface FinancialAccountsApiCreateFinancialAccountRequest {
+    /**
+     *
+     * @type {CreateFinancialAccountRequestDto}
+     * @memberof FinancialAccountsApiCreateFinancialAccount
+     */
+    readonly createFinancialAccountRequestDto: CreateFinancialAccountRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof FinancialAccountsApiCreateFinancialAccount
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteFinancialAccount operation in FinancialAccountsApi.
+ * @export
+ * @interface FinancialAccountsApiDeleteFinancialAccountRequest
+ */
+export interface FinancialAccountsApiDeleteFinancialAccountRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof FinancialAccountsApiDeleteFinancialAccount
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof FinancialAccountsApiDeleteFinancialAccount
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getFinancialAccount operation in FinancialAccountsApi.
+ * @export
+ * @interface FinancialAccountsApiGetFinancialAccountRequest
+ */
+export interface FinancialAccountsApiGetFinancialAccountRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof FinancialAccountsApiGetFinancialAccount
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FinancialAccountsApiGetFinancialAccount
+     */
+    readonly expand: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof FinancialAccountsApiGetFinancialAccount
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listFinancialAccounts operation in FinancialAccountsApi.
+ * @export
+ * @interface FinancialAccountsApiListFinancialAccountsRequest
+ */
+export interface FinancialAccountsApiListFinancialAccountsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof FinancialAccountsApiListFinancialAccounts
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof FinancialAccountsApiListFinancialAccounts
+     */
+    readonly pageSize?: number;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof FinancialAccountsApiListFinancialAccounts
+     */
+    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&lt;/i&gt;
+     * @type {string}
+     * @memberof FinancialAccountsApiListFinancialAccounts
+     */
+    readonly filter?: string;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {string}
+     * @memberof FinancialAccountsApiListFinancialAccounts
+     */
+    readonly search?: string;
+    /**
+     * 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&lt;/i&gt;
+     * @type {string}
+     * @memberof FinancialAccountsApiListFinancialAccounts
+     */
+    readonly order?: string;
+    /**
+     * 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;
+     * @type {string}
+     * @memberof FinancialAccountsApiListFinancialAccounts
+     */
+    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&lt;/i&gt;
+     * @type {string}
+     * @memberof FinancialAccountsApiListFinancialAccounts
+     */
+    readonly filters?: string;
+}
+/**
+ * FinancialAccountsApi - object-oriented interface
+ * @export
+ * @class FinancialAccountsApi
+ * @extends {BaseAPI}
+ */
+export declare 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.accounts.create\"
+     * @summary Create the Financial Account
+     * @param {FinancialAccountsApiCreateFinancialAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FinancialAccountsApi
+     */
+    createFinancialAccount(requestParameters: FinancialAccountsApiCreateFinancialAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateFinancialAccountResponseClass, any>>;
+    /**
+     * Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.  **Required Permissions**  \"accounting-management.accounts.delete\"
+     * @summary Delete the Financial Account
+     * @param {FinancialAccountsApiDeleteFinancialAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FinancialAccountsApi
+     */
+    deleteFinancialAccount(requestParameters: FinancialAccountsApiDeleteFinancialAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code      that was returned when you created it and Emil Api will return the corresponding Financial Account information.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary Retrieve the Financial Account
+     * @param {FinancialAccountsApiGetFinancialAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FinancialAccountsApi
+     */
+    getFinancialAccount(requestParameters: FinancialAccountsApiGetFinancialAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFinancialAccountResponseClass, any>>;
+    /**
+     * Returns a list of Financial Accounts you have previously created.          The Financial Accounts are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary List Financial Accounts
+     * @param {FinancialAccountsApiListFinancialAccountsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FinancialAccountsApi
+     */
+    listFinancialAccounts(requestParameters?: FinancialAccountsApiListFinancialAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFinancialAccountsResponseClass, any>>;
+}