@evergis/api 4.0.22 → 4.0.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/Api.d.ts CHANGED
@@ -6,7 +6,7 @@ import { DataSourceService } from './__generated__/DataSourceService';
6
6
  import { QueryTokenAccessService } from './__generated__/QueryTokenAccessService';
7
7
  import { SpatialReferencesService } from './__generated__/SpatialReferencesService';
8
8
  import { CatalogService } from './__generated__/CatalogService';
9
- import { Account, AccountPreview, BulkOperations, ClientSettings, Eql, Feedback, FileUpload, Filters, Geocode, Import, Layers, Names, Notification, PortalSettings, Projects, RemoteTaskManager, Resources, Security, Statistic, Tables, Tools, VectorTiles } from './services';
9
+ import { Account, AccountPreview, BulkOperations, Cameras, ClientSettings, Eql, Feedback, FileUpload, Filters, Geocode, Import, Layers, Names, Notification, PortalSettings, Projects, RemoteTaskManager, Resources, Security, Statistic, Tables, Tools, VectorTiles } from './services';
10
10
  import { AuthenticateParams, LoginDc } from './__generated__/data-contracts';
11
11
  export declare type ApiParams = {
12
12
  url: string;
@@ -56,6 +56,7 @@ export declare class Api extends EventEmitter {
56
56
  readonly queryToken: QueryTokenAccessService;
57
57
  readonly dataSource: DataSourceService;
58
58
  readonly remoteTaskManager: RemoteTaskManager;
59
+ readonly cameras: Cameras;
59
60
  constructor({ url, wsUrl, wsKeepAlive, snappingHubUrl, http, urlPath, httpOptions, }: ApiParams);
60
61
  init({ authParams, authQueryParams, connectWs, fetchSettings, fetchUser, useJwt, }: {
61
62
  authParams?: LoginDc;
@@ -0,0 +1,105 @@
1
+ import { ArchiveCalendarDc, ArchiveTimelineDc, CameraListDc, GetArchiveCalendarParams, GetArchiveFeedParams, GetArchiveSnapshotParams, GetArchiveTimelineParams, GetCamerasParams, GetLiveFeedParams, GetLivePreviewStreamParams } from './data-contracts';
2
+ import { Service } from './Service';
3
+ /**
4
+ * @title Spatial Processing Core API
5
+ * @version 1.5.1.0
6
+ * @baseUrl /sp
7
+ */
8
+ export declare class CamerasService extends Service {
9
+ /**
10
+ * No description
11
+ *
12
+ * @tags Cameras
13
+ * @name GetCameras
14
+ * @operationId CamerasController_GetCameras
15
+ * @summary Get cameras list.
16
+ * @request GET:/cameras
17
+ * @secure
18
+ * @response `200` OK
19
+ */
20
+ getCameras(query: GetCamerasParams): Promise<CameraListDc>;
21
+ /**
22
+ * No description
23
+ *
24
+ * @tags Cameras
25
+ * @name GetArchiveFeed
26
+ * @operationId CamerasController_GetArchiveFeed
27
+ * @summary Streams an FLV-over-HTTP archive feed starting at specific time.
28
+ * @request GET:/cameras/{cameraId}/archiveFeed
29
+ * @secure
30
+ * @response `200` OK
31
+ */
32
+ getArchiveFeed({ cameraId, ...query }: GetArchiveFeedParams): Promise<Blob>;
33
+ /**
34
+ * No description
35
+ *
36
+ * @tags Cameras
37
+ * @name GetArchiveTimeline
38
+ * @operationId CamerasController_GetArchiveTimeline
39
+ * @summary Returns a list of records available within a given timeframe.
40
+ * @request GET:/cameras/{cameraId}/archiveTimeline
41
+ * @secure
42
+ * @response `200` OK
43
+ */
44
+ getArchiveTimeline({ cameraId, ...query }: GetArchiveTimelineParams): Promise<ArchiveTimelineDc>;
45
+ /**
46
+ * No description
47
+ *
48
+ * @tags Cameras
49
+ * @name GetArchiveCalendar
50
+ * @operationId CamerasController_GetArchiveCalendar
51
+ * @summary Returns a list of records available within a given timeframe.
52
+ * @request GET:/cameras/{cameraId}/archiveCalendar
53
+ * @secure
54
+ * @response `200` OK
55
+ */
56
+ getArchiveCalendar({ cameraId, ...query }: GetArchiveCalendarParams): Promise<ArchiveCalendarDc>;
57
+ /**
58
+ * No description
59
+ *
60
+ * @tags Cameras
61
+ * @name GetArchiveSnapshot
62
+ * @operationId CamerasController_GetArchiveSnapshot
63
+ * @summary Returns a JPEG image from the Camera’s archive.
64
+ * @request GET:/cameras/{cameraId}/archiveSnapshot
65
+ * @secure
66
+ * @response `200` OK
67
+ */
68
+ getArchiveSnapshot({ cameraId, ...query }: GetArchiveSnapshotParams): Promise<Blob>;
69
+ /**
70
+ * No description
71
+ *
72
+ * @tags Cameras
73
+ * @name GetLiveFeed
74
+ * @operationId CamerasController_GetLiveFeed
75
+ * @summary Streams live video feed from the Camera.
76
+ * @request GET:/cameras/{cameraId}/liveFeed
77
+ * @secure
78
+ * @response `200` OK
79
+ */
80
+ getLiveFeed({ cameraId, ...query }: GetLiveFeedParams): Promise<Blob>;
81
+ /**
82
+ * No description
83
+ *
84
+ * @tags Cameras
85
+ * @name GetLiveSnapshot
86
+ * @operationId CamerasController_GetLiveSnapshot
87
+ * @summary Returns a JPEG image from the Camera’s live feed.
88
+ * @request GET:/cameras/{cameraId}/liveSnapshot
89
+ * @secure
90
+ * @response `200` OK
91
+ */
92
+ getLiveSnapshot(cameraId: string): Promise<Blob>;
93
+ /**
94
+ * No description
95
+ *
96
+ * @tags Cameras
97
+ * @name GetLivePreviewStream
98
+ * @operationId CamerasController_GetLivePreviewStream
99
+ * @summary Get live preview stream.
100
+ * @request GET:/cameras/{cameraId}/getLivePreviewsStream
101
+ * @secure
102
+ * @response `200` OK
103
+ */
104
+ getLivePreviewStream({ cameraId, ...query }: GetLivePreviewStreamParams): Promise<object>;
105
+ }
@@ -1,4 +1,4 @@
1
- import { AggregateAttributeParams, AggregationDataResultDc, AttributeDistinctsDc, BulkExtentsDc, BulkFilteredFeaturesCountDc, BulkOperationResultDc, ClassifyDc, ClassifyParams, CreateFeaturesPayload, DeleteByConditionParams, DeleteFeatureParams, DeleteFeaturesParams, DeleteResourcesParams, DistinctsParams, EditAttributesInfoDc, EnvelopeDc, ExpressionValidationResultDc, FeatureDc, GetBulkExtentsParams, GetBulkExtentsPayload, GetBulkFeaturesPayload, GetByIdParams, GetFeatures1Params, GetFeaturesParametersDc, GetFilteredFeaturesCount1Params, GetFilteredFeaturesCountDc, GetFilteredFeaturesCountPayload, GetLayerExtentParams, GetLayersInfoParams, GetLayersListParams, GetRasterMetaParams3, GetTilesLayerImage1Params, GetTilesLayerImageParams, GetTilesLayerImageWithFormatAndDpiParams, LayerUpdateInfoDc, LinearServiceConfigurationDc, NetCdfMetaDc, PagedBulkFeaturesListDc, PagedFeaturesListDc, PbfServiceConfigurationDc, PbfServiceInfoDc, PostgresTileCatalogServiceConfigurationDc, ProxyServiceInfoDc, PublishProxyServicePayload, PythonServiceConfigurationDc, PythonServiceInfoDc, QueryLayerServiceConfigurationDc, QueryLayerServiceInfoDc, RasterMetaDc, RemoteTileServiceConfigurationDc, RemoteTileServiceInfoDc, ResourceDependenciesDc, ResourceInfoDc, RouteServiceConfigurationDc, ServiceInfoDc, ServiceListDc, TileCatalogServiceInfoDc, UpdateFeaturePayload, UpdateProxyServicePayload, ValidateExpressionParams } from './data-contracts';
1
+ import { AggregateAttributeParams, AggregationDataResultDc, AttributeDistinctsDc, BulkExtentsDc, BulkFilteredFeaturesCountDc, BulkOperationResultDc, ClassifyDc, ClassifyParams, CreateFeaturesPayload, DeleteByConditionParams, DeleteFeatureParams, DeleteFeaturesParams, DeleteResourcesParams, DistinctsParams, EditAttributesInfoDc, EnvelopeDc, ExpressionValidationResultDc, FeatureDc, GetBulkExtentsParams, GetBulkExtentsPayload, GetBulkFeaturesPayload, GetByIdParams, GetFeatures1Params, GetFeaturesParametersDc, GetFilteredFeaturesCount1Params, GetFilteredFeaturesCountDc, GetFilteredFeaturesCountPayload, GetLayerExtentParams, GetLayersInfoParams, GetLayersListParams, GetRasterMetaParams8, GetTilesLayerImage1Params, GetTilesLayerImageParams, GetTilesLayerImageWithFormatAndDpiParams, LayerUpdateInfoDc, LinearServiceConfigurationDc, NetCdfMetaDc, PagedBulkFeaturesListDc, PagedFeaturesListDc, PbfServiceConfigurationDc, PbfServiceInfoDc, PostgresTileCatalogServiceConfigurationDc, ProxyServiceInfoDc, PublishProxyServicePayload, PythonServiceConfigurationDc, PythonServiceInfoDc, QueryLayerServiceConfigurationDc, QueryLayerServiceInfoDc, RasterMetaDc, RemoteTileServiceConfigurationDc, RemoteTileServiceInfoDc, ResourceDependenciesDc, ResourceInfoDc, RouteServiceConfigurationDc, ServiceInfoDc, ServiceListDc, TileCatalogServiceInfoDc, UpdateFeaturePayload, UpdateProxyServicePayload, ValidateExpressionParams } from './data-contracts';
2
2
  import { Service } from './Service';
3
3
  /**
4
4
  * @title Spatial Processing Core API
@@ -533,7 +533,7 @@ export declare class LayersService extends Service {
533
533
  * @secure
534
534
  * @response `200` OK
535
535
  */
536
- getRasterMeta({ name, id, ...query }: GetRasterMetaParams3): Promise<(RasterMetaDc | NetCdfMetaDc)[]>;
536
+ getRasterMeta({ name, id, ...query }: GetRasterMetaParams8): Promise<(RasterMetaDc | NetCdfMetaDc)[]>;
537
537
  /**
538
538
  * No description
539
539
  *
@@ -1,4 +1,4 @@
1
- import { BulkOperationResultDc, DeleteResourcesParams3, EnvelopeDc, ExtendedProjectInfoDc, ExtendedProjectLayersInfo, GetProjectEnvelopeParams, GetProjectsInfoParams, GetProjectsListParams, JsonPatchDocumentExtendedProjectInfoDcV2, PagedListProjectInfoDc, ProjectsListDc, ResourceDependenciesDc, UpdateProjectV2Payload } from './data-contracts';
1
+ import { BulkOperationResultDc, DeleteResourcesParams5, EnvelopeDc, ExtendedProjectInfoDc, ExtendedProjectLayersInfo, GetProjectEnvelopeParams, GetProjectsInfoParams, GetProjectsListParams, JsonPatchDocumentExtendedProjectInfoDcV2, PagedListProjectInfoDc, ProjectsListDc, ResourceDependenciesDc, UpdateProjectV2Payload } from './data-contracts';
2
2
  import { Service } from './Service';
3
3
  /**
4
4
  * @title Spatial Processing Core API
@@ -41,7 +41,7 @@ export declare class ProjectsService extends Service {
41
41
  * @secure
42
42
  * @response `200` OK
43
43
  */
44
- deleteResources(query: DeleteResourcesParams3): Promise<BulkOperationResultDc[]>;
44
+ deleteResources(query: DeleteResourcesParams5): Promise<BulkOperationResultDc[]>;
45
45
  /**
46
46
  * No description
47
47
  *
@@ -1,4 +1,4 @@
1
- import { BulkOperationResultDc, CreateViewFromQueryDc, CreateViewFromQueryLayerDc, DeleteResourcesParams3, DeleteTableDataParams, DetailedTableInfoDc, GetTableDataParams, GetTableListParams, GetTablesInfoParams, MapTableInfoDc, MapTableParams, PagedBulkFeaturesListDc, PagedFeaturesListDc, PagedListFeatureDc, PagedListTableListItemDc, ResourceDependenciesDc, UpdateTableDataParams, UpdateTableDataPayload, UpdateTableDc, WriteTableDataPayload } from './data-contracts';
1
+ import { BulkOperationResultDc, CreateViewFromQueryDc, CreateViewFromQueryLayerDc, DeleteResourcesParams8, DeleteTableDataParams, DetailedTableInfoDc, GetTableDataParams, GetTableListParams, GetTablesInfoParams, MapTableInfoDc, MapTableParams, PagedBulkFeaturesListDc, PagedFeaturesListDc, PagedListFeatureDc, PagedListTableListItemDc, ResourceDependenciesDc, UpdateTableDataParams, UpdateTableDataPayload, UpdateTableDc, WriteTableDataPayload } from './data-contracts';
2
2
  import { Service } from './Service';
3
3
  /**
4
4
  * @title Spatial Processing Core API
@@ -41,7 +41,7 @@ export declare class TablesService extends Service {
41
41
  * @secure
42
42
  * @response `200` OK
43
43
  */
44
- deleteResources(query: DeleteResourcesParams3): Promise<BulkOperationResultDc[]>;
44
+ deleteResources(query: DeleteResourcesParams8): Promise<BulkOperationResultDc[]>;
45
45
  /**
46
46
  * No description
47
47
  *
@@ -1,4 +1,4 @@
1
- import { GetCapabilities1Params, GetCapabilitiesParams10, GetFeatureInfoParams, GetLegendGraphicParams, GetMapParams } from './data-contracts';
1
+ import { GetCapabilities1Params, GetCapabilitiesParams5, GetFeatureInfoParams, GetLegendGraphicParams, GetMapParams } from './data-contracts';
2
2
  import { Service } from './Service';
3
3
  /**
4
4
  * @title Spatial Processing Core API
@@ -17,7 +17,7 @@ export declare class WmsServerService extends Service {
17
17
  * @secure
18
18
  * @response `200` OK
19
19
  */
20
- getCapabilities(query: GetCapabilitiesParams10): Promise<void>;
20
+ getCapabilities(query: GetCapabilitiesParams5): Promise<void>;
21
21
  /**
22
22
  * No description
23
23
  *
@@ -254,6 +254,51 @@ export declare type ArcGisDataSourceDc = DataSourceDc & {
254
254
  export declare type ArcGisDataSourceInfoDc = DataSourceInfoDc & {
255
255
  serviceUrl?: string | null;
256
256
  };
257
+ /**
258
+ * Archive calendar response.
259
+ */
260
+ export interface ArchiveCalendarDc {
261
+ /** Each value represents the percentage of time covered by archive records within the corresponding day. */
262
+ calendar?: ArchiveCalendarItemDc[];
263
+ /** Check if request success. */
264
+ success?: boolean;
265
+ }
266
+ /**
267
+ * Archive calendar item.
268
+ */
269
+ export interface ArchiveCalendarItemDc {
270
+ /** Date. */
271
+ date?: string;
272
+ /**
273
+ * Daily coverage values.
274
+ * @format int32
275
+ */
276
+ coverage?: number;
277
+ }
278
+ /**
279
+ * Archive timeline request.
280
+ */
281
+ export interface ArchiveTimelineDc {
282
+ /** A list of daily coverage values. */
283
+ timeline?: ArchiveTimelineItemDc[];
284
+ /** Check if request success. */
285
+ success?: boolean;
286
+ }
287
+ /**
288
+ * Represents the percentage of time covered by archive records within the corresponding day.
289
+ */
290
+ export interface ArchiveTimelineItemDc {
291
+ /**
292
+ * Corresponding day.
293
+ * @format date-time
294
+ */
295
+ startTime?: string;
296
+ /**
297
+ * Percentage of time covered by archive record.
298
+ * @format int32
299
+ */
300
+ duration?: number;
301
+ }
257
302
  /**
258
303
  * Simple not filled arrow.
259
304
  */
@@ -756,6 +801,26 @@ export interface BulkOperationResultDc {
756
801
  /** Sets true. */
757
802
  isSuccess?: boolean;
758
803
  }
804
+ /**
805
+ * Camera item.
806
+ */
807
+ export interface CameraDc {
808
+ /** Id of the camera. */
809
+ id?: string;
810
+ /** Name of the camera. */
811
+ name?: string;
812
+ /** Checks if camera online. */
813
+ online?: boolean;
814
+ }
815
+ /**
816
+ * Cameras list response.
817
+ */
818
+ export interface CameraListDc {
819
+ /** The retrieved items in the list. */
820
+ items?: CameraDc[];
821
+ /** Check if request success. */
822
+ success?: boolean;
823
+ }
759
824
  /**
760
825
  * Resource catalog item.
761
826
  */
@@ -2545,6 +2610,7 @@ export declare type HexGridSymbolDc = SymbolDc & {
2545
2610
  fill?: HatchBrushDc | PatternBrushDc | SolidFillBrushDc | null;
2546
2611
  aggregations?: Record<string, AggregationFunction>;
2547
2612
  };
2613
+ export declare type IAsyncEnumerableLivePreviewDc = object;
2548
2614
  /**
2549
2615
  * A single image point symbol with an outer stroke.
2550
2616
  */
@@ -3786,6 +3852,20 @@ export declare type PythonTaskMethodConfigurationDc = TaskMethodConfigurationDc
3786
3852
  fileName?: string | null;
3787
3853
  methodName?: string | null;
3788
3854
  };
3855
+ /**
3856
+ * Stream quality.
3857
+
3858
+ Low
3859
+
3860
+ Medium
3861
+
3862
+ High
3863
+ */
3864
+ export declare enum Quality {
3865
+ Low = "Low",
3866
+ Medium = "Medium",
3867
+ High = "High"
3868
+ }
3789
3869
  /**
3790
3870
  * Query geometry data contract.
3791
3871
  */
@@ -6611,6 +6691,102 @@ export interface UploadPreview1Payload {
6611
6691
  /** @format binary */
6612
6692
  file?: File;
6613
6693
  }
6694
+ export interface GetCamerasParams {
6695
+ /**
6696
+ * Page objects limit.
6697
+ * @format int32
6698
+ */
6699
+ limit?: number;
6700
+ /**
6701
+ * Objects skip.
6702
+ * @format int32
6703
+ */
6704
+ offset?: number;
6705
+ }
6706
+ export interface GetArchiveFeedParams {
6707
+ /**
6708
+ * Timestamp from which to start the archive playback.
6709
+ * UNIX time (both seconds and milliseconds are supported).
6710
+ * @format date-time
6711
+ */
6712
+ startTime?: string;
6713
+ /**
6714
+ * Timestamp at which to stop the playback.
6715
+ * UNIX time (both seconds and milliseconds are supported).
6716
+ * @format date-time
6717
+ */
6718
+ endTime?: string;
6719
+ /**
6720
+ * Playback speed factor.
6721
+ * Possible values: 1 2 4 8 16 32 64.
6722
+ * @format int32
6723
+ */
6724
+ speed?: number;
6725
+ /** Camera id. */
6726
+ cameraId: string;
6727
+ }
6728
+ export interface GetArchiveTimelineParams {
6729
+ /**
6730
+ * Start of the timeframe UNIX time (seconds).
6731
+ * @format date-time
6732
+ */
6733
+ startTime?: string;
6734
+ /**
6735
+ * End of the timeframe UNIX time (seconds).
6736
+ * @format date-time
6737
+ */
6738
+ endTime?: string;
6739
+ /** Camera id. */
6740
+ cameraId: string;
6741
+ }
6742
+ export interface GetArchiveCalendarParams {
6743
+ /** Start of the timeframe UNIX time (seconds). */
6744
+ startTime?: string;
6745
+ /** End of the timeframe UNIX time (seconds). */
6746
+ endTime?: string;
6747
+ /** Timezone. */
6748
+ tz?: string;
6749
+ /** Camera id. */
6750
+ cameraId: string;
6751
+ }
6752
+ export interface GetArchiveSnapshotParams {
6753
+ /**
6754
+ * Timestamp of the moment at which to take the snapshot.
6755
+ * UNIX timestamp (in seconds).
6756
+ * @format date-time
6757
+ */
6758
+ time?: string;
6759
+ /** Camera id. */
6760
+ cameraId: string;
6761
+ }
6762
+ export interface GetLiveFeedParams {
6763
+ /**
6764
+ * Duration.
6765
+ * @format int64
6766
+ */
6767
+ duration?: number;
6768
+ /** Camera id. */
6769
+ cameraId: string;
6770
+ }
6771
+ export interface GetLivePreviewStreamParams {
6772
+ /**
6773
+ * Frame per second.
6774
+ * @format float
6775
+ */
6776
+ fps?: number;
6777
+ /**
6778
+ * Quality.
6779
+ *
6780
+ * Low
6781
+ *
6782
+ * Medium
6783
+ *
6784
+ * High
6785
+ */
6786
+ quality?: Quality;
6787
+ /** Id of the camera. */
6788
+ cameraId: string;
6789
+ }
6614
6790
  export interface GetTagsParams {
6615
6791
  /** Text filter. */
6616
6792
  filter?: string;
@@ -7269,7 +7445,7 @@ export interface ValidateExpressionParams {
7269
7445
  /** Layer name. */
7270
7446
  layerName: string;
7271
7447
  }
7272
- export interface GetRasterMetaParams3 {
7448
+ export interface GetRasterMetaParams8 {
7273
7449
  /**
7274
7450
  * Min value for build histogram.
7275
7451
  * @format double
@@ -7330,7 +7506,7 @@ export interface GetProjectsListParams {
7330
7506
  /** Filter layers by set of tags. */
7331
7507
  tags?: string[];
7332
7508
  }
7333
- export interface DeleteResourcesParams3 {
7509
+ export interface DeleteResourcesParams5 {
7334
7510
  /** Resource names. */
7335
7511
  names?: string[];
7336
7512
  }
@@ -7549,6 +7725,10 @@ export interface GetTableListParams {
7549
7725
  /** All available permissions list. */
7550
7726
  acl?: string;
7551
7727
  }
7728
+ export interface DeleteResourcesParams8 {
7729
+ /** Resource names. */
7730
+ names?: string[];
7731
+ }
7552
7732
  export interface GetTablesInfoParams {
7553
7733
  /** Table names. */
7554
7734
  tableNames?: string[];
@@ -7660,7 +7840,7 @@ export interface GetPublicCapabilitiesParams {
7660
7840
  /** When omitted or not supported by server, server shall return service metadata document using the MIME type "text/xml". */
7661
7841
  AcceptFormats?: string[];
7662
7842
  }
7663
- export interface GetCapabilitiesParams10 {
7843
+ export interface GetCapabilitiesParams5 {
7664
7844
  /** Output format of service metadata. */
7665
7845
  Format?: string;
7666
7846
  /** Must be WMS. */