@kuflow/kuflow-rest/lib/generated/operations/processItemOperations.d.ts

REST SDK for KuFlow.

/**
 * The MIT License
 * Copyright © 2021-present KuFlow S.L.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
import type { KuFlowRestClientGenerated } from '../kuFlowRestClientGenerated';
import type { JsonPatchOperation, ProcessItemAppendProcessItemTaskLogOptionalParams, ProcessItemAppendProcessItemTaskLogResponse, ProcessItemAssignProcessItemTaskOptionalParams, ProcessItemAssignProcessItemTaskResponse, ProcessItemClaimProcessItemTaskOptionalParams, ProcessItemClaimProcessItemTaskResponse, ProcessItemCompleteProcessItemTaskOptionalParams, ProcessItemCompleteProcessItemTaskResponse, ProcessItemCreateParams, ProcessItemCreateProcessItemOptionalParams, ProcessItemCreateProcessItemResponse, ProcessItemDownloadProcessItemTaskDataWebformsAsDocumentOptionalParams, ProcessItemDownloadProcessItemTaskDataWebformsAsDocumentResponse, ProcessItemFindProcessItemsOptionalParams, ProcessItemFindProcessItemsResponse, ProcessItemPatchProcessItemTaskDataOptionalParams, ProcessItemPatchProcessItemTaskDataResponse, ProcessItemRetrieveProcessItemOptionalParams, ProcessItemRetrieveProcessItemResponse, ProcessItemTaskAppendLogParams, ProcessItemTaskAssignParams, ProcessItemTaskDataUpdateParams, ProcessItemUpdateProcessItemTaskDataOptionalParams, ProcessItemUpdateProcessItemTaskDataResponse } from '../models';
import type { ProcessItemOperations } from '../operationsInterfaces';
/** Class containing ProcessItemOperations operations. */
export declare class ProcessItemOperationsImpl implements ProcessItemOperations {
    private readonly client;
    /**
     * Initialize a new instance of the class ProcessItemOperations class.
     * @param client Reference to the service client
     */
    constructor(client: KuFlowRestClientGenerated);
    /**
     * List all Process Items that have been created and the credentials has access.
     *
     * Available sort query values: id, createdAt, lastModifiedAt, claimedAt, completedAt, cancelledAt
     *
     * @param options The options parameters.
     */
    findProcessItems(options?: ProcessItemFindProcessItemsOptionalParams): Promise<ProcessItemFindProcessItemsResponse>;
    /**
     * Create a Process Item and optionally fill its value.
     *
     * If you want to add document type elements, you can pass a reference to an existing document type
     * element
     * indicating its 'uri'. This will copy that document into the element. In case you want to add a new
     * document,
     * please use the corresponding API method.
     *
     * If you want the method to be idempotent, please specify the `id` field in the request body.
     *
     * @param processItemCreateParams Process Item to be created
     * @param options The options parameters.
     */
    createProcessItem(processItemCreateParams: ProcessItemCreateParams, options?: ProcessItemCreateProcessItemOptionalParams): Promise<ProcessItemCreateProcessItemResponse>;
    /**
     * Allow to get a process item by ID.
     * @param id The resource ID.
     * @param options The options parameters.
     */
    retrieveProcessItem(id: string, options?: ProcessItemRetrieveProcessItemOptionalParams): Promise<ProcessItemRetrieveProcessItemResponse>;
    /**
     * Allow to claim a task.
     * @param id The resource ID.
     * @param options The options parameters.
     */
    claimProcessItemTask(id: string, options?: ProcessItemClaimProcessItemTaskOptionalParams): Promise<ProcessItemClaimProcessItemTaskResponse>;
    /**
     * Allow to assign a process item task to a user or application. Only one option will be necessary.
     * @param id The resource ID.
     * @param processItemTaskAssignParams Params to change the process item task owner.
     * @param options The options parameters.
     */
    assignProcessItemTask(id: string, processItemTaskAssignParams: ProcessItemTaskAssignParams, options?: ProcessItemAssignProcessItemTaskOptionalParams): Promise<ProcessItemAssignProcessItemTaskResponse>;
    /**
     * Allow to complete a claimed task by the principal.
     * @param id The resource ID.
     * @param options The options parameters.
     */
    completeProcessItemTask(id: string, options?: ProcessItemCompleteProcessItemTaskOptionalParams): Promise<ProcessItemCompleteProcessItemTaskResponse>;
    /**
     * A log entry is added to the task. If the number of log entries is reached, the oldest log entry is
     * removed.
     *
     * @param id The resource ID.
     * @param processItemTaskAppendLogParams Log to be created.
     * @param options The options parameters.
     */
    appendProcessItemTaskLog(id: string, processItemTaskAppendLogParams: ProcessItemTaskAppendLogParams, options?: ProcessItemAppendProcessItemTaskLogOptionalParams): Promise<ProcessItemAppendProcessItemTaskLogResponse>;
    /**
     * Allow to save a JSON data validating that the data follow the related schema. If the data is
     * invalid, then
     * the json form is marked as invalid.
     *
     * @param id The resource ID.
     * @param processItemTaskDataUpdateParams Params used to update the JSON value.
     * @param options The options parameters.
     */
    updateProcessItemTaskData(id: string, processItemTaskDataUpdateParams: ProcessItemTaskDataUpdateParams, options?: ProcessItemUpdateProcessItemTaskDataOptionalParams): Promise<ProcessItemUpdateProcessItemTaskDataResponse>;
    /**
     * Allow to patch a JSON data validating that the data follow the related schema. If the data is
     * invalid, then
     * the json is marked as invalid.
     *
     * @param id The resource ID.
     * @param jsonPatch Params to save the JSON value.
     * @param options The options parameters.
     */
    patchProcessItemTaskData(id: string, jsonPatch: JsonPatchOperation[], options?: ProcessItemPatchProcessItemTaskDataOptionalParams): Promise<ProcessItemPatchProcessItemTaskDataResponse>;
    /**
     * Given a task, generate a PDF from a Form type element with the data filled in, if any. If there are
     * multiple form values, they are packed into a ZIP.
     *
     * Important!: To use this feature, please contact to kuflow@kuflow.com
     *
     * @param id The resource ID.
     * @param propertyPath JSON pointer to the property with the error. See:
     *                     https://datatracker.ietf.org/doc/html/rfc6901
     *
     * ie: /user/name or /users/1/name
     *
     * @param options The options parameters.
     */
    downloadProcessItemTaskDataWebformsAsDocument(id: string, propertyPath: string, options?: ProcessItemDownloadProcessItemTaskDataWebformsAsDocumentOptionalParams): Promise<ProcessItemDownloadProcessItemTaskDataWebformsAsDocumentResponse>;
}