@emilgroup/accounting-sdk-node 1.19.0 → 1.20.0

package/dist/api/personal-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 { CreatePersonalAccountRequestDto } from '../models';
+import { CreatePersonalAccountResponseClass } from '../models';
+import { GetPersonalAccountResponseClass } from '../models';
+import { ListPersonalAccountsResponseClass } from '../models';
+/**
+ * PersonalAccountsApi - axios parameter creator
+ * @export
+ */
+export declare const PersonalAccountsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create an personal account in the database.      The personal account will be created with the provided name, type, and account number.      personal account should be created with a financial account number.  **Required Permissions**  \"accounting-management.accounts.create\"
+     * @summary Create the Personal Account
+     * @param {CreatePersonalAccountRequestDto} createPersonalAccountRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPersonalAccount: (createPersonalAccountRequestDto: CreatePersonalAccountRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the Personal Account. Supply the unique code that was returned when you created the Personal Account and this will delete it.  **Required Permissions**  \"accounting-management.accounts.delete\"
+     * @summary Delete the Personal 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}
+     */
+    deletePersonalAccount: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the Personal Account that was previously created. Supply the unique Personal Account code      that was returned when you created it and Emil Api will return the corresponding Personal Account information.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary Retrieve the Personal 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}
+     */
+    getPersonalAccount: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of Personal Accounts you have previously created.          The Personal 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 Personal 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, personalAccountNumber, createdAt, partnerNumber, 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, personalAccountNumber&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, personalAccountNumber, createdAt, partnerNumber, type&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPersonalAccounts: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PersonalAccountsApi - functional programming interface
+ * @export
+ */
+export declare const PersonalAccountsApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create an personal account in the database.      The personal account will be created with the provided name, type, and account number.      personal account should be created with a financial account number.  **Required Permissions**  \"accounting-management.accounts.create\"
+     * @summary Create the Personal Account
+     * @param {CreatePersonalAccountRequestDto} createPersonalAccountRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPersonalAccount(createPersonalAccountRequestDto: CreatePersonalAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePersonalAccountResponseClass>>;
+    /**
+     * Permanently deletes the Personal Account. Supply the unique code that was returned when you created the Personal Account and this will delete it.  **Required Permissions**  \"accounting-management.accounts.delete\"
+     * @summary Delete the Personal 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}
+     */
+    deletePersonalAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieves the details of the Personal Account that was previously created. Supply the unique Personal Account code      that was returned when you created it and Emil Api will return the corresponding Personal Account information.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary Retrieve the Personal 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}
+     */
+    getPersonalAccount(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPersonalAccountResponseClass>>;
+    /**
+     * Returns a list of Personal Accounts you have previously created.          The Personal 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 Personal 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, personalAccountNumber, createdAt, partnerNumber, 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, personalAccountNumber&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, personalAccountNumber, createdAt, partnerNumber, type&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPersonalAccounts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPersonalAccountsResponseClass>>;
+};
+/**
+ * PersonalAccountsApi - factory interface
+ * @export
+ */
+export declare const PersonalAccountsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create an personal account in the database.      The personal account will be created with the provided name, type, and account number.      personal account should be created with a financial account number.  **Required Permissions**  \"accounting-management.accounts.create\"
+     * @summary Create the Personal Account
+     * @param {CreatePersonalAccountRequestDto} createPersonalAccountRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPersonalAccount(createPersonalAccountRequestDto: CreatePersonalAccountRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePersonalAccountResponseClass>;
+    /**
+     * Permanently deletes the Personal Account. Supply the unique code that was returned when you created the Personal Account and this will delete it.  **Required Permissions**  \"accounting-management.accounts.delete\"
+     * @summary Delete the Personal 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}
+     */
+    deletePersonalAccount(code: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * Retrieves the details of the Personal Account that was previously created. Supply the unique Personal Account code      that was returned when you created it and Emil Api will return the corresponding Personal Account information.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary Retrieve the Personal 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}
+     */
+    getPersonalAccount(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetPersonalAccountResponseClass>;
+    /**
+     * Returns a list of Personal Accounts you have previously created.          The Personal 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 Personal 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, personalAccountNumber, createdAt, partnerNumber, 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, personalAccountNumber&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, personalAccountNumber, createdAt, partnerNumber, type&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPersonalAccounts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPersonalAccountsResponseClass>;
+};
+/**
+ * Request parameters for createPersonalAccount operation in PersonalAccountsApi.
+ * @export
+ * @interface PersonalAccountsApiCreatePersonalAccountRequest
+ */
+export interface PersonalAccountsApiCreatePersonalAccountRequest {
+    /**
+     *
+     * @type {CreatePersonalAccountRequestDto}
+     * @memberof PersonalAccountsApiCreatePersonalAccount
+     */
+    readonly createPersonalAccountRequestDto: CreatePersonalAccountRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PersonalAccountsApiCreatePersonalAccount
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deletePersonalAccount operation in PersonalAccountsApi.
+ * @export
+ * @interface PersonalAccountsApiDeletePersonalAccountRequest
+ */
+export interface PersonalAccountsApiDeletePersonalAccountRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PersonalAccountsApiDeletePersonalAccount
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PersonalAccountsApiDeletePersonalAccount
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getPersonalAccount operation in PersonalAccountsApi.
+ * @export
+ * @interface PersonalAccountsApiGetPersonalAccountRequest
+ */
+export interface PersonalAccountsApiGetPersonalAccountRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PersonalAccountsApiGetPersonalAccount
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PersonalAccountsApiGetPersonalAccount
+     */
+    readonly expand: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PersonalAccountsApiGetPersonalAccount
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listPersonalAccounts operation in PersonalAccountsApi.
+ * @export
+ * @interface PersonalAccountsApiListPersonalAccountsRequest
+ */
+export interface PersonalAccountsApiListPersonalAccountsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PersonalAccountsApiListPersonalAccounts
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof PersonalAccountsApiListPersonalAccounts
+     */
+    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 PersonalAccountsApiListPersonalAccounts
+     */
+    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, personalAccountNumber, createdAt, partnerNumber, type&lt;/i&gt;
+     * @type {string}
+     * @memberof PersonalAccountsApiListPersonalAccounts
+     */
+    readonly filter?: string;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {string}
+     * @memberof PersonalAccountsApiListPersonalAccounts
+     */
+    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, personalAccountNumber&lt;/i&gt;
+     * @type {string}
+     * @memberof PersonalAccountsApiListPersonalAccounts
+     */
+    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 PersonalAccountsApiListPersonalAccounts
+     */
+    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, personalAccountNumber, createdAt, partnerNumber, type&lt;/i&gt;
+     * @type {string}
+     * @memberof PersonalAccountsApiListPersonalAccounts
+     */
+    readonly filters?: string;
+}
+/**
+ * PersonalAccountsApi - object-oriented interface
+ * @export
+ * @class PersonalAccountsApi
+ * @extends {BaseAPI}
+ */
+export declare class PersonalAccountsApi extends BaseAPI {
+    /**
+     * This will create an personal account in the database.      The personal account will be created with the provided name, type, and account number.      personal account should be created with a financial account number.  **Required Permissions**  \"accounting-management.accounts.create\"
+     * @summary Create the Personal Account
+     * @param {PersonalAccountsApiCreatePersonalAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PersonalAccountsApi
+     */
+    createPersonalAccount(requestParameters: PersonalAccountsApiCreatePersonalAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePersonalAccountResponseClass, any>>;
+    /**
+     * Permanently deletes the Personal Account. Supply the unique code that was returned when you created the Personal Account and this will delete it.  **Required Permissions**  \"accounting-management.accounts.delete\"
+     * @summary Delete the Personal Account
+     * @param {PersonalAccountsApiDeletePersonalAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PersonalAccountsApi
+     */
+    deletePersonalAccount(requestParameters: PersonalAccountsApiDeletePersonalAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Retrieves the details of the Personal Account that was previously created. Supply the unique Personal Account code      that was returned when you created it and Emil Api will return the corresponding Personal Account information.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary Retrieve the Personal Account
+     * @param {PersonalAccountsApiGetPersonalAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PersonalAccountsApi
+     */
+    getPersonalAccount(requestParameters: PersonalAccountsApiGetPersonalAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPersonalAccountResponseClass, any>>;
+    /**
+     * Returns a list of Personal Accounts you have previously created.          The Personal 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 Personal Accounts
+     * @param {PersonalAccountsApiListPersonalAccountsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PersonalAccountsApi
+     */
+    listPersonalAccounts(requestParameters?: PersonalAccountsApiListPersonalAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPersonalAccountsResponseClass, any>>;
+}