@emilgroup/action-sdk-node 1.0.1-beta.20 → 1.0.1-beta.21

package/api.ts

@@ -24,8 +24,10 @@ import FormData from 'form-data'
 import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
+import { ActionsApi } from './api';
 import { DefaultApi } from './api';
 
 
+export * from './api/actions-api';
 export * from './api/default-api';
 

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

@@ -0,0 +1,411 @@
+/**
+ * EMIL ActionService
+ * The EMIL ActionService 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 { CreateActionRequestDto } from '../models';
+import { CreateActionResponseClass } from '../models';
+import { GetActionResponseClass } from '../models';
+import { ListActionsResponseClass } from '../models';
+import { UpdateActionRequestDto } from '../models';
+import { UpdateActionResponseClass } from '../models';
+/**
+ * ActionsApi - axios parameter creator
+ * @export
+ */
+export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Creates a new action configuration
+     * @summary Create the action
+     * @param {CreateActionRequestDto} createActionRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAction: (createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Deletes an action configuration by its code
+     * @summary Delete the action
+     * @param {string} code
+     * @param {any} action 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}
+     */
+    deleteAction: (code: string, action: any, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves an action configuration by its code
+     * @summary Retrieve the action
+     * @param {string} code
+     * @param {any} action 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}
+     */
+    getAction: (code: string, action: any, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Lists all action configurations with optional filters
+     * @summary List actions
+     * @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, name, slug, isEnabled, workflowCode, 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, name, slug, isEnabled, workflowCode, 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, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates an existing action configuration (patch semantics)
+     * @summary Update the action
+     * @param {string} code
+     * @param {any} action Unique identifier for the object.
+     * @param {UpdateActionRequestDto} updateActionRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateAction: (code: string, action: any, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ActionsApi - functional programming interface
+ * @export
+ */
+export declare const ActionsApiFp: (configuration?: Configuration) => {
+    /**
+     * Creates a new action configuration
+     * @summary Create the action
+     * @param {CreateActionRequestDto} createActionRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAction(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateActionResponseClass>>;
+    /**
+     * Deletes an action configuration by its code
+     * @summary Delete the action
+     * @param {string} code
+     * @param {any} action 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}
+     */
+    deleteAction(code: string, action: any, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieves an action configuration by its code
+     * @summary Retrieve the action
+     * @param {string} code
+     * @param {any} action 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}
+     */
+    getAction(code: string, action: any, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>>;
+    /**
+     * Lists all action configurations with optional filters
+     * @summary List actions
+     * @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, name, slug, isEnabled, workflowCode, 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, name, slug, isEnabled, workflowCode, 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, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListActionsResponseClass>>;
+    /**
+     * Updates an existing action configuration (patch semantics)
+     * @summary Update the action
+     * @param {string} code
+     * @param {any} action Unique identifier for the object.
+     * @param {UpdateActionRequestDto} updateActionRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateAction(code: string, action: any, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateActionResponseClass>>;
+};
+/**
+ * ActionsApi - factory interface
+ * @export
+ */
+export declare const ActionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Creates a new action configuration
+     * @summary Create the action
+     * @param {CreateActionRequestDto} createActionRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAction(createActionRequestDto: CreateActionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateActionResponseClass>;
+    /**
+     * Deletes an action configuration by its code
+     * @summary Delete the action
+     * @param {string} code
+     * @param {any} action 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}
+     */
+    deleteAction(code: string, action: any, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * Retrieves an action configuration by its code
+     * @summary Retrieve the action
+     * @param {string} code
+     * @param {any} action 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}
+     */
+    getAction(code: string, action: any, authorization?: string, options?: any): AxiosPromise<GetActionResponseClass>;
+    /**
+     * Lists all action configurations with optional filters
+     * @summary List actions
+     * @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, name, slug, isEnabled, workflowCode, 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, name, slug, isEnabled, workflowCode, 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, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionsResponseClass>;
+    /**
+     * Updates an existing action configuration (patch semantics)
+     * @summary Update the action
+     * @param {string} code
+     * @param {any} action Unique identifier for the object.
+     * @param {UpdateActionRequestDto} updateActionRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateAction(code: string, action: any, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateActionResponseClass>;
+};
+/**
+ * Request parameters for createAction operation in ActionsApi.
+ * @export
+ * @interface ActionsApiCreateActionRequest
+ */
+export interface ActionsApiCreateActionRequest {
+    /**
+     *
+     * @type {CreateActionRequestDto}
+     * @memberof ActionsApiCreateAction
+     */
+    readonly createActionRequestDto: CreateActionRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ActionsApiCreateAction
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteAction operation in ActionsApi.
+ * @export
+ * @interface ActionsApiDeleteActionRequest
+ */
+export interface ActionsApiDeleteActionRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ActionsApiDeleteAction
+     */
+    readonly code: string;
+    /**
+     * Unique identifier for the object.
+     * @type {any}
+     * @memberof ActionsApiDeleteAction
+     */
+    readonly action: any;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ActionsApiDeleteAction
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getAction operation in ActionsApi.
+ * @export
+ * @interface ActionsApiGetActionRequest
+ */
+export interface ActionsApiGetActionRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ActionsApiGetAction
+     */
+    readonly code: string;
+    /**
+     * Unique identifier for the object.
+     * @type {any}
+     * @memberof ActionsApiGetAction
+     */
+    readonly action: any;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ActionsApiGetAction
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listActions operation in ActionsApi.
+ * @export
+ * @interface ActionsApiListActionsRequest
+ */
+export interface ActionsApiListActionsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ActionsApiListActions
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof ActionsApiListActions
+     */
+    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 ActionsApiListActions
+     */
+    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, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @type {string}
+     * @memberof ActionsApiListActions
+     */
+    readonly filter?: string;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {string}
+     * @memberof ActionsApiListActions
+     */
+    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, name, slug, isEnabled, workflowCode, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof ActionsApiListActions
+     */
+    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 ActionsApiListActions
+     */
+    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, name, slug, isEnabled, workflowCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
+     * @type {string}
+     * @memberof ActionsApiListActions
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for updateAction operation in ActionsApi.
+ * @export
+ * @interface ActionsApiUpdateActionRequest
+ */
+export interface ActionsApiUpdateActionRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ActionsApiUpdateAction
+     */
+    readonly code: string;
+    /**
+     * Unique identifier for the object.
+     * @type {any}
+     * @memberof ActionsApiUpdateAction
+     */
+    readonly action: any;
+    /**
+     *
+     * @type {UpdateActionRequestDto}
+     * @memberof ActionsApiUpdateAction
+     */
+    readonly updateActionRequestDto: UpdateActionRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ActionsApiUpdateAction
+     */
+    readonly authorization?: string;
+}
+/**
+ * ActionsApi - object-oriented interface
+ * @export
+ * @class ActionsApi
+ * @extends {BaseAPI}
+ */
+export declare class ActionsApi extends BaseAPI {
+    /**
+     * Creates a new action configuration
+     * @summary Create the action
+     * @param {ActionsApiCreateActionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    createAction(requestParameters: ActionsApiCreateActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateActionResponseClass, any, {}>>;
+    /**
+     * Deletes an action configuration by its code
+     * @summary Delete the action
+     * @param {ActionsApiDeleteActionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    deleteAction(requestParameters: ActionsApiDeleteActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Retrieves an action configuration by its code
+     * @summary Retrieve the action
+     * @param {ActionsApiGetActionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    getAction(requestParameters: ActionsApiGetActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActionResponseClass, any, {}>>;
+    /**
+     * Lists all action configurations with optional filters
+     * @summary List actions
+     * @param {ActionsApiListActionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    listActions(requestParameters?: ActionsApiListActionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionsResponseClass, any, {}>>;
+    /**
+     * Updates an existing action configuration (patch semantics)
+     * @summary Update the action
+     * @param {ActionsApiUpdateActionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    updateAction(requestParameters: ActionsApiUpdateActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateActionResponseClass, any, {}>>;
+}