Class FacilitiesStatsApi

FacilitiesStatsApi - object-oriented interface

Hierarchy

BaseAPI
- FacilitiesStatsApi

Index

Constructors

Properties

axios basePath configuration

Methods

getFacilityStatsDemographics getFacilityStatsKrt

Constructors

constructor

new FacilitiesStatsApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): FacilitiesStatsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns FacilitiesStatsApi
Inherited from BaseAPI.constructor
- Defined in base.ts:39

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

getFacilityStatsDemographics

getFacilityStatsDemographics(
requestParameters: FacilitiesStatsApiGetFacilityStatsDemographicsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<DemographicsStats, any, {}>>
Retreive demographic statistics for a given facility
Parameters
- requestParameters: FacilitiesStatsApiGetFacilityStatsDemographicsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DemographicsStats, any, {}>>

Throws
- Defined in api.ts:5636

getFacilityStatsKrt

getFacilityStatsKrt(
requestParameters: FacilitiesStatsApiGetFacilityStatsKrtRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UnitLevelKRTStats, any, {}>>
Retreive KRT statistics for a given facility
Parameters
- requestParameters: FacilitiesStatsApiGetFacilityStatsKrtRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UnitLevelKRTStats, any, {}>>

Throws
- Defined in api.ts:5647