@emilgroup/document-sdk 1.12.2 → 1.16.0

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

@@ -0,0 +1,385 @@
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService 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 { CreateLayoutRequestDto } from '../models';
+import { CreateLayoutResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
+import { GetLayoutResponseClass } from '../models';
+import { ListLayoutsResponseClass } from '../models';
+import { UpdateLayoutRequestDto } from '../models';
+import { UpdateLayoutResponseClass } from '../models';
+/**
+ * LayoutsApi - axios parameter creator
+ * @export
+ */
+export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create a layout.
+     * @summary Create the layout
+     * @param {CreateLayoutRequestDto} createLayoutRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createLayout: (createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
+     * @summary Delete the layout
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteLayout: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
+     * @summary Retrieve the layout
+     * @param {string} id
+     * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLayout: (id: string, id2: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List layouts
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] Page size
+     * @param {string} [pageToken] Page token
+     * @param {string} [filter] List filter
+     * @param {string} [search] Search query
+     * @param {string} [order] Ordering criteria
+     * @param {string} [expand] Extra fields to fetch
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listLayouts: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the layout
+     * @param {number} id
+     * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateLayout: (id: number, updateLayoutRequestDto: UpdateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * LayoutsApi - functional programming interface
+ * @export
+ */
+export declare const LayoutsApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create a layout.
+     * @summary Create the layout
+     * @param {CreateLayoutRequestDto} createLayoutRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLayoutResponseClass>>;
+    /**
+     * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
+     * @summary Delete the layout
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteLayout(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
+     * @summary Retrieve the layout
+     * @param {string} id
+     * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLayout(id: string, id2: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLayoutResponseClass>>;
+    /**
+     * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List layouts
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] Page size
+     * @param {string} [pageToken] Page token
+     * @param {string} [filter] List filter
+     * @param {string} [search] Search query
+     * @param {string} [order] Ordering criteria
+     * @param {string} [expand] Extra fields to fetch
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLayoutsResponseClass>>;
+    /**
+     * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the layout
+     * @param {number} id
+     * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateLayout(id: number, updateLayoutRequestDto: UpdateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateLayoutResponseClass>>;
+};
+/**
+ * LayoutsApi - factory interface
+ * @export
+ */
+export declare const LayoutsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create a layout.
+     * @summary Create the layout
+     * @param {CreateLayoutRequestDto} createLayoutRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<CreateLayoutResponseClass>;
+    /**
+     * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
+     * @summary Delete the layout
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteLayout(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
+     * @summary Retrieve the layout
+     * @param {string} id
+     * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLayout(id: string, id2: number, authorization?: string, options?: any): AxiosPromise<GetLayoutResponseClass>;
+    /**
+     * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List layouts
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] Page size
+     * @param {string} [pageToken] Page token
+     * @param {string} [filter] List filter
+     * @param {string} [search] Search query
+     * @param {string} [order] Ordering criteria
+     * @param {string} [expand] Extra fields to fetch
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListLayoutsResponseClass>;
+    /**
+     * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the layout
+     * @param {number} id
+     * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateLayout(id: number, updateLayoutRequestDto: UpdateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateLayoutResponseClass>;
+};
+/**
+ * Request parameters for createLayout operation in LayoutsApi.
+ * @export
+ * @interface LayoutsApiCreateLayoutRequest
+ */
+export interface LayoutsApiCreateLayoutRequest {
+    /**
+     *
+     * @type {CreateLayoutRequestDto}
+     * @memberof LayoutsApiCreateLayout
+     */
+    readonly createLayoutRequestDto: CreateLayoutRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LayoutsApiCreateLayout
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteLayout operation in LayoutsApi.
+ * @export
+ * @interface LayoutsApiDeleteLayoutRequest
+ */
+export interface LayoutsApiDeleteLayoutRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof LayoutsApiDeleteLayout
+     */
+    readonly id: number;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LayoutsApiDeleteLayout
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getLayout operation in LayoutsApi.
+ * @export
+ * @interface LayoutsApiGetLayoutRequest
+ */
+export interface LayoutsApiGetLayoutRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof LayoutsApiGetLayout
+     */
+    readonly id: string;
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof LayoutsApiGetLayout
+     */
+    readonly id2: number;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LayoutsApiGetLayout
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listLayouts operation in LayoutsApi.
+ * @export
+ * @interface LayoutsApiListLayoutsRequest
+ */
+export interface LayoutsApiListLayoutsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LayoutsApiListLayouts
+     */
+    readonly authorization?: string;
+    /**
+     * Page size
+     * @type {number}
+     * @memberof LayoutsApiListLayouts
+     */
+    readonly pageSize?: number;
+    /**
+     * Page token
+     * @type {string}
+     * @memberof LayoutsApiListLayouts
+     */
+    readonly pageToken?: string;
+    /**
+     * List filter
+     * @type {string}
+     * @memberof LayoutsApiListLayouts
+     */
+    readonly filter?: string;
+    /**
+     * Search query
+     * @type {string}
+     * @memberof LayoutsApiListLayouts
+     */
+    readonly search?: string;
+    /**
+     * Ordering criteria
+     * @type {string}
+     * @memberof LayoutsApiListLayouts
+     */
+    readonly order?: string;
+    /**
+     * Extra fields to fetch
+     * @type {string}
+     * @memberof LayoutsApiListLayouts
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for updateLayout operation in LayoutsApi.
+ * @export
+ * @interface LayoutsApiUpdateLayoutRequest
+ */
+export interface LayoutsApiUpdateLayoutRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof LayoutsApiUpdateLayout
+     */
+    readonly id: number;
+    /**
+     *
+     * @type {UpdateLayoutRequestDto}
+     * @memberof LayoutsApiUpdateLayout
+     */
+    readonly updateLayoutRequestDto: UpdateLayoutRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LayoutsApiUpdateLayout
+     */
+    readonly authorization?: string;
+}
+/**
+ * LayoutsApi - object-oriented interface
+ * @export
+ * @class LayoutsApi
+ * @extends {BaseAPI}
+ */
+export declare class LayoutsApi extends BaseAPI {
+    /**
+     * This will create a layout.
+     * @summary Create the layout
+     * @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LayoutsApi
+     */
+    createLayout(requestParameters: LayoutsApiCreateLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateLayoutResponseClass, any>>;
+    /**
+     * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
+     * @summary Delete the layout
+     * @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LayoutsApi
+     */
+    deleteLayout(requestParameters: LayoutsApiDeleteLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
+     * @summary Retrieve the layout
+     * @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LayoutsApi
+     */
+    getLayout(requestParameters: LayoutsApiGetLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLayoutResponseClass, any>>;
+    /**
+     * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List layouts
+     * @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LayoutsApi
+     */
+    listLayouts(requestParameters?: LayoutsApiListLayoutsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListLayoutsResponseClass, any>>;
+    /**
+     * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the layout
+     * @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LayoutsApi
+     */
+    updateLayout(requestParameters: LayoutsApiUpdateLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateLayoutResponseClass, any>>;
+}