/** * 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 { NEWUpdateOfTheArticleLink } from '../api'; import { WebitelKnowledgebaseArticle } from '../api'; import { WebitelKnowledgebaseArticleList } from '../api'; import { WebitelKnowledgebaseArticleVersion } from '../api'; import { WebitelKnowledgebaseArticleVersionList } from '../api'; import { WebitelKnowledgebaseAttachmentList } from '../api'; import { WebitelKnowledgebaseInputArticle } from '../api'; /** * ArticlesApi - axios parameter creator * @export */ export declare const ArticlesApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @param {string} spaceId Space ID associated with. * @param {string} articleId Record(s) with unique ID only. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {Array} [sort] Sort the result according to fields. * @param {*} [options] Override http request option. * @throws {RequiredError} */ articleVersionsList: (spaceId: string, articleId: string, page?: number, size?: number, sort?: Array, options?: any) => Promise; /** * * @param {string} spaceId Space ID associated with. * @param {string} articleId Record(s) with unique ID only. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {Array} [sort] Sort the result according to fields. * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesAttachmentList: (spaceId: string, articleId: string, page?: number, size?: number, sort?: Array, options?: any) => Promise; /** * * @param {string} spaceId Link space ID. * @param {WebitelKnowledgebaseInputArticle} input NEW Update of the Article link. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createArticle: (spaceId: string, input: WebitelKnowledgebaseInputArticle, fields?: Array, options?: any) => Promise; /** * * @summary Remove the space\'s Article association. * @param {string} spaceId Space ID associated with. * @param {string} etag Unique ID to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteArticle: (spaceId: string, etag: string, fields?: Array, options?: any) => Promise; /** * * @summary List of the Space\'s Article(s). * @param {string} spaceId Space ID associated with. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {Array} [sort] Sort the result according to fields. * @param {Array} [fields] Fields to be retrieved as a result. * @param {string} [q] Search term: location name; `?` - matches any one character `*` - matches 0 or more characters * @param {string} [articleId] Record(s) with unique ID only. * @param {boolean} [state] Active Article only. * @param {Array} [tags] Tags associated with the article. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listArticles: (spaceId: string, page?: number, size?: number, sort?: Array, fields?: Array, q?: string, articleId?: string, state?: boolean, tags?: Array, options?: any) => Promise; /** * * @summary List of the Space\'s Article(s). * @param {string} spaceId Space ID associated with. * @param {string} articleId Record(s) with unique ID only. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {Array} [sort] Sort the result according to fields. * @param {Array} [fields] Fields to be retrieved as a result. * @param {string} [q] Search term: location name; `?` - matches any one character `*` - matches 0 or more characters * @param {boolean} [state] Active Article only. * @param {Array} [tags] Tags associated with the article. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listArticles2: (spaceId: string, articleId: string, page?: number, size?: number, sort?: Array, fields?: Array, q?: string, state?: boolean, tags?: Array, options?: any) => Promise; /** * * @summary Locate the space\'s Article association. * @param {string} spaceId Space ID associated with. * @param {string} etag Unique Article link IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateArticle: (spaceId: string, etag: string, fields?: Array, options?: any) => Promise; /** * * @param {string} spaceId Space ID associated with. * @param {string} articleId Record(s) with unique ID only. * @param {string} versionId The unique ID of version record * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateArticleVersion: (spaceId: string, articleId: string, versionId: string, options?: any) => Promise; /** * * @summary Update the space\'s Article details. * @param {string} spaceId Link space ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheArticleLink} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateArticle: (spaceId: string, etag: string, input: NEWUpdateOfTheArticleLink, fields?: Array, options?: any) => Promise; }; /** * ArticlesApi - functional programming interface * @export */ export declare const ArticlesApiFp: (configuration?: Configuration) => { /** * * @param {string} spaceId Space ID associated with. * @param {string} articleId Record(s) with unique ID only. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {Array} [sort] Sort the result according to fields. * @param {*} [options] Override http request option. * @throws {RequiredError} */ articleVersionsList(spaceId: string, articleId: string, page?: number, size?: number, sort?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} spaceId Space ID associated with. * @param {string} articleId Record(s) with unique ID only. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {Array} [sort] Sort the result according to fields. * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesAttachmentList(spaceId: string, articleId: string, page?: number, size?: number, sort?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} spaceId Link space ID. * @param {WebitelKnowledgebaseInputArticle} input NEW Update of the Article link. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createArticle(spaceId: string, input: WebitelKnowledgebaseInputArticle, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Remove the space\'s Article association. * @param {string} spaceId Space ID associated with. * @param {string} etag Unique ID to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteArticle(spaceId: string, etag: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary List of the Space\'s Article(s). * @param {string} spaceId Space ID associated with. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {Array} [sort] Sort the result according to fields. * @param {Array} [fields] Fields to be retrieved as a result. * @param {string} [q] Search term: location name; `?` - matches any one character `*` - matches 0 or more characters * @param {string} [articleId] Record(s) with unique ID only. * @param {boolean} [state] Active Article only. * @param {Array} [tags] Tags associated with the article. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listArticles(spaceId: string, page?: number, size?: number, sort?: Array, fields?: Array, q?: string, articleId?: string, state?: boolean, tags?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary List of the Space\'s Article(s). * @param {string} spaceId Space ID associated with. * @param {string} articleId Record(s) with unique ID only. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {Array} [sort] Sort the result according to fields. * @param {Array} [fields] Fields to be retrieved as a result. * @param {string} [q] Search term: location name; `?` - matches any one character `*` - matches 0 or more characters * @param {boolean} [state] Active Article only. * @param {Array} [tags] Tags associated with the article. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listArticles2(spaceId: string, articleId: string, page?: number, size?: number, sort?: Array, fields?: Array, q?: string, state?: boolean, tags?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Locate the space\'s Article association. * @param {string} spaceId Space ID associated with. * @param {string} etag Unique Article link IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateArticle(spaceId: string, etag: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} spaceId Space ID associated with. * @param {string} articleId Record(s) with unique ID only. * @param {string} versionId The unique ID of version record * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateArticleVersion(spaceId: string, articleId: string, versionId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update the space\'s Article details. * @param {string} spaceId Link space ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheArticleLink} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateArticle(spaceId: string, etag: string, input: NEWUpdateOfTheArticleLink, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ArticlesApi - factory interface * @export */ export declare const ArticlesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @param {string} spaceId Space ID associated with. * @param {string} articleId Record(s) with unique ID only. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {Array} [sort] Sort the result according to fields. * @param {*} [options] Override http request option. * @throws {RequiredError} */ articleVersionsList(spaceId: string, articleId: string, page?: number, size?: number, sort?: Array, options?: any): AxiosPromise; /** * * @param {string} spaceId Space ID associated with. * @param {string} articleId Record(s) with unique ID only. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {Array} [sort] Sort the result according to fields. * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesAttachmentList(spaceId: string, articleId: string, page?: number, size?: number, sort?: Array, options?: any): AxiosPromise; /** * * @param {string} spaceId Link space ID. * @param {WebitelKnowledgebaseInputArticle} input NEW Update of the Article link. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createArticle(spaceId: string, input: WebitelKnowledgebaseInputArticle, fields?: Array, options?: any): AxiosPromise; /** * * @summary Remove the space\'s Article association. * @param {string} spaceId Space ID associated with. * @param {string} etag Unique ID to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteArticle(spaceId: string, etag: string, fields?: Array, options?: any): AxiosPromise; /** * * @summary List of the Space\'s Article(s). * @param {string} spaceId Space ID associated with. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {Array} [sort] Sort the result according to fields. * @param {Array} [fields] Fields to be retrieved as a result. * @param {string} [q] Search term: location name; `?` - matches any one character `*` - matches 0 or more characters * @param {string} [articleId] Record(s) with unique ID only. * @param {boolean} [state] Active Article only. * @param {Array} [tags] Tags associated with the article. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listArticles(spaceId: string, page?: number, size?: number, sort?: Array, fields?: Array, q?: string, articleId?: string, state?: boolean, tags?: Array, options?: any): AxiosPromise; /** * * @summary List of the Space\'s Article(s). * @param {string} spaceId Space ID associated with. * @param {string} articleId Record(s) with unique ID only. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {Array} [sort] Sort the result according to fields. * @param {Array} [fields] Fields to be retrieved as a result. * @param {string} [q] Search term: location name; `?` - matches any one character `*` - matches 0 or more characters * @param {boolean} [state] Active Article only. * @param {Array} [tags] Tags associated with the article. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listArticles2(spaceId: string, articleId: string, page?: number, size?: number, sort?: Array, fields?: Array, q?: string, state?: boolean, tags?: Array, options?: any): AxiosPromise; /** * * @summary Locate the space\'s Article association. * @param {string} spaceId Space ID associated with. * @param {string} etag Unique Article link IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateArticle(spaceId: string, etag: string, fields?: Array, options?: any): AxiosPromise; /** * * @param {string} spaceId Space ID associated with. * @param {string} articleId Record(s) with unique ID only. * @param {string} versionId The unique ID of version record * @param {*} [options] Override http request option. * @throws {RequiredError} */ locateArticleVersion(spaceId: string, articleId: string, versionId: string, options?: any): AxiosPromise; /** * * @summary Update the space\'s Article details. * @param {string} spaceId Link space ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheArticleLink} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateArticle(spaceId: string, etag: string, input: NEWUpdateOfTheArticleLink, fields?: Array, options?: any): AxiosPromise; }; /** * ArticlesApi - object-oriented interface * @export * @class ArticlesApi * @extends {BaseAPI} */ export declare class ArticlesApi extends BaseAPI { /** * * @param {string} spaceId Space ID associated with. * @param {string} articleId Record(s) with unique ID only. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {Array} [sort] Sort the result according to fields. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArticlesApi */ articleVersionsList(spaceId: string, articleId: string, page?: number, size?: number, sort?: Array, options?: any): Promise>; /** * * @param {string} spaceId Space ID associated with. * @param {string} articleId Record(s) with unique ID only. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {Array} [sort] Sort the result according to fields. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArticlesApi */ articlesAttachmentList(spaceId: string, articleId: string, page?: number, size?: number, sort?: Array, options?: any): Promise>; /** * * @param {string} spaceId Link space ID. * @param {WebitelKnowledgebaseInputArticle} input NEW Update of the Article link. * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArticlesApi */ createArticle(spaceId: string, input: WebitelKnowledgebaseInputArticle, fields?: Array, options?: any): Promise>; /** * * @summary Remove the space\'s Article association. * @param {string} spaceId Space ID associated with. * @param {string} etag Unique ID to remove. * @param {Array} [fields] Fields to be retrieved as a result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArticlesApi */ deleteArticle(spaceId: string, etag: string, fields?: Array, options?: any): Promise>; /** * * @summary List of the Space\'s Article(s). * @param {string} spaceId Space ID associated with. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {Array} [sort] Sort the result according to fields. * @param {Array} [fields] Fields to be retrieved as a result. * @param {string} [q] Search term: location name; `?` - matches any one character `*` - matches 0 or more characters * @param {string} [articleId] Record(s) with unique ID only. * @param {boolean} [state] Active Article only. * @param {Array} [tags] Tags associated with the article. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArticlesApi */ listArticles(spaceId: string, page?: number, size?: number, sort?: Array, fields?: Array, q?: string, articleId?: string, state?: boolean, tags?: Array, options?: any): Promise>; /** * * @summary List of the Space\'s Article(s). * @param {string} spaceId Space ID associated with. * @param {string} articleId Record(s) with unique ID only. * @param {number} [page] Page number of result dataset records. offset = (page*size) * @param {number} [size] Size count of records on result page. limit = (size++) * @param {Array} [sort] Sort the result according to fields. * @param {Array} [fields] Fields to be retrieved as a result. * @param {string} [q] Search term: location name; `?` - matches any one character `*` - matches 0 or more characters * @param {boolean} [state] Active Article only. * @param {Array} [tags] Tags associated with the article. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArticlesApi */ listArticles2(spaceId: string, articleId: string, page?: number, size?: number, sort?: Array, fields?: Array, q?: string, state?: boolean, tags?: Array, options?: any): Promise>; /** * * @summary Locate the space\'s Article association. * @param {string} spaceId Space ID associated with. * @param {string} etag Unique Article link IDentifier. Accept: `etag` (obsolete+) or `id`. * @param {Array} [fields] Fields to be retrieved into result. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArticlesApi */ locateArticle(spaceId: string, etag: string, fields?: Array, options?: any): Promise>; /** * * @param {string} spaceId Space ID associated with. * @param {string} articleId Record(s) with unique ID only. * @param {string} versionId The unique ID of version record * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArticlesApi */ locateArticleVersion(spaceId: string, articleId: string, versionId: string, options?: any): Promise>; /** * * @summary Update the space\'s Article details. * @param {string} spaceId Link space ID. * @param {string} etag Unique ID of the latest version of an existing resource. * @param {NEWUpdateOfTheArticleLink} input * @param {Array} [fields] Fields to be retrieved into result of changes. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArticlesApi */ updateArticle(spaceId: string, etag: string, input: NEWUpdateOfTheArticleLink, fields?: Array, options?: any): Promise>; } //# sourceMappingURL=articles-api.d.ts.map