@xyo-network/api 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,3772 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/api
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
+
+Using npm:
+
+```sh
+npm install {{name}}
+```
+
+Using yarn:
 
-Version: 5.0.2
+```sh
+yarn add {{name}}
+```
 
-Primary SDK for using XYO Protocol 2.0
+Using pnpm:
 
-## Documentation
+```sh
+pnpm add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__api)
+Using bun:
+
+```sh
+bun add {{name}}
+```
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Reference
+
+### packages
+
+  ### sdk-utils
+
+    ### packages
+
+      ### api
+
+        ### .temp-typedoc
+
+          ### classes
+
+            ### <a id="ApiBase"></a>ApiBase
+
+[**@xyo-network/api**](#../README)
+
+***
+
+## Extended by
+
+- [`ApiSimple`](#ApiSimple)
+
+## Type Parameters
+
+### C
+
+`C` *extends* `ApiConfig` = `ApiConfig`
+
+## Implements
+
+- `ApiReportable`
+
+## Constructors
+
+### Constructor
+
+```ts
+new ApiBase<C>(config): ApiBase<C>;
+```
+
+### Parameters
+
+#### config
+
+`C`
+
+### Returns
+
+`ApiBase`\<`C`\>
+
+## Properties
+
+### config
+
+```ts
+readonly config: C;
+```
+
+***
+
+### axios
+
+```ts
+protected axios: Axios;
+```
+
+## Accessors
+
+### authenticated
+
+### Get Signature
+
+```ts
+get authenticated(): boolean;
+```
+
+#### Returns
+
+`boolean`
+
+***
+
+### headers
+
+### Get Signature
+
+```ts
+get protected headers(): Record<string, string>;
+```
+
+#### Returns
+
+`Record`\<`string`, `string`\>
+
+***
+
+### query
+
+### Get Signature
+
+```ts
+get protected query(): string;
+```
+
+#### Returns
+
+`string`
+
+***
+
+### root
+
+### Get Signature
+
+```ts
+get protected root(): string;
+```
+
+#### Returns
+
+`string`
+
+## Methods
+
+### onError()
+
+```ts
+onError(error, depth?): void;
+```
+
+### Parameters
+
+#### error
+
+`ApiError`
+
+#### depth?
+
+`number` = `0`
+
+### Returns
+
+`void`
+
+### Implementation of
+
+```ts
+ApiReportable.onError
+```
+
+***
+
+### onFailure()
+
+```ts
+onFailure(response, depth?): void;
+```
+
+### Parameters
+
+#### response
+
+`ApiResponse`
+
+#### depth?
+
+`number` = `0`
+
+### Returns
+
+`void`
+
+### Implementation of
+
+```ts
+ApiReportable.onFailure
+```
+
+***
+
+### onSuccess()
+
+```ts
+onSuccess(response, depth?): void;
+```
+
+### Parameters
+
+#### response
+
+`ApiResponse`
+
+#### depth?
+
+`number` = `0`
+
+### Returns
+
+`void`
+
+### Implementation of
+
+```ts
+ApiReportable.onSuccess
+```
+
+***
+
+### deleteEndpoint()
+
+### Call Signature
+
+```ts
+protected deleteEndpoint<T>(endPoint?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+### Call Signature
+
+```ts
+protected deleteEndpoint<T>(endPoint?, responseType?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+### Call Signature
+
+```ts
+protected deleteEndpoint<T>(endPoint?, responseType?): Promise<ApiResponseTuple<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`T`\>\>
+
+***
+
+### getEndpoint()
+
+### Call Signature
+
+```ts
+protected getEndpoint<T>(endPoint?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+### Call Signature
+
+```ts
+protected getEndpoint<T>(endPoint?, responseType?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+### Call Signature
+
+```ts
+protected getEndpoint<T>(endPoint?, responseType?): Promise<ApiResponseTuple<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`T`\>\>
+
+***
+
+### handleMonitorResponseError()
+
+```ts
+protected handleMonitorResponseError<T>(error, trapAxiosException): ApiResponse<ApiEnvelope<T>> | undefined;
+```
+
+### Type Parameters
+
+#### T
+
+`T`
+
+### Parameters
+
+#### error
+
+`ApiError`
+
+#### trapAxiosException
+
+`boolean`
+
+### Returns
+
+`ApiResponse`\<`ApiEnvelope`\<`T`\>\> \| `undefined`
+
+***
+
+### monitorResponse()
+
+```ts
+protected monitorResponse<T>(closure): Promise<ApiResponse<ApiEnvelope<T>> | undefined>;
+```
+
+### Type Parameters
+
+#### T
+
+`T`
+
+### Parameters
+
+#### closure
+
+() => `Promise`\<`ApiResponse`\<`ApiEnvelope`\<`T`\>\>\>
+
+### Returns
+
+`Promise`\<`ApiResponse`\<`ApiEnvelope`\<`T`\>\> \| `undefined`\>
+
+***
+
+### postEndpoint()
+
+### Call Signature
+
+```ts
+protected postEndpoint<T, D>(endPoint?, data?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### data?
+
+`D`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+### Call Signature
+
+```ts
+protected postEndpoint<T, D>(
+   endPoint?, 
+   data?, 
+responseType?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### data?
+
+`D`
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+### Call Signature
+
+```ts
+protected postEndpoint<T, D>(
+   endPoint?, 
+   data?, 
+responseType?): Promise<ApiResponseTuple<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### data?
+
+`D`
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`T`\>\>
+
+***
+
+### putEndpoint()
+
+### Call Signature
+
+```ts
+protected putEndpoint<T, D>(endPoint?, data?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### data?
+
+`D`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+### Call Signature
+
+```ts
+protected putEndpoint<T, D>(
+   endPoint?, 
+   data?, 
+responseType?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### data?
+
+`D`
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+### Call Signature
+
+```ts
+protected putEndpoint<T, D>(
+   endPoint?, 
+   data?, 
+responseType?): Promise<ApiResponseTuple<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### data?
+
+`D`
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`T`\>\>
+
+            ### <a id="ApiSimple"></a>ApiSimple
+
+[**@xyo-network/api**](#../README)
+
+***
+
+## Extends
+
+- [`ApiBase`](#ApiBase)\<`C`\>
+
+## Extended by
+
+- [`ArchivistApi`](#ArchivistApi)
+
+## Type Parameters
+
+### T
+
+`T` = `Payload`
+
+### D
+
+`D` = `T`
+
+### Q
+
+`Q` *extends* [`ApiSimpleQuery`](#../type-aliases/ApiSimpleQuery) = [`ApiSimpleQuery`](#../type-aliases/ApiSimpleQuery)
+
+### C
+
+`C` *extends* `ApiConfig` = `ApiConfig`
+
+## Constructors
+
+### Constructor
+
+```ts
+new ApiSimple<T, D, Q, C>(config): ApiSimple<T, D, Q, C>;
+```
+
+### Parameters
+
+#### config
+
+`C`
+
+### Returns
+
+`ApiSimple`\<`T`, `D`, `Q`, `C`\>
+
+### Inherited from
+
+[`ApiBase`](#ApiBase).[`constructor`](ApiBase.md#constructor)
+
+## Properties
+
+### config
+
+```ts
+readonly config: C;
+```
+
+### Inherited from
+
+[`ApiBase`](#ApiBase).[`config`](ApiBase.md#config)
+
+***
+
+### axios
+
+```ts
+protected axios: Axios;
+```
+
+### Inherited from
+
+[`ApiBase`](#ApiBase).[`axios`](ApiBase.md#axios)
+
+## Accessors
+
+### authenticated
+
+### Get Signature
+
+```ts
+get authenticated(): boolean;
+```
+
+#### Returns
+
+`boolean`
+
+### Inherited from
+
+[`ApiBase`](#ApiBase).[`authenticated`](ApiBase.md#authenticated)
+
+***
+
+### headers
+
+### Get Signature
+
+```ts
+get protected headers(): Record<string, string>;
+```
+
+#### Returns
+
+`Record`\<`string`, `string`\>
+
+### Inherited from
+
+[`ApiBase`](#ApiBase).[`headers`](ApiBase.md#headers)
+
+***
+
+### query
+
+### Get Signature
+
+```ts
+get protected query(): string;
+```
+
+#### Returns
+
+`string`
+
+### Inherited from
+
+[`ApiBase`](#ApiBase).[`query`](ApiBase.md#query)
+
+***
+
+### root
+
+### Get Signature
+
+```ts
+get protected root(): string;
+```
+
+#### Returns
+
+`string`
+
+### Inherited from
+
+[`ApiBase`](#ApiBase).[`root`](ApiBase.md#root)
+
+## Methods
+
+### onError()
+
+```ts
+onError(error, depth?): void;
+```
+
+### Parameters
+
+#### error
+
+`ApiError`
+
+#### depth?
+
+`number` = `0`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+[`ApiBase`](#ApiBase).[`onError`](ApiBase.md#onerror)
+
+***
+
+### onFailure()
+
+```ts
+onFailure(response, depth?): void;
+```
+
+### Parameters
+
+#### response
+
+`ApiResponse`
+
+#### depth?
+
+`number` = `0`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+[`ApiBase`](#ApiBase).[`onFailure`](ApiBase.md#onfailure)
+
+***
+
+### onSuccess()
+
+```ts
+onSuccess(response, depth?): void;
+```
+
+### Parameters
+
+#### response
+
+`ApiResponse`
+
+#### depth?
+
+`number` = `0`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+[`ApiBase`](#ApiBase).[`onSuccess`](ApiBase.md#onsuccess)
+
+***
+
+### deleteEndpoint()
+
+### Call Signature
+
+```ts
+protected deleteEndpoint<T>(endPoint?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiBase`](#ApiBase).[`deleteEndpoint`](ApiBase.md#deleteendpoint)
+
+### Call Signature
+
+```ts
+protected deleteEndpoint<T>(endPoint?, responseType?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiBase`](#ApiBase).[`deleteEndpoint`](ApiBase.md#deleteendpoint)
+
+### Call Signature
+
+```ts
+protected deleteEndpoint<T>(endPoint?, responseType?): Promise<ApiResponseTuple<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiBase`](#ApiBase).[`deleteEndpoint`](ApiBase.md#deleteendpoint)
+
+***
+
+### getEndpoint()
+
+### Call Signature
+
+```ts
+protected getEndpoint<T>(endPoint?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiBase`](#ApiBase).[`getEndpoint`](ApiBase.md#getendpoint)
+
+### Call Signature
+
+```ts
+protected getEndpoint<T>(endPoint?, responseType?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiBase`](#ApiBase).[`getEndpoint`](ApiBase.md#getendpoint)
+
+### Call Signature
+
+```ts
+protected getEndpoint<T>(endPoint?, responseType?): Promise<ApiResponseTuple<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiBase`](#ApiBase).[`getEndpoint`](ApiBase.md#getendpoint)
+
+***
+
+### handleMonitorResponseError()
+
+```ts
+protected handleMonitorResponseError<T>(error, trapAxiosException): ApiResponse<ApiEnvelope<T>> | undefined;
+```
+
+### Type Parameters
+
+#### T
+
+`T`
+
+### Parameters
+
+#### error
+
+`ApiError`
+
+#### trapAxiosException
+
+`boolean`
+
+### Returns
+
+`ApiResponse`\<`ApiEnvelope`\<`T`\>\> \| `undefined`
+
+### Inherited from
+
+[`ApiBase`](#ApiBase).[`handleMonitorResponseError`](ApiBase.md#handlemonitorresponseerror)
+
+***
+
+### monitorResponse()
+
+```ts
+protected monitorResponse<T>(closure): Promise<ApiResponse<ApiEnvelope<T>> | undefined>;
+```
+
+### Type Parameters
+
+#### T
+
+`T`
+
+### Parameters
+
+#### closure
+
+() => `Promise`\<`ApiResponse`\<`ApiEnvelope`\<`T`\>\>\>
+
+### Returns
+
+`Promise`\<`ApiResponse`\<`ApiEnvelope`\<`T`\>\> \| `undefined`\>
+
+### Inherited from
+
+[`ApiBase`](#ApiBase).[`monitorResponse`](ApiBase.md#monitorresponse)
+
+***
+
+### postEndpoint()
+
+### Call Signature
+
+```ts
+protected postEndpoint<T, D>(endPoint?, data?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### data?
+
+`D`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiBase`](#ApiBase).[`postEndpoint`](ApiBase.md#postendpoint)
+
+### Call Signature
+
+```ts
+protected postEndpoint<T, D>(
+   endPoint?, 
+   data?, 
+responseType?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### data?
+
+`D`
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiBase`](#ApiBase).[`postEndpoint`](ApiBase.md#postendpoint)
+
+### Call Signature
+
+```ts
+protected postEndpoint<T, D>(
+   endPoint?, 
+   data?, 
+responseType?): Promise<ApiResponseTuple<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### data?
+
+`D`
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiBase`](#ApiBase).[`postEndpoint`](ApiBase.md#postendpoint)
+
+***
+
+### putEndpoint()
+
+### Call Signature
+
+```ts
+protected putEndpoint<T, D>(endPoint?, data?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### data?
+
+`D`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiBase`](#ApiBase).[`putEndpoint`](ApiBase.md#putendpoint)
+
+### Call Signature
+
+```ts
+protected putEndpoint<T, D>(
+   endPoint?, 
+   data?, 
+responseType?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### data?
+
+`D`
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiBase`](#ApiBase).[`putEndpoint`](ApiBase.md#putendpoint)
+
+### Call Signature
+
+```ts
+protected putEndpoint<T, D>(
+   endPoint?, 
+   data?, 
+responseType?): Promise<ApiResponseTuple<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### data?
+
+`D`
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiBase`](#ApiBase).[`putEndpoint`](ApiBase.md#putendpoint)
+
+***
+
+### delete()
+
+### Call Signature
+
+```ts
+delete(): Promise<ApiResponseBody<T>>;
+```
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+### Call Signature
+
+```ts
+delete(responseType?): Promise<ApiResponseBody<T>>;
+```
+
+#### Parameters
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+### Call Signature
+
+```ts
+delete(responseType?): Promise<ApiResponseTuple<T>>;
+```
+
+#### Parameters
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`T`\>\>
+
+***
+
+### find()
+
+### Call Signature
+
+```ts
+find(query?): Promise<ApiResponseBody<T>>;
+```
+
+#### Parameters
+
+##### query?
+
+`Q`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+### Call Signature
+
+```ts
+find(query?, responseType?): Promise<ApiResponseBody<T>>;
+```
+
+#### Parameters
+
+##### query?
+
+`Q`
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+### Call Signature
+
+```ts
+find(query?, responseType?): Promise<ApiResponseTuple<T>>;
+```
+
+#### Parameters
+
+##### query?
+
+`Q`
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`T`\>\>
+
+***
+
+### get()
+
+### Call Signature
+
+```ts
+get(): Promise<ApiResponseBody<T>>;
+```
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+### Call Signature
+
+```ts
+get(responseType?): Promise<ApiResponseBody<T>>;
+```
+
+#### Parameters
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+### Call Signature
+
+```ts
+get(responseType?): Promise<ApiResponseTuple<T>>;
+```
+
+#### Parameters
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`T`\>\>
+
+***
+
+### post()
+
+### Call Signature
+
+```ts
+post(data?): Promise<ApiResponseBody<T>>;
+```
+
+#### Parameters
+
+##### data?
+
+`D`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+### Call Signature
+
+```ts
+post(data?, responseType?): Promise<ApiResponseBody<T>>;
+```
+
+#### Parameters
+
+##### data?
+
+`D`
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+### Call Signature
+
+```ts
+post(data?, responseType?): Promise<ApiResponseTuple<T>>;
+```
+
+#### Parameters
+
+##### data?
+
+`D`
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`T`\>\>
+
+***
+
+### put()
+
+### Call Signature
+
+```ts
+put(data?): Promise<ApiResponseBody<T>>;
+```
+
+#### Parameters
+
+##### data?
+
+`D`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+### Call Signature
+
+```ts
+put(data?, responseType?): Promise<ApiResponseBody<T>>;
+```
+
+#### Parameters
+
+##### data?
+
+`D`
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+### Call Signature
+
+```ts
+put(data?, responseType?): Promise<ApiResponseTuple<T>>;
+```
+
+#### Parameters
+
+##### data?
+
+`D`
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`T`\>\>
+
+            ### <a id="ArchivistApi"></a>ArchivistApi
+
+[**@xyo-network/api**](#../README)
+
+***
+
+## Extends
+
+- [`ApiSimple`](#ApiSimple)\<`Payload`[], `C`\>
+
+## Type Parameters
+
+### C
+
+`C` *extends* `ApiConfig` = `ApiConfig`
+
+## Constructors
+
+### Constructor
+
+```ts
+new ArchivistApi<C>(config): ArchivistApi<C>;
+```
+
+### Parameters
+
+#### config
+
+`ApiConfig`
+
+### Returns
+
+`ArchivistApi`\<`C`\>
+
+### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`constructor`](ApiSimple.md#constructor)
+
+## Properties
+
+### config
+
+```ts
+readonly config: ApiConfig;
+```
+
+### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`config`](ApiSimple.md#config)
+
+***
+
+### axios
+
+```ts
+protected axios: Axios;
+```
+
+### Inherited from
+
+[`ApiBase`](#ApiBase).[`axios`](ApiBase.md#axios)
+
+## Accessors
+
+### authenticated
+
+### Get Signature
+
+```ts
+get authenticated(): boolean;
+```
+
+#### Returns
+
+`boolean`
+
+### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`authenticated`](ApiSimple.md#authenticated)
+
+***
+
+### headers
+
+### Get Signature
+
+```ts
+get protected headers(): Record<string, string>;
+```
+
+#### Returns
+
+`Record`\<`string`, `string`\>
+
+### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`headers`](ApiSimple.md#headers)
+
+***
+
+### query
+
+### Get Signature
+
+```ts
+get protected query(): string;
+```
+
+#### Returns
+
+`string`
+
+### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`query`](ApiSimple.md#query)
+
+***
+
+### root
+
+### Get Signature
+
+```ts
+get protected root(): string;
+```
+
+#### Returns
+
+`string`
+
+### Inherited from
+
+[`ApiBase`](#ApiBase).[`root`](ApiBase.md#root)
+
+## Methods
+
+### huri()
+
+```ts
+huri(huri): ApiSimple<Payload, Payload, PayloadFindFilter, ApiConfig>;
+```
+
+### Parameters
+
+#### huri
+
+`string` \| `Huri`\<`Payload`\>
+
+### Returns
+
+[`ApiSimple`](#ApiSimple)\<`Payload`, `Payload`, `PayloadFindFilter`, `ApiConfig`\>
+
+***
+
+### onError()
+
+```ts
+onError(error, depth?): void;
+```
+
+### Parameters
+
+#### error
+
+`ApiError`
+
+#### depth?
+
+`number` = `0`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`onError`](ApiSimple.md#onerror)
+
+***
+
+### onFailure()
+
+```ts
+onFailure(response, depth?): void;
+```
+
+### Parameters
+
+#### response
+
+`ApiResponse`
+
+#### depth?
+
+`number` = `0`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`onFailure`](ApiSimple.md#onfailure)
+
+***
+
+### onSuccess()
+
+```ts
+onSuccess(response, depth?): void;
+```
+
+### Parameters
+
+#### response
+
+`ApiResponse`
+
+#### depth?
+
+`number` = `0`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`onSuccess`](ApiSimple.md#onsuccess)
+
+***
+
+### deleteEndpoint()
+
+### Call Signature
+
+```ts
+protected deleteEndpoint<T>(endPoint?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`deleteEndpoint`](ApiSimple.md#deleteendpoint)
+
+### Call Signature
+
+```ts
+protected deleteEndpoint<T>(endPoint?, responseType?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`deleteEndpoint`](ApiSimple.md#deleteendpoint)
+
+### Call Signature
+
+```ts
+protected deleteEndpoint<T>(endPoint?, responseType?): Promise<ApiResponseTuple<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`deleteEndpoint`](ApiSimple.md#deleteendpoint)
+
+***
+
+### getEndpoint()
+
+### Call Signature
+
+```ts
+protected getEndpoint<T>(endPoint?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`getEndpoint`](ApiSimple.md#getendpoint)
+
+### Call Signature
+
+```ts
+protected getEndpoint<T>(endPoint?, responseType?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`getEndpoint`](ApiSimple.md#getendpoint)
+
+### Call Signature
+
+```ts
+protected getEndpoint<T>(endPoint?, responseType?): Promise<ApiResponseTuple<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`getEndpoint`](ApiSimple.md#getendpoint)
+
+***
+
+### handleMonitorResponseError()
+
+```ts
+protected handleMonitorResponseError<T>(error, trapAxiosException): ApiResponse<ApiEnvelope<T>> | undefined;
+```
+
+### Type Parameters
+
+#### T
+
+`T`
+
+### Parameters
+
+#### error
+
+`ApiError`
+
+#### trapAxiosException
+
+`boolean`
+
+### Returns
+
+`ApiResponse`\<`ApiEnvelope`\<`T`\>\> \| `undefined`
+
+### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`handleMonitorResponseError`](ApiSimple.md#handlemonitorresponseerror)
+
+***
+
+### monitorResponse()
+
+```ts
+protected monitorResponse<T>(closure): Promise<ApiResponse<ApiEnvelope<T>> | undefined>;
+```
+
+### Type Parameters
+
+#### T
+
+`T`
+
+### Parameters
+
+#### closure
+
+() => `Promise`\<`ApiResponse`\<`ApiEnvelope`\<`T`\>\>\>
+
+### Returns
+
+`Promise`\<`ApiResponse`\<`ApiEnvelope`\<`T`\>\> \| `undefined`\>
+
+### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`monitorResponse`](ApiSimple.md#monitorresponse)
+
+***
+
+### postEndpoint()
+
+### Call Signature
+
+```ts
+protected postEndpoint<T, D>(endPoint?, data?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### data?
+
+`D`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`postEndpoint`](ApiSimple.md#postendpoint)
+
+### Call Signature
+
+```ts
+protected postEndpoint<T, D>(
+   endPoint?, 
+   data?, 
+responseType?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### data?
+
+`D`
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`postEndpoint`](ApiSimple.md#postendpoint)
+
+### Call Signature
+
+```ts
+protected postEndpoint<T, D>(
+   endPoint?, 
+   data?, 
+responseType?): Promise<ApiResponseTuple<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### data?
+
+`D`
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`postEndpoint`](ApiSimple.md#postendpoint)
+
+***
+
+### putEndpoint()
+
+### Call Signature
+
+```ts
+protected putEndpoint<T, D>(endPoint?, data?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### data?
+
+`D`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`putEndpoint`](ApiSimple.md#putendpoint)
+
+### Call Signature
+
+```ts
+protected putEndpoint<T, D>(
+   endPoint?, 
+   data?, 
+responseType?): Promise<ApiResponseBody<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### data?
+
+`D`
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`putEndpoint`](ApiSimple.md#putendpoint)
+
+### Call Signature
+
+```ts
+protected putEndpoint<T, D>(
+   endPoint?, 
+   data?, 
+responseType?): Promise<ApiResponseTuple<T>>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+##### D
+
+`D` = `unknown`
+
+#### Parameters
+
+##### endPoint?
+
+`string`
+
+##### data?
+
+`D`
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`T`\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`putEndpoint`](ApiSimple.md#putendpoint)
+
+***
+
+### delete()
+
+### Call Signature
+
+```ts
+delete(): Promise<ApiResponseBody<Payload[]>>;
+```
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`Payload`[]\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`delete`](ApiSimple.md#delete)
+
+### Call Signature
+
+```ts
+delete(responseType?): Promise<ApiResponseBody<Payload[]>>;
+```
+
+#### Parameters
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`Payload`[]\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`delete`](ApiSimple.md#delete)
+
+### Call Signature
+
+```ts
+delete(responseType?): Promise<ApiResponseTuple<Payload[]>>;
+```
+
+#### Parameters
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`Payload`[]\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`delete`](ApiSimple.md#delete)
+
+***
+
+### find()
+
+### Call Signature
+
+```ts
+find(query?): Promise<ApiResponseBody<Payload[]>>;
+```
+
+#### Parameters
+
+##### query?
+
+`PayloadFindFilter`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`Payload`[]\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`find`](ApiSimple.md#find)
+
+### Call Signature
+
+```ts
+find(query?, responseType?): Promise<ApiResponseBody<Payload[]>>;
+```
+
+#### Parameters
+
+##### query?
+
+`PayloadFindFilter`
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`Payload`[]\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`find`](ApiSimple.md#find)
+
+### Call Signature
+
+```ts
+find(query?, responseType?): Promise<ApiResponseTuple<Payload[]>>;
+```
+
+#### Parameters
+
+##### query?
+
+`PayloadFindFilter`
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`Payload`[]\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`find`](ApiSimple.md#find)
+
+***
+
+### get()
+
+### Call Signature
+
+```ts
+get(): Promise<ApiResponseBody<Payload[]>>;
+```
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`Payload`[]\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`get`](ApiSimple.md#get)
+
+### Call Signature
+
+```ts
+get(responseType?): Promise<ApiResponseBody<Payload[]>>;
+```
+
+#### Parameters
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`Payload`[]\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`get`](ApiSimple.md#get)
+
+### Call Signature
+
+```ts
+get(responseType?): Promise<ApiResponseTuple<Payload[]>>;
+```
+
+#### Parameters
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`Payload`[]\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`get`](ApiSimple.md#get)
+
+***
+
+### post()
+
+### Call Signature
+
+```ts
+post(data?): Promise<ApiResponseBody<Payload[]>>;
+```
+
+#### Parameters
+
+##### data?
+
+`C`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`Payload`[]\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`post`](ApiSimple.md#post)
+
+### Call Signature
+
+```ts
+post(data?, responseType?): Promise<ApiResponseBody<Payload[]>>;
+```
+
+#### Parameters
+
+##### data?
+
+`C`
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`Payload`[]\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`post`](ApiSimple.md#post)
+
+### Call Signature
+
+```ts
+post(data?, responseType?): Promise<ApiResponseTuple<Payload[]>>;
+```
+
+#### Parameters
+
+##### data?
+
+`C`
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`Payload`[]\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`post`](ApiSimple.md#post)
+
+***
+
+### put()
+
+### Call Signature
+
+```ts
+put(data?): Promise<ApiResponseBody<Payload[]>>;
+```
+
+#### Parameters
+
+##### data?
+
+`C`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`Payload`[]\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`put`](ApiSimple.md#put)
+
+### Call Signature
+
+```ts
+put(data?, responseType?): Promise<ApiResponseBody<Payload[]>>;
+```
+
+#### Parameters
+
+##### data?
+
+`C`
+
+##### responseType?
+
+`"body"`
+
+#### Returns
+
+`Promise`\<`ApiResponseBody`\<`Payload`[]\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`put`](ApiSimple.md#put)
+
+### Call Signature
+
+```ts
+put(data?, responseType?): Promise<ApiResponseTuple<Payload[]>>;
+```
+
+#### Parameters
+
+##### data?
+
+`C`
+
+##### responseType?
+
+`"tuple"`
+
+#### Returns
+
+`Promise`\<`ApiResponseTuple`\<`Payload`[]\>\>
+
+#### Inherited from
+
+[`ApiSimple`](#ApiSimple).[`put`](ApiSimple.md#put)
+
+            ### <a id="LocationDivinerApi"></a>LocationDivinerApi
+
+[**@xyo-network/api**](#../README)
+
+***
+
+## Constructors
+
+### Constructor
+
+```ts
+new LocationDivinerApi(config): LocationDivinerApi;
+```
+
+### Parameters
+
+#### config
+
+`ApiConfig`
+
+### Returns
+
+`LocationDivinerApi`
+
+## Properties
+
+### config
+
+```ts
+config: ApiConfig;
+```
+
+## Methods
+
+### getLocationQuery()
+
+```ts
+getLocationQuery(hash): Promise<GetLocationQueryResponse>;
+```
+
+### Parameters
+
+#### hash
+
+`string`
+
+### Returns
+
+`Promise`\<[`GetLocationQueryResponse`](#../interfaces/GetLocationQueryResponse)\>
+
+***
+
+### postLocationQuery()
+
+```ts
+postLocationQuery(request): Promise<LocationQueryCreationResponse>;
+```
+
+### Parameters
+
+#### request
+
+[`SupportedLocationQueryCreationRequest`](#../type-aliases/SupportedLocationQueryCreationRequest)
+
+### Returns
+
+`Promise`\<[`LocationQueryCreationResponse`](#../interfaces/LocationQueryCreationResponse)\>
+
+            ### <a id="RemoteDivinerError"></a>RemoteDivinerError
+
+[**@xyo-network/api**](#../README)
+
+***
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+```ts
+new RemoteDivinerError(
+   action, 
+   error, 
+   message?): RemoteDivinerError;
+```
+
+### Parameters
+
+#### action
+
+`string`
+
+#### error
+
+`unknown`
+
+#### message?
+
+`string`
+
+### Returns
+
+`RemoteDivinerError`
+
+### Overrides
+
+```ts
+Error.constructor
+```
+
+## Properties
+
+### isRemoteDivinerError
+
+```ts
+isRemoteDivinerError: boolean = true;
+```
+
+## Methods
+
+### isRemoteDivinerError()
+
+```ts
+static isRemoteDivinerError(error): RemoteDivinerError | undefined;
+```
+
+### Parameters
+
+#### error
+
+`unknown`
+
+### Returns
+
+`RemoteDivinerError` \| `undefined`
+
+          ### functions
+
+            ### <a id="isLocationHeatmapQuery"></a>isLocationHeatmapQuery
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+function isLocationHeatmapQuery(query): query is LocationHeatmapQuery;
+```
+
+## Parameters
+
+### query
+
+`Record`\<`string`, `unknown`\>
+
+## Returns
+
+`query is LocationHeatmapQuery`
+
+            ### <a id="isLocationQuadkeyHeatmapQuery"></a>isLocationQuadkeyHeatmapQuery
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+function isLocationQuadkeyHeatmapQuery(query): query is LocationQuadkeyHeatmapQuery;
+```
+
+## Parameters
+
+### query
+
+`Record`\<`string`, `unknown`\>
+
+## Returns
+
+`query is LocationQuadkeyHeatmapQuery`
+
+            ### <a id="isSupportedLocationQuerySchema"></a>isSupportedLocationQuerySchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+function isSupportedLocationQuerySchema(schema): schema is LocationQuerySchema;
+```
+
+## Parameters
+
+### schema
+
+`Schema`
+
+## Returns
+
+`schema is LocationQuerySchema`
+
+          ### interfaces
+
+            ### <a id="ArchivePath"></a>ArchivePath
+
+[**@xyo-network/api**](#../README)
+
+***
+
+## Properties
+
+### archive
+
+```ts
+archive: string;
+```
+
+            ### <a id="Coordinates"></a>Coordinates
+
+[**@xyo-network/api**](#../README)
+
+***
+
+## Properties
+
+### accuracy
+
+```ts
+accuracy: number | null;
+```
+
+***
+
+### altitude
+
+```ts
+altitude: number | null;
+```
+
+***
+
+### altitudeAccuracy
+
+```ts
+altitudeAccuracy: number | null;
+```
+
+***
+
+### heading
+
+```ts
+heading: number | null;
+```
+
+***
+
+### latitude
+
+```ts
+latitude: number;
+```
+
+***
+
+### longitude
+
+```ts
+longitude: number;
+```
+
+***
+
+### speed
+
+```ts
+speed: number | null;
+```
+
+            ### <a id="CurrentLocation"></a>CurrentLocation
+
+[**@xyo-network/api**](#../README)
+
+***
+
+## Properties
+
+### coords
+
+```ts
+coords: Coordinates;
+```
+
+***
+
+### timestamp
+
+```ts
+timestamp: number;
+```
+
+            ### <a id="GetLocationQueryResponse"></a>GetLocationQueryResponse
+
+[**@xyo-network/api**](#../README)
+
+***
+
+## Properties
+
+### answerHash?
+
+```ts
+optional answerHash?: string;
+```
+
+***
+
+### queryHash
+
+```ts
+queryHash: string;
+```
+
+            ### <a id="LocationHeatmapPointProperties"></a>LocationHeatmapPointProperties
+
+[**@xyo-network/api**](#../README)
+
+***
+
+## Properties
+
+### hash
+
+```ts
+hash: string;
+```
+
+***
+
+### value
+
+```ts
+value: number;
+```
+
+            ### <a id="LocationQueryCreationRequest"></a>LocationQueryCreationRequest
+
+[**@xyo-network/api**](#../README)
+
+***
+
+## Extended by
+
+- [`LocationQueryCreationResponse`](#LocationQueryCreationResponse)
+
+## Type Parameters
+
+### TSchema
+
+`TSchema` *extends* [`LocationQuerySchema`](#../type-aliases/LocationQuerySchema) = [`LocationQuerySchema`](#../type-aliases/LocationQuerySchema)
+
+### TQuery
+
+`TQuery` *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\>
+
+## Properties
+
+### query
+
+```ts
+query: TQuery;
+```
+
+***
+
+### resultArchive
+
+```ts
+resultArchive: string;
+```
+
+***
+
+### resultArchivist
+
+```ts
+resultArchivist: ApiConfig;
+```
+
+***
+
+### schema
+
+```ts
+schema: TSchema;
+```
+
+***
+
+### sourceArchive
+
+```ts
+sourceArchive: string;
+```
+
+***
+
+### sourceArchivist
+
+```ts
+sourceArchivist: ApiConfig;
+```
+
+            ### <a id="LocationQueryCreationResponse"></a>LocationQueryCreationResponse
+
+[**@xyo-network/api**](#../README)
+
+***
+
+## Extends
+
+- [`LocationQueryCreationRequest`](#LocationQueryCreationRequest)
+
+## Properties
+
+### query
+
+```ts
+query: TQuery;
+```
+
+### Inherited from
+
+[`LocationQueryCreationRequest`](#LocationQueryCreationRequest).[`query`](LocationQueryCreationRequest.md#query)
+
+***
+
+### resultArchive
+
+```ts
+resultArchive: string;
+```
+
+### Inherited from
+
+[`LocationQueryCreationRequest`](#LocationQueryCreationRequest).[`resultArchive`](LocationQueryCreationRequest.md#resultarchive)
+
+***
+
+### resultArchivist
+
+```ts
+resultArchivist: ApiConfig;
+```
+
+### Inherited from
+
+[`LocationQueryCreationRequest`](#LocationQueryCreationRequest).[`resultArchivist`](LocationQueryCreationRequest.md#resultarchivist)
+
+***
+
+### schema
+
+```ts
+schema: LocationQuerySchema;
+```
+
+### Inherited from
+
+[`LocationQueryCreationRequest`](#LocationQueryCreationRequest).[`schema`](LocationQueryCreationRequest.md#schema)
+
+***
+
+### sourceArchive
+
+```ts
+sourceArchive: string;
+```
+
+### Inherited from
+
+[`LocationQueryCreationRequest`](#LocationQueryCreationRequest).[`sourceArchive`](LocationQueryCreationRequest.md#sourcearchive)
+
+***
+
+### sourceArchivist
+
+```ts
+sourceArchivist: ApiConfig;
+```
+
+### Inherited from
+
+[`LocationQueryCreationRequest`](#LocationQueryCreationRequest).[`sourceArchivist`](LocationQueryCreationRequest.md#sourcearchivist)
+
+***
+
+### hash
+
+```ts
+hash: string;
+```
+
+            ### <a id="LocationTimeRangePointProperties"></a>LocationTimeRangePointProperties
+
+[**@xyo-network/api**](#../README)
+
+***
+
+## Properties
+
+### \_archive
+
+```ts
+_archive: string;
+```
+
+***
+
+### \_client
+
+```ts
+_client: string;
+```
+
+***
+
+### \_timestamp
+
+```ts
+_timestamp: number;
+```
+
+***
+
+### schema
+
+```ts
+schema: "network.xyo.location" & object;
+```
+
+### Type Declaration
+
+#### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+          ### type-aliases
+
+            ### <a id="ApiSimpleQuery"></a>ApiSimpleQuery
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type ApiSimpleQuery = PayloadFindFilter;
+```
+
+            ### <a id="CurrentLocationWitnessPayload"></a>CurrentLocationWitnessPayload
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type CurrentLocationWitnessPayload = Payload<{
+  altitudeMeters: number;
+  directionDegrees: number;
+  latitude: number;
+  longitude: number;
+  quadkey: string;
+  schema: CurrentLocationWitnessSchema;
+  speedKph: number;
+}>;
+```
+
+            ### <a id="CurrentLocationWitnessSchema"></a>CurrentLocationWitnessSchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type CurrentLocationWitnessSchema = typeof CurrentLocationWitnessSchema;
+```
+
+            ### <a id="LocationHeatmapAnswerSchema"></a>LocationHeatmapAnswerSchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type LocationHeatmapAnswerSchema = typeof LocationHeatmapAnswerSchema;
+```
+
+            ### <a id="LocationHeatmapQuery"></a>LocationHeatmapQuery
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type LocationHeatmapQuery = object;
+```
+
+## Properties
+
+### schema
+
+```ts
+schema: LocationWitnessSchema;
+```
+
+***
+
+### startTime?
+
+```ts
+optional startTime?: string;
+```
+
+***
+
+### stopTime?
+
+```ts
+optional stopTime?: string;
+```
+
+            ### <a id="LocationHeatmapQueryCreationRequest"></a>LocationHeatmapQueryCreationRequest
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type LocationHeatmapQueryCreationRequest = LocationQueryCreationRequest<LocationHeatmapQuerySchema, LocationHeatmapQuery>;
+```
+
+            ### <a id="LocationHeatmapQuerySchema"></a>LocationHeatmapQuerySchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type LocationHeatmapQuerySchema = typeof LocationHeatmapQuerySchema;
+```
+
+            ### <a id="LocationQuadkeyHeatmapAnswerSchema"></a>LocationQuadkeyHeatmapAnswerSchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type LocationQuadkeyHeatmapAnswerSchema = typeof LocationQuadkeyHeatmapAnswerSchema;
+```
+
+            ### <a id="LocationQuadkeyHeatmapQuery"></a>LocationQuadkeyHeatmapQuery
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type LocationQuadkeyHeatmapQuery = object;
+```
+
+## Properties
+
+### schema
+
+```ts
+schema: LocationWitnessSchema;
+```
+
+***
+
+### startTime?
+
+```ts
+optional startTime?: string;
+```
+
+***
+
+### stopTime?
+
+```ts
+optional stopTime?: string;
+```
+
+            ### <a id="LocationQuadkeyHeatmapQueryCreationRequest"></a>LocationQuadkeyHeatmapQueryCreationRequest
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type LocationQuadkeyHeatmapQueryCreationRequest = LocationQueryCreationRequest<LocationQuadkeyHeatmapQuerySchema, LocationQuadkeyHeatmapQuery>;
+```
+
+            ### <a id="LocationQuadkeyHeatmapQuerySchema"></a>LocationQuadkeyHeatmapQuerySchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type LocationQuadkeyHeatmapQuerySchema = typeof LocationQuadkeyHeatmapQuerySchema;
+```
+
+            ### <a id="LocationQuerySchema"></a>LocationQuerySchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type LocationQuerySchema = 
+  | LocationQuadkeyHeatmapQuerySchema
+  | LocationHeatmapQuerySchema
+  | LocationTimeRangeQuerySchema;
+```
+
+            ### <a id="LocationTimeRangeAnswerSchema"></a>LocationTimeRangeAnswerSchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type LocationTimeRangeAnswerSchema = typeof LocationTimeRangeAnswerSchema;
+```
+
+            ### <a id="LocationTimeRangeQuery"></a>LocationTimeRangeQuery
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type LocationTimeRangeQuery = object;
+```
+
+## Properties
+
+### schema
+
+```ts
+schema: LocationWitnessSchema;
+```
+
+***
+
+### startTime?
+
+```ts
+optional startTime?: string;
+```
+
+***
+
+### stopTime?
+
+```ts
+optional stopTime?: string;
+```
+
+            ### <a id="LocationTimeRangeQueryCreationRequest"></a>LocationTimeRangeQueryCreationRequest
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type LocationTimeRangeQueryCreationRequest = LocationQueryCreationRequest<LocationTimeRangeQuerySchema, LocationTimeRangeQuery>;
+```
+
+            ### <a id="LocationTimeRangeQuerySchema"></a>LocationTimeRangeQuerySchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type LocationTimeRangeQuerySchema = typeof LocationTimeRangeQuerySchema;
+```
+
+            ### <a id="LocationWitnessPayload"></a>LocationWitnessPayload
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type LocationWitnessPayload = Payload<{
+  currentLocation: CurrentLocation;
+  schema: LocationWitnessSchema;
+}>;
+```
+
+            ### <a id="LocationWitnessSchema"></a>LocationWitnessSchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type LocationWitnessSchema = typeof LocationWitnessSchema;
+```
+
+            ### <a id="RemoteDivinerConfig"></a>RemoteDivinerConfig
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type RemoteDivinerConfig = DivinerConfig & object;
+```
+
+## Type Declaration
+
+### ~~api?~~
+
+```ts
+optional api?: ArchivistApi;
+```
+
+### Deprecated
+
+use in params instead
+
+### archive?
+
+```ts
+optional archive?: string;
+```
+
+### schema
+
+```ts
+schema: RemoteDivinerConfigSchema;
+```
+
+            ### <a id="RemoteDivinerConfigSchema"></a>RemoteDivinerConfigSchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type RemoteDivinerConfigSchema = typeof RemoteDivinerConfigSchema;
+```
+
+            ### <a id="SupportedLocationQueryCreationRequest"></a>SupportedLocationQueryCreationRequest
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type SupportedLocationQueryCreationRequest = 
+  | LocationTimeRangeQueryCreationRequest
+  | LocationHeatmapQueryCreationRequest
+  | LocationQuadkeyHeatmapQueryCreationRequest;
+```
+
+            ### <a id="WithArchive"></a>WithArchive
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+type WithArchive<ArchivistApiConfig> = ArchivistApiConfig & object;
+```
+
+## Type Declaration
+
+### \_archive?
+
+```ts
+optional _archive?: string;
+```
+
+## Type Parameters
+
+### ArchivistApiConfig
+
+`ArchivistApiConfig`
+
+          ### variables
+
+            ### <a id="CurrentLocationWitnessSchema"></a>CurrentLocationWitnessSchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+const CurrentLocationWitnessSchema: "co.coinapp.currentlocationwitness" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+            ### <a id="LocationHeatmapAnswerSchema"></a>LocationHeatmapAnswerSchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+const LocationHeatmapAnswerSchema: "network.xyo.location.heatmap.answer" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+            ### <a id="LocationHeatmapQuerySchema"></a>LocationHeatmapQuerySchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+const LocationHeatmapQuerySchema: "network.xyo.location.heatmap.query" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+            ### <a id="LocationQuadkeyHeatmapAnswerSchema"></a>LocationQuadkeyHeatmapAnswerSchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+const LocationQuadkeyHeatmapAnswerSchema: "network.xyo.location.heatmap.quadkey.answer" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+            ### <a id="LocationQuadkeyHeatmapQuerySchema"></a>LocationQuadkeyHeatmapQuerySchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+const LocationQuadkeyHeatmapQuerySchema: "network.xyo.location.heatmap.quadkey.query" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+            ### <a id="LocationTimeRangeAnswerSchema"></a>LocationTimeRangeAnswerSchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+const LocationTimeRangeAnswerSchema: "network.xyo.location.range.answer" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+            ### <a id="LocationTimeRangeQuerySchema"></a>LocationTimeRangeQuerySchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+const LocationTimeRangeQuerySchema: "network.xyo.location.range.query" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+            ### <a id="LocationWitnessSchema"></a>LocationWitnessSchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+const LocationWitnessSchema: "network.xyo.location" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+            ### <a id="RemoteDivinerConfigSchema"></a>RemoteDivinerConfigSchema
+
+[**@xyo-network/api**](#../README)
+
+***
+
+```ts
+const RemoteDivinerConfigSchema: "network.xyo.diviner.remote.config" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+            ### <a id="isLocationTimeRangeQuery"></a>isLocationTimeRangeQuery
+
+[**@xyo-network/api**](#../README)
+
+***
 
-## Credits
+```ts
+const isLocationTimeRangeQuery: boolean;
+```
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/api.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/api
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/api.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE