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

package/dist/api/validation-rules-api.d.ts

@@ -0,0 +1,318 @@
+/**
+ * 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 { CreateValidationRuleRequestDto } from '../models';
+import { CreateValidationRuleResponseClass } from '../models';
+import { GetValidationRuleResponseClass } from '../models';
+import { ListValidationRulesResponseClass } from '../models';
+/**
+ * ValidationRulesApi - axios parameter creator
+ * @export
+ */
+export declare const ValidationRulesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Creates a new validation rule  **Required Permissions**  \"validation-rules-management.validation-rules.create\"
+     * @summary Create the validation rule
+     * @param {CreateValidationRuleRequestDto} createValidationRuleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createValidationRule: (createValidationRuleRequestDto: CreateValidationRuleRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Deletes a validation rule by its code  **Required Permissions**  \"validation-rules-management.validation-rules.delete\"
+     * @summary Delete the validation rule
+     * @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}
+     */
+    deleteValidationRule: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves a validation rule by its code  **Required Permissions**  \"validation-rules-management.validation-rules.view\"
+     * @summary Retrieve the validation rule
+     * @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}
+     */
+    getValidationRule: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Lists all validation rules with optional filters  **Required Permissions**  \"validation-rules-management.validation-rules.view\"
+     * @summary List validation rules
+     * @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, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt&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, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listValidationRules: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ValidationRulesApi - functional programming interface
+ * @export
+ */
+export declare const ValidationRulesApiFp: (configuration?: Configuration) => {
+    /**
+     * Creates a new validation rule  **Required Permissions**  \"validation-rules-management.validation-rules.create\"
+     * @summary Create the validation rule
+     * @param {CreateValidationRuleRequestDto} createValidationRuleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createValidationRule(createValidationRuleRequestDto: CreateValidationRuleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateValidationRuleResponseClass>>;
+    /**
+     * Deletes a validation rule by its code  **Required Permissions**  \"validation-rules-management.validation-rules.delete\"
+     * @summary Delete the validation rule
+     * @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}
+     */
+    deleteValidationRule(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieves a validation rule by its code  **Required Permissions**  \"validation-rules-management.validation-rules.view\"
+     * @summary Retrieve the validation rule
+     * @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}
+     */
+    getValidationRule(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetValidationRuleResponseClass>>;
+    /**
+     * Lists all validation rules with optional filters  **Required Permissions**  \"validation-rules-management.validation-rules.view\"
+     * @summary List validation rules
+     * @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, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt&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, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listValidationRules(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListValidationRulesResponseClass>>;
+};
+/**
+ * ValidationRulesApi - factory interface
+ * @export
+ */
+export declare const ValidationRulesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Creates a new validation rule  **Required Permissions**  \"validation-rules-management.validation-rules.create\"
+     * @summary Create the validation rule
+     * @param {CreateValidationRuleRequestDto} createValidationRuleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createValidationRule(createValidationRuleRequestDto: CreateValidationRuleRequestDto, authorization?: string, options?: any): AxiosPromise<CreateValidationRuleResponseClass>;
+    /**
+     * Deletes a validation rule by its code  **Required Permissions**  \"validation-rules-management.validation-rules.delete\"
+     * @summary Delete the validation rule
+     * @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}
+     */
+    deleteValidationRule(code: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * Retrieves a validation rule by its code  **Required Permissions**  \"validation-rules-management.validation-rules.view\"
+     * @summary Retrieve the validation rule
+     * @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}
+     */
+    getValidationRule(code: string, authorization?: string, options?: any): AxiosPromise<GetValidationRuleResponseClass>;
+    /**
+     * Lists all validation rules with optional filters  **Required Permissions**  \"validation-rules-management.validation-rules.view\"
+     * @summary List validation rules
+     * @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, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt&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, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listValidationRules(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListValidationRulesResponseClass>;
+};
+/**
+ * Request parameters for createValidationRule operation in ValidationRulesApi.
+ * @export
+ * @interface ValidationRulesApiCreateValidationRuleRequest
+ */
+export interface ValidationRulesApiCreateValidationRuleRequest {
+    /**
+     *
+     * @type {CreateValidationRuleRequestDto}
+     * @memberof ValidationRulesApiCreateValidationRule
+     */
+    readonly createValidationRuleRequestDto: CreateValidationRuleRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ValidationRulesApiCreateValidationRule
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteValidationRule operation in ValidationRulesApi.
+ * @export
+ * @interface ValidationRulesApiDeleteValidationRuleRequest
+ */
+export interface ValidationRulesApiDeleteValidationRuleRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof ValidationRulesApiDeleteValidationRule
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ValidationRulesApiDeleteValidationRule
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getValidationRule operation in ValidationRulesApi.
+ * @export
+ * @interface ValidationRulesApiGetValidationRuleRequest
+ */
+export interface ValidationRulesApiGetValidationRuleRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof ValidationRulesApiGetValidationRule
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ValidationRulesApiGetValidationRule
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listValidationRules operation in ValidationRulesApi.
+ * @export
+ * @interface ValidationRulesApiListValidationRulesRequest
+ */
+export interface ValidationRulesApiListValidationRulesRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ValidationRulesApiListValidationRules
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof ValidationRulesApiListValidationRules
+     */
+    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 ValidationRulesApiListValidationRules
+     */
+    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, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @type {string}
+     * @memberof ValidationRulesApiListValidationRules
+     */
+    readonly filter?: string;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {string}
+     * @memberof ValidationRulesApiListValidationRules
+     */
+    readonly search?: string;
+    /**
+     * Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof ValidationRulesApiListValidationRules
+     */
+    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 ValidationRulesApiListValidationRules
+     */
+    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, slug, entityType, productSlug, productVersionCode, severity, isEnabled, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @type {string}
+     * @memberof ValidationRulesApiListValidationRules
+     */
+    readonly filters?: string;
+}
+/**
+ * ValidationRulesApi - object-oriented interface
+ * @export
+ * @class ValidationRulesApi
+ * @extends {BaseAPI}
+ */
+export declare class ValidationRulesApi extends BaseAPI {
+    /**
+     * Creates a new validation rule  **Required Permissions**  \"validation-rules-management.validation-rules.create\"
+     * @summary Create the validation rule
+     * @param {ValidationRulesApiCreateValidationRuleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ValidationRulesApi
+     */
+    createValidationRule(requestParameters: ValidationRulesApiCreateValidationRuleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateValidationRuleResponseClass, any, {}>>;
+    /**
+     * Deletes a validation rule by its code  **Required Permissions**  \"validation-rules-management.validation-rules.delete\"
+     * @summary Delete the validation rule
+     * @param {ValidationRulesApiDeleteValidationRuleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ValidationRulesApi
+     */
+    deleteValidationRule(requestParameters: ValidationRulesApiDeleteValidationRuleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Retrieves a validation rule by its code  **Required Permissions**  \"validation-rules-management.validation-rules.view\"
+     * @summary Retrieve the validation rule
+     * @param {ValidationRulesApiGetValidationRuleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ValidationRulesApi
+     */
+    getValidationRule(requestParameters: ValidationRulesApiGetValidationRuleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetValidationRuleResponseClass, any, {}>>;
+    /**
+     * Lists all validation rules with optional filters  **Required Permissions**  \"validation-rules-management.validation-rules.view\"
+     * @summary List validation rules
+     * @param {ValidationRulesApiListValidationRulesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ValidationRulesApi
+     */
+    listValidationRules(requestParameters?: ValidationRulesApiListValidationRulesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListValidationRulesResponseClass, any, {}>>;
+}