Class YearApi

YearApi - object-oriented interface

Hierarchy

BaseAPI
- YearApi

Index

Constructors

Properties

axios basePath configuration

Methods

getYear getYears

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

getYear

getYear(
requestParameters: YearApiGetYearRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDto, any, {}>>
Parameters
- requestParameters: YearApiGetYearRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto, any, {}>>

Throws
- Defined in generated-client/api/year-api.ts:384

getYears

getYears(
requestParameters?: YearApiGetYearsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: YearApiGetYearsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/year-api.ts:395