@emilgroup/numbergenerator-sdk-node 1.3.1 → 1.5.0

package/dist/api/numbers-api.d.ts

@@ -0,0 +1,457 @@
+/**
+ * EMIL Number Generator Service
+ * The EMIL Number Generator Service API is a robust tool                  designed to generate unique and structured entity numbers                  like policies, accounts, invoices, and other entities.                  This API streamlines the process of creating distinct identifiers                  for various business objects.
+ *
+ * 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 { CreateNumberResponseClass } from '../models';
+import { GetNumberResponseClass } from '../models';
+import { ListNumbersResponseClass } from '../models';
+import { LookupNumberRequestDto } from '../models';
+import { ResetNumberRequestDto } from '../models';
+import { UpdateNumberResponseClass } from '../models';
+/**
+ * NumbersApi - axios parameter creator
+ * @export
+ */
+export declare const NumbersApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create an entity number in the database. Entity number is a way to generate unique numbers     for your entities. You can create as many numbers as you want.
+     * @summary Create the number
+     * @param {string} slug The slug of the number
+     * @param {string} type The type of number generator. This determines the structure of the config object.
+     * @param {object} config Configuration object that varies based on the type field
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createNumber: (slug: string, type: string, config: object, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the number that was previously created. Supply the unique number code      that was returned when you created it and Emil Api will return the corresponding number information.
+     * @summary Retrieve the number
+     * @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}
+     */
+    getNumber: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of Numbers you have previously created.        The Numbers are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+     * @summary List Numbers
+     * @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.
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @param {string} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNumbers: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * The endpoint performs a lookup based on an entity number to retrieve a unique string.
+     * @summary Lookup entity number
+     * @param {LookupNumberRequestDto} lookupNumberRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    lookupNumber: (lookupNumberRequestDto: LookupNumberRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This endpoint facilitates the resetting of an entity number useful for sequence type numbers.
+     * @summary Reset entity number
+     * @param {ResetNumberRequestDto} resetNumberRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resetNumber: (resetNumberRequestDto: ResetNumberRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will update an entity number in the database.
+     * @summary Update the number
+     * @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}
+     */
+    updateNumber: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * NumbersApi - functional programming interface
+ * @export
+ */
+export declare const NumbersApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create an entity number in the database. Entity number is a way to generate unique numbers     for your entities. You can create as many numbers as you want.
+     * @summary Create the number
+     * @param {string} slug The slug of the number
+     * @param {string} type The type of number generator. This determines the structure of the config object.
+     * @param {object} config Configuration object that varies based on the type field
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createNumber(slug: string, type: string, config: object, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateNumberResponseClass>>;
+    /**
+     * Retrieves the details of the number that was previously created. Supply the unique number code      that was returned when you created it and Emil Api will return the corresponding number information.
+     * @summary Retrieve the number
+     * @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}
+     */
+    getNumber(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetNumberResponseClass>>;
+    /**
+     * Returns a list of Numbers you have previously created.        The Numbers are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+     * @summary List Numbers
+     * @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.
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @param {string} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNumbers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListNumbersResponseClass>>;
+    /**
+     * The endpoint performs a lookup based on an entity number to retrieve a unique string.
+     * @summary Lookup entity number
+     * @param {LookupNumberRequestDto} lookupNumberRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    lookupNumber(lookupNumberRequestDto: LookupNumberRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * This endpoint facilitates the resetting of an entity number useful for sequence type numbers.
+     * @summary Reset entity number
+     * @param {ResetNumberRequestDto} resetNumberRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resetNumber(resetNumberRequestDto: ResetNumberRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * This will update an entity number in the database.
+     * @summary Update the number
+     * @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}
+     */
+    updateNumber(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateNumberResponseClass>>;
+};
+/**
+ * NumbersApi - factory interface
+ * @export
+ */
+export declare const NumbersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create an entity number in the database. Entity number is a way to generate unique numbers     for your entities. You can create as many numbers as you want.
+     * @summary Create the number
+     * @param {string} slug The slug of the number
+     * @param {string} type The type of number generator. This determines the structure of the config object.
+     * @param {object} config Configuration object that varies based on the type field
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createNumber(slug: string, type: string, config: object, authorization?: string, options?: any): AxiosPromise<CreateNumberResponseClass>;
+    /**
+     * Retrieves the details of the number that was previously created. Supply the unique number code      that was returned when you created it and Emil Api will return the corresponding number information.
+     * @summary Retrieve the number
+     * @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}
+     */
+    getNumber(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetNumberResponseClass>;
+    /**
+     * Returns a list of Numbers you have previously created.        The Numbers are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+     * @summary List Numbers
+     * @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.
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @param {string} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {string} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNumbers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListNumbersResponseClass>;
+    /**
+     * The endpoint performs a lookup based on an entity number to retrieve a unique string.
+     * @summary Lookup entity number
+     * @param {LookupNumberRequestDto} lookupNumberRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    lookupNumber(lookupNumberRequestDto: LookupNumberRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * This endpoint facilitates the resetting of an entity number useful for sequence type numbers.
+     * @summary Reset entity number
+     * @param {ResetNumberRequestDto} resetNumberRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resetNumber(resetNumberRequestDto: ResetNumberRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * This will update an entity number in the database.
+     * @summary Update the number
+     * @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}
+     */
+    updateNumber(code: string, authorization?: string, options?: any): AxiosPromise<UpdateNumberResponseClass>;
+};
+/**
+ * Request parameters for createNumber operation in NumbersApi.
+ * @export
+ * @interface NumbersApiCreateNumberRequest
+ */
+export interface NumbersApiCreateNumberRequest {
+    /**
+     * The slug of the number
+     * @type {string}
+     * @memberof NumbersApiCreateNumber
+     */
+    readonly slug: string;
+    /**
+     * The type of number generator. This determines the structure of the config object.
+     * @type {string}
+     * @memberof NumbersApiCreateNumber
+     */
+    readonly type: string;
+    /**
+     * Configuration object that varies based on the type field
+     * @type {object}
+     * @memberof NumbersApiCreateNumber
+     */
+    readonly config: object;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof NumbersApiCreateNumber
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getNumber operation in NumbersApi.
+ * @export
+ * @interface NumbersApiGetNumberRequest
+ */
+export interface NumbersApiGetNumberRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof NumbersApiGetNumber
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {string}
+     * @memberof NumbersApiGetNumber
+     */
+    readonly expand: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof NumbersApiGetNumber
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listNumbers operation in NumbersApi.
+ * @export
+ * @interface NumbersApiListNumbersRequest
+ */
+export interface NumbersApiListNumbersRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof NumbersApiListNumbers
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof NumbersApiListNumbers
+     */
+    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 NumbersApiListNumbers
+     */
+    readonly pageToken?: string;
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @type {string}
+     * @memberof NumbersApiListNumbers
+     */
+    readonly filter?: string;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {string}
+     * @memberof NumbersApiListNumbers
+     */
+    readonly search?: string;
+    /**
+     * The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @type {string}
+     * @memberof NumbersApiListNumbers
+     */
+    readonly order?: string;
+    /**
+     * Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @type {string}
+     * @memberof NumbersApiListNumbers
+     */
+    readonly expand?: string;
+    /**
+     * Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @type {string}
+     * @memberof NumbersApiListNumbers
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for lookupNumber operation in NumbersApi.
+ * @export
+ * @interface NumbersApiLookupNumberRequest
+ */
+export interface NumbersApiLookupNumberRequest {
+    /**
+     *
+     * @type {LookupNumberRequestDto}
+     * @memberof NumbersApiLookupNumber
+     */
+    readonly lookupNumberRequestDto: LookupNumberRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof NumbersApiLookupNumber
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for resetNumber operation in NumbersApi.
+ * @export
+ * @interface NumbersApiResetNumberRequest
+ */
+export interface NumbersApiResetNumberRequest {
+    /**
+     *
+     * @type {ResetNumberRequestDto}
+     * @memberof NumbersApiResetNumber
+     */
+    readonly resetNumberRequestDto: ResetNumberRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof NumbersApiResetNumber
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for updateNumber operation in NumbersApi.
+ * @export
+ * @interface NumbersApiUpdateNumberRequest
+ */
+export interface NumbersApiUpdateNumberRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof NumbersApiUpdateNumber
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof NumbersApiUpdateNumber
+     */
+    readonly authorization?: string;
+}
+/**
+ * NumbersApi - object-oriented interface
+ * @export
+ * @class NumbersApi
+ * @extends {BaseAPI}
+ */
+export declare class NumbersApi extends BaseAPI {
+    /**
+     * This will create an entity number in the database. Entity number is a way to generate unique numbers     for your entities. You can create as many numbers as you want.
+     * @summary Create the number
+     * @param {NumbersApiCreateNumberRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NumbersApi
+     */
+    createNumber(requestParameters: NumbersApiCreateNumberRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateNumberResponseClass, any, {}>>;
+    /**
+     * Retrieves the details of the number that was previously created. Supply the unique number code      that was returned when you created it and Emil Api will return the corresponding number information.
+     * @summary Retrieve the number
+     * @param {NumbersApiGetNumberRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NumbersApi
+     */
+    getNumber(requestParameters: NumbersApiGetNumberRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetNumberResponseClass, any, {}>>;
+    /**
+     * Returns a list of Numbers you have previously created.        The Numbers are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+     * @summary List Numbers
+     * @param {NumbersApiListNumbersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NumbersApi
+     */
+    listNumbers(requestParameters?: NumbersApiListNumbersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListNumbersResponseClass, any, {}>>;
+    /**
+     * The endpoint performs a lookup based on an entity number to retrieve a unique string.
+     * @summary Lookup entity number
+     * @param {NumbersApiLookupNumberRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NumbersApi
+     */
+    lookupNumber(requestParameters: NumbersApiLookupNumberRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * This endpoint facilitates the resetting of an entity number useful for sequence type numbers.
+     * @summary Reset entity number
+     * @param {NumbersApiResetNumberRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NumbersApi
+     */
+    resetNumber(requestParameters: NumbersApiResetNumberRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * This will update an entity number in the database.
+     * @summary Update the number
+     * @param {NumbersApiUpdateNumberRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NumbersApi
+     */
+    updateNumber(requestParameters: NumbersApiUpdateNumberRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateNumberResponseClass, any, {}>>;
+}