@spotto/contract 1.0.69-alpha.6 → 1.0.69-alpha.7

package/README.md

@@ -1,33 +1,33 @@
-# README
-
-This repository is a source of truth / documentation for the spotto-api.
-
-The repository consists of a series of typescript classes that document the API contract
-between the spotto API and its clients
-
-### How do I get set up?
-
-1. Clone this repository
-1. yarn install
-1. run 'yarn start' to start a documentation server
-
-### Contribution guidelines
-
-When adding endpoints create a new folder / file for your endpoint.
-Fill out file using others as a guide.
-
-Any response and request shapes should be specified in the /types folder. The documentation server
-is sometimes unable to understand more complicated interfaces. In these scenarios please create two
-types files, one with a logical working type that can be used by other repositories. The other will
-be simply for filling the response server.
-
-Any documentation specific types files should have the suffix 'Docs' within the same folder. e.g.
-
-- types
-  - objects
-    - objectTypes.ts
-    - objectTypesDocs.ts
-
-### Who do I talk to?
-
-- Repo owner or admin
+# README
+
+This repository is a source of truth / documentation for the spotto-api.
+
+The repository consists of a series of typescript classes that document the API contract
+between the spotto API and its clients
+
+### How do I get set up?
+
+1. Clone this repository
+1. yarn install
+1. run 'yarn start' to start a documentation server
+
+### Contribution guidelines
+
+When adding endpoints create a new folder / file for your endpoint.
+Fill out file using others as a guide.
+
+Any response and request shapes should be specified in the /types folder. The documentation server
+is sometimes unable to understand more complicated interfaces. In these scenarios please create two
+types files, one with a logical working type that can be used by other repositories. The other will
+be simply for filling the response server.
+
+Any documentation specific types files should have the suffix 'Docs' within the same folder. e.g.
+
+- types
+  - objects
+    - objectTypes.ts
+    - objectTypesDocs.ts
+
+### Who do I talk to?
+
+- Repo owner or admin

package/dist/assets/[id]/get.d.ts

@@ -1,60 +1,60 @@
-import { type Point } from 'geojson';
-import { IEmbeddedLabel } from '../../labels';
-import { LocationStatus, LocationType } from '../../locations/constants';
-import { IEntityMeta, IEmbeddedEntity } from '../../shared';
-import { IAssetTelemetry } from '../../telemetry';
-import { IFieldValue } from '../../types';
-export interface ILastLocation {
-    id?: string;
-    /** @obsolete however, left in for backward compatibility */
-    name?: string;
-    path?: string;
-    type?: LocationType;
-    firstSeen?: number;
-    lastSeen?: number;
-    distance?: number;
-    confidence?: number;
-    moving?: boolean;
-    geolocation?: Point;
-    organisation?: IEmbeddedEntity;
-    /** default to "NEVERSEEN" when no state */
-    status: LocationStatus;
-    supportsWith?: boolean;
-    withAsset?: {
-        id: string;
-        name: string;
-    };
-    nearReader?: {
-        id: string;
-        name: string;
-        type?: LocationType;
-    };
-}
-export interface ICandidateLocation extends IEmbeddedEntity {
-    type: LocationType;
-    distance: number;
-    organisation?: IEmbeddedEntity;
-    path?: string;
-}
-export interface GetAssetResponse {
-    id: string;
-    name: string;
-    nameComputed?: boolean;
-    nameSuffix?: string;
-    labels: IEmbeddedLabel[];
-    organisation?: IEmbeddedEntity;
-    tagIds?: string[];
-    typeId?: string;
-    typeName?: string;
-    typePath?: string;
-    fieldValues?: IFieldValue[];
-    score?: number;
-    meta?: IEntityMeta;
-    telemetry?: IAssetTelemetry;
-    lastLocation: ILastLocation;
-    candidateLocations?: ICandidateLocation[];
-    homeLocationId?: string;
-    homeLocationPath?: string;
-    readers?: IEmbeddedEntity[];
-    manifestIds?: string[];
-}
+import { type Point } from 'geojson';
+import { IEmbeddedLabel } from '../../labels';
+import { LocationStatus, LocationType } from '../../locations/constants';
+import { IEntityMeta, IEmbeddedEntity } from '../../shared';
+import { IAssetTelemetry } from '../../telemetry';
+import { IFieldValue } from '../../types';
+export interface ILastLocation {
+    id?: string;
+    /** @obsolete however, left in for backward compatibility */
+    name?: string;
+    path?: string;
+    type?: LocationType;
+    firstSeen?: number;
+    lastSeen?: number;
+    distance?: number;
+    confidence?: number;
+    moving?: boolean;
+    geolocation?: Point;
+    organisation?: IEmbeddedEntity;
+    /** default to "NEVERSEEN" when no state */
+    status: LocationStatus;
+    supportsWith?: boolean;
+    withAsset?: {
+        id: string;
+        name: string;
+    };
+    nearReader?: {
+        id: string;
+        name: string;
+        type?: LocationType;
+    };
+}
+export interface ICandidateLocation extends IEmbeddedEntity {
+    type: LocationType;
+    distance: number;
+    organisation?: IEmbeddedEntity;
+    path?: string;
+}
+export interface GetAssetResponse {
+    id: string;
+    name: string;
+    nameComputed?: boolean;
+    nameSuffix?: string;
+    labels: IEmbeddedLabel[];
+    organisation?: IEmbeddedEntity;
+    tagIds?: string[];
+    typeId?: string;
+    typeName?: string;
+    typePath?: string;
+    fieldValues?: IFieldValue[];
+    score?: number;
+    meta?: IEntityMeta;
+    telemetry?: IAssetTelemetry;
+    lastLocation: ILastLocation;
+    candidateLocations?: ICandidateLocation[];
+    homeLocationId?: string;
+    homeLocationPath?: string;
+    readers?: IEmbeddedEntity[];
+    manifestIds?: string[];
+}

package/dist/assets/[id]/get.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=get.js.map

package/dist/assets/[id]/index.d.ts

@@ -1,4 +1,4 @@
-export * from './patch';
-export * from './get';
-export * from './location';
-export * from './readers';
+export * from './patch';
+export * from './get';
+export * from './location';
+export * from './readers';

package/dist/assets/[id]/index.js

@@ -1,21 +1,21 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./patch"), exports);
-__exportStar(require("./get"), exports);
-__exportStar(require("./location"), exports);
-__exportStar(require("./readers"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./patch"), exports);
+__exportStar(require("./get"), exports);
+__exportStar(require("./location"), exports);
+__exportStar(require("./readers"), exports);
 //# sourceMappingURL=index.js.map

package/dist/assets/[id]/location.d.ts

@@ -1,6 +1,6 @@
-import { ILastLocation, ICandidateLocation } from './get';
-export interface GetAssetLastLocationResponse {
-    id: string;
-    lastLocation: ILastLocation | null;
-    candidateLocations?: ICandidateLocation[];
-}
+import { ILastLocation, ICandidateLocation } from './get';
+export interface GetAssetLastLocationResponse {
+    id: string;
+    lastLocation: ILastLocation | null;
+    candidateLocations?: ICandidateLocation[];
+}

package/dist/assets/[id]/location.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=location.js.map

package/dist/assets/[id]/patch/index.d.ts

@@ -1,2 +1,2 @@
-export * from './request';
-export * from './response';
+export * from './request';
+export * from './response';

package/dist/assets/[id]/patch/index.js

@@ -1,19 +1,19 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./request"), exports);
-__exportStar(require("./response"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./request"), exports);
+__exportStar(require("./response"), exports);
 //# sourceMappingURL=index.js.map

package/dist/assets/[id]/patch/request.d.ts

@@ -1,11 +1,11 @@
-import { IFieldValueWithConstraints } from '../../../types';
-export interface UpdateAssetRequest {
-    name?: string;
-    nameSuffix?: string;
-    tagIds?: string[];
-    labels?: string[];
-    typeId?: string;
-    fieldValues?: IFieldValueWithConstraints[];
-    homeLocationId?: string;
-    manifestIds?: string[];
-}
+import { IFieldValueWithConstraints } from '../../../types';
+export interface UpdateAssetRequest {
+    name?: string;
+    nameSuffix?: string;
+    tagIds?: string[];
+    labels?: string[];
+    typeId?: string;
+    fieldValues?: IFieldValueWithConstraints[];
+    homeLocationId?: string;
+    manifestIds?: string[];
+}

package/dist/assets/[id]/patch/request.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=request.js.map

package/dist/assets/[id]/patch/response.d.ts

@@ -1,7 +1,7 @@
-import { DefaultError } from '../../../shared/errors';
-import { TagsExistError } from '../../../tags/errors';
-export { GetAssetResponse as UpdateAssetResponse } from '../get';
-export interface UpdateAssetError extends DefaultError {
-    data: TagsExistError;
-}
-export declare type UpdateAssetErrorResponse = DefaultError | UpdateAssetError;
+import { DefaultError } from '../../../shared/errors';
+import { TagsExistError } from '../../../tags/errors';
+export { GetAssetResponse as UpdateAssetResponse } from '../get';
+export interface UpdateAssetError extends DefaultError {
+    data: TagsExistError;
+}
+export declare type UpdateAssetErrorResponse = DefaultError | UpdateAssetError;

package/dist/assets/[id]/patch/response.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=response.js.map

package/dist/assets/[id]/readers.d.ts

@@ -1,9 +1,9 @@
-import { IEmbeddedEntity } from '../../shared';
-export interface IReaderSighting extends IEmbeddedEntity {
-    firstSeen: number;
-    lastSeen: number;
-    organisation?: IEmbeddedEntity;
-    distance?: number;
-    rssi?: number;
-}
-export declare type GetAssetReaderSightingsResponse = IReaderSighting[];
+import { IEmbeddedEntity } from '../../shared';
+export interface IReaderSighting extends IEmbeddedEntity {
+    firstSeen: number;
+    lastSeen: number;
+    organisation?: IEmbeddedEntity;
+    distance?: number;
+    rssi?: number;
+}
+export declare type GetAssetReaderSightingsResponse = IReaderSighting[];

package/dist/assets/[id]/readers.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=readers.js.map

package/dist/assets/count/index.d.ts

@@ -1,2 +1,2 @@
-export * from './query';
-export * from './response';
+export * from './query';
+export * from './response';

package/dist/assets/count/index.js

@@ -1,19 +1,19 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./query"), exports);
-__exportStar(require("./response"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./query"), exports);
+__exportStar(require("./response"), exports);
 //# sourceMappingURL=index.js.map

package/dist/assets/count/query.d.ts

@@ -1 +1 @@
-export { AssetFilters as CountAssetsQuery } from '../get/query';
+export { AssetFilters as CountAssetsQuery } from '../get/query';

package/dist/assets/count/query.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=query.js.map

package/dist/assets/count/response.d.ts

@@ -1,15 +1,15 @@
-export interface IBatteryCounts {
-    critical: number;
-    low: number;
-    ok: number;
-}
-export interface CountAssetsResponse {
-    battery: IBatteryCounts;
-    isVisiting: number;
-    isAway: number;
-    hasTags: number;
-    hasReaders: number;
-    setupComplete: number;
-    hasReported: number;
-    total: number;
-}
+export interface IBatteryCounts {
+    critical: number;
+    low: number;
+    ok: number;
+}
+export interface CountAssetsResponse {
+    battery: IBatteryCounts;
+    isVisiting: number;
+    isAway: number;
+    hasTags: number;
+    hasReaders: number;
+    setupComplete: number;
+    hasReported: number;
+    total: number;
+}

package/dist/assets/count/response.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=response.js.map

package/dist/assets/count-filtered/index.d.ts

@@ -1 +1 @@
-export * from './response';
+export * from './response';

package/dist/assets/count-filtered/index.js

@@ -1,18 +1,18 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./response"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./response"), exports);
 //# sourceMappingURL=index.js.map

package/dist/assets/count-filtered/response.d.ts

@@ -1,5 +1,5 @@
-import { GetAssetsQuery } from '../get/query';
-export interface CountFilteredAssetsResponse {
-    query: GetAssetsQuery | null;
-    total: number;
-}
+import { GetAssetsQuery } from '../get/query';
+export interface CountFilteredAssetsResponse {
+    query: GetAssetsQuery | null;
+    total: number;
+}

package/dist/assets/count-filtered/response.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=response.js.map

package/dist/assets/download/index.d.ts

@@ -1,2 +1,2 @@
-export * from './query';
-export * from './response';
+export * from './query';
+export * from './response';

package/dist/assets/download/index.js

@@ -1,19 +1,19 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./query"), exports);
-__exportStar(require("./response"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./query"), exports);
+__exportStar(require("./response"), exports);
 //# sourceMappingURL=index.js.map

package/dist/assets/download/query.d.ts

@@ -1,10 +1,10 @@
-import { SortOrders, TimestampFormat } from '../../shared';
-import { AssetFilters, AssetSortField } from '../get';
-export interface DownloadAssetsQuery extends AssetFilters {
-    limit?: number;
-    sort?: AssetSortField;
-    sortOrder?: SortOrders;
-    timestampFormat?: TimestampFormat;
-    timezone?: string;
-    withEntityLinks?: boolean;
-}
+import { SortOrders, TimestampFormat } from '../../shared';
+import { AssetFilters, AssetSortField } from '../get';
+export interface DownloadAssetsQuery extends AssetFilters {
+    limit?: number;
+    sort?: AssetSortField;
+    sortOrder?: SortOrders;
+    timestampFormat?: TimestampFormat;
+    timezone?: string;
+    withEntityLinks?: boolean;
+}

package/dist/assets/download/query.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=query.js.map

package/dist/assets/download/response.d.ts

@@ -1,3 +1,3 @@
-export interface DownloadAssetsResponse {
-    path: string;
-}
+export interface DownloadAssetsResponse {
+    path: string;
+}

package/dist/assets/download/response.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=response.js.map