Class LocationAPI

Hierarchy

APIBase
- LocationAPI

Index

Constructors

Properties

apiClient options

Methods

checkApiKey deleteLocation retrieveLocation retrieveLocations setApiAuthorization setApiUrl

Constructors

constructor

new LocationAPI(apiClient: APIClient, options: ClientOptions): LocationAPI
Parameters
- apiClient: APIClient
- options: ClientOptions
Returns LocationAPI
Overrides APIBase.constructor
- Defined in api/LocationAPI.ts:9

Properties

`Protected` `Readonly`apiClient

apiClient: APIClient

`Protected` `Readonly`options

options: ClientOptions

Methods

`Protected`checkApiKey

checkApiKey(apiName?: string): void
Parameters
- OptionalapiName: string
Returns void
Inherited from APIBase.checkApiKey
- Defined in api/APIBase.ts:41

deleteLocation

deleteLocation(id: string): Promise<void>
Deletes a location
Parameters
- id: string
  The location id
Returns Promise<void>
- Defined in api/LocationAPI.ts:17

retrieveLocation

retrieveLocation(id: string): Promise<Location>
Retrieve a single location
Parameters
- id: string
Returns Promise<Location>
- Defined in api/LocationAPI.ts:26

retrieveLocations

retrieveLocations(options?: PaginationOptions): Promise<Paginated<Location[]>>
Retrieve locations
Parameters
- Optionaloptions: PaginationOptions
Returns Promise<Paginated<Location[]>>
- Defined in api/LocationAPI.ts:36

setApiAuthorization

setApiAuthorization(authorization: Authorization): void
Set a new API key.
Parameters
- authorization: Authorization
  The API authorization data
Returns void
Inherited from APIBase.setApiAuthorization
- Defined in api/APIBase.ts:20

setApiUrl

setApiUrl(newURL: string): void
Set a new API URL.
Parameters
- newURL: string
  The new API url
Returns void
Inherited from APIBase.setApiUrl
- Defined in api/APIBase.ts:37