ch-admin-api-client-typescript
Version:
Openapi generated typescript-axios client for CloudHospital admin
945 lines (944 loc) • 89.6 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 { ArticleStatus } from '../models';
import { ArticleType } from '../models';
import { ContributionType } from '../models';
import { CreateGeneralArticleCommand } from '../models';
import { CreateGeneralArticleContributorCommand } from '../models';
import { CreateGeneralArticleMediaCommand } from '../models';
import { CreateGeneralArticleSourceCommand } from '../models';
import { CreateGeneralArticleTagCommand } from '../models';
import { GeneralArticleContributorModel } from '../models';
import { GeneralArticleContributorsModel } from '../models';
import { GeneralArticleModel } from '../models';
import { GeneralArticleSourcesModel } from '../models';
import { GeneralArticleTagsModel } from '../models';
import { GeneralArticlesModel } from '../models';
import { MediaModel } from '../models';
import { MediaType } from '../models';
import { MediasModel } from '../models';
import { SourceModel } from '../models';
import { TranslateGeneralArticleCommand } from '../models';
import { UpdateGeneralArticleCommand } from '../models';
import { UpdateGeneralArticleContributorCommand } from '../models';
import { UpdateGeneralArticleMediaCommand } from '../models';
import { UpdateGeneralArticleSourceCommand } from '../models';
import { UpdateGeneralArticleTagCommand } from '../models';
/**
* GeneralArticlesApi - axios parameter creator
* @export
*/
export declare const GeneralArticlesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Delete GeneralArticleContributor (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} contributorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdContributorsContributorIdDelete: (generalArticleId: string, contributorId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get GeneralArticleContributor (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} contributorId
* @param {string} [languageCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdContributorsContributorIdGet: (generalArticleId: string, contributorId: string, languageCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create GeneralArticleContributor (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} contributorId
* @param {CreateGeneralArticleContributorCommand} [createGeneralArticleContributorCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdContributorsContributorIdPost: (generalArticleId: string, contributorId: string, createGeneralArticleContributorCommand?: CreateGeneralArticleContributorCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Update GeneralArticleContributor (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} contributorId
* @param {UpdateGeneralArticleContributorCommand} [updateGeneralArticleContributorCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdContributorsContributorIdPut: (generalArticleId: string, contributorId: string, updateGeneralArticleContributorCommand?: UpdateGeneralArticleContributorCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get GeneralArticleContributors (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} [languageCode]
* @param {string} [contributorId]
* @param {string} [contributorName]
* @param {string} [email]
* @param {string} [website]
* @param {ContributionType} [contributionType]
* @param {boolean} [showHidden]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdContributorsGet: (generalArticleId: string, languageCode?: string, contributorId?: string, contributorName?: string, email?: string, website?: string, contributionType?: ContributionType, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Delete generalArticle (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {boolean} [isPermanent]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdDelete: (generalArticleId: string, isPermanent?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get generalArticle by id (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} [languageCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdGet: (generalArticleId: string, languageCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get generalArticleMedias (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} [id]
* @param {MediaType} [mediaType]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdMediasGet: (generalArticleId: string, id?: string, mediaType?: MediaType, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Delete generalArticleMedia (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} mediaId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdMediasMediaIdDelete: (generalArticleId: string, mediaId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get generalArticleMedia (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} mediaId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdMediasMediaIdGet: (generalArticleId: string, mediaId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Update generalArticleMedia (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} mediaId
* @param {UpdateGeneralArticleMediaCommand} [updateGeneralArticleMediaCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdMediasMediaIdPut: (generalArticleId: string, mediaId: string, updateGeneralArticleMediaCommand?: UpdateGeneralArticleMediaCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create generalArticleMedia (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {CreateGeneralArticleMediaCommand} [createGeneralArticleMediaCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdMediasPost: (generalArticleId: string, createGeneralArticleMediaCommand?: CreateGeneralArticleMediaCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Update generalArticle (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {UpdateGeneralArticleCommand} [updateGeneralArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdPut: (generalArticleId: string, updateGeneralArticleCommand?: UpdateGeneralArticleCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Reactivate generalArticle (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdReactivatePut: (generalArticleId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get generalArticleSources (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdSourcesGet: (generalArticleId: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create generalArticleSource (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {CreateGeneralArticleSourceCommand} [createGeneralArticleSourceCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdSourcesPost: (generalArticleId: string, createGeneralArticleSourceCommand?: CreateGeneralArticleSourceCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Delete generalArticleSource (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} sourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdSourcesSourceIdDelete: (generalArticleId: string, sourceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get GeneralArticleSource (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} sourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdSourcesSourceIdGet: (generalArticleId: string, sourceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Update generalArticleSource (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} sourceId
* @param {UpdateGeneralArticleSourceCommand} [updateGeneralArticleSourceCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdSourcesSourceIdPut: (generalArticleId: string, sourceId: string, updateGeneralArticleSourceCommand?: UpdateGeneralArticleSourceCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get generalArticleTags (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} [tagId]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdTagsGet: (generalArticleId: string, tagId?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create generalArticleTag (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {CreateGeneralArticleTagCommand} [createGeneralArticleTagCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdTagsPost: (generalArticleId: string, createGeneralArticleTagCommand?: CreateGeneralArticleTagCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Delete generalArticleTag (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} tagId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdTagsTagIdDelete: (generalArticleId: string, tagId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get generalArticleTag (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} tagId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdTagsTagIdGet: (generalArticleId: string, tagId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Update generalArticleTag (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} tagId
* @param {UpdateGeneralArticleTagCommand} [updateGeneralArticleTagCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdTagsTagIdPut: (generalArticleId: string, tagId: string, updateGeneralArticleTagCommand?: UpdateGeneralArticleTagCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Translate generalArticle (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {TranslateGeneralArticleCommand} [translateGeneralArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdTranslatePost: (generalArticleId: string, translateGeneralArticleCommand?: TranslateGeneralArticleCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get all generalArticles (Auth policies: RequireContentManagerRole)
* @param {string} [id]
* @param {string} [name]
* @param {string} [description]
* @param {ArticleType} [articleType]
* @param {ArticleStatus} [status]
* @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} [articleCategoryId]
* @param {boolean} [includesSubArticleCategoryEntries]
* @param {string} [languageCode]
* @param {boolean} [showHidden]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGet: (id?: string, name?: string, description?: string, articleType?: ArticleType, status?: ArticleStatus, userId?: string, userName?: string, hospitalId?: string, hospitalName?: string, countryId?: string, tag?: string, exceptArticleId?: string, exceptHospitalId?: string, contributorId?: string, articleCategoryId?: string, includesSubArticleCategoryEntries?: boolean, languageCode?: string, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create generalArticle (Auth policies: RequireContentManagerRole)
* @param {CreateGeneralArticleCommand} [createGeneralArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesPost: (createGeneralArticleCommand?: CreateGeneralArticleCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* GeneralArticlesApi - functional programming interface
* @export
*/
export declare const GeneralArticlesApiFp: (configuration?: Configuration) => {
/**
*
* @summary Delete GeneralArticleContributor (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} contributorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdContributorsContributorIdDelete(generalArticleId: string, contributorId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
/**
*
* @summary Get GeneralArticleContributor (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} contributorId
* @param {string} [languageCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdContributorsContributorIdGet(generalArticleId: string, contributorId: string, languageCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleContributorModel>>;
/**
*
* @summary Create GeneralArticleContributor (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} contributorId
* @param {CreateGeneralArticleContributorCommand} [createGeneralArticleContributorCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdContributorsContributorIdPost(generalArticleId: string, contributorId: string, createGeneralArticleContributorCommand?: CreateGeneralArticleContributorCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleContributorModel>>;
/**
*
* @summary Update GeneralArticleContributor (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} contributorId
* @param {UpdateGeneralArticleContributorCommand} [updateGeneralArticleContributorCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdContributorsContributorIdPut(generalArticleId: string, contributorId: string, updateGeneralArticleContributorCommand?: UpdateGeneralArticleContributorCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleContributorModel>>;
/**
*
* @summary Get GeneralArticleContributors (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} [languageCode]
* @param {string} [contributorId]
* @param {string} [contributorName]
* @param {string} [email]
* @param {string} [website]
* @param {ContributionType} [contributionType]
* @param {boolean} [showHidden]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdContributorsGet(generalArticleId: string, languageCode?: string, contributorId?: string, contributorName?: string, email?: string, website?: string, contributionType?: ContributionType, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleContributorsModel>>;
/**
*
* @summary Delete generalArticle (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {boolean} [isPermanent]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdDelete(generalArticleId: string, isPermanent?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
/**
*
* @summary Get generalArticle by id (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} [languageCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdGet(generalArticleId: string, languageCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleModel>>;
/**
*
* @summary Get generalArticleMedias (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} [id]
* @param {MediaType} [mediaType]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdMediasGet(generalArticleId: string, id?: string, mediaType?: MediaType, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MediasModel>>;
/**
*
* @summary Delete generalArticleMedia (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} mediaId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdMediasMediaIdDelete(generalArticleId: string, mediaId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
/**
*
* @summary Get generalArticleMedia (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} mediaId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdMediasMediaIdGet(generalArticleId: string, mediaId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MediaModel>>;
/**
*
* @summary Update generalArticleMedia (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} mediaId
* @param {UpdateGeneralArticleMediaCommand} [updateGeneralArticleMediaCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdMediasMediaIdPut(generalArticleId: string, mediaId: string, updateGeneralArticleMediaCommand?: UpdateGeneralArticleMediaCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MediaModel>>;
/**
*
* @summary Create generalArticleMedia (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {CreateGeneralArticleMediaCommand} [createGeneralArticleMediaCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdMediasPost(generalArticleId: string, createGeneralArticleMediaCommand?: CreateGeneralArticleMediaCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MediaModel>>;
/**
*
* @summary Update generalArticle (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {UpdateGeneralArticleCommand} [updateGeneralArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdPut(generalArticleId: string, updateGeneralArticleCommand?: UpdateGeneralArticleCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleModel>>;
/**
*
* @summary Reactivate generalArticle (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdReactivatePut(generalArticleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
/**
*
* @summary Get generalArticleSources (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdSourcesGet(generalArticleId: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleSourcesModel>>;
/**
*
* @summary Create generalArticleSource (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {CreateGeneralArticleSourceCommand} [createGeneralArticleSourceCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdSourcesPost(generalArticleId: string, createGeneralArticleSourceCommand?: CreateGeneralArticleSourceCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceModel>>;
/**
*
* @summary Delete generalArticleSource (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} sourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdSourcesSourceIdDelete(generalArticleId: string, sourceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
/**
*
* @summary Get GeneralArticleSource (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} sourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdSourcesSourceIdGet(generalArticleId: string, sourceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceModel>>;
/**
*
* @summary Update generalArticleSource (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} sourceId
* @param {UpdateGeneralArticleSourceCommand} [updateGeneralArticleSourceCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdSourcesSourceIdPut(generalArticleId: string, sourceId: string, updateGeneralArticleSourceCommand?: UpdateGeneralArticleSourceCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceModel>>;
/**
*
* @summary Get generalArticleTags (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} [tagId]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdTagsGet(generalArticleId: string, tagId?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleTagsModel>>;
/**
*
* @summary Create generalArticleTag (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {CreateGeneralArticleTagCommand} [createGeneralArticleTagCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdTagsPost(generalArticleId: string, createGeneralArticleTagCommand?: CreateGeneralArticleTagCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleTagsModel>>;
/**
*
* @summary Delete generalArticleTag (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} tagId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdTagsTagIdDelete(generalArticleId: string, tagId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleTagsModel>>;
/**
*
* @summary Get generalArticleTag (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} tagId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdTagsTagIdGet(generalArticleId: string, tagId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleTagsModel>>;
/**
*
* @summary Update generalArticleTag (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} tagId
* @param {UpdateGeneralArticleTagCommand} [updateGeneralArticleTagCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdTagsTagIdPut(generalArticleId: string, tagId: string, updateGeneralArticleTagCommand?: UpdateGeneralArticleTagCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleTagsModel>>;
/**
*
* @summary Translate generalArticle (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {TranslateGeneralArticleCommand} [translateGeneralArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdTranslatePost(generalArticleId: string, translateGeneralArticleCommand?: TranslateGeneralArticleCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
/**
*
* @summary Get all generalArticles (Auth policies: RequireContentManagerRole)
* @param {string} [id]
* @param {string} [name]
* @param {string} [description]
* @param {ArticleType} [articleType]
* @param {ArticleStatus} [status]
* @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} [articleCategoryId]
* @param {boolean} [includesSubArticleCategoryEntries]
* @param {string} [languageCode]
* @param {boolean} [showHidden]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGet(id?: string, name?: string, description?: string, articleType?: ArticleType, status?: ArticleStatus, userId?: string, userName?: string, hospitalId?: string, hospitalName?: string, countryId?: string, tag?: string, exceptArticleId?: string, exceptHospitalId?: string, contributorId?: string, articleCategoryId?: string, includesSubArticleCategoryEntries?: boolean, languageCode?: string, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticlesModel>>;
/**
*
* @summary Create generalArticle (Auth policies: RequireContentManagerRole)
* @param {CreateGeneralArticleCommand} [createGeneralArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesPost(createGeneralArticleCommand?: CreateGeneralArticleCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleModel>>;
};
/**
* GeneralArticlesApi - factory interface
* @export
*/
export declare const GeneralArticlesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Delete GeneralArticleContributor (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} contributorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdContributorsContributorIdDelete(generalArticleId: string, contributorId: string, options?: any): AxiosPromise<boolean>;
/**
*
* @summary Get GeneralArticleContributor (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} contributorId
* @param {string} [languageCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdContributorsContributorIdGet(generalArticleId: string, contributorId: string, languageCode?: string, options?: any): AxiosPromise<GeneralArticleContributorModel>;
/**
*
* @summary Create GeneralArticleContributor (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} contributorId
* @param {CreateGeneralArticleContributorCommand} [createGeneralArticleContributorCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdContributorsContributorIdPost(generalArticleId: string, contributorId: string, createGeneralArticleContributorCommand?: CreateGeneralArticleContributorCommand, options?: any): AxiosPromise<GeneralArticleContributorModel>;
/**
*
* @summary Update GeneralArticleContributor (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} contributorId
* @param {UpdateGeneralArticleContributorCommand} [updateGeneralArticleContributorCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdContributorsContributorIdPut(generalArticleId: string, contributorId: string, updateGeneralArticleContributorCommand?: UpdateGeneralArticleContributorCommand, options?: any): AxiosPromise<GeneralArticleContributorModel>;
/**
*
* @summary Get GeneralArticleContributors (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} [languageCode]
* @param {string} [contributorId]
* @param {string} [contributorName]
* @param {string} [email]
* @param {string} [website]
* @param {ContributionType} [contributionType]
* @param {boolean} [showHidden]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdContributorsGet(generalArticleId: string, languageCode?: string, contributorId?: string, contributorName?: string, email?: string, website?: string, contributionType?: ContributionType, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<GeneralArticleContributorsModel>;
/**
*
* @summary Delete generalArticle (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {boolean} [isPermanent]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdDelete(generalArticleId: string, isPermanent?: boolean, options?: any): AxiosPromise<boolean>;
/**
*
* @summary Get generalArticle by id (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} [languageCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdGet(generalArticleId: string, languageCode?: string, options?: any): AxiosPromise<GeneralArticleModel>;
/**
*
* @summary Get generalArticleMedias (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} [id]
* @param {MediaType} [mediaType]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdMediasGet(generalArticleId: string, id?: string, mediaType?: MediaType, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<MediasModel>;
/**
*
* @summary Delete generalArticleMedia (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} mediaId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdMediasMediaIdDelete(generalArticleId: string, mediaId: string, options?: any): AxiosPromise<boolean>;
/**
*
* @summary Get generalArticleMedia (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} mediaId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdMediasMediaIdGet(generalArticleId: string, mediaId: string, options?: any): AxiosPromise<MediaModel>;
/**
*
* @summary Update generalArticleMedia (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} mediaId
* @param {UpdateGeneralArticleMediaCommand} [updateGeneralArticleMediaCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdMediasMediaIdPut(generalArticleId: string, mediaId: string, updateGeneralArticleMediaCommand?: UpdateGeneralArticleMediaCommand, options?: any): AxiosPromise<MediaModel>;
/**
*
* @summary Create generalArticleMedia (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {CreateGeneralArticleMediaCommand} [createGeneralArticleMediaCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdMediasPost(generalArticleId: string, createGeneralArticleMediaCommand?: CreateGeneralArticleMediaCommand, options?: any): AxiosPromise<MediaModel>;
/**
*
* @summary Update generalArticle (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {UpdateGeneralArticleCommand} [updateGeneralArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdPut(generalArticleId: string, updateGeneralArticleCommand?: UpdateGeneralArticleCommand, options?: any): AxiosPromise<GeneralArticleModel>;
/**
*
* @summary Reactivate generalArticle (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdReactivatePut(generalArticleId: string, options?: any): AxiosPromise<boolean>;
/**
*
* @summary Get generalArticleSources (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdSourcesGet(generalArticleId: string, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<GeneralArticleSourcesModel>;
/**
*
* @summary Create generalArticleSource (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {CreateGeneralArticleSourceCommand} [createGeneralArticleSourceCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdSourcesPost(generalArticleId: string, createGeneralArticleSourceCommand?: CreateGeneralArticleSourceCommand, options?: any): AxiosPromise<SourceModel>;
/**
*
* @summary Delete generalArticleSource (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} sourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdSourcesSourceIdDelete(generalArticleId: string, sourceId: string, options?: any): AxiosPromise<boolean>;
/**
*
* @summary Get GeneralArticleSource (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} sourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdSourcesSourceIdGet(generalArticleId: string, sourceId: string, options?: any): AxiosPromise<SourceModel>;
/**
*
* @summary Update generalArticleSource (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} sourceId
* @param {UpdateGeneralArticleSourceCommand} [updateGeneralArticleSourceCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdSourcesSourceIdPut(generalArticleId: string, sourceId: string, updateGeneralArticleSourceCommand?: UpdateGeneralArticleSourceCommand, options?: any): AxiosPromise<SourceModel>;
/**
*
* @summary Get generalArticleTags (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} [tagId]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdTagsGet(generalArticleId: string, tagId?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<GeneralArticleTagsModel>;
/**
*
* @summary Create generalArticleTag (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {CreateGeneralArticleTagCommand} [createGeneralArticleTagCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdTagsPost(generalArticleId: string, createGeneralArticleTagCommand?: CreateGeneralArticleTagCommand, options?: any): AxiosPromise<GeneralArticleTagsModel>;
/**
*
* @summary Delete generalArticleTag (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} tagId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdTagsTagIdDelete(generalArticleId: string, tagId: string, options?: any): AxiosPromise<GeneralArticleTagsModel>;
/**
*
* @summary Get generalArticleTag (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} tagId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdTagsTagIdGet(generalArticleId: string, tagId: string, options?: any): AxiosPromise<GeneralArticleTagsModel>;
/**
*
* @summary Update generalArticleTag (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {string} tagId
* @param {UpdateGeneralArticleTagCommand} [updateGeneralArticleTagCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdTagsTagIdPut(generalArticleId: string, tagId: string, updateGeneralArticleTagCommand?: UpdateGeneralArticleTagCommand, options?: any): AxiosPromise<GeneralArticleTagsModel>;
/**
*
* @summary Translate generalArticle (Auth policies: RequireContentManagerRole)
* @param {string} generalArticleId
* @param {TranslateGeneralArticleCommand} [translateGeneralArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGeneralArticleIdTranslatePost(generalArticleId: string, translateGeneralArticleCommand?: TranslateGeneralArticleCommand, options?: any): AxiosPromise<boolean>;
/**
*
* @summary Get all generalArticles (Auth policies: RequireContentManagerRole)
* @param {string} [id]
* @param {string} [name]
* @param {string} [description]
* @param {ArticleType} [articleType]
* @param {ArticleStatus} [status]
* @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} [articleCategoryId]
* @param {boolean} [includesSubArticleCategoryEntries]
* @param {string} [languageCode]
* @param {boolean} [showHidden]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesGet(id?: string, name?: string, description?: string, articleType?: ArticleType, status?: ArticleStatus, userId?: string, userName?: string, hospitalId?: string, hospitalName?: string, countryId?: string, tag?: string, exceptArticleId?: string, exceptHospitalId?: string, contributorId?: string, articleCategoryId?: string, includesSubArticleCategoryEntries?: boolean, languageCode?: string, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<GeneralArticlesModel>;
/**
*
* @summary Create generalArticle (Auth policies: RequireContentManagerRole)
* @param {CreateGeneralArticleCommand} [createGeneralArticleCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1GeneralarticlesPost(createGeneralArticleCommand?: CreateGeneralArticleCommand, options?: any): AxiosPromise<GeneralArticleModel>;
};
/**
* Request parameters for apiV1GeneralarticlesGeneralArticleIdContributorsContributorIdDelete operation in GeneralArticlesApi.
* @export
* @interface GeneralArticlesApiApiV1GeneralarticlesGeneralArticleIdContributorsContributorIdDeleteRequest
*/
export interface GeneralArticlesApiApiV1GeneralarticlesGeneralArticleIdContributorsContributorIdDeleteRequest {
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV1GeneralarticlesGeneralArticleIdContributorsContributorIdDelete
*/
readonly generalArticleId: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV1GeneralarticlesGeneralArticleIdContributorsContributorIdDelete
*/
readonly contributorId: string;
}
/**
* Request parameters for apiV1GeneralarticlesGeneralArticleIdContributorsContributorIdGet operation in GeneralArticlesApi.
* @export
* @interface GeneralArticlesApiApiV1GeneralarticlesGeneralArticleIdContributorsContributorIdGetRequest
*/
export interface GeneralArticlesApiApiV1GeneralarticlesGeneralArticleIdContributorsContributorIdGetRequest {
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV1GeneralarticlesGeneralArticleIdContributorsContributorIdGet
*/
readonly generalArticleId: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV1GeneralarticlesGeneralArticleIdContributorsContributorIdGet
*/