@mindconnect/mindconnect-nodejs
Version:
NodeJS Library for Siemens Insights Hub Connectivity - TypeScript SDK for Insights Hub and Industrial IoT - Command Line Interface - Insights Hub Development Proxy (Siemens Insights Hub was formerly known as MindSphere)
228 lines (227 loc) • 8.52 kB
TypeScript
import { SdkClient } from "../common/sdk-client";
import { CaseManagementModels } from "./cases-models";
/**
* * Case Management API
* case solution building block provides a workflow for maintenance, repair, inspection and incident handling requests.
*
* This workflow would enable user to
* Digitalize preventive maintenance - cases for planned maintenance requests (insights from condition monitoring, prescribed by manufacturer,
* dictated by performance, required by policies)
* Digitalize corrective maintenance - cases for incident handling and repair requests (alerts from condition monitoring, observations)
* Digitalize compliance to regulations - Audit of inspection records
* Improve work request coordination leading to improvement in productivity
* Improve work request efficiency - right information at right place at right time case solution building block would enable user
* by allowing to create, monitor and update cases in multiple ways.
*
* @export
* @class CaseManagementClient
* @extends {SdkClient}
*/
export declare class CaseManagementClient extends SdkClient {
private _baseUrl;
/**
*
* Retrieves the list of cases for the tenant.
*
* @param {{
* page?: number;
* size?: number;
* sort?: string;
* filter?: string;
* }} [params]
* @return {*} {Promise<CaseManagementModels.CaseListResponse>}
* @memberof CaseManagementClient
*/
GetCases(params?: {
page?: number;
size?: number;
sort?: string;
filter?: string;
}): Promise<CaseManagementModels.CaseListResponse>;
/**
* Create case
*
* @param {CaseManagementModels.CaseRequestDTO} caseRequest
* @return {*} {Promise<CaseManagementModels.CaseSuccessResponseStatus>}
* @memberof CaseManagementClient
*/
CreateCase(caseRequest: CaseManagementModels.CaseRequestDTO): Promise<CaseManagementModels.CaseSuccessResponseStatus>;
/**
* Get list of all cases activities
*
* @param {{
* page?: number;
* size?: number;
* sort?: string;
* filter?: string;
* }} [params]
* @return {*} {Promise<CaseManagementModels.CaseActivitiesListResponse>}
* @memberof CaseManagementClient
*/
GetCasesActivities(params?: {
page?: number;
size?: number;
sort?: string;
filter?: string;
}): Promise<CaseManagementModels.CaseActivitiesListResponse>;
/**
* Get list of cases comments
*
* @param {{
* page?: number;
* size?: number;
* sort?: string;
* filter?: string;
* }} [params]
* @return {*} {Promise<CaseManagementModels.CaseCommentsListResponse>}
* @memberof CaseManagementClient
*/
GetCasesComments(params?: {
page?: number;
size?: number;
sort?: string;
filter?: string;
}): Promise<CaseManagementModels.CaseCommentsListResponse>;
/**
* Get aggregate summary of the case
*
* @param {{
* includeOnly?: string;
* }} [params]
* @return {*} {Promise<CaseManagementModels.CaseAggregateResponse>}
* @memberof CaseManagementClient
*/
GetCasesAggregate(params?: {
includeOnly?: string;
}): Promise<CaseManagementModels.CaseAggregateResponse>;
/**
* Retrieve case for given case handle
*
* @param {string} handle
* @return {*} {Promise<CaseManagementModels.CaseResponse>}
* @memberof CaseManagementClient
*/
GetCase(handle: string): Promise<CaseManagementModels.CaseResponse>;
/**
* Update case for given case handle.
*
* @param {string} handle
* @param {CaseManagementModels.CaseRequestDTO} caseRequest
* @param {{ ifMatch: string }} params
* @return {*} {Promise<CaseManagementModels.CaseResponseStatus>}
* @memberof CaseManagementClient
*/
UpdateCase(handle: string, caseRequest: CaseManagementModels.CaseRequestDTO, params: {
ifMatch: string;
}): Promise<CaseManagementModels.CaseResponseStatus>;
/**
* Delete case for given case handle
*
* @param {string} handle
* @param {{ ifMatch: string }} params
* @memberof CaseManagementClient
*/
DeleteCase(handle: string, params: {
ifMatch: string;
}): Promise<void>;
/**
* Partial update attachments case for given case handle
*
* @param {string} handle
* @param {CaseManagementModels.AttachmentsRequestDTO} attachementRequestDto
* @param {{ ifMatch: string }} params
* @return {*} {Promise<CaseManagementModels.CaseSuccessResponseStatus>}
* @memberof CaseManagementClient
*/
UpdateAttachments(handle: string, attachementRequestDto: CaseManagementModels.AttachmentsRequestDTO, params: {
ifMatch: string;
}): Promise<CaseManagementModels.CaseSuccessResponseStatus>;
/**
* Partial update associations case for given case handle
*
* @param {string} handle
* @param {CaseManagementModels.AssociationsRequestDTO} associationsRequestDto
* @param {{ ifMatch: string }} params
* @return {*} {Promise<CaseManagementModels.CaseSuccessResponseStatus>}
* @memberof CaseManagementClient
*/
UpdateAssociations(handle: string, associationsRequestDto: CaseManagementModels.AssociationsRequestDTO, params: {
ifMatch: string;
}): Promise<CaseManagementModels.CaseSuccessResponseStatus>;
/**
* Partial update externalSystems for given case handle
*
* @param {string} handle
* @param {CaseManagementModels.ExternalSystemsRequestDTO} externalSystemsRequestDto
* @param {{ ifMatch: string }} params
* @return {*} {Promise<CaseManagementModels.CaseSuccessResponseStatus>}
* @memberof CaseManagementClient
*/
UpdateExternalSystems(handle: string, externalSystemsRequestDto: CaseManagementModels.ExternalSystemsRequestDTO, params: {
ifMatch: string;
}): Promise<CaseManagementModels.CaseSuccessResponseStatus>;
/**
* Partial update tags for given case handle
*
* @param {string} handle
* @param {CaseManagementModels.TagsRequestDTO} tags
* @param {{ ifMatch: string }} params
* @return {*} {Promise<CaseManagementModels.CaseSuccessResponseStatus>}
* @memberof CaseManagementClient
*/
UpdateTags(handle: string, tags: CaseManagementModels.TagsRequestDTO, params: {
ifMatch: string;
}): Promise<CaseManagementModels.CaseSuccessResponseStatus>;
/**
* Create comment for given case handle
*
* @param {string} handle
* @param {CaseManagementModels.CaseCommentsRequestDTO} comment
* @return {*} {Promise<CaseManagementModels.CaseSuccessResponseStatus>}
* @memberof CaseManagementClient
*/
CreateComment(handle: string, comment: CaseManagementModels.CaseCommentsResponse): Promise<CaseManagementModels.CaseCommentsResponse>;
/**
* Get list of case comments for given case handle
*
* @param {string} handle
* @param {{
* page?: number;
* size?: number;
* sort?: string;
* filter?: string;
* }} [params]
* @return {*} {Promise<CaseManagementModels.CaseCommentsListResponse>}
* @memberof CaseManagementClient
*/
GetCaseComents(handle: string, params?: {
page?: number;
size?: number;
sort?: string;
filter?: string;
}): Promise<CaseManagementModels.CaseCommentsListResponse>;
/**
* Partial update comment for given case handle
*
* @param {string} handle
* @param {string} id
* @param {CaseManagementModels.CaseCommentsRequestDTO} comment
* @param {{ ifMatch: string }} params
* @return {*} {Promise<CaseManagementModels.CaseSuccessResponseStatus>}
* @memberof CaseManagementClient
*/
UpdateComment(handle: string, id: string, comment: CaseManagementModels.CaseCommentsRequestDTO, params: {
ifMatch: string;
}): Promise<CaseManagementModels.CaseSuccessResponseStatus>;
/**
* Delete comment
*
* @param {string} handle
* @param {string} id
* @param {{ ifMatch: string }} params
* @memberof CaseManagementClient
*/
DeleteComment(handle: string, id: string, params: {
ifMatch: string;
}): Promise<void>;
}