ch-admin-api-client-typescript
Version:
Openapi generated typescript-axios client for CloudHospital admin
1,016 lines • 88.1 kB
TypeScript
/**
* CloudHospital Admin Api
* CloudHospital application with Swagger, Swashbuckle, and API versioning.
*
* The version of the OpenAPI document: 1
* Contact: developer@icloudhospital.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, AxiosRequestConfig } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { ArticleContributorModel } from '../models';
import { ArticleContributorsModel } from '../models';
import { ArticleModel } from '../models';
import { ArticleSourcesModel } from '../models';
import { ArticleTagModel } from '../models';
import { ArticleTagsModel } from '../models';
import { ArticleTranslationHistoriesModel } from '../models';
import { ArticleType } from '../models';
import { ArticlesModel } from '../models';
import { ContributionType } from '../models';
import { CreateArticleCommand } from '../models';
import { CreateArticleContributorCommand } from '../models';
import { CreateArticleSourceCommand } from '../models';
import { CreateArticleTagCommand } from '../models';
import { CreateMediaCommand } from '../models';
import { MediaModel } from '../models';
import { MediaType } from '../models';
import { MediasModel } from '../models';
import { RewriteArticleCommand } from '../models';
import { SourceModel } from '../models';
import { TranslateArticleCommand } from '../models';
import { UpdateArticleCommand } from '../models';
import { UpdateArticleContributorCommand } from '../models';
import { UpdateArticleSourceCommand } from '../models';
import { UpdateMediaCommand } from '../models';
/**
* ArticlesApi - axios parameter creator
* @export
*/
export declare const ArticlesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Delete ArticleContributor. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} contributorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdContributorsContributorIdDelete: (articleId: string, contributorId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get ArticleContributor. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} contributorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdContributorsContributorIdGet: (articleId: string, contributorId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Update ArticleContributor. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} contributorId
* @param {UpdateArticleContributorCommand} [updateArticleContributorCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdContributorsContributorIdPut: (articleId: string, contributorId: string, updateArticleContributorCommand?: UpdateArticleContributorCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary GetAll ArticleContributors. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} [articleName]
* @param {string} [contributorId]
* @param {string} [contributorName]
* @param {string} [email]
* @param {string} [website]
* @param {ContributionType} [contributionType]
* @param {string} [languageCode]
* @param {boolean} [showHidden]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdContributorsGet: (articleId: string, articleName?: string, contributorId?: string, contributorName?: string, email?: string, website?: string, contributionType?: ContributionType, languageCode?: string, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create ArticleContributor. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {CreateArticleContributorCommand} [createArticleContributorCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdContributorsPost: (articleId: string, createArticleContributorCommand?: CreateArticleContributorCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Delete Article. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} [languageCode]
* @param {boolean} [isPermanent]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdDelete: (articleId: string, languageCode?: string, isPermanent?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get Article. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdGet: (articleId: string, languageCode?: string, returnDefaultValue?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Retrieve translation histories for the specified article. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} [languageCode]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdHistoriesGet: (articleId: string, languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create translation histories using AI rewriting (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {RewriteArticleCommand} [rewriteArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdHistoriesRewritesPost: (articleId: string, rewriteArticleCommand?: RewriteArticleCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get all ArticleMedias. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} [id]
* @param {MediaType} [mediaType]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdMediasGet: (articleId: string, id?: string, mediaType?: MediaType, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Delete ArticleMedia (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} mediaId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdMediasMediaIdDelete: (articleId: string, mediaId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get ArticleMedia. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} mediaId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdMediasMediaIdGet: (articleId: string, mediaId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Update ArticleMedia. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} mediaId
* @param {UpdateMediaCommand} [updateMediaCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdMediasMediaIdPut: (articleId: string, mediaId: string, updateMediaCommand?: UpdateMediaCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create ArticleMedia. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {CreateMediaCommand} [createMediaCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdMediasPost: (articleId: string, createMediaCommand?: CreateMediaCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Update Article. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {UpdateArticleCommand} [updateArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdPut: (articleId: string, updateArticleCommand?: UpdateArticleCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Reactivate article (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdReactivatePut: (articleId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Revalidate article (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {boolean} [includeCurrent]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdRevalidatePost: (articleId: string, includeCurrent?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get all ArticleSource. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdSourcesGet: (articleId: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create ArticleSource. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {CreateArticleSourceCommand} [createArticleSourceCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdSourcesPost: (articleId: string, createArticleSourceCommand?: CreateArticleSourceCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Delete ArticleSource. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} sourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdSourcesSourceIdDelete: (articleId: string, sourceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get ArticleSource. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} sourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdSourcesSourceIdGet: (articleId: string, sourceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Update ArticleSource. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} sourceId
* @param {UpdateArticleSourceCommand} [updateArticleSourceCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdSourcesSourceIdPut: (articleId: string, sourceId: string, updateArticleSourceCommand?: UpdateArticleSourceCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary GetAll ArticleTags. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} [tagId]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdTagsGet: (articleId: string, tagId?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create ArticleTag. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {CreateArticleTagCommand} [createArticleTagCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdTagsPost: (articleId: string, createArticleTagCommand?: CreateArticleTagCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Delete ArticleTag. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} tagId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdTagsTagIdDelete: (articleId: string, tagId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get ArticleTag. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} tagId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdTagsTagIdGet: (articleId: string, tagId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Translate article (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {TranslateArticleCommand} [translateArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdTranslatePost: (articleId: string, translateArticleCommand?: TranslateArticleCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get all Articles. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} [id]
* @param {string} [name]
* @param {string} [description]
* @param {ArticleType} [articleType]
* @param {string} [userId]
* @param {string} [userName]
* @param {string} [hospitalId]
* @param {string} [hospitalName]
* @param {string} [countryId]
* @param {string} [tag]
* @param {string} [exceptArticleId]
* @param {string} [exceptHospitalId]
* @param {string} [contributorId]
* @param {string} [specialtyTypeId]
* @param {string} [languageCode]
* @param {boolean} [showHidden]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesGet: (id?: string, name?: string, description?: string, articleType?: ArticleType, userId?: string, userName?: string, hospitalId?: string, hospitalName?: string, countryId?: string, tag?: string, exceptArticleId?: string, exceptHospitalId?: string, contributorId?: string, specialtyTypeId?: string, languageCode?: string, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create a Article. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {CreateArticleCommand} [createArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesPost: (createArticleCommand?: CreateArticleCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get Article by slug. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} slug
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesSlugGet: (slug: string, languageCode?: string, returnDefaultValue?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* ArticlesApi - functional programming interface
* @export
*/
export declare const ArticlesApiFp: (configuration?: Configuration) => {
/**
*
* @summary Delete ArticleContributor. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} contributorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdContributorsContributorIdDelete(articleId: string, contributorId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
/**
*
* @summary Get ArticleContributor. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} contributorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdContributorsContributorIdGet(articleId: string, contributorId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleContributorModel>>;
/**
*
* @summary Update ArticleContributor. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} contributorId
* @param {UpdateArticleContributorCommand} [updateArticleContributorCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdContributorsContributorIdPut(articleId: string, contributorId: string, updateArticleContributorCommand?: UpdateArticleContributorCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleContributorModel>>;
/**
*
* @summary GetAll ArticleContributors. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} [articleName]
* @param {string} [contributorId]
* @param {string} [contributorName]
* @param {string} [email]
* @param {string} [website]
* @param {ContributionType} [contributionType]
* @param {string} [languageCode]
* @param {boolean} [showHidden]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdContributorsGet(articleId: string, articleName?: string, contributorId?: string, contributorName?: string, email?: string, website?: string, contributionType?: ContributionType, languageCode?: string, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleContributorsModel>>;
/**
*
* @summary Create ArticleContributor. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {CreateArticleContributorCommand} [createArticleContributorCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdContributorsPost(articleId: string, createArticleContributorCommand?: CreateArticleContributorCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleContributorModel>>;
/**
*
* @summary Delete Article. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} [languageCode]
* @param {boolean} [isPermanent]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdDelete(articleId: string, languageCode?: string, isPermanent?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
/**
*
* @summary Get Article. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdGet(articleId: string, languageCode?: string, returnDefaultValue?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleModel>>;
/**
*
* @summary Retrieve translation histories for the specified article. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} [languageCode]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdHistoriesGet(articleId: string, languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleTranslationHistoriesModel>>;
/**
*
* @summary Create translation histories using AI rewriting (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {RewriteArticleCommand} [rewriteArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdHistoriesRewritesPost(articleId: string, rewriteArticleCommand?: RewriteArticleCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
*
* @summary Get all ArticleMedias. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} [id]
* @param {MediaType} [mediaType]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdMediasGet(articleId: string, id?: string, mediaType?: MediaType, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MediasModel>>;
/**
*
* @summary Delete ArticleMedia (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} mediaId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdMediasMediaIdDelete(articleId: string, mediaId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
/**
*
* @summary Get ArticleMedia. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} mediaId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdMediasMediaIdGet(articleId: string, mediaId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MediaModel>>;
/**
*
* @summary Update ArticleMedia. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} mediaId
* @param {UpdateMediaCommand} [updateMediaCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdMediasMediaIdPut(articleId: string, mediaId: string, updateMediaCommand?: UpdateMediaCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MediaModel>>;
/**
*
* @summary Create ArticleMedia. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {CreateMediaCommand} [createMediaCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdMediasPost(articleId: string, createMediaCommand?: CreateMediaCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MediaModel>>;
/**
*
* @summary Update Article. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {UpdateArticleCommand} [updateArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdPut(articleId: string, updateArticleCommand?: UpdateArticleCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleModel>>;
/**
*
* @summary Reactivate article (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdReactivatePut(articleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
/**
*
* @summary Revalidate article (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {boolean} [includeCurrent]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdRevalidatePost(articleId: string, includeCurrent?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
/**
*
* @summary Get all ArticleSource. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdSourcesGet(articleId: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleSourcesModel>>;
/**
*
* @summary Create ArticleSource. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {CreateArticleSourceCommand} [createArticleSourceCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdSourcesPost(articleId: string, createArticleSourceCommand?: CreateArticleSourceCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceModel>>;
/**
*
* @summary Delete ArticleSource. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} sourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdSourcesSourceIdDelete(articleId: string, sourceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
/**
*
* @summary Get ArticleSource. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} sourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdSourcesSourceIdGet(articleId: string, sourceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceModel>>;
/**
*
* @summary Update ArticleSource. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} sourceId
* @param {UpdateArticleSourceCommand} [updateArticleSourceCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdSourcesSourceIdPut(articleId: string, sourceId: string, updateArticleSourceCommand?: UpdateArticleSourceCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceModel>>;
/**
*
* @summary GetAll ArticleTags. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} [tagId]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdTagsGet(articleId: string, tagId?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleTagsModel>>;
/**
*
* @summary Create ArticleTag. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {CreateArticleTagCommand} [createArticleTagCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdTagsPost(articleId: string, createArticleTagCommand?: CreateArticleTagCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleTagModel>>;
/**
*
* @summary Delete ArticleTag. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} tagId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdTagsTagIdDelete(articleId: string, tagId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
/**
*
* @summary Get ArticleTag. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} tagId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdTagsTagIdGet(articleId: string, tagId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleTagModel>>;
/**
*
* @summary Translate article (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {TranslateArticleCommand} [translateArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdTranslatePost(articleId: string, translateArticleCommand?: TranslateArticleCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
/**
*
* @summary Get all Articles. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} [id]
* @param {string} [name]
* @param {string} [description]
* @param {ArticleType} [articleType]
* @param {string} [userId]
* @param {string} [userName]
* @param {string} [hospitalId]
* @param {string} [hospitalName]
* @param {string} [countryId]
* @param {string} [tag]
* @param {string} [exceptArticleId]
* @param {string} [exceptHospitalId]
* @param {string} [contributorId]
* @param {string} [specialtyTypeId]
* @param {string} [languageCode]
* @param {boolean} [showHidden]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesGet(id?: string, name?: string, description?: string, articleType?: ArticleType, userId?: string, userName?: string, hospitalId?: string, hospitalName?: string, countryId?: string, tag?: string, exceptArticleId?: string, exceptHospitalId?: string, contributorId?: string, specialtyTypeId?: string, languageCode?: string, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticlesModel>>;
/**
*
* @summary Create a Article. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {CreateArticleCommand} [createArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesPost(createArticleCommand?: CreateArticleCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleModel>>;
/**
*
* @summary Get Article by slug. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} slug
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesSlugGet(slug: string, languageCode?: string, returnDefaultValue?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleModel>>;
};
/**
* ArticlesApi - factory interface
* @export
*/
export declare const ArticlesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Delete ArticleContributor. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} contributorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdContributorsContributorIdDelete(articleId: string, contributorId: string, options?: any): AxiosPromise<boolean>;
/**
*
* @summary Get ArticleContributor. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} contributorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdContributorsContributorIdGet(articleId: string, contributorId: string, options?: any): AxiosPromise<ArticleContributorModel>;
/**
*
* @summary Update ArticleContributor. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} contributorId
* @param {UpdateArticleContributorCommand} [updateArticleContributorCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdContributorsContributorIdPut(articleId: string, contributorId: string, updateArticleContributorCommand?: UpdateArticleContributorCommand, options?: any): AxiosPromise<ArticleContributorModel>;
/**
*
* @summary GetAll ArticleContributors. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} [articleName]
* @param {string} [contributorId]
* @param {string} [contributorName]
* @param {string} [email]
* @param {string} [website]
* @param {ContributionType} [contributionType]
* @param {string} [languageCode]
* @param {boolean} [showHidden]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdContributorsGet(articleId: string, articleName?: string, contributorId?: string, contributorName?: string, email?: string, website?: string, contributionType?: ContributionType, languageCode?: string, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<ArticleContributorsModel>;
/**
*
* @summary Create ArticleContributor. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {CreateArticleContributorCommand} [createArticleContributorCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdContributorsPost(articleId: string, createArticleContributorCommand?: CreateArticleContributorCommand, options?: any): AxiosPromise<ArticleContributorModel>;
/**
*
* @summary Delete Article. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} [languageCode]
* @param {boolean} [isPermanent]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdDelete(articleId: string, languageCode?: string, isPermanent?: boolean, options?: any): AxiosPromise<boolean>;
/**
*
* @summary Get Article. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdGet(articleId: string, languageCode?: string, returnDefaultValue?: boolean, options?: any): AxiosPromise<ArticleModel>;
/**
*
* @summary Retrieve translation histories for the specified article. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} [languageCode]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdHistoriesGet(articleId: string, languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<ArticleTranslationHistoriesModel>;
/**
*
* @summary Create translation histories using AI rewriting (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {RewriteArticleCommand} [rewriteArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdHistoriesRewritesPost(articleId: string, rewriteArticleCommand?: RewriteArticleCommand, options?: any): AxiosPromise<string>;
/**
*
* @summary Get all ArticleMedias. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} [id]
* @param {MediaType} [mediaType]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdMediasGet(articleId: string, id?: string, mediaType?: MediaType, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<MediasModel>;
/**
*
* @summary Delete ArticleMedia (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} mediaId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdMediasMediaIdDelete(articleId: string, mediaId: string, options?: any): AxiosPromise<boolean>;
/**
*
* @summary Get ArticleMedia. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} mediaId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdMediasMediaIdGet(articleId: string, mediaId: string, options?: any): AxiosPromise<MediaModel>;
/**
*
* @summary Update ArticleMedia. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} mediaId
* @param {UpdateMediaCommand} [updateMediaCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdMediasMediaIdPut(articleId: string, mediaId: string, updateMediaCommand?: UpdateMediaCommand, options?: any): AxiosPromise<MediaModel>;
/**
*
* @summary Create ArticleMedia. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {CreateMediaCommand} [createMediaCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdMediasPost(articleId: string, createMediaCommand?: CreateMediaCommand, options?: any): AxiosPromise<MediaModel>;
/**
*
* @summary Update Article. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {UpdateArticleCommand} [updateArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdPut(articleId: string, updateArticleCommand?: UpdateArticleCommand, options?: any): AxiosPromise<ArticleModel>;
/**
*
* @summary Reactivate article (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdReactivatePut(articleId: string, options?: any): AxiosPromise<boolean>;
/**
*
* @summary Revalidate article (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {boolean} [includeCurrent]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdRevalidatePost(articleId: string, includeCurrent?: boolean, options?: any): AxiosPromise<boolean>;
/**
*
* @summary Get all ArticleSource. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdSourcesGet(articleId: string, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<ArticleSourcesModel>;
/**
*
* @summary Create ArticleSource. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {CreateArticleSourceCommand} [createArticleSourceCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdSourcesPost(articleId: string, createArticleSourceCommand?: CreateArticleSourceCommand, options?: any): AxiosPromise<SourceModel>;
/**
*
* @summary Delete ArticleSource. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} sourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdSourcesSourceIdDelete(articleId: string, sourceId: string, options?: any): AxiosPromise<boolean>;
/**
*
* @summary Get ArticleSource. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} sourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdSourcesSourceIdGet(articleId: string, sourceId: string, options?: any): AxiosPromise<SourceModel>;
/**
*
* @summary Update ArticleSource. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} sourceId
* @param {UpdateArticleSourceCommand} [updateArticleSourceCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdSourcesSourceIdPut(articleId: string, sourceId: string, updateArticleSourceCommand?: UpdateArticleSourceCommand, options?: any): AxiosPromise<SourceModel>;
/**
*
* @summary GetAll ArticleTags. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} [tagId]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdTagsGet(articleId: string, tagId?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<ArticleTagsModel>;
/**
*
* @summary Create ArticleTag. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {CreateArticleTagCommand} [createArticleTagCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdTagsPost(articleId: string, createArticleTagCommand?: CreateArticleTagCommand, options?: any): AxiosPromise<ArticleTagModel>;
/**
*
* @summary Delete ArticleTag. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} tagId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdTagsTagIdDelete(articleId: string, tagId: string, options?: any): AxiosPromise<boolean>;
/**
*
* @summary Get ArticleTag. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {string} tagId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdTagsTagIdGet(articleId: string, tagId: string, options?: any): AxiosPromise<ArticleTagModel>;
/**
*
* @summary Translate article (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} articleId
* @param {TranslateArticleCommand} [translateArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesArticleIdTranslatePost(articleId: string, translateArticleCommand?: TranslateArticleCommand, options?: any): AxiosPromise<boolean>;
/**
*
* @summary Get all Articles. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} [id]
* @param {string} [name]
* @param {string} [description]
* @param {ArticleType} [articleType]
* @param {string} [userId]
* @param {string} [userName]
* @param {string} [hospitalId]
* @param {string} [hospitalName]
* @param {string} [countryId]
* @param {string} [tag]
* @param {string} [exceptArticleId]
* @param {string} [exceptHospitalId]
* @param {string} [contributorId]
* @param {string} [specialtyTypeId]
* @param {string} [languageCode]
* @param {boolean} [showHidden]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesGet(id?: string, name?: string, description?: string, articleType?: ArticleType, userId?: string, userName?: string, hospitalId?: string, hospitalName?: string, countryId?: string, tag?: string, exceptArticleId?: string, exceptHospitalId?: string, contributorId?: string, specialtyTypeId?: string, languageCode?: string, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<ArticlesModel>;
/**
*
* @summary Create a Article. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {CreateArticleCommand} [createArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesPost(createArticleCommand?: CreateArticleCommand, options?: any): AxiosPromise<ArticleModel>;
/**
*
* @summary Get Article by slug. (Auth policies: RequireDoctorOrContentManagerRole)
* @param {string} slug
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ArticlesSlugGet(slug: string, languageCode?: string, returnDefaultValue?: boolean, options?: any): AxiosPromise<ArticleModel>;
};
/**
* Request parameters for apiV1ArticlesArticleIdContributorsContributorIdDelete operation in ArticlesApi.
* @export
* @interface ArticlesApiApiV1ArticlesArticleIdContributorsContributorIdDeleteRequest
*/
export interface ArticlesApiApiV1ArticlesArticleIdContributorsContributorIdDeleteRequest {
/**
*
* @type {string}
* @memberof ArticlesApiApiV1ArticlesArticleIdContributorsContributorIdDelete
*/
readonly articleId: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV1ArticlesArticleIdContributorsContributorIdDelete
*/
readonly contributorId: string;
}
/**