ch-api-client-typescript2
Version:
Openapi generated typescript-axios client for CloudHospital
1,046 lines • 38.5 kB
TypeScript
/**
* CloudHospital Api
* CloudHospital application with Swagger, Swashbuckle, and API versioning.
*
* The version of the OpenAPI document: 2
* 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 { ArticleType } from '../models';
import { ArticlesModel } from '../models';
import { ContributionType } from '../models';
import { MediaModel } from '../models';
import { MediaType } from '../models';
import { MediasModel } from '../models';
import { SourceModel } from '../models';
/**
* ArticlesApi - axios parameter creator
* @export
*/
export declare const ArticlesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Get ArticleContributor.
* @param {string} articleId
* @param {string} contributorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdContributorsContributorIdGet: (articleId: string, contributorId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary GetAll ArticleContributors.
* @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}
*/
apiV2ArticlesArticleIdContributorsGet: (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 Get Article.
* @param {string} articleId
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [languageCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdGet: (articleId: string, xCloudhospitalPlatform?: string, languageCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get all ArticleMedias.
* @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}
*/
apiV2ArticlesArticleIdMediasGet: (articleId: string, id?: string, mediaType?: MediaType, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get ArticleMedia.
* @param {string} articleId
* @param {string} mediaId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdMediasMediaIdGet: (articleId: string, mediaId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get all ArticleSource.
* @param {string} articleId
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdSourcesGet: (articleId: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get ArticleSource.
* @param {string} articleId
* @param {string} sourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdSourcesSourceIdGet: (articleId: string, sourceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary GetAll ArticleTags.
* @param {string} articleId
* @param {string} [tagId]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdTagsGet: (articleId: string, tagId?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get ArticleTag.
* @param {string} articleId
* @param {string} tagId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdTagsTagIdGet: (articleId: string, tagId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get all Articles.
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @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 {boolean} [returnDefaultValue]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesGet: (xCloudhospitalPlatform?: string, 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, returnDefaultValue?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get article by slug
* @param {string} slug
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {string} [previewSecret]
* @param {string} [hospitalId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesSlugGet: (slug: string, xCloudhospitalPlatform?: string, languageCode?: string, returnDefaultValue?: boolean, previewSecret?: string, hospitalId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* ArticlesApi - functional programming interface
* @export
*/
export declare const ArticlesApiFp: (configuration?: Configuration) => {
/**
*
* @summary Get ArticleContributor.
* @param {string} articleId
* @param {string} contributorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdContributorsContributorIdGet(articleId: string, contributorId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleContributorModel>>;
/**
*
* @summary GetAll ArticleContributors.
* @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}
*/
apiV2ArticlesArticleIdContributorsGet(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 Get Article.
* @param {string} articleId
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [languageCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdGet(articleId: string, xCloudhospitalPlatform?: string, languageCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleModel>>;
/**
*
* @summary Get all ArticleMedias.
* @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}
*/
apiV2ArticlesArticleIdMediasGet(articleId: string, id?: string, mediaType?: MediaType, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MediasModel>>;
/**
*
* @summary Get ArticleMedia.
* @param {string} articleId
* @param {string} mediaId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdMediasMediaIdGet(articleId: string, mediaId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MediaModel>>;
/**
*
* @summary Get all ArticleSource.
* @param {string} articleId
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdSourcesGet(articleId: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleSourcesModel>>;
/**
*
* @summary Get ArticleSource.
* @param {string} articleId
* @param {string} sourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdSourcesSourceIdGet(articleId: string, sourceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceModel>>;
/**
*
* @summary GetAll ArticleTags.
* @param {string} articleId
* @param {string} [tagId]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdTagsGet(articleId: string, tagId?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleTagsModel>>;
/**
*
* @summary Get ArticleTag.
* @param {string} articleId
* @param {string} tagId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdTagsTagIdGet(articleId: string, tagId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleTagModel>>;
/**
*
* @summary Get all Articles.
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @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 {boolean} [returnDefaultValue]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesGet(xCloudhospitalPlatform?: string, 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, returnDefaultValue?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticlesModel>>;
/**
*
* @summary Get article by slug
* @param {string} slug
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {string} [previewSecret]
* @param {string} [hospitalId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesSlugGet(slug: string, xCloudhospitalPlatform?: string, languageCode?: string, returnDefaultValue?: boolean, previewSecret?: string, hospitalId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleModel>>;
};
/**
* ArticlesApi - factory interface
* @export
*/
export declare const ArticlesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Get ArticleContributor.
* @param {string} articleId
* @param {string} contributorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdContributorsContributorIdGet(articleId: string, contributorId: string, options?: any): AxiosPromise<ArticleContributorModel>;
/**
*
* @summary GetAll ArticleContributors.
* @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}
*/
apiV2ArticlesArticleIdContributorsGet(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 Get Article.
* @param {string} articleId
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [languageCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdGet(articleId: string, xCloudhospitalPlatform?: string, languageCode?: string, options?: any): AxiosPromise<ArticleModel>;
/**
*
* @summary Get all ArticleMedias.
* @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}
*/
apiV2ArticlesArticleIdMediasGet(articleId: string, id?: string, mediaType?: MediaType, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<MediasModel>;
/**
*
* @summary Get ArticleMedia.
* @param {string} articleId
* @param {string} mediaId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdMediasMediaIdGet(articleId: string, mediaId: string, options?: any): AxiosPromise<MediaModel>;
/**
*
* @summary Get all ArticleSource.
* @param {string} articleId
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdSourcesGet(articleId: string, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<ArticleSourcesModel>;
/**
*
* @summary Get ArticleSource.
* @param {string} articleId
* @param {string} sourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdSourcesSourceIdGet(articleId: string, sourceId: string, options?: any): AxiosPromise<SourceModel>;
/**
*
* @summary GetAll ArticleTags.
* @param {string} articleId
* @param {string} [tagId]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdTagsGet(articleId: string, tagId?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<ArticleTagsModel>;
/**
*
* @summary Get ArticleTag.
* @param {string} articleId
* @param {string} tagId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesArticleIdTagsTagIdGet(articleId: string, tagId: string, options?: any): AxiosPromise<ArticleTagModel>;
/**
*
* @summary Get all Articles.
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @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 {boolean} [returnDefaultValue]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesGet(xCloudhospitalPlatform?: string, 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, returnDefaultValue?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<ArticlesModel>;
/**
*
* @summary Get article by slug
* @param {string} slug
* @param {string} [xCloudhospitalPlatform] Platform identifier from request header
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {string} [previewSecret]
* @param {string} [hospitalId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2ArticlesSlugGet(slug: string, xCloudhospitalPlatform?: string, languageCode?: string, returnDefaultValue?: boolean, previewSecret?: string, hospitalId?: string, options?: any): AxiosPromise<ArticleModel>;
};
/**
* Request parameters for apiV2ArticlesArticleIdContributorsContributorIdGet operation in ArticlesApi.
* @export
* @interface ArticlesApiApiV2ArticlesArticleIdContributorsContributorIdGetRequest
*/
export interface ArticlesApiApiV2ArticlesArticleIdContributorsContributorIdGetRequest {
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdContributorsContributorIdGet
*/
readonly articleId: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdContributorsContributorIdGet
*/
readonly contributorId: string;
}
/**
* Request parameters for apiV2ArticlesArticleIdContributorsGet operation in ArticlesApi.
* @export
* @interface ArticlesApiApiV2ArticlesArticleIdContributorsGetRequest
*/
export interface ArticlesApiApiV2ArticlesArticleIdContributorsGetRequest {
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdContributorsGet
*/
readonly articleId: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdContributorsGet
*/
readonly articleName?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdContributorsGet
*/
readonly contributorId?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdContributorsGet
*/
readonly contributorName?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdContributorsGet
*/
readonly email?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdContributorsGet
*/
readonly website?: string;
/**
*
* @type {ContributionType}
* @memberof ArticlesApiApiV2ArticlesArticleIdContributorsGet
*/
readonly contributionType?: ContributionType;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdContributorsGet
*/
readonly languageCode?: string;
/**
*
* @type {boolean}
* @memberof ArticlesApiApiV2ArticlesArticleIdContributorsGet
*/
readonly showHidden?: boolean;
/**
*
* @type {number}
* @memberof ArticlesApiApiV2ArticlesArticleIdContributorsGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof ArticlesApiApiV2ArticlesArticleIdContributorsGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof ArticlesApiApiV2ArticlesArticleIdContributorsGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV2ArticlesArticleIdGet operation in ArticlesApi.
* @export
* @interface ArticlesApiApiV2ArticlesArticleIdGetRequest
*/
export interface ArticlesApiApiV2ArticlesArticleIdGetRequest {
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdGet
*/
readonly articleId: string;
/**
* Platform identifier from request header
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdGet
*/
readonly xCloudhospitalPlatform?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdGet
*/
readonly languageCode?: string;
}
/**
* Request parameters for apiV2ArticlesArticleIdMediasGet operation in ArticlesApi.
* @export
* @interface ArticlesApiApiV2ArticlesArticleIdMediasGetRequest
*/
export interface ArticlesApiApiV2ArticlesArticleIdMediasGetRequest {
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdMediasGet
*/
readonly articleId: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdMediasGet
*/
readonly id?: string;
/**
*
* @type {MediaType}
* @memberof ArticlesApiApiV2ArticlesArticleIdMediasGet
*/
readonly mediaType?: MediaType;
/**
*
* @type {number}
* @memberof ArticlesApiApiV2ArticlesArticleIdMediasGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof ArticlesApiApiV2ArticlesArticleIdMediasGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof ArticlesApiApiV2ArticlesArticleIdMediasGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV2ArticlesArticleIdMediasMediaIdGet operation in ArticlesApi.
* @export
* @interface ArticlesApiApiV2ArticlesArticleIdMediasMediaIdGetRequest
*/
export interface ArticlesApiApiV2ArticlesArticleIdMediasMediaIdGetRequest {
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdMediasMediaIdGet
*/
readonly articleId: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdMediasMediaIdGet
*/
readonly mediaId: string;
}
/**
* Request parameters for apiV2ArticlesArticleIdSourcesGet operation in ArticlesApi.
* @export
* @interface ArticlesApiApiV2ArticlesArticleIdSourcesGetRequest
*/
export interface ArticlesApiApiV2ArticlesArticleIdSourcesGetRequest {
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdSourcesGet
*/
readonly articleId: string;
/**
*
* @type {number}
* @memberof ArticlesApiApiV2ArticlesArticleIdSourcesGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof ArticlesApiApiV2ArticlesArticleIdSourcesGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof ArticlesApiApiV2ArticlesArticleIdSourcesGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV2ArticlesArticleIdSourcesSourceIdGet operation in ArticlesApi.
* @export
* @interface ArticlesApiApiV2ArticlesArticleIdSourcesSourceIdGetRequest
*/
export interface ArticlesApiApiV2ArticlesArticleIdSourcesSourceIdGetRequest {
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdSourcesSourceIdGet
*/
readonly articleId: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdSourcesSourceIdGet
*/
readonly sourceId: string;
}
/**
* Request parameters for apiV2ArticlesArticleIdTagsGet operation in ArticlesApi.
* @export
* @interface ArticlesApiApiV2ArticlesArticleIdTagsGetRequest
*/
export interface ArticlesApiApiV2ArticlesArticleIdTagsGetRequest {
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdTagsGet
*/
readonly articleId: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdTagsGet
*/
readonly tagId?: string;
/**
*
* @type {number}
* @memberof ArticlesApiApiV2ArticlesArticleIdTagsGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof ArticlesApiApiV2ArticlesArticleIdTagsGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof ArticlesApiApiV2ArticlesArticleIdTagsGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV2ArticlesArticleIdTagsTagIdGet operation in ArticlesApi.
* @export
* @interface ArticlesApiApiV2ArticlesArticleIdTagsTagIdGetRequest
*/
export interface ArticlesApiApiV2ArticlesArticleIdTagsTagIdGetRequest {
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdTagsTagIdGet
*/
readonly articleId: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesArticleIdTagsTagIdGet
*/
readonly tagId: string;
}
/**
* Request parameters for apiV2ArticlesGet operation in ArticlesApi.
* @export
* @interface ArticlesApiApiV2ArticlesGetRequest
*/
export interface ArticlesApiApiV2ArticlesGetRequest {
/**
* Platform identifier from request header
* @type {string}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly xCloudhospitalPlatform?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly id?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly name?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly description?: string;
/**
*
* @type {ArticleType}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly articleType?: ArticleType;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly userId?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly userName?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly hospitalId?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly hospitalName?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly countryId?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly tag?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly exceptArticleId?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly exceptHospitalId?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly contributorId?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly specialtyTypeId?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly languageCode?: string;
/**
*
* @type {boolean}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly showHidden?: boolean;
/**
*
* @type {boolean}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly returnDefaultValue?: boolean;
/**
*
* @type {number}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof ArticlesApiApiV2ArticlesGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV2ArticlesSlugGet operation in ArticlesApi.
* @export
* @interface ArticlesApiApiV2ArticlesSlugGetRequest
*/
export interface ArticlesApiApiV2ArticlesSlugGetRequest {
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesSlugGet
*/
readonly slug: string;
/**
* Platform identifier from request header
* @type {string}
* @memberof ArticlesApiApiV2ArticlesSlugGet
*/
readonly xCloudhospitalPlatform?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesSlugGet
*/
readonly languageCode?: string;
/**
*
* @type {boolean}
* @memberof ArticlesApiApiV2ArticlesSlugGet
*/
readonly returnDefaultValue?: boolean;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesSlugGet
*/
readonly previewSecret?: string;
/**
*
* @type {string}
* @memberof ArticlesApiApiV2ArticlesSlugGet
*/
readonly hospitalId?: string;
}
/**
* ArticlesApi - object-oriented interface
* @export
* @class ArticlesApi
* @extends {BaseAPI}
*/
export declare class ArticlesApi extends BaseAPI {
/**
*
* @summary Get ArticleContributor.
* @param {ArticlesApiApiV2ArticlesArticleIdContributorsContributorIdGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ArticlesApi
*/
apiV2ArticlesArticleIdContributorsContributorIdGet(requestParameters: ArticlesApiApiV2ArticlesArticleIdContributorsContributorIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ArticleContributorModel, any>>;
/**
*
* @summary GetAll ArticleContributors.
* @param {ArticlesApiApiV2ArticlesArticleIdContributorsGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ArticlesApi
*/
apiV2ArticlesArticleIdContributorsGet(requestParameters: ArticlesApiApiV2ArticlesArticleIdContributorsGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ArticleContributorsModel, any>>;
/**
*
* @summary Get Article.
* @param {ArticlesApiApiV2ArticlesArticleIdGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ArticlesApi
*/
apiV2ArticlesArticleIdGet(requestParameters: ArticlesApiApiV2ArticlesArticleIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ArticleModel, any>>;
/**
*
* @summary Get all ArticleMedias.
* @param {ArticlesApiApiV2ArticlesArticleIdMediasGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ArticlesApi
*/
apiV2ArticlesArticleIdMediasGet(requestParameters: ArticlesApiApiV2ArticlesArticleIdMediasGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MediasModel, any>>;
/**
*
* @summary Get ArticleMedia.
* @param {ArticlesApiApiV2ArticlesArticleIdMediasMediaIdGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ArticlesApi
*/
apiV2ArticlesArticleIdMediasMediaIdGet(requestParameters: ArticlesApiApiV2ArticlesArticleIdMediasMediaIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MediaModel, any>>;
/**
*
* @summary Get all ArticleSource.
* @param {ArticlesApiApiV2ArticlesArticleIdSourcesGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ArticlesApi
*/
apiV2ArticlesArticleIdSourcesGet(requestParameters: ArticlesApiApiV2ArticlesArticleIdSourcesGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ArticleSourcesModel, any>>;
/**
*
* @summary Get ArticleSource.
* @param {ArticlesApiApiV2ArticlesArticleIdSourcesSourceIdGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ArticlesApi
*/
apiV2ArticlesArticleIdSourcesSourceIdGet(requestParameters: ArticlesApiApiV2ArticlesArticleIdSourcesSourceIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SourceModel, any>>;
/**
*
* @summary GetAll ArticleTags.
* @param {ArticlesApiApiV2ArticlesArticleIdTagsGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ArticlesApi
*/
apiV2ArticlesArticleIdTagsGet(requestParameters: ArticlesApiApiV2ArticlesArticleIdTagsGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ArticleTagsModel, any>>;
/**
*
* @summary Get ArticleTag.
* @param {ArticlesApiApiV2ArticlesArticleIdTagsTagIdGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ArticlesApi
*/
apiV2ArticlesArticleIdTagsTagIdGet(requestParameters: ArticlesApiApiV2ArticlesArticleIdTagsTagIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ArticleTagModel, any>>;
/**
*
* @summary Get all Articles.
* @param {ArticlesApiApiV2ArticlesGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ArticlesApi
*/
apiV2ArticlesGet(requestParameters?: ArticlesApiApiV2ArticlesGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ArticlesModel, any>>;
/**
*
* @summary Get article by slug
* @param {ArticlesApiApiV2ArticlesSlugGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ArticlesApi
*/
apiV2ArticlesSlugGet(requestParameters: ArticlesApiApiV2ArticlesSlugGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ArticleModel, any>>;
}
//# sourceMappingURL=articles-api.d.ts.map