@emilgroup/tenant-sdk 1.0.0

package/dist/api/custom-schema-api.d.ts

@@ -0,0 +1,329 @@
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService 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 { CreateCustomSchemaRequestDto } from '../models';
+import { CreateCustomSchemaResponseClass } from '../models';
+import { GetCustomSchemaResponseClass } from '../models';
+import { ListCustomSchemasResponseClass } from '../models';
+import { UpdateCustomSchemaRequestDto } from '../models';
+import { UpdateCustomSchemaResponseClass } from '../models';
+/**
+ * CustomSchemaApi - axios parameter creator
+ * @export
+ */
+export declare const CustomSchemaApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create an custom schema for tenant in the database.      Custom schema are extra fields that tenant added to his entity and we need to validate this fields     using the created schema.
+     * @summary Create the custom-schema
+     * @param {CreateCustomSchemaRequestDto} createCustomSchemaRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCustomSchema: (createCustomSchemaRequestDto: CreateCustomSchemaRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
+     * @summary Retrieve the custom-schema
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [expand] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCustomSchema: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List custom-schemas
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+     * @param {any} [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 {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @param {any} [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 {any} [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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomSchemas: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the custom-schema
+     * @param {string} code
+     * @param {UpdateCustomSchemaRequestDto} updateCustomSchemaRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCustomSchema: (code: string, updateCustomSchemaRequestDto: UpdateCustomSchemaRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * CustomSchemaApi - functional programming interface
+ * @export
+ */
+export declare const CustomSchemaApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create an custom schema for tenant in the database.      Custom schema are extra fields that tenant added to his entity and we need to validate this fields     using the created schema.
+     * @summary Create the custom-schema
+     * @param {CreateCustomSchemaRequestDto} createCustomSchemaRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCustomSchema(createCustomSchemaRequestDto: CreateCustomSchemaRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCustomSchemaResponseClass>>;
+    /**
+     * Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
+     * @summary Retrieve the custom-schema
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [expand] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCustomSchema(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomSchemaResponseClass>>;
+    /**
+     * Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List custom-schemas
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+     * @param {any} [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 {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @param {any} [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 {any} [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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomSchemas(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomSchemasResponseClass>>;
+    /**
+     * Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the custom-schema
+     * @param {string} code
+     * @param {UpdateCustomSchemaRequestDto} updateCustomSchemaRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCustomSchema(code: string, updateCustomSchemaRequestDto: UpdateCustomSchemaRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCustomSchemaResponseClass>>;
+};
+/**
+ * CustomSchemaApi - factory interface
+ * @export
+ */
+export declare const CustomSchemaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create an custom schema for tenant in the database.      Custom schema are extra fields that tenant added to his entity and we need to validate this fields     using the created schema.
+     * @summary Create the custom-schema
+     * @param {CreateCustomSchemaRequestDto} createCustomSchemaRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCustomSchema(createCustomSchemaRequestDto: CreateCustomSchemaRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCustomSchemaResponseClass>;
+    /**
+     * Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
+     * @summary Retrieve the custom-schema
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [expand] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCustomSchema(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetCustomSchemaResponseClass>;
+    /**
+     * Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List custom-schemas
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+     * @param {any} [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 {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @param {any} [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 {any} [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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomSchemas(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListCustomSchemasResponseClass>;
+    /**
+     * Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the custom-schema
+     * @param {string} code
+     * @param {UpdateCustomSchemaRequestDto} updateCustomSchemaRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCustomSchema(code: string, updateCustomSchemaRequestDto: UpdateCustomSchemaRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCustomSchemaResponseClass>;
+};
+/**
+ * Request parameters for createCustomSchema operation in CustomSchemaApi.
+ * @export
+ * @interface CustomSchemaApiCreateCustomSchemaRequest
+ */
+export interface CustomSchemaApiCreateCustomSchemaRequest {
+    /**
+     *
+     * @type {CreateCustomSchemaRequestDto}
+     * @memberof CustomSchemaApiCreateCustomSchema
+     */
+    readonly createCustomSchemaRequestDto: CreateCustomSchemaRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CustomSchemaApiCreateCustomSchema
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getCustomSchema operation in CustomSchemaApi.
+ * @export
+ * @interface CustomSchemaApiGetCustomSchemaRequest
+ */
+export interface CustomSchemaApiGetCustomSchemaRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CustomSchemaApiGetCustomSchema
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CustomSchemaApiGetCustomSchema
+     */
+    readonly authorization?: string;
+    /**
+     * Fields to expand response by
+     * @type {string}
+     * @memberof CustomSchemaApiGetCustomSchema
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for listCustomSchemas operation in CustomSchemaApi.
+ * @export
+ * @interface CustomSchemaApiListCustomSchemasRequest
+ */
+export interface CustomSchemaApiListCustomSchemasRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CustomSchemaApiListCustomSchemas
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+     * @type {any}
+     * @memberof CustomSchemaApiListCustomSchemas
+     */
+    readonly pageSize?: any;
+    /**
+     * 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 {any}
+     * @memberof CustomSchemaApiListCustomSchemas
+     */
+    readonly pageToken?: any;
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @type {any}
+     * @memberof CustomSchemaApiListCustomSchemas
+     */
+    readonly filter?: any;
+    /**
+     * Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @type {any}
+     * @memberof CustomSchemaApiListCustomSchemas
+     */
+    readonly search?: any;
+    /**
+     * 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 {any}
+     * @memberof CustomSchemaApiListCustomSchemas
+     */
+    readonly order?: any;
+    /**
+     * 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 {any}
+     * @memberof CustomSchemaApiListCustomSchemas
+     */
+    readonly expand?: any;
+}
+/**
+ * Request parameters for updateCustomSchema operation in CustomSchemaApi.
+ * @export
+ * @interface CustomSchemaApiUpdateCustomSchemaRequest
+ */
+export interface CustomSchemaApiUpdateCustomSchemaRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CustomSchemaApiUpdateCustomSchema
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateCustomSchemaRequestDto}
+     * @memberof CustomSchemaApiUpdateCustomSchema
+     */
+    readonly updateCustomSchemaRequestDto: UpdateCustomSchemaRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CustomSchemaApiUpdateCustomSchema
+     */
+    readonly authorization?: string;
+}
+/**
+ * CustomSchemaApi - object-oriented interface
+ * @export
+ * @class CustomSchemaApi
+ * @extends {BaseAPI}
+ */
+export declare class CustomSchemaApi extends BaseAPI {
+    /**
+     * This will create an custom schema for tenant in the database.      Custom schema are extra fields that tenant added to his entity and we need to validate this fields     using the created schema.
+     * @summary Create the custom-schema
+     * @param {CustomSchemaApiCreateCustomSchemaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomSchemaApi
+     */
+    createCustomSchema(requestParameters: CustomSchemaApiCreateCustomSchemaRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomSchemaResponseClass, any>>;
+    /**
+     * Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
+     * @summary Retrieve the custom-schema
+     * @param {CustomSchemaApiGetCustomSchemaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomSchemaApi
+     */
+    getCustomSchema(requestParameters: CustomSchemaApiGetCustomSchemaRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomSchemaResponseClass, any>>;
+    /**
+     * Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List custom-schemas
+     * @param {CustomSchemaApiListCustomSchemasRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomSchemaApi
+     */
+    listCustomSchemas(requestParameters?: CustomSchemaApiListCustomSchemasRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCustomSchemasResponseClass, any>>;
+    /**
+     * Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the custom-schema
+     * @param {CustomSchemaApiUpdateCustomSchemaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomSchemaApi
+     */
+    updateCustomSchema(requestParameters: CustomSchemaApiUpdateCustomSchemaRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomSchemaResponseClass, any>>;
+}