@evergis/api 3.0.52 → 3.0.56

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
@@ -1,6 +1,6 @@
1
1
  import { Options as KyOptions } from 'ky';
2
2
  import { EventEmitter } from '@evergis/event-emitter';
3
- import { Account, External, ClientSettings, FileUpload, General, Geocode, Import, Layers, Names, Namespace, Notification, Projects, ResourceCatalog, Resources, Scheduler, Security, Styles, Tables, Tools, AccountPreview, BulkOperations, IceRouter } from './services';
3
+ import { Account, External, ClientSettings, PortalSettings, FileUpload, General, Geocode, Import, Layers, Names, Namespace, Notification, Projects, ResourceCatalog, Resources, Scheduler, Security, Styles, Tables, Tools, AccountPreview, BulkOperations, IceRouter } from './services';
4
4
  import { Print } from './services/Print';
5
5
  import { HttpClient } from './__generated__/HttpClient';
6
6
  import { LoginDc } from './__generated__/data-contracts';
@@ -13,7 +13,8 @@ export declare type ApiParams = {
13
13
  };
14
14
  export declare enum UrlPath {
15
15
  Base = "/map",
16
- Shared = "/shared"
16
+ Shared = "/shared",
17
+ Portal = "/portal"
17
18
  }
18
19
  export declare type SocAuthNetwork = 'vk' | 'facebook' | 'google';
19
20
  export declare type SocAuthCallback = 'vkCallback' | 'facebookCallback' | 'googleCallback';
@@ -42,6 +43,7 @@ export declare class Api extends EventEmitter {
42
43
  readonly accountPreview: AccountPreview;
43
44
  readonly external: External;
44
45
  readonly clientSettings: ClientSettings;
46
+ readonly portalSettings: PortalSettings;
45
47
  readonly names: Names;
46
48
  readonly bulk: BulkOperations;
47
49
  readonly iceRouter: IceRouter;
@@ -1,4 +1,4 @@
1
- import { AccessControlListDc, AggregateAttributeParams, AggregationDataResultDc, AttributeDistinctsDc, BulkOperationResultDc, ClassifyParams, CompositeServiceConfigurationDc, CompositeServiceInfoDc, CreateFeaturesPayload, DeleteFeatureParams, DeleteFeaturesParams, DeleteResourcesParams, DistinctsParams, EditAttributesInfoDc, EnvelopeDc, ExpressionValidationResultDc, FailedServiceInfoDc, FeatureDc, FeatureLayerServiceInfoDc, FeatureSelectionDc, FeaturesListDc, FileUploadResponse, GetByGeometryGetParams, GetByGeometryParams, GetByGeometryPostParams, GetByGeometryPostPayload, GetByIdParams, GetFeaturesParams, GetFilteredFeaturesCountParams, GetLayerExtentParams, GetLayerImageParams, GetLayersListParams, GetTilesLayerImageParams, LayerUpdateInfoDc, LocalTileServiceConfigurationDc, PositionDc, PostgresLayerServiceConfigurationDc, PostgresTileCatalogServiceConfigurationDc, ProxyServiceConfigurationDc, ProxyServiceInfoDc, RemoteTileServiceConfigurationDc, RemoteTileServiceInfo, RemoteTileServiceInfoDc, ResourceDependenciesDc, SelectFeaturesParams, ServiceInfoDc, SetPermissionsBatchPayload, SetPreviewPayload, StyledLayerServiceConfigurationDc, SubtractParams, SubtractPayload, TileCatalogServiceInfoDc, TileServiceInfoDc, UniteParams, UnitePayload, UpdateFeaturePayload, ValidateExpressionParams } from './data-contracts';
1
+ import { AccessControlListDc, AggregateAttributeParams, AggregationDataResultDc, AttributeDistinctsDc, BulkOperationResultDc, ClassifyParams, CompositeServiceConfigurationDc, CompositeServiceInfoDc, CreateFeaturesPayload, DeleteFeatureParams, DeleteFeaturesParams, DeleteResourcesParams, DistinctsParams, EditAttributesInfoDc, EnvelopeDc, ExpressionValidationResultDc, FailedServiceInfoDc, FeatureDc, FeatureLayerServiceInfoDc, FeaturesContainsParams, FeatureSelectionDc, FeaturesListDc, FileUploadResponse, GetByGeometryGetParams, GetByGeometryParams, GetByGeometryPostParams, GetByGeometryPostPayload, GetByIdParams, GetFeaturesParams, GetFilteredFeaturesCountParams, GetLayerExtentParams, GetLayerImageParams, GetLayersListParams, GetTilesLayerImageParams, LayerUpdateInfoDc, LocalTileServiceConfigurationDc, PositionDc, PostgresLayerServiceConfigurationDc, PostgresTileCatalogServiceConfigurationDc, ProxyServiceConfigurationDc, ProxyServiceInfoDc, RemoteTileServiceConfigurationDc, RemoteTileServiceInfo, RemoteTileServiceInfoDc, ResourceDependenciesDc, SelectFeaturesParams, ServiceInfoDc, SetPermissionsBatchPayload, SetPreviewPayload, StyledLayerServiceConfigurationDc, SubtractParams, SubtractPayload, TileCatalogServiceInfoDc, TileServiceInfoDc, UniteParams, UnitePayload, UpdateFeaturePayload, ValidateExpressionParams } from './data-contracts';
2
2
  import { Service } from './Service';
3
3
  /**
4
4
  * @title Spatial Processing Core API
@@ -260,6 +260,17 @@ export declare class LayersService extends Service {
260
260
  * @response `200` Success
261
261
  */
262
262
  updateFeature(name: string, data: UpdateFeaturePayload): Promise<LayerUpdateInfoDc>;
263
+ /**
264
+ * No description
265
+ *
266
+ * @tags Layers
267
+ * @name FeaturesContains
268
+ * @operationId LayersController_FeaturesContains
269
+ * @summary Gets filtered features with given filter.
270
+ * @request GET:/layers/{name}/features/contains
271
+ * @response `200` Success
272
+ */
273
+ featuresContains({ name, ...query }: FeaturesContainsParams): Promise<import("./data-contracts").ListResponseFeatureDc>;
263
274
  /**
264
275
  * No description
265
276
  *
@@ -1,4 +1,4 @@
1
- import { AccessControlListDc, BulkOperationResultDc, DeleteResourcesParams7, ExtendedProjectInfoDc, ExtendedProjectLayersInfo, FileUploadResponse, GetProjectsListParams, ListResponseProjectInfoPubDc, ResourceDependenciesDc, SetPermissionsBatchBody, SetPreviewBody, SharedProjectConfigurationDc, SharedProjectInfoDc } from './data-contracts';
1
+ import { AccessControlListDc, BulkOperationResultDc, DeleteResourcesParams, ExtendedProjectInfoDc, ExtendedProjectLayersInfo, FileUploadResponse, GetProjectsListParams, ListResponseProjectInfoPubDc, ResourceDependenciesDc, SetPermissionsBatchBody, SetPreviewBody, SharedProjectConfigurationDc, SharedProjectInfoDc } from './data-contracts';
2
2
  import { Service } from './Service';
3
3
  /**
4
4
  * @title Spatial Processing Core API
@@ -60,7 +60,7 @@ export declare class ProjectsService extends Service {
60
60
  * @request DELETE:/projects
61
61
  * @response `200` Success
62
62
  */
63
- deleteResources(query: DeleteResourcesParams7): Promise<BulkOperationResultDc[]>;
63
+ deleteResources(query: DeleteResourcesParams): Promise<BulkOperationResultDc[]>;
64
64
  /**
65
65
  * No description
66
66
  *
@@ -23,7 +23,7 @@ export declare class SecurityService extends Service {
23
23
  * @tags SecurityService
24
24
  * @name FindUserByName
25
25
  * @operationId SecurityServiceController_FindUserByName
26
- * @summary Returns the list of users found by username or email.
26
+ * @summary Returns the list of users found by username.
27
27
  * @request GET:/security/users
28
28
  * @response `200` Success
29
29
  */
@@ -1,4 +1,4 @@
1
- import { DownloadFileParams, FileUploadResponse, UploadFilePayload } from './data-contracts';
1
+ import { DeleteFileParams, DownloadFileParams, FileUploadResponse, UploadFilePayload } from './data-contracts';
2
2
  import { Service } from './Service';
3
3
  /**
4
4
  * @title Spatial Processing Core API
@@ -28,4 +28,15 @@ export declare class StaticContentService extends Service {
28
28
  * @response `200` Success
29
29
  */
30
30
  uploadFile(data: UploadFilePayload): Promise<FileUploadResponse>;
31
+ /**
32
+ * No description
33
+ *
34
+ * @tags StaticContentService
35
+ * @name DeleteFile
36
+ * @operationId StaticContentServiceController_DeleteFile
37
+ * @summary Delete file from temporary session storage.
38
+ * @request DELETE:/upload/file
39
+ * @response `200` Success
40
+ */
41
+ deleteFile(query: DeleteFileParams): Promise<void>;
31
42
  }
@@ -1,4 +1,4 @@
1
- import { AccessControlListDc, BulkOperationResultDc, DeleteResourcesParams5, DeleteTableDataParams, DetailedTableInfoDc, FileUploadResponse, GetTableListParams, GetUniqueDataRowsParams, MapRemoteTableInfoDc, MapRemoteTableParams, MapTableParams, MapTablePayload, MapViewInfoDc, MapViewParams, ResourceDependenciesDc, SetPermissionsBatchInput, SetPreviewInput, UpdateTableDataParams, UpdateTableDataPayload, UpdateTableDc } from './data-contracts';
1
+ import { AccessControlListDc, BulkOperationResultDc, DeleteResourcesParams, DeleteTableDataParams, DetailedTableInfoDc, FileUploadResponse, GetTableDataParams, GetTableListParams, GetUniqueDataRowsParams, ListResponseIEnumerable1, MapRemoteTableInfoDc, MapRemoteTableParams, MapTableParams, MapTablePayload, MapViewInfoDc, MapViewParams, ResourceDependenciesDc, SetPermissionsBatchInput, SetPreviewInput, UpdateTableDataParams, UpdateTableDataPayload, UpdateTableDc } from './data-contracts';
2
2
  import { Service } from './Service';
3
3
  /**
4
4
  * @title Spatial Processing Core API
@@ -49,7 +49,7 @@ export declare class TablesService extends Service {
49
49
  * @request DELETE:/tables
50
50
  * @response `200` Success
51
51
  */
52
- deleteResources(query: DeleteResourcesParams5): Promise<BulkOperationResultDc[]>;
52
+ deleteResources(query: DeleteResourcesParams): Promise<BulkOperationResultDc[]>;
53
53
  /**
54
54
  * No description
55
55
  *
@@ -83,6 +83,17 @@ export declare class TablesService extends Service {
83
83
  * @response `200` Success
84
84
  */
85
85
  getTableInfo(name: string): Promise<DetailedTableInfoDc>;
86
+ /**
87
+ * No description
88
+ *
89
+ * @tags Tables
90
+ * @name GetTableData
91
+ * @operationId TablesController_GetTableData
92
+ * @summary Retrieves the data from the table.
93
+ * @request GET:/tables/{name}/data
94
+ * @response `200` Success
95
+ */
96
+ getTableData({ name, ...query }: GetTableDataParams): Promise<ListResponseIEnumerable1>;
86
97
  /**
87
98
  * No description
88
99
  *
@@ -0,0 +1,20 @@
1
+ import { ProcessWmsRequestParams } from './data-contracts';
2
+ import { Service } from './Service';
3
+ /**
4
+ * @title Spatial Processing Core API
5
+ * @version v0.6.0
6
+ * @baseUrl /sp
7
+ */
8
+ export declare class WmsServerService extends Service {
9
+ /**
10
+ * No description
11
+ *
12
+ * @tags WmsServer
13
+ * @name ProcessWmsRequest
14
+ * @operationId WmsServerController_ProcessWmsRequestAsync
15
+ * @summary WMS entrypoint.
16
+ * @request GET:/wms
17
+ * @response `200` Success
18
+ */
19
+ processWmsRequest(query: ProcessWmsRequestParams): Promise<void>;
20
+ }
@@ -911,6 +911,8 @@ InvalidLayerType
911
911
  ColumnLoadingError
912
912
 
913
913
  InvalidAttributeFormat
914
+
915
+ DataSourceNotFound
914
916
  */
915
917
  export declare enum ConfigurationErrorEnum {
916
918
  Unknown = "Unknown",
@@ -931,7 +933,8 @@ export declare enum ConfigurationErrorEnum {
931
933
  InvalidStyle = "InvalidStyle",
932
934
  InvalidLayerType = "InvalidLayerType",
933
935
  ColumnLoadingError = "ColumnLoadingError",
934
- InvalidAttributeFormat = "InvalidAttributeFormat"
936
+ InvalidAttributeFormat = "InvalidAttributeFormat",
937
+ DataSourceNotFound = "DataSourceNotFound"
935
938
  }
936
939
  /**
937
940
  * SPCore.Connectors.Connectors.Base.Models.Scheduler.ConfiguredLayerDataStorageDc provides configurable layer storage.
@@ -2385,6 +2388,19 @@ export interface ListResponseFeatureDc {
2385
2388
  /** @format int64 */
2386
2389
  limit?: number;
2387
2390
  }
2391
+ /**
2392
+ * The response that contains a paged list of items.
2393
+ */
2394
+ export interface ListResponseIEnumerable1 {
2395
+ /** The items of the response. */
2396
+ items?: Record<string, any>[][];
2397
+ /** @format int64 */
2398
+ totalCount?: number;
2399
+ /** @format int64 */
2400
+ offset?: number;
2401
+ /** @format int64 */
2402
+ limit?: number;
2403
+ }
2388
2404
  /**
2389
2405
  * The response that contains a paged list of items.
2390
2406
  */
@@ -5401,6 +5417,8 @@ export interface GetLayersListParams {
5401
5417
  * @format int32
5402
5418
  */
5403
5419
  limit?: number;
5420
+ /** Strict list of names of the resources to get. */
5421
+ names?: string[];
5404
5422
  /** A list of {ServiceInfoDc} fields for sorting. If a field starts with {-} ordering is by descending. */
5405
5423
  orderByFields?: string[];
5406
5424
  /** Filters layers by geometry types. */
@@ -5454,6 +5472,39 @@ export interface DeleteFeatureParams {
5454
5472
  }
5455
5473
  export declare type CreateFeaturesPayload = FeatureDc[];
5456
5474
  export declare type UpdateFeaturePayload = FeatureDc[];
5475
+ export interface FeaturesContainsParams {
5476
+ /** Contains filter within a given filterAttributes. */
5477
+ filter?: string;
5478
+ /** Filter attributes. */
5479
+ filterAttributes?: string[];
5480
+ /**
5481
+ * Comma separated list of attributes by which to sort the resulting feature list.
5482
+ * If the attribute name is preceded with the "-" sign, sorting by this attribute will be
5483
+ * in descending order.
5484
+ */
5485
+ sort?: string[];
5486
+ /** Comma separated list of attributes to be returned. If not set, all attributes are returned. */
5487
+ attributes?: string[];
5488
+ /**
5489
+ * Features count have to skip.
5490
+ * @format int32
5491
+ */
5492
+ offset?: number;
5493
+ /**
5494
+ * Features limit per response.
5495
+ * @format int32
5496
+ */
5497
+ limit?: number;
5498
+ /**
5499
+ * Spatial reference of returned features.
5500
+ * @format int32
5501
+ */
5502
+ wkid?: number;
5503
+ /** If set to true, the geometry will not be returned for features. */
5504
+ withGeom?: boolean;
5505
+ /** Full name of the layer. */
5506
+ name: string;
5507
+ }
5457
5508
  export interface GetByIdParams {
5458
5509
  /**
5459
5510
  * Spatial reference of returned features.
@@ -5807,7 +5858,7 @@ export interface GetProjectsListParams {
5807
5858
  forAllUsers?: boolean;
5808
5859
  }
5809
5860
  export declare type SetPermissionsBatchBody = ResourceAclDc[];
5810
- export interface DeleteResourcesParams7 {
5861
+ export interface DeleteResourcesParams6 {
5811
5862
  /** Resource names. */
5812
5863
  names?: string[];
5813
5864
  }
@@ -5942,7 +5993,7 @@ export interface FindUserByNameByRolesParams {
5942
5993
  roles?: string[];
5943
5994
  }
5944
5995
  export interface FindUserByNameParams {
5945
- /** String filter for the username or email (uses % and _ wild cards like SQL). */
5996
+ /** String filter for the username. */
5946
5997
  filter?: string;
5947
5998
  }
5948
5999
  export interface GetPolicyListParams {
@@ -5995,6 +6046,10 @@ export interface UploadFilePayload {
5995
6046
  */
5996
6047
  rewrite?: boolean;
5997
6048
  }
6049
+ export interface DeleteFileParams {
6050
+ /** File id to delete. */
6051
+ fileid?: string;
6052
+ }
5998
6053
  export interface GetTableListParams {
5999
6054
  /** Table name filter (support % and _ wildcards). */
6000
6055
  filter?: string;
@@ -6008,6 +6063,8 @@ export interface GetTableListParams {
6008
6063
  * @format int32
6009
6064
  */
6010
6065
  limit?: number;
6066
+ /** Strict list of names of the resources to get. */
6067
+ names?: string[];
6011
6068
  /** A list of {TableListDc} fields for sorting. If a field starts with {-} ordering is by descending. */
6012
6069
  orderByFields?: string[];
6013
6070
  /** Filters tables list by users favorite. */
@@ -6022,6 +6079,26 @@ export interface DeleteResourcesParams5 {
6022
6079
  /** Resource names. */
6023
6080
  names?: string[];
6024
6081
  }
6082
+ export interface GetTableDataParams {
6083
+ /** String filter for the all text column (uses % and _ wild cards like SQL). */
6084
+ filter?: string;
6085
+ /**
6086
+ * Max number of rows to return.
6087
+ * @format int32
6088
+ */
6089
+ limit?: number;
6090
+ /**
6091
+ * The first row index to return.
6092
+ * @format int32
6093
+ */
6094
+ offset?: number;
6095
+ /** Include column with geometry. */
6096
+ includeGeometry?: boolean;
6097
+ /** Columns to select. */
6098
+ columns?: string[];
6099
+ /** Name of the table. */
6100
+ name: string;
6101
+ }
6025
6102
  export declare type UpdateTableDataPayload = Record<string, any>[];
6026
6103
  export interface UpdateTableDataParams {
6027
6104
  /** Id column name. */
@@ -6152,4 +6229,52 @@ export interface GetToolsListsParams {
6152
6229
  */
6153
6230
  status?: ToolStatus;
6154
6231
  }
6232
+ export interface ProcessWmsRequestParams {
6233
+ /** Request version. */
6234
+ Version?: string;
6235
+ /** Comma-separated list of one or more map layers. */
6236
+ Layers?: string;
6237
+ /** Array of one or more map layers. */
6238
+ LayerNames?: string[];
6239
+ /** Comma-separated list of one rendering style per requested layer. */
6240
+ Styles?: string;
6241
+ /** Coordinate reference system for version 1.3.0. */
6242
+ Crs?: string;
6243
+ /** Comma-separated list of bounding box corners (lower left, upper right) in CRS units. */
6244
+ Bbox?: string;
6245
+ /** @format double */
6246
+ 'BoundingBox.Width'?: number;
6247
+ /** @format double */
6248
+ 'BoundingBox.Height'?: number;
6249
+ /** @format int32 */
6250
+ 'BoundingBox.Center.Dimensions'?: number;
6251
+ /** @format int32 */
6252
+ 'BoundingBox.HalfSize.Dimensions'?: number;
6253
+ /**
6254
+ * Width in pixels of map picture.
6255
+ * @format int32
6256
+ */
6257
+ Width?: number;
6258
+ /**
6259
+ * Height in pixels of map picture.
6260
+ * @format int32
6261
+ */
6262
+ Height?: number;
6263
+ /** Output format of map. */
6264
+ Format?: string;
6265
+ /** Background transparency of map. */
6266
+ Transparent?: boolean;
6267
+ /** Hexadecimal red-green-blue colour value for the background color. */
6268
+ Bgcolor?: string;
6269
+ /** The format in which exceptions are to be reported by the WMS. */
6270
+ Exceptions?: string;
6271
+ /** Time value of layer desired. */
6272
+ Time?: string;
6273
+ /** Elevation of layer desired. */
6274
+ Elevation?: string;
6275
+ /** Must be WMS. */
6276
+ Service?: string;
6277
+ /** Request name. */
6278
+ Request?: string;
6279
+ }
6155
6280
  export {};