ch-api-client-typescript2/lib/api/contributors-api.d.ts

Openapi generated typescript-axios client for CloudHospital

/**
 * 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 { ContributorModel } from '../models';
import { ContributorSnsHandlesModel } from '../models';
import { ContributorsModel } from '../models';
import { SnsHandleModel } from '../models';
import { SnsType } from '../models';
/**
 * ContributorsApi - axios parameter creator
 * @export
 */
export declare const ContributorsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Get Contributor.
     * @param {string} contributorId
     * @param {string} [languageCode]
     * @param {boolean} [returnDefaultValue]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ContributorsContributorIdGet: (contributorId: string, languageCode?: string, returnDefaultValue?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get all ContributorHandles.
     * @param {string} contributorId
     * @param {string} [id]
     * @param {SnsType} [snsType]
     * @param {string} [handle]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ContributorsContributorIdHandlesGet: (contributorId: string, id?: string, snsType?: SnsType, handle?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get ContributorHandle.
     * @param {string} contributorId
     * @param {string} handleId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ContributorsContributorIdHandlesHandleIdGet: (contributorId: string, handleId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get all Contributors.
     * @param {string} [id]
     * @param {string} [name]
     * @param {string} [email]
     * @param {string} [website]
     * @param {string} [hospitalId]
     * @param {boolean} [interviewerOnly]
     * @param {boolean} [showHidden]
     * @param {string} [languageCode]
     * @param {boolean} [returnDefaultValue]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ContributorsGet: (id?: string, name?: string, email?: string, website?: string, hospitalId?: string, interviewerOnly?: boolean, showHidden?: boolean, languageCode?: string, returnDefaultValue?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get Contributor by slug.
     * @param {string} slug
     * @param {string} [languageCode]
     * @param {boolean} [returnDefaultValue]
     * @param {string} [previewSecret]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ContributorsSlugGet: (slug: string, languageCode?: string, returnDefaultValue?: boolean, previewSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * ContributorsApi - functional programming interface
 * @export
 */
export declare const ContributorsApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Get Contributor.
     * @param {string} contributorId
     * @param {string} [languageCode]
     * @param {boolean} [returnDefaultValue]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ContributorsContributorIdGet(contributorId: string, languageCode?: string, returnDefaultValue?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContributorModel>>;
    /**
     *
     * @summary Get all ContributorHandles.
     * @param {string} contributorId
     * @param {string} [id]
     * @param {SnsType} [snsType]
     * @param {string} [handle]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ContributorsContributorIdHandlesGet(contributorId: string, id?: string, snsType?: SnsType, handle?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContributorSnsHandlesModel>>;
    /**
     *
     * @summary Get ContributorHandle.
     * @param {string} contributorId
     * @param {string} handleId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ContributorsContributorIdHandlesHandleIdGet(contributorId: string, handleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SnsHandleModel>>;
    /**
     *
     * @summary Get all Contributors.
     * @param {string} [id]
     * @param {string} [name]
     * @param {string} [email]
     * @param {string} [website]
     * @param {string} [hospitalId]
     * @param {boolean} [interviewerOnly]
     * @param {boolean} [showHidden]
     * @param {string} [languageCode]
     * @param {boolean} [returnDefaultValue]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ContributorsGet(id?: string, name?: string, email?: string, website?: string, hospitalId?: string, interviewerOnly?: boolean, showHidden?: boolean, languageCode?: string, returnDefaultValue?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContributorsModel>>;
    /**
     *
     * @summary Get Contributor by slug.
     * @param {string} slug
     * @param {string} [languageCode]
     * @param {boolean} [returnDefaultValue]
     * @param {string} [previewSecret]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ContributorsSlugGet(slug: string, languageCode?: string, returnDefaultValue?: boolean, previewSecret?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContributorModel>>;
};
/**
 * ContributorsApi - factory interface
 * @export
 */
export declare const ContributorsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Get Contributor.
     * @param {string} contributorId
     * @param {string} [languageCode]
     * @param {boolean} [returnDefaultValue]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ContributorsContributorIdGet(contributorId: string, languageCode?: string, returnDefaultValue?: boolean, options?: any): AxiosPromise<ContributorModel>;
    /**
     *
     * @summary Get all ContributorHandles.
     * @param {string} contributorId
     * @param {string} [id]
     * @param {SnsType} [snsType]
     * @param {string} [handle]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ContributorsContributorIdHandlesGet(contributorId: string, id?: string, snsType?: SnsType, handle?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<ContributorSnsHandlesModel>;
    /**
     *
     * @summary Get ContributorHandle.
     * @param {string} contributorId
     * @param {string} handleId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ContributorsContributorIdHandlesHandleIdGet(contributorId: string, handleId: string, options?: any): AxiosPromise<SnsHandleModel>;
    /**
     *
     * @summary Get all Contributors.
     * @param {string} [id]
     * @param {string} [name]
     * @param {string} [email]
     * @param {string} [website]
     * @param {string} [hospitalId]
     * @param {boolean} [interviewerOnly]
     * @param {boolean} [showHidden]
     * @param {string} [languageCode]
     * @param {boolean} [returnDefaultValue]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ContributorsGet(id?: string, name?: string, email?: string, website?: string, hospitalId?: string, interviewerOnly?: boolean, showHidden?: boolean, languageCode?: string, returnDefaultValue?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<ContributorsModel>;
    /**
     *
     * @summary Get Contributor by slug.
     * @param {string} slug
     * @param {string} [languageCode]
     * @param {boolean} [returnDefaultValue]
     * @param {string} [previewSecret]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ContributorsSlugGet(slug: string, languageCode?: string, returnDefaultValue?: boolean, previewSecret?: string, options?: any): AxiosPromise<ContributorModel>;
};
/**
 * Request parameters for apiV2ContributorsContributorIdGet operation in ContributorsApi.
 * @export
 * @interface ContributorsApiApiV2ContributorsContributorIdGetRequest
 */
export interface ContributorsApiApiV2ContributorsContributorIdGetRequest {
    /**
     *
     * @type {string}
     * @memberof ContributorsApiApiV2ContributorsContributorIdGet
     */
    readonly contributorId: string;
    /**
     *
     * @type {string}
     * @memberof ContributorsApiApiV2ContributorsContributorIdGet
     */
    readonly languageCode?: string;
    /**
     *
     * @type {boolean}
     * @memberof ContributorsApiApiV2ContributorsContributorIdGet
     */
    readonly returnDefaultValue?: boolean;
}
/**
 * Request parameters for apiV2ContributorsContributorIdHandlesGet operation in ContributorsApi.
 * @export
 * @interface ContributorsApiApiV2ContributorsContributorIdHandlesGetRequest
 */
export interface ContributorsApiApiV2ContributorsContributorIdHandlesGetRequest {
    /**
     *
     * @type {string}
     * @memberof ContributorsApiApiV2ContributorsContributorIdHandlesGet
     */
    readonly contributorId: string;
    /**
     *
     * @type {string}
     * @memberof ContributorsApiApiV2ContributorsContributorIdHandlesGet
     */
    readonly id?: string;
    /**
     *
     * @type {SnsType}
     * @memberof ContributorsApiApiV2ContributorsContributorIdHandlesGet
     */
    readonly snsType?: SnsType;
    /**
     *
     * @type {string}
     * @memberof ContributorsApiApiV2ContributorsContributorIdHandlesGet
     */
    readonly handle?: string;
    /**
     *
     * @type {number}
     * @memberof ContributorsApiApiV2ContributorsContributorIdHandlesGet
     */
    readonly page?: number;
    /**
     *
     * @type {number}
     * @memberof ContributorsApiApiV2ContributorsContributorIdHandlesGet
     */
    readonly limit?: number;
    /**
     *
     * @type {Date}
     * @memberof ContributorsApiApiV2ContributorsContributorIdHandlesGet
     */
    readonly lastRetrieved?: Date;
}
/**
 * Request parameters for apiV2ContributorsContributorIdHandlesHandleIdGet operation in ContributorsApi.
 * @export
 * @interface ContributorsApiApiV2ContributorsContributorIdHandlesHandleIdGetRequest
 */
export interface ContributorsApiApiV2ContributorsContributorIdHandlesHandleIdGetRequest {
    /**
     *
     * @type {string}
     * @memberof ContributorsApiApiV2ContributorsContributorIdHandlesHandleIdGet
     */
    readonly contributorId: string;
    /**
     *
     * @type {string}
     * @memberof ContributorsApiApiV2ContributorsContributorIdHandlesHandleIdGet
     */
    readonly handleId: string;
}
/**
 * Request parameters for apiV2ContributorsGet operation in ContributorsApi.
 * @export
 * @interface ContributorsApiApiV2ContributorsGetRequest
 */
export interface ContributorsApiApiV2ContributorsGetRequest {
    /**
     *
     * @type {string}
     * @memberof ContributorsApiApiV2ContributorsGet
     */
    readonly id?: string;
    /**
     *
     * @type {string}
     * @memberof ContributorsApiApiV2ContributorsGet
     */
    readonly name?: string;
    /**
     *
     * @type {string}
     * @memberof ContributorsApiApiV2ContributorsGet
     */
    readonly email?: string;
    /**
     *
     * @type {string}
     * @memberof ContributorsApiApiV2ContributorsGet
     */
    readonly website?: string;
    /**
     *
     * @type {string}
     * @memberof ContributorsApiApiV2ContributorsGet
     */
    readonly hospitalId?: string;
    /**
     *
     * @type {boolean}
     * @memberof ContributorsApiApiV2ContributorsGet
     */
    readonly interviewerOnly?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof ContributorsApiApiV2ContributorsGet
     */
    readonly showHidden?: boolean;
    /**
     *
     * @type {string}
     * @memberof ContributorsApiApiV2ContributorsGet
     */
    readonly languageCode?: string;
    /**
     *
     * @type {boolean}
     * @memberof ContributorsApiApiV2ContributorsGet
     */
    readonly returnDefaultValue?: boolean;
    /**
     *
     * @type {number}
     * @memberof ContributorsApiApiV2ContributorsGet
     */
    readonly page?: number;
    /**
     *
     * @type {number}
     * @memberof ContributorsApiApiV2ContributorsGet
     */
    readonly limit?: number;
    /**
     *
     * @type {Date}
     * @memberof ContributorsApiApiV2ContributorsGet
     */
    readonly lastRetrieved?: Date;
}
/**
 * Request parameters for apiV2ContributorsSlugGet operation in ContributorsApi.
 * @export
 * @interface ContributorsApiApiV2ContributorsSlugGetRequest
 */
export interface ContributorsApiApiV2ContributorsSlugGetRequest {
    /**
     *
     * @type {string}
     * @memberof ContributorsApiApiV2ContributorsSlugGet
     */
    readonly slug: string;
    /**
     *
     * @type {string}
     * @memberof ContributorsApiApiV2ContributorsSlugGet
     */
    readonly languageCode?: string;
    /**
     *
     * @type {boolean}
     * @memberof ContributorsApiApiV2ContributorsSlugGet
     */
    readonly returnDefaultValue?: boolean;
    /**
     *
     * @type {string}
     * @memberof ContributorsApiApiV2ContributorsSlugGet
     */
    readonly previewSecret?: string;
}
/**
 * ContributorsApi - object-oriented interface
 * @export
 * @class ContributorsApi
 * @extends {BaseAPI}
 */
export declare class ContributorsApi extends BaseAPI {
    /**
     *
     * @summary Get Contributor.
     * @param {ContributorsApiApiV2ContributorsContributorIdGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ContributorsApi
     */
    apiV2ContributorsContributorIdGet(requestParameters: ContributorsApiApiV2ContributorsContributorIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ContributorModel, any>>;
    /**
     *
     * @summary Get all ContributorHandles.
     * @param {ContributorsApiApiV2ContributorsContributorIdHandlesGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ContributorsApi
     */
    apiV2ContributorsContributorIdHandlesGet(requestParameters: ContributorsApiApiV2ContributorsContributorIdHandlesGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ContributorSnsHandlesModel, any>>;
    /**
     *
     * @summary Get ContributorHandle.
     * @param {ContributorsApiApiV2ContributorsContributorIdHandlesHandleIdGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ContributorsApi
     */
    apiV2ContributorsContributorIdHandlesHandleIdGet(requestParameters: ContributorsApiApiV2ContributorsContributorIdHandlesHandleIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SnsHandleModel, any>>;
    /**
     *
     * @summary Get all Contributors.
     * @param {ContributorsApiApiV2ContributorsGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ContributorsApi
     */
    apiV2ContributorsGet(requestParameters?: ContributorsApiApiV2ContributorsGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ContributorsModel, any>>;
    /**
     *
     * @summary Get Contributor by slug.
     * @param {ContributorsApiApiV2ContributorsSlugGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ContributorsApi
     */
    apiV2ContributorsSlugGet(requestParameters: ContributorsApiApiV2ContributorsSlugGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ContributorModel, any>>;
}
//# sourceMappingURL=contributors-api.d.ts.map