@emilgroup/validation-rules-sdk 1.0.1-beta.0

package/dist/api/investigation-blocks-api.d.ts

@@ -0,0 +1,393 @@
+/**
+ * EMIL Validation Rules Service
+ * The EMIL Validation Rules Service 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 { CreateInvestigationBlockRequestDto } from '../models';
+import { CreateInvestigationBlockResponseClass } from '../models';
+import { GetInvestigationBlockResponseClass } from '../models';
+import { ListInvestigationBlocksResponseClass } from '../models';
+import { UpdateInvestigationBlockRequestDto } from '../models';
+import { UpdateInvestigationBlockResponseClass } from '../models';
+/**
+ * InvestigationBlocksApi - axios parameter creator
+ * @export
+ */
+export declare const InvestigationBlocksApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Creates a new investigation block.  **Required Permissions**  \"validation-rules-management.validation-rules.create\"
+     * @summary Create the investigation block
+     * @param {CreateInvestigationBlockRequestDto} createInvestigationBlockRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createInvestigationBlock: (createInvestigationBlockRequestDto: CreateInvestigationBlockRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Deletes an investigation block by its code.  **Required Permissions**  \"validation-rules-management.validation-rules.delete\"
+     * @summary Delete the investigation block
+     * @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}
+     */
+    deleteInvestigationBlock: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves an investigation block by its code.  **Required Permissions**  \"validation-rules-management.validation-rules.view\"
+     * @summary Retrieve the investigation block
+     * @param {string} code
+     * @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}
+     */
+    getInvestigationBlock: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves a list of investigation blocks with pagination.  **Required Permissions**  \"validation-rules-management.validation-rules.view\"
+     * @summary List investigation blocks
+     * @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: id, code, createdAt&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: createdAt&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: id, code, createdAt&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listInvestigationBlocks: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates an investigation block by its code.  **Required Permissions**  \"validation-rules-management.validation-rules.update\"
+     * @summary Update the investigation block
+     * @param {string} code
+     * @param {UpdateInvestigationBlockRequestDto} updateInvestigationBlockRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateInvestigationBlock: (code: string, updateInvestigationBlockRequestDto: UpdateInvestigationBlockRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * InvestigationBlocksApi - functional programming interface
+ * @export
+ */
+export declare const InvestigationBlocksApiFp: (configuration?: Configuration) => {
+    /**
+     * Creates a new investigation block.  **Required Permissions**  \"validation-rules-management.validation-rules.create\"
+     * @summary Create the investigation block
+     * @param {CreateInvestigationBlockRequestDto} createInvestigationBlockRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createInvestigationBlock(createInvestigationBlockRequestDto: CreateInvestigationBlockRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateInvestigationBlockResponseClass>>;
+    /**
+     * Deletes an investigation block by its code.  **Required Permissions**  \"validation-rules-management.validation-rules.delete\"
+     * @summary Delete the investigation block
+     * @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}
+     */
+    deleteInvestigationBlock(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieves an investigation block by its code.  **Required Permissions**  \"validation-rules-management.validation-rules.view\"
+     * @summary Retrieve the investigation block
+     * @param {string} code
+     * @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}
+     */
+    getInvestigationBlock(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInvestigationBlockResponseClass>>;
+    /**
+     * Retrieves a list of investigation blocks with pagination.  **Required Permissions**  \"validation-rules-management.validation-rules.view\"
+     * @summary List investigation blocks
+     * @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: id, code, createdAt&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: createdAt&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: id, code, createdAt&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listInvestigationBlocks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInvestigationBlocksResponseClass>>;
+    /**
+     * Updates an investigation block by its code.  **Required Permissions**  \"validation-rules-management.validation-rules.update\"
+     * @summary Update the investigation block
+     * @param {string} code
+     * @param {UpdateInvestigationBlockRequestDto} updateInvestigationBlockRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateInvestigationBlock(code: string, updateInvestigationBlockRequestDto: UpdateInvestigationBlockRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateInvestigationBlockResponseClass>>;
+};
+/**
+ * InvestigationBlocksApi - factory interface
+ * @export
+ */
+export declare const InvestigationBlocksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Creates a new investigation block.  **Required Permissions**  \"validation-rules-management.validation-rules.create\"
+     * @summary Create the investigation block
+     * @param {CreateInvestigationBlockRequestDto} createInvestigationBlockRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createInvestigationBlock(createInvestigationBlockRequestDto: CreateInvestigationBlockRequestDto, authorization?: string, options?: any): AxiosPromise<CreateInvestigationBlockResponseClass>;
+    /**
+     * Deletes an investigation block by its code.  **Required Permissions**  \"validation-rules-management.validation-rules.delete\"
+     * @summary Delete the investigation block
+     * @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}
+     */
+    deleteInvestigationBlock(code: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * Retrieves an investigation block by its code.  **Required Permissions**  \"validation-rules-management.validation-rules.view\"
+     * @summary Retrieve the investigation block
+     * @param {string} code
+     * @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}
+     */
+    getInvestigationBlock(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetInvestigationBlockResponseClass>;
+    /**
+     * Retrieves a list of investigation blocks with pagination.  **Required Permissions**  \"validation-rules-management.validation-rules.view\"
+     * @summary List investigation blocks
+     * @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: id, code, createdAt&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: createdAt&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: id, code, createdAt&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listInvestigationBlocks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListInvestigationBlocksResponseClass>;
+    /**
+     * Updates an investigation block by its code.  **Required Permissions**  \"validation-rules-management.validation-rules.update\"
+     * @summary Update the investigation block
+     * @param {string} code
+     * @param {UpdateInvestigationBlockRequestDto} updateInvestigationBlockRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateInvestigationBlock(code: string, updateInvestigationBlockRequestDto: UpdateInvestigationBlockRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateInvestigationBlockResponseClass>;
+};
+/**
+ * Request parameters for createInvestigationBlock operation in InvestigationBlocksApi.
+ * @export
+ * @interface InvestigationBlocksApiCreateInvestigationBlockRequest
+ */
+export interface InvestigationBlocksApiCreateInvestigationBlockRequest {
+    /**
+     *
+     * @type {CreateInvestigationBlockRequestDto}
+     * @memberof InvestigationBlocksApiCreateInvestigationBlock
+     */
+    readonly createInvestigationBlockRequestDto: CreateInvestigationBlockRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof InvestigationBlocksApiCreateInvestigationBlock
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteInvestigationBlock operation in InvestigationBlocksApi.
+ * @export
+ * @interface InvestigationBlocksApiDeleteInvestigationBlockRequest
+ */
+export interface InvestigationBlocksApiDeleteInvestigationBlockRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof InvestigationBlocksApiDeleteInvestigationBlock
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof InvestigationBlocksApiDeleteInvestigationBlock
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getInvestigationBlock operation in InvestigationBlocksApi.
+ * @export
+ * @interface InvestigationBlocksApiGetInvestigationBlockRequest
+ */
+export interface InvestigationBlocksApiGetInvestigationBlockRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof InvestigationBlocksApiGetInvestigationBlock
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {string}
+     * @memberof InvestigationBlocksApiGetInvestigationBlock
+     */
+    readonly expand: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof InvestigationBlocksApiGetInvestigationBlock
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listInvestigationBlocks operation in InvestigationBlocksApi.
+ * @export
+ * @interface InvestigationBlocksApiListInvestigationBlocksRequest
+ */
+export interface InvestigationBlocksApiListInvestigationBlocksRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof InvestigationBlocksApiListInvestigationBlocks
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof InvestigationBlocksApiListInvestigationBlocks
+     */
+    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 InvestigationBlocksApiListInvestigationBlocks
+     */
+    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: id, code, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof InvestigationBlocksApiListInvestigationBlocks
+     */
+    readonly filter?: string;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {string}
+     * @memberof InvestigationBlocksApiListInvestigationBlocks
+     */
+    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: createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof InvestigationBlocksApiListInvestigationBlocks
+     */
+    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 InvestigationBlocksApiListInvestigationBlocks
+     */
+    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: id, code, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof InvestigationBlocksApiListInvestigationBlocks
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for updateInvestigationBlock operation in InvestigationBlocksApi.
+ * @export
+ * @interface InvestigationBlocksApiUpdateInvestigationBlockRequest
+ */
+export interface InvestigationBlocksApiUpdateInvestigationBlockRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof InvestigationBlocksApiUpdateInvestigationBlock
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateInvestigationBlockRequestDto}
+     * @memberof InvestigationBlocksApiUpdateInvestigationBlock
+     */
+    readonly updateInvestigationBlockRequestDto: UpdateInvestigationBlockRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof InvestigationBlocksApiUpdateInvestigationBlock
+     */
+    readonly authorization?: string;
+}
+/**
+ * InvestigationBlocksApi - object-oriented interface
+ * @export
+ * @class InvestigationBlocksApi
+ * @extends {BaseAPI}
+ */
+export declare class InvestigationBlocksApi extends BaseAPI {
+    /**
+     * Creates a new investigation block.  **Required Permissions**  \"validation-rules-management.validation-rules.create\"
+     * @summary Create the investigation block
+     * @param {InvestigationBlocksApiCreateInvestigationBlockRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InvestigationBlocksApi
+     */
+    createInvestigationBlock(requestParameters: InvestigationBlocksApiCreateInvestigationBlockRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateInvestigationBlockResponseClass, any, {}>>;
+    /**
+     * Deletes an investigation block by its code.  **Required Permissions**  \"validation-rules-management.validation-rules.delete\"
+     * @summary Delete the investigation block
+     * @param {InvestigationBlocksApiDeleteInvestigationBlockRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InvestigationBlocksApi
+     */
+    deleteInvestigationBlock(requestParameters: InvestigationBlocksApiDeleteInvestigationBlockRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Retrieves an investigation block by its code.  **Required Permissions**  \"validation-rules-management.validation-rules.view\"
+     * @summary Retrieve the investigation block
+     * @param {InvestigationBlocksApiGetInvestigationBlockRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InvestigationBlocksApi
+     */
+    getInvestigationBlock(requestParameters: InvestigationBlocksApiGetInvestigationBlockRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetInvestigationBlockResponseClass, any, {}>>;
+    /**
+     * Retrieves a list of investigation blocks with pagination.  **Required Permissions**  \"validation-rules-management.validation-rules.view\"
+     * @summary List investigation blocks
+     * @param {InvestigationBlocksApiListInvestigationBlocksRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InvestigationBlocksApi
+     */
+    listInvestigationBlocks(requestParameters?: InvestigationBlocksApiListInvestigationBlocksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListInvestigationBlocksResponseClass, any, {}>>;
+    /**
+     * Updates an investigation block by its code.  **Required Permissions**  \"validation-rules-management.validation-rules.update\"
+     * @summary Update the investigation block
+     * @param {InvestigationBlocksApiUpdateInvestigationBlockRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InvestigationBlocksApi
+     */
+    updateInvestigationBlock(requestParameters: InvestigationBlocksApiUpdateInvestigationBlockRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateInvestigationBlockResponseClass, any, {}>>;
+}