@kuflow/kuflow-rest
Version:
REST SDK for KuFlow.
440 lines • 15.7 kB
JavaScript
;
/**
* 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.
*/
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ProcessOperationsImpl = void 0;
const coreClient = __importStar(require("@azure/core-client"));
const Mappers = __importStar(require("../models/mappers"));
const Parameters = __importStar(require("../models/parameters"));
/** Class containing ProcessOperations operations. */
class ProcessOperationsImpl {
client;
/**
* Initialize a new instance of the class ProcessOperations class.
* @param client Reference to the service client
*/
constructor(client) {
this.client = client;
}
/**
* List all the Processes that have been created and the credentials has access.
*
* Available sort query values: id, createdAt, lastModifiedAt
*
* @param options The options parameters.
*/
async findProcesses(options) {
return await this.client.sendOperationRequest({ options }, findProcessesOperationSpec);
}
/**
* Creates a process. This option has direct correspondence to the action of starting a process in the
* Kuflow GUI.
*
* If you want the method to be idempotent, please specify the `id` field in the request body.
*
* @param processCreateParams Process to create
* @param options The options parameters.
*/
async createProcess(processCreateParams, options) {
return await this.client.sendOperationRequest({ processCreateParams, options }, createProcessOperationSpec);
}
/**
* Returns the requested Process when has access to do it.
* @param id The resource ID.
* @param options The options parameters.
*/
async retrieveProcess(id, options) {
return await this.client.sendOperationRequest({ id, options }, retrieveProcessOperationSpec);
}
/**
* Complete a Process. The state of Process is set to 'completed'.
*
* If you are already in this state, no action is taken.
*
* @param id The resource ID.
* @param options The options parameters.
*/
async completeProcess(id, options) {
return await this.client.sendOperationRequest({ id, options }, completeProcessOperationSpec);
}
/**
* Cancel a Process. The Process state is set to 'cancelled'.
*
* All the active process items will be marked as cancelled too.
*
* If you are already in this state, no action is taken.
*
* @param id The resource ID.
* @param options The options parameters.
*/
async cancelProcess(id, options) {
return await this.client.sendOperationRequest({ id, options }, cancelProcessOperationSpec);
}
/**
* Change the current initiator of a process.
*
* Allows you to choose a user (by email or principal identifier) or an application (principal
* identifier).
* Only one option will be necessary.
*
* @param id The resource ID.
* @param processChangeInitiatorParams Params to change the process initiator.
* @param options The options parameters.
*/
async changeProcessInitiator(id, processChangeInitiatorParams, options) {
return await this.client.sendOperationRequest({ id, processChangeInitiatorParams, options }, changeProcessInitiatorOperationSpec);
}
/**
* Allow saving a user action document uploading the content.
*
* @param id The resource ID.
* @param fileContentType Document content type
* @param fileName Document name
* @param userActionValueId User action value ID related to de document
* @param file Document to save.
* @param options The options parameters.
*/
async uploadProcessUserActionDocument(id, fileContentType, fileName, userActionValueId, file, options) {
return await this.client.sendOperationRequest({ id, fileContentType, fileName, userActionValueId, file, options }, uploadProcessUserActionDocumentOperationSpec);
}
/**
* Save process metadata
* @param id The resource ID.
* @param processMetadataUpdateParams Params to save the metadata data.
* @param options The options parameters.
*/
async updateProcessMetadata(id, processMetadataUpdateParams, options) {
return await this.client.sendOperationRequest({ id, processMetadataUpdateParams, options }, updateProcessMetadataOperationSpec);
}
/**
* 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.
*/
async patchProcessMetadata(id, jsonPatch, options) {
return await this.client.sendOperationRequest({ id, jsonPatch, options }, patchProcessMetadataOperationSpec);
}
/**
* Allow to save a JSON 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 processEntityUpdateParams Params to save the JSON value.
* @param options The options parameters.
*/
async updateProcessEntity(id, processEntityUpdateParams, options) {
return await this.client.sendOperationRequest({ id, processEntityUpdateParams, options }, updateProcessEntityOperationSpec);
}
/**
* 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.
*/
async patchProcessEntity(id, jsonPatch, options) {
return await this.client.sendOperationRequest({ id, jsonPatch, options }, patchProcessEntityOperationSpec);
}
/**
* Upload a temporal document into the process that later on must be linked with a process domain
* resource.
*
* Documents uploaded with this API will be deleted after 24 hours as long as they have not been linked
* to a
* process or process item..
*
* @param id The resource ID.
* @param fileContentType Document content type
* @param fileName Document name
* @param file Document to save.
* @param options The options parameters.
*/
async uploadProcessDocument(id, fileContentType, fileName, file, options) {
return await this.client.sendOperationRequest({ id, fileContentType, fileName, file, options }, uploadProcessDocumentOperationSpec);
}
/**
* Given a document uri download a document.
* @param id The resource ID.
* @param documentUri Document URI to download.
* @param options The options parameters.
*/
async downloadProcessDocument(id, documentUri, options) {
return await this.client.sendOperationRequest({ id, documentUri, options }, downloadProcessDocumentOperationSpec);
}
}
exports.ProcessOperationsImpl = ProcessOperationsImpl;
// Operation Specifications
const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
const findProcessesOperationSpec = {
path: '/processes',
httpMethod: 'GET',
responses: {
200: {
bodyMapper: Mappers.ProcessPage,
},
default: {
bodyMapper: Mappers.DefaultError,
},
},
queryParameters: [Parameters.size, Parameters.page, Parameters.sort, Parameters.tenantId],
urlParameters: [Parameters.$host],
headerParameters: [Parameters.accept],
serializer,
};
const createProcessOperationSpec = {
path: '/processes',
httpMethod: 'POST',
responses: {
200: {
bodyMapper: Mappers.Process,
},
201: {
bodyMapper: Mappers.Process,
},
default: {
bodyMapper: Mappers.DefaultError,
},
},
requestBody: Parameters.processCreateParams,
urlParameters: [Parameters.$host],
headerParameters: [Parameters.contentType, Parameters.accept],
mediaType: 'json',
serializer,
};
const retrieveProcessOperationSpec = {
path: '/processes/{id}',
httpMethod: 'GET',
responses: {
200: {
bodyMapper: Mappers.Process,
},
default: {
bodyMapper: Mappers.DefaultError,
},
},
urlParameters: [Parameters.$host, Parameters.id],
headerParameters: [Parameters.accept],
serializer,
};
const completeProcessOperationSpec = {
path: '/processes/{id}/~actions/complete',
httpMethod: 'POST',
responses: {
200: {
bodyMapper: Mappers.Process,
},
default: {
bodyMapper: Mappers.DefaultError,
},
},
urlParameters: [Parameters.$host, Parameters.id],
headerParameters: [Parameters.accept],
serializer,
};
const cancelProcessOperationSpec = {
path: '/processes/{id}/~actions/cancel',
httpMethod: 'POST',
responses: {
200: {
bodyMapper: Mappers.Process,
},
default: {
bodyMapper: Mappers.DefaultError,
},
},
urlParameters: [Parameters.$host, Parameters.id],
headerParameters: [Parameters.accept],
serializer,
};
const changeProcessInitiatorOperationSpec = {
path: '/processes/{id}/~actions/change-initiator',
httpMethod: 'POST',
responses: {
200: {
bodyMapper: Mappers.Process,
},
default: {
bodyMapper: Mappers.DefaultError,
},
},
requestBody: Parameters.processChangeInitiatorParams,
urlParameters: [Parameters.$host, Parameters.id],
headerParameters: [Parameters.contentType, Parameters.accept],
mediaType: 'json',
serializer,
};
const uploadProcessUserActionDocumentOperationSpec = {
path: '/processes/{id}/~actions/upload-user-action-document',
httpMethod: 'POST',
responses: {
200: {
bodyMapper: Mappers.Process,
},
304: {},
default: {
bodyMapper: Mappers.DefaultError,
},
},
requestBody: Parameters.file,
queryParameters: [Parameters.fileContentType, Parameters.fileName, Parameters.userActionValueId],
urlParameters: [Parameters.$host, Parameters.id],
headerParameters: [Parameters.contentType1, Parameters.accept1],
mediaType: 'binary',
serializer,
};
const updateProcessMetadataOperationSpec = {
path: '/processes/{id}/metadata',
httpMethod: 'PUT',
responses: {
200: {
bodyMapper: Mappers.Process,
},
default: {
bodyMapper: Mappers.DefaultError,
},
},
requestBody: Parameters.processMetadataUpdateParams,
urlParameters: [Parameters.$host, Parameters.id],
headerParameters: [Parameters.contentType, Parameters.accept],
mediaType: 'json',
serializer,
};
const patchProcessMetadataOperationSpec = {
path: '/processes/{id}/metadata',
httpMethod: 'PATCH',
responses: {
200: {
bodyMapper: Mappers.Process,
},
default: {
bodyMapper: Mappers.DefaultError,
},
},
requestBody: Parameters.jsonPatch,
urlParameters: [Parameters.$host, Parameters.id],
headerParameters: [Parameters.accept, Parameters.contentType2],
mediaType: 'json',
serializer,
};
const updateProcessEntityOperationSpec = {
path: '/processes/{id}/entity',
httpMethod: 'PUT',
responses: {
200: {
bodyMapper: Mappers.Process,
},
default: {
bodyMapper: Mappers.DefaultError,
},
},
requestBody: Parameters.processEntityUpdateParams,
urlParameters: [Parameters.$host, Parameters.id],
headerParameters: [Parameters.contentType, Parameters.accept],
mediaType: 'json',
serializer,
};
const patchProcessEntityOperationSpec = {
path: '/processes/{id}/entity',
httpMethod: 'PATCH',
responses: {
200: {
bodyMapper: Mappers.Process,
},
default: {
bodyMapper: Mappers.DefaultError,
},
},
requestBody: Parameters.jsonPatch,
urlParameters: [Parameters.$host, Parameters.id],
headerParameters: [Parameters.accept, Parameters.contentType2],
mediaType: 'json',
serializer,
};
const uploadProcessDocumentOperationSpec = {
path: '/processes/{id}/~actions/upload-document',
httpMethod: 'POST',
responses: {
200: {
bodyMapper: Mappers.DocumentReference,
},
default: {
bodyMapper: Mappers.DefaultError,
},
},
requestBody: Parameters.file,
queryParameters: [Parameters.fileContentType, Parameters.fileName],
urlParameters: [Parameters.$host, Parameters.id],
headerParameters: [Parameters.contentType1, Parameters.accept1],
mediaType: 'binary',
serializer,
};
const downloadProcessDocumentOperationSpec = {
path: '/processes/{id}/~actions/download-document',
httpMethod: 'GET',
responses: {
200: {
bodyMapper: {
type: { name: 'Stream' },
serializedName: 'parsedResponse',
},
},
default: {
bodyMapper: Mappers.DefaultError,
},
},
queryParameters: [Parameters.documentUri],
urlParameters: [Parameters.$host, Parameters.id],
headerParameters: [Parameters.accept2],
serializer,
};
//# sourceMappingURL=processOperations.js.map