Class RawClient

Index

Constructors

Methods

getDestinations getEntity getEntityChildren getEntityHistory getEntityHistoryCoverage getEntityHistoryDaily getEntityLive getEntitySchedule getEntityScheduleMonth getUrl

Constructors

constructor

new RawClient(transport: Transport): RawClient
Parameters
- transport: Transport
Returns RawClient
- Defined in raw.ts:51

Methods

getDestinations

getDestinations(): Promise<{}>
Returns Promise<{}>
- Defined in raw.ts:53

getEntity

getEntity(entityId: string): Promise<{} & { [key: string]: unknown }>
Parameters
- entityId: string
Returns Promise<{} & { [key: string]: unknown }>
- Defined in raw.ts:57

getEntityChildren

getEntityChildren(entityId: string): Promise<{}>
Parameters
- entityId: string
Returns Promise<{}>
- Defined in raw.ts:61

getEntityHistory

getEntityHistory(entityId: string, query?: {}): Promise<EntityHistory>
Parameters
- entityId: string
- query: {} = {}
Returns Promise<EntityHistory>
- Defined in raw.ts:80

getEntityHistoryCoverage

getEntityHistoryCoverage(entityId: string): Promise<EntityHistoryCoverage>
Parameters
- entityId: string
Returns Promise<EntityHistoryCoverage>
- Defined in raw.ts:86

getEntityHistoryDaily

getEntityHistoryDaily(entityId: string, query?: {}): Promise<EntityHistoryDaily>
Parameters
- entityId: string
- query: {} = {}
Returns Promise<EntityHistoryDaily>
- Defined in raw.ts:92

getEntityLive

getEntityLive(entityId: string): Promise<{}>
Parameters
- entityId: string
Returns Promise<{}>
- Defined in raw.ts:65

getEntitySchedule

getEntitySchedule(entityId: string): Promise<{}>
Parameters
- entityId: string
Returns Promise<{}>
- Defined in raw.ts:69

getEntityScheduleMonth

getEntityScheduleMonth(
    entityId: string,
    year: number,
    month: number,
): Promise<{}>
Parameters
- entityId: string
- year: number
- month: number
Returns Promise<{}>
- Defined in raw.ts:73

getUrl

getUrl<T = unknown>(url: string): Promise<T>
GET an absolute URL the API itself handed us, such as a paged response's next. The server has already applied every parameter; re-deriving the URL from its path is how a paging loop starts asking for the wrong range.
Type Parameters
- T = unknown
Parameters
- url: string
Returns Promise<T>
- Defined in raw.ts:103