@evergis/api 3.0.51 → 3.0.55

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, ClassifyParams, CompositeServiceConfigurationDc, CompositeServiceInfoDc, CreateFeaturesPayload, DeleteFeatureParams, DeleteFeaturesParams, 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
@@ -28,6 +28,17 @@ export declare class LayersService extends Service {
28
28
  * @response `200` Success
29
29
  */
30
30
  setPermissionsBatch(data: SetPermissionsBatchPayload): Promise<void>;
31
+ /**
32
+ * No description
33
+ *
34
+ * @tags Layers
35
+ * @name DeleteResources
36
+ * @operationId LayersController_DeleteResources
37
+ * @summary Bulk delete resources.
38
+ * @request DELETE:/layers
39
+ * @response `200` Success
40
+ */
41
+ deleteResources(query: DeleteResourcesParams): Promise<BulkOperationResultDc[]>;
31
42
  /**
32
43
  * No description
33
44
  *
@@ -249,6 +260,17 @@ export declare class LayersService extends Service {
249
260
  * @response `200` Success
250
261
  */
251
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>;
252
274
  /**
253
275
  * No description
254
276
  *
@@ -1,4 +1,4 @@
1
- import { AccessControlListDc, 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
@@ -50,6 +50,17 @@ export declare class ProjectsService extends Service {
50
50
  * @response `200` Success
51
51
  */
52
52
  setPermissionsBatch(data: SetPermissionsBatchBody): Promise<void>;
53
+ /**
54
+ * No description
55
+ *
56
+ * @tags Projects
57
+ * @name DeleteResources
58
+ * @operationId ProjectsController_DeleteResources
59
+ * @summary Bulk delete resources.
60
+ * @request DELETE:/projects
61
+ * @response `200` Success
62
+ */
63
+ deleteResources(query: DeleteResourcesParams): Promise<BulkOperationResultDc[]>;
53
64
  /**
54
65
  * No description
55
66
  *
@@ -1,4 +1,4 @@
1
- import { FindUserByNameParams, GetPolicyListParams, PolicyDc, RemovePolicyParams, SearchedUserDc } from './data-contracts';
1
+ import { FindUserByNameByRolesParams, FindUserByNameParams, GetPolicyListParams, PolicyDc, RemovePolicyParams, SearchedUserDc } from './data-contracts';
2
2
  import { Service } from './Service';
3
3
  /**
4
4
  * @title Spatial Processing Core API
@@ -6,13 +6,24 @@ import { Service } from './Service';
6
6
  * @baseUrl /sp
7
7
  */
8
8
  export declare class SecurityService extends Service {
9
+ /**
10
+ * No description
11
+ *
12
+ * @tags SecurityService
13
+ * @name FindUserByNameByRoles
14
+ * @operationId SecurityServiceController_FindUserByNameByRoles
15
+ * @summary Get users list with given roles list.
16
+ * @request GET:/security/findUsersWithRoles
17
+ * @response `200` Success
18
+ */
19
+ findUserByNameByRoles(query: FindUserByNameByRolesParams): Promise<SearchedUserDc[]>;
9
20
  /**
10
21
  * No description
11
22
  *
12
23
  * @tags SecurityService
13
24
  * @name FindUserByName
14
25
  * @operationId SecurityServiceController_FindUserByName
15
- * @summary Returns the list of users found by username or email.
26
+ * @summary Returns the list of users found by username.
16
27
  * @request GET:/security/users
17
28
  * @response `200` Success
18
29
  */
@@ -1,4 +1,4 @@
1
- import { AccessControlListDc, 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, 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
@@ -39,6 +39,17 @@ export declare class TablesService extends Service {
39
39
  * @response `200` Success
40
40
  */
41
41
  setPermissionsBatch(data: SetPermissionsBatchInput): Promise<void>;
42
+ /**
43
+ * No description
44
+ *
45
+ * @tags Tables
46
+ * @name DeleteResources
47
+ * @operationId TablesController_DeleteResources
48
+ * @summary Bulk delete resources.
49
+ * @request DELETE:/tables
50
+ * @response `200` Success
51
+ */
52
+ deleteResources(query: DeleteResourcesParams): Promise<BulkOperationResultDc[]>;
42
53
  /**
43
54
  * No description
44
55
  *
@@ -72,6 +83,17 @@ export declare class TablesService extends Service {
72
83
  * @response `200` Success
73
84
  */
74
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<Record<string, any>[]>;
75
97
  /**
76
98
  * No description
77
99
  *
@@ -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.
@@ -1918,6 +1921,10 @@ export interface IceRouteDc {
1918
1921
  attributes?: IceRouteAttributesDc;
1919
1922
  /** Route geometry. */
1920
1923
  geometry?: IceRouteGeometryDc;
1924
+ /** Gets false if route build process failed. */
1925
+ isSuccess?: boolean;
1926
+ /** Gets error message if route build process failed. */
1927
+ error?: string;
1921
1928
  }
1922
1929
  /**
1923
1930
  * Route geometry.
@@ -5397,6 +5404,8 @@ export interface GetLayersListParams {
5397
5404
  * @format int32
5398
5405
  */
5399
5406
  limit?: number;
5407
+ /** Strict list of names of the resources to get. */
5408
+ names?: string[];
5400
5409
  /** A list of {ServiceInfoDc} fields for sorting. If a field starts with {-} ordering is by descending. */
5401
5410
  orderByFields?: string[];
5402
5411
  /** Filters layers by geometry types. */
@@ -5407,6 +5416,10 @@ export interface GetLayersListParams {
5407
5416
  forAllUsers?: boolean;
5408
5417
  }
5409
5418
  export declare type SetPermissionsBatchPayload = ResourceAclDc[];
5419
+ export interface DeleteResourcesParams {
5420
+ /** Resource names. */
5421
+ names?: string[];
5422
+ }
5410
5423
  export interface GetFeaturesParams {
5411
5424
  /** Sets features filtering query. */
5412
5425
  query?: string;
@@ -5446,6 +5459,39 @@ export interface DeleteFeatureParams {
5446
5459
  }
5447
5460
  export declare type CreateFeaturesPayload = FeatureDc[];
5448
5461
  export declare type UpdateFeaturePayload = FeatureDc[];
5462
+ export interface FeaturesContainsParams {
5463
+ /** Contains filter within a given filterAttributes. */
5464
+ filter?: string;
5465
+ /** Filter attributes. */
5466
+ filterAttributes?: string[];
5467
+ /**
5468
+ * Comma separated list of attributes by which to sort the resulting feature list.
5469
+ * If the attribute name is preceded with the "-" sign, sorting by this attribute will be
5470
+ * in descending order.
5471
+ */
5472
+ sort?: string[];
5473
+ /** Comma separated list of attributes to be returned. If not set, all attributes are returned. */
5474
+ attributes?: string[];
5475
+ /**
5476
+ * Features count have to skip.
5477
+ * @format int32
5478
+ */
5479
+ offset?: number;
5480
+ /**
5481
+ * Features limit per response.
5482
+ * @format int32
5483
+ */
5484
+ limit?: number;
5485
+ /**
5486
+ * Spatial reference of returned features.
5487
+ * @format int32
5488
+ */
5489
+ wkid?: number;
5490
+ /** If set to true, the geometry will not be returned for features. */
5491
+ withGeom?: boolean;
5492
+ /** Full name of the layer. */
5493
+ name: string;
5494
+ }
5449
5495
  export interface GetByIdParams {
5450
5496
  /**
5451
5497
  * Spatial reference of returned features.
@@ -5925,8 +5971,12 @@ export interface UploadScriptFilePayload {
5925
5971
  /** @format binary */
5926
5972
  settings?: File;
5927
5973
  }
5974
+ export interface FindUserByNameByRolesParams {
5975
+ /** Roles. */
5976
+ roles?: string[];
5977
+ }
5928
5978
  export interface FindUserByNameParams {
5929
- /** String filter for the username or email (uses % and _ wild cards like SQL). */
5979
+ /** String filter for the username. */
5930
5980
  filter?: string;
5931
5981
  }
5932
5982
  export interface GetPolicyListParams {
@@ -5992,6 +6042,8 @@ export interface GetTableListParams {
5992
6042
  * @format int32
5993
6043
  */
5994
6044
  limit?: number;
6045
+ /** Strict list of names of the resources to get. */
6046
+ names?: string[];
5995
6047
  /** A list of {TableListDc} fields for sorting. If a field starts with {-} ordering is by descending. */
5996
6048
  orderByFields?: string[];
5997
6049
  /** Filters tables list by users favorite. */
@@ -6002,6 +6054,26 @@ export interface GetTableListParams {
6002
6054
  geometryFilter?: string[];
6003
6055
  }
6004
6056
  export declare type SetPermissionsBatchInput = ResourceAclDc[];
6057
+ export interface GetTableDataParams {
6058
+ /** String filter for the all text column (uses % and _ wild cards like SQL). */
6059
+ filter?: string;
6060
+ /**
6061
+ * Max number of rows to return.
6062
+ * @format int32
6063
+ */
6064
+ limit?: number;
6065
+ /**
6066
+ * The first row index to return.
6067
+ * @format int32
6068
+ */
6069
+ offset?: number;
6070
+ /** Include column with geometry. */
6071
+ includeGeometry?: boolean;
6072
+ /** Columns to select. */
6073
+ columns?: string[];
6074
+ /** Name of the table. */
6075
+ name: string;
6076
+ }
6005
6077
  export declare type UpdateTableDataPayload = Record<string, any>[];
6006
6078
  export interface UpdateTableDataParams {
6007
6079
  /** Id column name. */