@emilgroup/accounting-sdk-node 1.18.1-beta.4 → 1.19.0

package/dist/api/number-ranges-api.d.ts

@@ -1,327 +0,0 @@
-/**
- * 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 { CreateNumberRangeRequestDto } from '../models';
-import { CreateNumberRangeResponseClass } from '../models';
-import { GetNumberRangeResponseClass } from '../models';
-import { ListNumberRangeResponseClass } from '../models';
-/**
- * NumberRangesApi - axios parameter creator
- * @export
- */
-export declare const NumberRangesApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     * This will create an number range in the database.      The number range 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 Number Range
-     * @param {CreateNumberRangeRequestDto} createNumberRangeRequestDto
-     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    createNumberRange: (createNumberRangeRequestDto: CreateNumberRangeRequestDto, 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}
-     */
-    deleteNumberRange: (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}
-     */
-    getNumberRange: (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: slug, createdAt, accountType&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, slug, accountType&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: slug, createdAt, accountType&lt;/i&gt;
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listNumberRanges: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-};
-/**
- * NumberRangesApi - functional programming interface
- * @export
- */
-export declare const NumberRangesApiFp: (configuration?: Configuration) => {
-    /**
-     * This will create an number range in the database.      The number range 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 Number Range
-     * @param {CreateNumberRangeRequestDto} createNumberRangeRequestDto
-     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    createNumberRange(createNumberRangeRequestDto: CreateNumberRangeRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateNumberRangeResponseClass>>;
-    /**
-     * 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}
-     */
-    deleteNumberRange(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}
-     */
-    getNumberRange(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetNumberRangeResponseClass>>;
-    /**
-     * 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: slug, createdAt, accountType&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, slug, accountType&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: slug, createdAt, accountType&lt;/i&gt;
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listNumberRanges(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListNumberRangeResponseClass>>;
-};
-/**
- * NumberRangesApi - factory interface
- * @export
- */
-export declare const NumberRangesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     * This will create an number range in the database.      The number range 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 Number Range
-     * @param {CreateNumberRangeRequestDto} createNumberRangeRequestDto
-     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    createNumberRange(createNumberRangeRequestDto: CreateNumberRangeRequestDto, authorization?: string, options?: any): AxiosPromise<CreateNumberRangeResponseClass>;
-    /**
-     * 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}
-     */
-    deleteNumberRange(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}
-     */
-    getNumberRange(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetNumberRangeResponseClass>;
-    /**
-     * 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: slug, createdAt, accountType&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, slug, accountType&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: slug, createdAt, accountType&lt;/i&gt;
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listNumberRanges(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListNumberRangeResponseClass>;
-};
-/**
- * Request parameters for createNumberRange operation in NumberRangesApi.
- * @export
- * @interface NumberRangesApiCreateNumberRangeRequest
- */
-export interface NumberRangesApiCreateNumberRangeRequest {
-    /**
-     *
-     * @type {CreateNumberRangeRequestDto}
-     * @memberof NumberRangesApiCreateNumberRange
-     */
-    readonly createNumberRangeRequestDto: CreateNumberRangeRequestDto;
-    /**
-     * Bearer Token: provided by the login endpoint under the name accessToken.
-     * @type {string}
-     * @memberof NumberRangesApiCreateNumberRange
-     */
-    readonly authorization?: string;
-}
-/**
- * Request parameters for deleteNumberRange operation in NumberRangesApi.
- * @export
- * @interface NumberRangesApiDeleteNumberRangeRequest
- */
-export interface NumberRangesApiDeleteNumberRangeRequest {
-    /**
-     * Unique identifier for the object.
-     * @type {string}
-     * @memberof NumberRangesApiDeleteNumberRange
-     */
-    readonly code: string;
-    /**
-     * Bearer Token: provided by the login endpoint under the name accessToken.
-     * @type {string}
-     * @memberof NumberRangesApiDeleteNumberRange
-     */
-    readonly authorization?: string;
-}
-/**
- * Request parameters for getNumberRange operation in NumberRangesApi.
- * @export
- * @interface NumberRangesApiGetNumberRangeRequest
- */
-export interface NumberRangesApiGetNumberRangeRequest {
-    /**
-     * Unique identifier for the object.
-     * @type {string}
-     * @memberof NumberRangesApiGetNumberRange
-     */
-    readonly code: string;
-    /**
-     *
-     * @type {string}
-     * @memberof NumberRangesApiGetNumberRange
-     */
-    readonly expand: string;
-    /**
-     * Bearer Token: provided by the login endpoint under the name accessToken.
-     * @type {string}
-     * @memberof NumberRangesApiGetNumberRange
-     */
-    readonly authorization?: string;
-}
-/**
- * Request parameters for listNumberRanges operation in NumberRangesApi.
- * @export
- * @interface NumberRangesApiListNumberRangesRequest
- */
-export interface NumberRangesApiListNumberRangesRequest {
-    /**
-     * Bearer Token: provided by the login endpoint under the name accessToken.
-     * @type {string}
-     * @memberof NumberRangesApiListNumberRanges
-     */
-    readonly authorization?: string;
-    /**
-     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
-     * @type {number}
-     * @memberof NumberRangesApiListNumberRanges
-     */
-    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 NumberRangesApiListNumberRanges
-     */
-    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: slug, createdAt, accountType&lt;/i&gt;
-     * @type {string}
-     * @memberof NumberRangesApiListNumberRanges
-     */
-    readonly filter?: string;
-    /**
-     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
-     * @type {string}
-     * @memberof NumberRangesApiListNumberRanges
-     */
-    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, slug, accountType&lt;/i&gt;
-     * @type {string}
-     * @memberof NumberRangesApiListNumberRanges
-     */
-    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 NumberRangesApiListNumberRanges
-     */
-    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: slug, createdAt, accountType&lt;/i&gt;
-     * @type {string}
-     * @memberof NumberRangesApiListNumberRanges
-     */
-    readonly filters?: string;
-}
-/**
- * NumberRangesApi - object-oriented interface
- * @export
- * @class NumberRangesApi
- * @extends {BaseAPI}
- */
-export declare class NumberRangesApi extends BaseAPI {
-    /**
-     * This will create an number range in the database.      The number range 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 Number Range
-     * @param {NumberRangesApiCreateNumberRangeRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof NumberRangesApi
-     */
-    createNumberRange(requestParameters: NumberRangesApiCreateNumberRangeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateNumberRangeResponseClass, 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 {NumberRangesApiDeleteNumberRangeRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof NumberRangesApi
-     */
-    deleteNumberRange(requestParameters: NumberRangesApiDeleteNumberRangeRequest, 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 {NumberRangesApiGetNumberRangeRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof NumberRangesApi
-     */
-    getNumberRange(requestParameters: NumberRangesApiGetNumberRangeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetNumberRangeResponseClass, 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 {NumberRangesApiListNumberRangesRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof NumberRangesApi
-     */
-    listNumberRanges(requestParameters?: NumberRangesApiListNumberRangesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListNumberRangeResponseClass, any>>;
-}