/** * Squidex API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { CreateRuleDto, RuleDto, RuleElementDto, RuleEventsDto, RulesDto, SimulatedRuleEventsDto, UpdateRuleDto } from '../models/index'; export interface RulesDeleteEventRequestRaw { id: string; } export interface RulesDeleteRuleRequestRaw { id: string; } export interface RulesDeleteRuleEventsRequestRaw { id: string; } export interface RulesDisableRuleRequestRaw { id: string; } export interface RulesEnableRuleRequestRaw { id: string; } export interface RulesGetEventSchemaRequestRaw { type: string; } export interface RulesGetEventsRequest { ruleId?: string | null; skip?: number; take?: number; } export interface RulesGetEventsRequestRaw { ruleId?: string | null; skip?: number; take?: number; } export interface RulesPostRuleRequestRaw { createRuleDto: CreateRuleDto; } export interface RulesPutEventRequestRaw { id: string; } export interface RulesPutRuleRequestRaw { id: string; updateRuleDto: UpdateRuleDto; } export interface RulesPutRuleRunRequest { fromSnapshots?: boolean; } export interface RulesPutRuleRunRequestRaw { id: string; fromSnapshots?: boolean; } export interface RulesSimulateGETRequestRaw { id: string; } export interface RulesSimulatePOSTRequestRaw { createRuleDto: CreateRuleDto; } export interface RulesTriggerRuleRequestRaw { id: string; } /** * RulesApi - interface * * @export * @interface RulesApiInterface */ export interface RulesApiInterface { /** * * @summary Cancels an event. * @param {string} id The event to cancel. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RulesApiInterface */ deleteEventRaw(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Cancels an event. */ deleteEvent(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * * @summary Cancels all events. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RulesApiInterface */ deleteEventsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Cancels all events. */ deleteEvents(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * * @summary Delete a rule. * @param {string} id The ID of the rule to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RulesApiInterface */ deleteRuleRaw(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Delete a rule. */ deleteRule(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * * @summary Cancels all rule events. * @param {string} id The ID of the rule to cancel. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RulesApiInterface */ deleteRuleEventsRaw(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Cancels all rule events. */ deleteRuleEvents(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * * @summary Cancel the current run. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RulesApiInterface */ deleteRuleRunRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Cancel the current run. */ deleteRuleRun(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * * @summary Disable a rule. * @param {string} id The ID of the rule to disable. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RulesApiInterface */ disableRuleRaw(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Disable a rule. */ disableRule(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * * @summary Enable a rule. * @param {string} id The ID of the rule to enable. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RulesApiInterface */ enableRuleRaw(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable a rule. */ enableRule(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * * @summary Get supported rule actions. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RulesApiInterface */ getActionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get supported rule actions. */ getActions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: RuleElementDto; }>; /** * * @summary Provide the json schema for the event with the specified name. * @param {string} type The type name of the event. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RulesApiInterface */ getEventSchemaRaw(type: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Provide the json schema for the event with the specified name. */ getEventSchema(type: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * * @summary Provide a list of all event types that are used in rules. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RulesApiInterface */ getEventTypesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Provide a list of all event types that are used in rules. */ getEventTypes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * * @summary Get rule events. * @param {string} [ruleId] The optional rule id to filter to events. * @param {number} [skip] The number of events to skip. * @param {number} [take] The number of events to take. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RulesApiInterface */ getEventsRaw(requestParameters?: RulesGetEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get rule events. */ getEvents(requestParameters?: RulesGetEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * * @summary Get rules. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RulesApiInterface */ getRulesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get rules. */ getRules(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * * @summary Create a new rule. * @param {CreateRuleDto} createRuleDto The rule object that needs to be added to the app. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RulesApiInterface */ postRuleRaw(createRuleDto: CreateRuleDto, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create a new rule. */ postRule(createRuleDto: CreateRuleDto, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * * @summary Retry the event immediately. * @param {string} id The event to enqueue. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RulesApiInterface */ putEventRaw(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retry the event immediately. */ putEvent(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * * @summary Update a rule. * @param {string} id The ID of the rule to update. * @param {UpdateRuleDto} updateRuleDto The rule object that needs to be added to the app. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RulesApiInterface */ putRuleRaw(id: string, updateRuleDto: UpdateRuleDto, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Update a rule. */ putRule(id: string, updateRuleDto: UpdateRuleDto, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * * @summary Run a rule. * @param {string} id The ID of the rule to run. * @param {boolean} [fromSnapshots] Runs the rule from snapeshots if possible. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RulesApiInterface */ putRuleRunRaw(id: string, requestParameters?: RulesPutRuleRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Run a rule. */ putRuleRun(id: string, requestParameters?: RulesPutRuleRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * * @summary Simulate a rule. * @param {string} id The ID of the rule to simulate. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RulesApiInterface */ simulateGETRaw(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Simulate a rule. */ simulateGET(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * * @summary Simulate a rule. * @param {CreateRuleDto} createRuleDto The rule to simulate. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RulesApiInterface */ simulatePOSTRaw(createRuleDto: CreateRuleDto, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Simulate a rule. */ simulatePOST(createRuleDto: CreateRuleDto, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * * @summary Trigger a rule. * @param {string} id The ID of the rule to disable. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RulesApiInterface */ triggerRuleRaw(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Trigger a rule. */ triggerRule(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export declare class RulesApi extends runtime.BaseAPI implements RulesApiInterface { /** * Cancels an event. */ deleteEventRaw(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Cancels an event. */ deleteEvent(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Cancels all events. */ deleteEventsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Cancels all events. */ deleteEvents(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Delete a rule. */ deleteRuleRaw(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Delete a rule. */ deleteRule(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Cancels all rule events. */ deleteRuleEventsRaw(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Cancels all rule events. */ deleteRuleEvents(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Cancel the current run. */ deleteRuleRunRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Cancel the current run. */ deleteRuleRun(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Disable a rule. */ disableRuleRaw(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Disable a rule. */ disableRule(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Enable a rule. */ enableRuleRaw(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable a rule. */ enableRule(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get supported rule actions. */ getActionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get supported rule actions. */ getActions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: RuleElementDto; }>; /** * Provide the json schema for the event with the specified name. */ getEventSchemaRaw(type: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Provide the json schema for the event with the specified name. */ getEventSchema(type: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Provide a list of all event types that are used in rules. */ getEventTypesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Provide a list of all event types that are used in rules. */ getEventTypes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get rule events. */ getEventsRaw(requestParameters: RulesGetEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get rule events. */ getEvents(requestParameters?: RulesGetEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get rules. */ getRulesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get rules. */ getRules(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Create a new rule. */ postRuleRaw(createRuleDto: CreateRuleDto, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create a new rule. */ postRule(createRuleDto: CreateRuleDto, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Retry the event immediately. */ putEventRaw(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retry the event immediately. */ putEvent(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Update a rule. */ putRuleRaw(id: string, updateRuleDto: UpdateRuleDto, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Update a rule. */ putRule(id: string, updateRuleDto: UpdateRuleDto, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Run a rule. */ putRuleRunRaw(id: string, requestParameters: RulesPutRuleRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Run a rule. */ putRuleRun(id: string, requestParameters: RulesPutRuleRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Simulate a rule. */ simulateGETRaw(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Simulate a rule. */ simulateGET(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Simulate a rule. */ simulatePOSTRaw(createRuleDto: CreateRuleDto, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Simulate a rule. */ simulatePOST(createRuleDto: CreateRuleDto, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Trigger a rule. */ triggerRuleRaw(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Trigger a rule. */ triggerRule(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }