ch-api-client-typescript2
Version:
Openapi generated typescript-axios client for CloudHospital
992 lines • 40 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 { ArticleType } from '../models';
import { ContributionType } from '../models';
import { GeneralArticleContributorModel } from '../models';
import { GeneralArticleContributorsModel } from '../models';
import { GeneralArticleModel } from '../models';
import { GeneralArticleSourcesModel } from '../models';
import { GeneralArticleTagItemModel } 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';
/**
* GeneralArticlesApi - axios parameter creator
* @export
*/
export declare const GeneralArticlesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Get GeneralArticleContributor.
* @param {string} generalArticleId
* @param {string} contributorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdContributorsContributorIdGet: (generalArticleId: string, contributorId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary GetAll GeneralArticleContributors.
* @param {string} generalArticleId
* @param {string} [languageCode]
* @param {string} [contributorId]
* @param {string} [contributorName]
* @param {string} [email]
* @param {string} [website]
* @param {ContributionType} [contributionType]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdContributorsGet: (generalArticleId: string, languageCode?: string, contributorId?: string, contributorName?: string, email?: string, website?: string, contributionType?: ContributionType, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get GeneralArticle by id.
* @param {string} generalArticleId
* @param {string} [languageCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdGet: (generalArticleId: string, languageCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get all GeneralArticleMedias.
* @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}
*/
apiV2GeneralarticlesGeneralArticleIdMediasGet: (generalArticleId: string, id?: string, mediaType?: MediaType, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get GeneralArticleMedia.
* @param {string} generalArticleId
* @param {string} mediaId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdMediasMediaIdGet: (generalArticleId: string, mediaId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get all GeneralArticleSource.
* @param {string} generalArticleId
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdSourcesGet: (generalArticleId: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get GeneralArticleSource.
* @param {string} generalArticleId
* @param {string} sourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdSourcesSourceIdGet: (generalArticleId: string, sourceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary GetAll GeneralArticleTags.
* @param {string} generalArticleId
* @param {string} [tagId]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdTagsGet: (generalArticleId: string, tagId?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get GeneralArticleTag.
* @param {string} generalArticleId
* @param {string} tagId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdTagsTagIdGet: (generalArticleId: string, tagId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get all GeneralArticles.
* @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} [articleCategoryId]
* @param {boolean} [includesSubArticleCategoryEntries]
* @param {string} [languageCode]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGet: (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, articleCategoryId?: string, includesSubArticleCategoryEntries?: boolean, languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get GeneralArticle by slug
* @param {string} slug
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {string} [previewSecret]
* @param {string} [hospitalId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesSlugGet: (slug: string, languageCode?: string, returnDefaultValue?: boolean, previewSecret?: string, hospitalId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* GeneralArticlesApi - functional programming interface
* @export
*/
export declare const GeneralArticlesApiFp: (configuration?: Configuration) => {
/**
*
* @summary Get GeneralArticleContributor.
* @param {string} generalArticleId
* @param {string} contributorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdContributorsContributorIdGet(generalArticleId: string, contributorId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleContributorModel>>;
/**
*
* @summary GetAll GeneralArticleContributors.
* @param {string} generalArticleId
* @param {string} [languageCode]
* @param {string} [contributorId]
* @param {string} [contributorName]
* @param {string} [email]
* @param {string} [website]
* @param {ContributionType} [contributionType]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdContributorsGet(generalArticleId: string, languageCode?: string, contributorId?: string, contributorName?: string, email?: string, website?: string, contributionType?: ContributionType, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleContributorsModel>>;
/**
*
* @summary Get GeneralArticle by id.
* @param {string} generalArticleId
* @param {string} [languageCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdGet(generalArticleId: string, languageCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleModel>>;
/**
*
* @summary Get all GeneralArticleMedias.
* @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}
*/
apiV2GeneralarticlesGeneralArticleIdMediasGet(generalArticleId: string, id?: string, mediaType?: MediaType, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MediasModel>>;
/**
*
* @summary Get GeneralArticleMedia.
* @param {string} generalArticleId
* @param {string} mediaId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdMediasMediaIdGet(generalArticleId: string, mediaId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MediaModel>>;
/**
*
* @summary Get all GeneralArticleSource.
* @param {string} generalArticleId
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdSourcesGet(generalArticleId: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleSourcesModel>>;
/**
*
* @summary Get GeneralArticleSource.
* @param {string} generalArticleId
* @param {string} sourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdSourcesSourceIdGet(generalArticleId: string, sourceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceModel>>;
/**
*
* @summary GetAll GeneralArticleTags.
* @param {string} generalArticleId
* @param {string} [tagId]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdTagsGet(generalArticleId: string, tagId?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleTagsModel>>;
/**
*
* @summary Get GeneralArticleTag.
* @param {string} generalArticleId
* @param {string} tagId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdTagsTagIdGet(generalArticleId: string, tagId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleTagItemModel>>;
/**
*
* @summary Get all GeneralArticles.
* @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} [articleCategoryId]
* @param {boolean} [includesSubArticleCategoryEntries]
* @param {string} [languageCode]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGet(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, articleCategoryId?: string, includesSubArticleCategoryEntries?: boolean, languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticlesModel>>;
/**
*
* @summary Get GeneralArticle by slug
* @param {string} slug
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {string} [previewSecret]
* @param {string} [hospitalId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesSlugGet(slug: string, languageCode?: string, returnDefaultValue?: boolean, previewSecret?: string, hospitalId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneralArticleModel>>;
};
/**
* GeneralArticlesApi - factory interface
* @export
*/
export declare const GeneralArticlesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Get GeneralArticleContributor.
* @param {string} generalArticleId
* @param {string} contributorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdContributorsContributorIdGet(generalArticleId: string, contributorId: string, options?: any): AxiosPromise<GeneralArticleContributorModel>;
/**
*
* @summary GetAll GeneralArticleContributors.
* @param {string} generalArticleId
* @param {string} [languageCode]
* @param {string} [contributorId]
* @param {string} [contributorName]
* @param {string} [email]
* @param {string} [website]
* @param {ContributionType} [contributionType]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdContributorsGet(generalArticleId: string, languageCode?: string, contributorId?: string, contributorName?: string, email?: string, website?: string, contributionType?: ContributionType, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<GeneralArticleContributorsModel>;
/**
*
* @summary Get GeneralArticle by id.
* @param {string} generalArticleId
* @param {string} [languageCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdGet(generalArticleId: string, languageCode?: string, options?: any): AxiosPromise<GeneralArticleModel>;
/**
*
* @summary Get all GeneralArticleMedias.
* @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}
*/
apiV2GeneralarticlesGeneralArticleIdMediasGet(generalArticleId: string, id?: string, mediaType?: MediaType, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<MediasModel>;
/**
*
* @summary Get GeneralArticleMedia.
* @param {string} generalArticleId
* @param {string} mediaId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdMediasMediaIdGet(generalArticleId: string, mediaId: string, options?: any): AxiosPromise<MediaModel>;
/**
*
* @summary Get all GeneralArticleSource.
* @param {string} generalArticleId
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdSourcesGet(generalArticleId: string, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<GeneralArticleSourcesModel>;
/**
*
* @summary Get GeneralArticleSource.
* @param {string} generalArticleId
* @param {string} sourceId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdSourcesSourceIdGet(generalArticleId: string, sourceId: string, options?: any): AxiosPromise<SourceModel>;
/**
*
* @summary GetAll GeneralArticleTags.
* @param {string} generalArticleId
* @param {string} [tagId]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdTagsGet(generalArticleId: string, tagId?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<GeneralArticleTagsModel>;
/**
*
* @summary Get GeneralArticleTag.
* @param {string} generalArticleId
* @param {string} tagId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGeneralArticleIdTagsTagIdGet(generalArticleId: string, tagId: string, options?: any): AxiosPromise<GeneralArticleTagItemModel>;
/**
*
* @summary Get all GeneralArticles.
* @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} [articleCategoryId]
* @param {boolean} [includesSubArticleCategoryEntries]
* @param {string} [languageCode]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesGet(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, articleCategoryId?: string, includesSubArticleCategoryEntries?: boolean, languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<GeneralArticlesModel>;
/**
*
* @summary Get GeneralArticle by slug
* @param {string} slug
* @param {string} [languageCode]
* @param {boolean} [returnDefaultValue]
* @param {string} [previewSecret]
* @param {string} [hospitalId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV2GeneralarticlesSlugGet(slug: string, languageCode?: string, returnDefaultValue?: boolean, previewSecret?: string, hospitalId?: string, options?: any): AxiosPromise<GeneralArticleModel>;
};
/**
* Request parameters for apiV2GeneralarticlesGeneralArticleIdContributorsContributorIdGet operation in GeneralArticlesApi.
* @export
* @interface GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsContributorIdGetRequest
*/
export interface GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsContributorIdGetRequest {
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsContributorIdGet
*/
readonly generalArticleId: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsContributorIdGet
*/
readonly contributorId: string;
}
/**
* Request parameters for apiV2GeneralarticlesGeneralArticleIdContributorsGet operation in GeneralArticlesApi.
* @export
* @interface GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsGetRequest
*/
export interface GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsGetRequest {
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsGet
*/
readonly generalArticleId: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsGet
*/
readonly languageCode?: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsGet
*/
readonly contributorId?: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsGet
*/
readonly contributorName?: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsGet
*/
readonly email?: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsGet
*/
readonly website?: string;
/**
*
* @type {ContributionType}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsGet
*/
readonly contributionType?: ContributionType;
/**
*
* @type {number}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV2GeneralarticlesGeneralArticleIdGet operation in GeneralArticlesApi.
* @export
* @interface GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdGetRequest
*/
export interface GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdGetRequest {
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdGet
*/
readonly generalArticleId: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdGet
*/
readonly languageCode?: string;
}
/**
* Request parameters for apiV2GeneralarticlesGeneralArticleIdMediasGet operation in GeneralArticlesApi.
* @export
* @interface GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdMediasGetRequest
*/
export interface GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdMediasGetRequest {
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdMediasGet
*/
readonly generalArticleId: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdMediasGet
*/
readonly id?: string;
/**
*
* @type {MediaType}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdMediasGet
*/
readonly mediaType?: MediaType;
/**
*
* @type {number}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdMediasGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdMediasGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdMediasGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV2GeneralarticlesGeneralArticleIdMediasMediaIdGet operation in GeneralArticlesApi.
* @export
* @interface GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdMediasMediaIdGetRequest
*/
export interface GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdMediasMediaIdGetRequest {
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdMediasMediaIdGet
*/
readonly generalArticleId: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdMediasMediaIdGet
*/
readonly mediaId: string;
}
/**
* Request parameters for apiV2GeneralarticlesGeneralArticleIdSourcesGet operation in GeneralArticlesApi.
* @export
* @interface GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdSourcesGetRequest
*/
export interface GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdSourcesGetRequest {
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdSourcesGet
*/
readonly generalArticleId: string;
/**
*
* @type {number}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdSourcesGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdSourcesGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdSourcesGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV2GeneralarticlesGeneralArticleIdSourcesSourceIdGet operation in GeneralArticlesApi.
* @export
* @interface GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdSourcesSourceIdGetRequest
*/
export interface GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdSourcesSourceIdGetRequest {
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdSourcesSourceIdGet
*/
readonly generalArticleId: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdSourcesSourceIdGet
*/
readonly sourceId: string;
}
/**
* Request parameters for apiV2GeneralarticlesGeneralArticleIdTagsGet operation in GeneralArticlesApi.
* @export
* @interface GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdTagsGetRequest
*/
export interface GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdTagsGetRequest {
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdTagsGet
*/
readonly generalArticleId: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdTagsGet
*/
readonly tagId?: string;
/**
*
* @type {number}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdTagsGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdTagsGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdTagsGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV2GeneralarticlesGeneralArticleIdTagsTagIdGet operation in GeneralArticlesApi.
* @export
* @interface GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdTagsTagIdGetRequest
*/
export interface GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdTagsTagIdGetRequest {
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdTagsTagIdGet
*/
readonly generalArticleId: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdTagsTagIdGet
*/
readonly tagId: string;
}
/**
* Request parameters for apiV2GeneralarticlesGet operation in GeneralArticlesApi.
* @export
* @interface GeneralArticlesApiApiV2GeneralarticlesGetRequest
*/
export interface GeneralArticlesApiApiV2GeneralarticlesGetRequest {
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGet
*/
readonly id?: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGet
*/
readonly name?: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGet
*/
readonly description?: string;
/**
*
* @type {ArticleType}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGet
*/
readonly articleType?: ArticleType;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGet
*/
readonly userId?: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGet
*/
readonly userName?: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGet
*/
readonly hospitalId?: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGet
*/
readonly hospitalName?: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGet
*/
readonly countryId?: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGet
*/
readonly tag?: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGet
*/
readonly exceptArticleId?: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGet
*/
readonly exceptHospitalId?: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGet
*/
readonly contributorId?: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGet
*/
readonly articleCategoryId?: string;
/**
*
* @type {boolean}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGet
*/
readonly includesSubArticleCategoryEntries?: boolean;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGet
*/
readonly languageCode?: string;
/**
*
* @type {number}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof GeneralArticlesApiApiV2GeneralarticlesGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV2GeneralarticlesSlugGet operation in GeneralArticlesApi.
* @export
* @interface GeneralArticlesApiApiV2GeneralarticlesSlugGetRequest
*/
export interface GeneralArticlesApiApiV2GeneralarticlesSlugGetRequest {
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesSlugGet
*/
readonly slug: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesSlugGet
*/
readonly languageCode?: string;
/**
*
* @type {boolean}
* @memberof GeneralArticlesApiApiV2GeneralarticlesSlugGet
*/
readonly returnDefaultValue?: boolean;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesSlugGet
*/
readonly previewSecret?: string;
/**
*
* @type {string}
* @memberof GeneralArticlesApiApiV2GeneralarticlesSlugGet
*/
readonly hospitalId?: string;
}
/**
* GeneralArticlesApi - object-oriented interface
* @export
* @class GeneralArticlesApi
* @extends {BaseAPI}
*/
export declare class GeneralArticlesApi extends BaseAPI {
/**
*
* @summary Get GeneralArticleContributor.
* @param {GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsContributorIdGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GeneralArticlesApi
*/
apiV2GeneralarticlesGeneralArticleIdContributorsContributorIdGet(requestParameters: GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsContributorIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GeneralArticleContributorModel, any>>;
/**
*
* @summary GetAll GeneralArticleContributors.
* @param {GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GeneralArticlesApi
*/
apiV2GeneralarticlesGeneralArticleIdContributorsGet(requestParameters: GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdContributorsGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GeneralArticleContributorsModel, any>>;
/**
*
* @summary Get GeneralArticle by id.
* @param {GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GeneralArticlesApi
*/
apiV2GeneralarticlesGeneralArticleIdGet(requestParameters: GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GeneralArticleModel, any>>;
/**
*
* @summary Get all GeneralArticleMedias.
* @param {GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdMediasGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GeneralArticlesApi
*/
apiV2GeneralarticlesGeneralArticleIdMediasGet(requestParameters: GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdMediasGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MediasModel, any>>;
/**
*
* @summary Get GeneralArticleMedia.
* @param {GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdMediasMediaIdGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GeneralArticlesApi
*/
apiV2GeneralarticlesGeneralArticleIdMediasMediaIdGet(requestParameters: GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdMediasMediaIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MediaModel, any>>;
/**
*
* @summary Get all GeneralArticleSource.
* @param {GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdSourcesGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GeneralArticlesApi
*/
apiV2GeneralarticlesGeneralArticleIdSourcesGet(requestParameters: GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdSourcesGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GeneralArticleSourcesModel, any>>;
/**
*
* @summary Get GeneralArticleSource.
* @param {GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdSourcesSourceIdGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GeneralArticlesApi
*/
apiV2GeneralarticlesGeneralArticleIdSourcesSourceIdGet(requestParameters: GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdSourcesSourceIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SourceModel, any>>;
/**
*
* @summary GetAll GeneralArticleTags.
* @param {GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdTagsGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GeneralArticlesApi
*/
apiV2GeneralarticlesGeneralArticleIdTagsGet(requestParameters: GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdTagsGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GeneralArticleTagsModel, any>>;
/**
*
* @summary Get GeneralArticleTag.
* @param {GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdTagsTagIdGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GeneralArticlesApi
*/
apiV2GeneralarticlesGeneralArticleIdTagsTagIdGet(requestParameters: GeneralArticlesApiApiV2GeneralarticlesGeneralArticleIdTagsTagIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GeneralArticleTagItemModel, any>>;
/**
*
* @summary Get all GeneralArticles.
* @param {GeneralArticlesApiApiV2GeneralarticlesGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GeneralArticlesApi
*/
apiV2GeneralarticlesGet(requestParameters?: GeneralArticlesApiApiV2GeneralarticlesGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GeneralArticlesModel, any>>;
/**
*
* @summary Get GeneralArticle by slug
* @param {GeneralArticlesApiApiV2GeneralarticlesSlugGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GeneralArticlesApi
*/
apiV2GeneralarticlesSlugGet(requestParameters: GeneralArticlesApiApiV2GeneralarticlesSlugGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GeneralArticleModel, any>>;
}
//# sourceMappingURL=general-articles-api.d.ts.map