/** * Webitel API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 24.04.0 * Contact: support@webitel.com * * 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 } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { DataForTheCommentToUpdate } from '../api'; import { DataForTheCommentToUpdate1 } from '../api'; import { WebitelCasesCaseComment } from '../api'; import { WebitelCasesCaseCommentList } from '../api'; import { WebitelCasesInputCaseComment } from '../api'; /** * CaseCommentsApi - axios parameter creator * @export */ export declare const CaseCommentsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Delete a specific comment by its etag * @param {string} etag Identifier of the comment to delete. * @param {Array} [fields] Fields to return after deletion. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteComment: (etag: string, fields?: Array, options?: any) => Promise; /** * * @summary Retrieve a list of comments associated with a specific case * @param {string} caseEtag Etag or ID of the case for which comments are requested. * @param {number} [page] Page number for pagination. * @param {number} [size] Number of comments per page. * @param {string} [q] Query string for search. * @param {Array} [ids] Array of requested id. * @param {string} [sort] Sorting order. * @param {Array} [fields] Fields to return for each comment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listComments: (caseEtag: string, page?: number, size?: number, q?: string, ids?: Array, sort?: string, fields?: Array, options?: any) => Promise; /** * * @summary Retrieve a specific comment by its etag * @param {string} etag Identifier of the comment to retrieve. * @param {Array} [fields] Specific fields to return for the comment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateComment: (etag: string, fields?: Array, options?: any) => Promise; /** * * @summary Publish comment into a specific case * @param {string} caseEtag Etag or ID of the case to which comments belong. * @param {WebitelCasesInputCaseComment} input Comment to publish. * @param {Array} [fields] Result fields to include in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ publishComment: (caseEtag: string, input: WebitelCasesInputCaseComment, fields?: Array, options?: any) => Promise; /** * * @summary Update a specific comment by its etag * @param {string} inputEtag Identifier for the comment. * @param {DataForTheCommentToUpdate} input * @param {Array} [fields] Fields to include in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateComment: (inputEtag: string, input: DataForTheCommentToUpdate, fields?: Array, options?: any) => Promise; /** * * @summary Update a specific comment by its etag * @param {string} inputEtag Identifier for the comment. * @param {DataForTheCommentToUpdate1} input * @param {Array} [fields] Fields to include in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateComment2: (inputEtag: string, input: DataForTheCommentToUpdate1, fields?: Array, options?: any) => Promise; }; /** * CaseCommentsApi - functional programming interface * @export */ export declare const CaseCommentsApiFp: (configuration?: Configuration) => { /** * * @summary Delete a specific comment by its etag * @param {string} etag Identifier of the comment to delete. * @param {Array} [fields] Fields to return after deletion. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteComment(etag: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Retrieve a list of comments associated with a specific case * @param {string} caseEtag Etag or ID of the case for which comments are requested. * @param {number} [page] Page number for pagination. * @param {number} [size] Number of comments per page. * @param {string} [q] Query string for search. * @param {Array} [ids] Array of requested id. * @param {string} [sort] Sorting order. * @param {Array} [fields] Fields to return for each comment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listComments(caseEtag: string, page?: number, size?: number, q?: string, ids?: Array, sort?: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Retrieve a specific comment by its etag * @param {string} etag Identifier of the comment to retrieve. * @param {Array} [fields] Specific fields to return for the comment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateComment(etag: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Publish comment into a specific case * @param {string} caseEtag Etag or ID of the case to which comments belong. * @param {WebitelCasesInputCaseComment} input Comment to publish. * @param {Array} [fields] Result fields to include in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ publishComment(caseEtag: string, input: WebitelCasesInputCaseComment, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update a specific comment by its etag * @param {string} inputEtag Identifier for the comment. * @param {DataForTheCommentToUpdate} input * @param {Array} [fields] Fields to include in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateComment(inputEtag: string, input: DataForTheCommentToUpdate, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update a specific comment by its etag * @param {string} inputEtag Identifier for the comment. * @param {DataForTheCommentToUpdate1} input * @param {Array} [fields] Fields to include in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateComment2(inputEtag: string, input: DataForTheCommentToUpdate1, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CaseCommentsApi - factory interface * @export */ export declare const CaseCommentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Delete a specific comment by its etag * @param {string} etag Identifier of the comment to delete. * @param {Array} [fields] Fields to return after deletion. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteComment(etag: string, fields?: Array, options?: any): AxiosPromise; /** * * @summary Retrieve a list of comments associated with a specific case * @param {string} caseEtag Etag or ID of the case for which comments are requested. * @param {number} [page] Page number for pagination. * @param {number} [size] Number of comments per page. * @param {string} [q] Query string for search. * @param {Array} [ids] Array of requested id. * @param {string} [sort] Sorting order. * @param {Array} [fields] Fields to return for each comment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listComments(caseEtag: string, page?: number, size?: number, q?: string, ids?: Array, sort?: string, fields?: Array, options?: any): AxiosPromise; /** * * @summary Retrieve a specific comment by its etag * @param {string} etag Identifier of the comment to retrieve. * @param {Array} [fields] Specific fields to return for the comment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateComment(etag: string, fields?: Array, options?: any): AxiosPromise; /** * * @summary Publish comment into a specific case * @param {string} caseEtag Etag or ID of the case to which comments belong. * @param {WebitelCasesInputCaseComment} input Comment to publish. * @param {Array} [fields] Result fields to include in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ publishComment(caseEtag: string, input: WebitelCasesInputCaseComment, fields?: Array, options?: any): AxiosPromise; /** * * @summary Update a specific comment by its etag * @param {string} inputEtag Identifier for the comment. * @param {DataForTheCommentToUpdate} input * @param {Array} [fields] Fields to include in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateComment(inputEtag: string, input: DataForTheCommentToUpdate, fields?: Array, options?: any): AxiosPromise; /** * * @summary Update a specific comment by its etag * @param {string} inputEtag Identifier for the comment. * @param {DataForTheCommentToUpdate1} input * @param {Array} [fields] Fields to include in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateComment2(inputEtag: string, input: DataForTheCommentToUpdate1, fields?: Array, options?: any): AxiosPromise; }; /** * CaseCommentsApi - object-oriented interface * @export * @class CaseCommentsApi * @extends {BaseAPI} */ export declare class CaseCommentsApi extends BaseAPI { /** * * @summary Delete a specific comment by its etag * @param {string} etag Identifier of the comment to delete. * @param {Array} [fields] Fields to return after deletion. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CaseCommentsApi */ deleteComment(etag: string, fields?: Array, options?: any): Promise>; /** * * @summary Retrieve a list of comments associated with a specific case * @param {string} caseEtag Etag or ID of the case for which comments are requested. * @param {number} [page] Page number for pagination. * @param {number} [size] Number of comments per page. * @param {string} [q] Query string for search. * @param {Array} [ids] Array of requested id. * @param {string} [sort] Sorting order. * @param {Array} [fields] Fields to return for each comment. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CaseCommentsApi */ listComments(caseEtag: string, page?: number, size?: number, q?: string, ids?: Array, sort?: string, fields?: Array, options?: any): Promise>; /** * * @summary Retrieve a specific comment by its etag * @param {string} etag Identifier of the comment to retrieve. * @param {Array} [fields] Specific fields to return for the comment. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CaseCommentsApi */ locateComment(etag: string, fields?: Array, options?: any): Promise>; /** * * @summary Publish comment into a specific case * @param {string} caseEtag Etag or ID of the case to which comments belong. * @param {WebitelCasesInputCaseComment} input Comment to publish. * @param {Array} [fields] Result fields to include in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CaseCommentsApi */ publishComment(caseEtag: string, input: WebitelCasesInputCaseComment, fields?: Array, options?: any): Promise>; /** * * @summary Update a specific comment by its etag * @param {string} inputEtag Identifier for the comment. * @param {DataForTheCommentToUpdate} input * @param {Array} [fields] Fields to include in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CaseCommentsApi */ updateComment(inputEtag: string, input: DataForTheCommentToUpdate, fields?: Array, options?: any): Promise>; /** * * @summary Update a specific comment by its etag * @param {string} inputEtag Identifier for the comment. * @param {DataForTheCommentToUpdate1} input * @param {Array} [fields] Fields to include in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CaseCommentsApi */ updateComment2(inputEtag: string, input: DataForTheCommentToUpdate1, fields?: Array, options?: any): Promise>; } //# sourceMappingURL=case-comments-api.d.ts.map