@evergis/api 5.0.31 → 5.0.33

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/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2025 Everpoint
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Everpoint
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
- # @evergis/api
2
-
3
- Библиотека API.
4
-
5
- ### Генерирование API
6
-
7
- ```shell
8
- $ yarn generate
9
- ```
10
-
11
- ***ВАЖНО!!!***: Никогда и ни при каких обстоятельствах нельзя вручную править файлы,
12
- размещенные в директории `src/__generated__`!
1
+ # @evergis/api
2
+
3
+ Библиотека API.
4
+
5
+ ### Генерирование API
6
+
7
+ ```shell
8
+ $ yarn generate
9
+ ```
10
+
11
+ ***ВАЖНО!!!***: Никогда и ни при каких обстоятельствах нельзя вручную править файлы,
12
+ размещенные в директории `src/__generated__`!
@@ -1,5 +1,5 @@
1
1
  import { Service } from './Service';
2
- import { AccessControlListDc, CatalogResourceDc, CopyResourceResultDc, CopyResourcesPayload, CreateDirectoryDc, CreateFile1Payload, CreateFilePayload, CreateSymlinkDc, DeleteResourceParams, GetByPathDc, GetTagsParams, ListResourcesDc, MoveResourceDc, PagedResourcesListDc, PagedTagsListDc, PatchResourceDc, PostGetAllParams, PutTagsPayload, ResourceParentDc, SetPermissionsPayload, ZipExtractRequestDc } from './data-contracts';
2
+ import { AccessControlListDc, CopyResourceResultDc, CopyResourcesPayload, CreateDirectoryDc, CreateFile1Payload, CreateFilePayload, CreateSymlinkDc, DeleteResourceParams, ExtendedCatalogResourceDc, GetTagsParams, ListResourcesDc, MoveResourceDc, PagedResourcesListDc, PagedTagsListDc, PatchResourceDc, PostGetAllParams, PutTagsPayload, ResourceParentDc, SetPermissionsPayload, ZipExtractRequestDc } from './data-contracts';
3
3
  /**
4
4
  * @title Spatial Processing Gateway API
5
5
  * @version 1.5.1.0
@@ -41,7 +41,7 @@ export declare class CatalogService extends Service {
41
41
  * @secure
42
42
  * @response `200` OK
43
43
  */
44
- putTags(resourceId: string, data: PutTagsPayload): Promise<CatalogResourceDc>;
44
+ putTags(resourceId: string, data: PutTagsPayload): Promise<ExtendedCatalogResourceDc>;
45
45
  /**
46
46
  * No description
47
47
  *
@@ -53,7 +53,7 @@ export declare class CatalogService extends Service {
53
53
  * @secure
54
54
  * @response `200` OK
55
55
  */
56
- postLink(data: CreateSymlinkDc): Promise<CatalogResourceDc>;
56
+ postLink(data: CreateSymlinkDc): Promise<ExtendedCatalogResourceDc>;
57
57
  /**
58
58
  * No description
59
59
  *
@@ -77,7 +77,7 @@ export declare class CatalogService extends Service {
77
77
  * @secure
78
78
  * @response `200` OK
79
79
  */
80
- getResource(resourceId: string): Promise<CatalogResourceDc>;
80
+ getResource(resourceId: string): Promise<ExtendedCatalogResourceDc>;
81
81
  /**
82
82
  * No description
83
83
  *
@@ -89,7 +89,7 @@ export declare class CatalogService extends Service {
89
89
  * @secure
90
90
  * @response `200` OK
91
91
  */
92
- patchResource(resourceId: string, data: PatchResourceDc): Promise<CatalogResourceDc>;
92
+ patchResource(resourceId: string, data: PatchResourceDc): Promise<ExtendedCatalogResourceDc>;
93
93
  /**
94
94
  * No description
95
95
  *
@@ -102,18 +102,6 @@ export declare class CatalogService extends Service {
102
102
  * @response `200` OK
103
103
  */
104
104
  deleteResource({ resourceId, ...query }: DeleteResourceParams): Promise<void>;
105
- /**
106
- * No description
107
- *
108
- * @tags Catalog
109
- * @name ResourceExistsByPath
110
- * @operationId CatalogController_ResourceExistsByPathAsync
111
- * @summary Check resource path is existing.
112
- * @request GET:/resources/existsByPath/{path}
113
- * @secure
114
- * @response `200` OK
115
- */
116
- resourceExistsByPath(path: string): Promise<boolean>;
117
105
  /**
118
106
  * No description
119
107
  *
@@ -121,59 +109,11 @@ export declare class CatalogService extends Service {
121
109
  * @name ResourceExistsById
122
110
  * @operationId CatalogController_ResourceExistsByIdAsync
123
111
  * @summary Check resource id is existing.
124
- * @request GET:/resources/existsById/{resourceId}
112
+ * @request GET:/resources/exists/{resourceId}
125
113
  * @secure
126
114
  * @response `200` OK
127
115
  */
128
116
  resourceExistsById(resourceId: string): Promise<boolean>;
129
- /**
130
- * No description
131
- *
132
- * @tags Catalog
133
- * @name ResourceExistsByName
134
- * @operationId CatalogController_ResourceExistsByNameAsync
135
- * @summary Check resource path exists.
136
- * @request GET:/resources/existsByName/{systemName}
137
- * @secure
138
- * @response `200` OK
139
- */
140
- resourceExistsByName(systemName: string): Promise<boolean>;
141
- /**
142
- * No description
143
- *
144
- * @tags Catalog
145
- * @name GetResourceByPath
146
- * @operationId CatalogController_GetResourceByPath
147
- * @summary Get resource with given path.
148
- * @request GET:/resources/getByPath/{path}
149
- * @secure
150
- * @response `200` OK
151
- */
152
- getResourceByPath(path: string): Promise<CatalogResourceDc>;
153
- /**
154
- * No description
155
- *
156
- * @tags Catalog
157
- * @name PostGetResourceByPath
158
- * @operationId CatalogController_PostGetResourceByPath
159
- * @summary Get resource with given path.
160
- * @request POST:/resources/getByPath
161
- * @secure
162
- * @response `200` OK
163
- */
164
- postGetResourceByPath(data: GetByPathDc): Promise<CatalogResourceDc>;
165
- /**
166
- * No description
167
- *
168
- * @tags Catalog
169
- * @name GetBySystemName
170
- * @operationId CatalogController_GetBySystemName
171
- * @summary Get resource with given system name.
172
- * @request GET:/resources/getBySystemName/{systemName}
173
- * @secure
174
- * @response `200` OK
175
- */
176
- getBySystemName(systemName: string): Promise<CatalogResourceDc>;
177
117
  /**
178
118
  * No description
179
119
  *
@@ -185,7 +125,7 @@ export declare class CatalogService extends Service {
185
125
  * @secure
186
126
  * @response `200` OK
187
127
  */
188
- moveResource(resourceId: string, data: MoveResourceDc): Promise<CatalogResourceDc>;
128
+ moveResource(resourceId: string, data: MoveResourceDc): Promise<ExtendedCatalogResourceDc>;
189
129
  /**
190
130
  * No description
191
131
  *
@@ -197,7 +137,7 @@ export declare class CatalogService extends Service {
197
137
  * @secure
198
138
  * @response `200` OK
199
139
  */
200
- createDirectory(data: CreateDirectoryDc): Promise<CatalogResourceDc>;
140
+ createDirectory(data: CreateDirectoryDc): Promise<ExtendedCatalogResourceDc>;
201
141
  /**
202
142
  * No description
203
143
  *
@@ -209,7 +149,7 @@ export declare class CatalogService extends Service {
209
149
  * @secure
210
150
  * @response `200` OK
211
151
  */
212
- createFile(data: CreateFilePayload | FormData): Promise<CatalogResourceDc>;
152
+ createFile(data: CreateFilePayload | FormData): Promise<ExtendedCatalogResourceDc>;
213
153
  /**
214
154
  * No description
215
155
  *
@@ -221,7 +161,7 @@ export declare class CatalogService extends Service {
221
161
  * @secure
222
162
  * @response `200` OK
223
163
  */
224
- createFile1(data: CreateFile1Payload | FormData): Promise<CatalogResourceDc>;
164
+ createFile1(data: CreateFile1Payload | FormData): Promise<ExtendedCatalogResourceDc>;
225
165
  /**
226
166
  * No description
227
167
  *
@@ -246,6 +186,18 @@ export declare class CatalogService extends Service {
246
186
  * @response `200` OK
247
187
  */
248
188
  setPermissions1(resourceId: string, data: AccessControlListDc): Promise<void>;
189
+ /**
190
+ * No description
191
+ *
192
+ * @tags Catalog
193
+ * @name GetPermissionsV2
194
+ * @operationId CatalogController_GetPermissionsV2
195
+ * @summary Set permissions to the resource.
196
+ * @request GET:/resources/permissions/{resourceId}
197
+ * @secure
198
+ * @response `200` OK
199
+ */
200
+ getPermissionsV2(resourceId: string): Promise<AccessControlListDc>;
249
201
  /**
250
202
  * No description
251
203
  *
@@ -1,5 +1,5 @@
1
1
  import { Service } from './Service';
2
- import { AggregateAttributeParams, AggregationDataResultDc, AttributeDistinctsDc, BulkExtentsDc, BulkFilteredFeaturesCountDc, BulkOperationResultDc, ClassifyDc, ClassifyParams, CreateFeaturesParams, CreateFeaturesPayload, DeleteByConditionParams, DeleteFeatureParams, DeleteFeaturesParams, DeleteResourcesParams, DetailedTableInfoDc, DistinctsParams, EditAttributesInfoDc, EnvelopeDc, ExpressionValidationResultDc, ExtendedProjectInfoDc, ExtendedProjectInfoDcV2, FailedServiceInfoDc, FeatureDc, GetBulkExtentsParams, GetBulkExtentsPayload, GetBulkFeaturesPayload, GetByIdParams, GetFeatures1Params, GetFeaturesParametersDc, GetFilteredFeaturesCount1Params, GetFilteredFeaturesCountDc, GetFilteredFeaturesCountPayload, GetLayerExtentParams, GetLayersInfoParams, GetRasterMetaParams2, GetTilesLayerImage1Params, GetTilesLayerImageParams, GetTilesLayerImageWithFormatAndDpiParams, LayerUpdateInfoDc, NetCdfMetaDc, Operation, PagedBulkFeaturesListDc, PagedFeaturesListDc, PatchQueryLayerService1Payload, PatchQueryLayerServicePayload, PbfServiceInfoDc, ProjectInfoDcV2, ProxyServiceInfoDc, PublishLayerInfoDc, PythonServiceInfoDc, QueryLayerServiceInfoDc, RasterMetaDc, RemoteTileServiceInfoDc, ResourceDependenciesDc, ServiceInfoDc, TileCatalogServiceInfoDc, UpdateFeaturePayload, UpdateTableDc, ValidateExpressionParams } from './data-contracts';
2
+ import { AggregateAttributeParams, AggregationDataResultDc, AttributeDistinctsDc, BulkExtentsDc, BulkFilteredFeaturesCountDc, ClassifyDc, ClassifyParams, CreateFeaturesParams, CreateFeaturesPayload, DeleteByConditionParams, DeleteFeatureParams, DeleteFeaturesParams, DetailedTableInfoDc, DistinctsParams, EditAttributesInfoDc, EnvelopeDc, ExpressionValidationResultDc, ExtendedProjectInfoDc, ExtendedProjectInfoDcV2, FailedServiceInfoDc, FeatureDc, GetBulkExtentsParams, GetBulkExtentsPayload, GetBulkFeaturesPayload, GetByIdParams, GetFeatures1Params, GetFeaturesParametersDc, GetFilteredFeaturesCount1Params, GetFilteredFeaturesCountDc, GetFilteredFeaturesCountPayload, GetLayerExtentParams, GetLayersInfoParams, GetRasterMetaParams2, GetTilesLayerImage1Params, GetTilesLayerImageParams, GetTilesLayerImageWithFormatAndDpiParams, LayerUpdateInfoDc, NetCdfMetaDc, Operation, PagedBulkFeaturesListDc, PagedFeaturesListDc, PatchQueryLayerService1Payload, PatchQueryLayerServicePayload, PbfServiceInfoDc, ProjectInfoDcV2, ProxyServiceInfoDc, PublishLayerInfoDc, PythonServiceInfoDc, QueryLayerServiceInfoDc, RasterMetaDc, RemoteTileServiceInfoDc, ResourceDependenciesDc, ServiceInfoDc, TileCatalogServiceInfoDc, UpdateFeaturePayload, UpdateTableDc, ValidateExpressionParams } from './data-contracts';
3
3
  /**
4
4
  * @title Spatial Processing Gateway API
5
5
  * @version 1.5.1.0
@@ -90,18 +90,6 @@ export declare class LayersService extends Service {
90
90
  * @response `200` OK
91
91
  */
92
92
  publishService(data: PublishLayerInfoDc): Promise<ServiceInfoDc | RemoteTileServiceInfoDc | ProxyServiceInfoDc | PythonServiceInfoDc | ExtendedProjectInfoDc | ProjectInfoDcV2 | ExtendedProjectInfoDcV2 | PbfServiceInfoDc | FailedServiceInfoDc | QueryLayerServiceInfoDc | TileCatalogServiceInfoDc | DetailedTableInfoDc | UpdateTableDc>;
93
- /**
94
- * No description
95
- *
96
- * @tags Layers
97
- * @name DeleteResources
98
- * @operationId LayersController_DeleteResources
99
- * @summary Bulk delete resources.
100
- * @request DELETE:/layers
101
- * @secure
102
- * @response `200` OK
103
- */
104
- deleteResources(query: DeleteResourcesParams): Promise<BulkOperationResultDc[]>;
105
93
  /**
106
94
  * No description
107
95
  *
@@ -0,0 +1,69 @@
1
+ import { Service } from './Service';
2
+ import { SubscribeListOperationPayload, SubscribeOperationParams, UnsubscribeListOperationPayload, UnsubscribeOperationParams } from './data-contracts';
3
+ /**
4
+ * @title Spatial Processing Gateway API
5
+ * @version 1.5.1.0
6
+ * @baseUrl /sp
7
+ */
8
+ export declare class NotificationService extends Service {
9
+ /**
10
+ * No description
11
+ *
12
+ * @tags NotificationService
13
+ * @name GetSubscriptionList
14
+ * @operationId NotificationServiceController_GetSubscriptionList
15
+ * @summary Returns a list of notification tags that the current session is subscribed to.
16
+ * @request GET:/notifications/subscribes
17
+ * @secure
18
+ * @response `200` OK
19
+ */
20
+ getSubscriptionList(): Promise<string[]>;
21
+ /**
22
+ * No description
23
+ *
24
+ * @tags NotificationService
25
+ * @name SubscribeOperation
26
+ * @operationId NotificationServiceController_SubscribeOperation
27
+ * @summary Subscribe current session by subscribe tag. A subscribed session will receive all notifications added for the specified tag.
28
+ * @request POST:/notifications/subscribes
29
+ * @secure
30
+ * @response `200` OK
31
+ */
32
+ subscribeOperation(query: SubscribeOperationParams): Promise<void>;
33
+ /**
34
+ * No description
35
+ *
36
+ * @tags NotificationService
37
+ * @name UnsubscribeOperation
38
+ * @operationId NotificationServiceController_UnsubscribeOperation
39
+ * @summary Unsubscribe from receiving notifications that come for the specified tag.
40
+ * @request DELETE:/notifications/subscribes
41
+ * @secure
42
+ * @response `200` OK
43
+ */
44
+ unsubscribeOperation(query: UnsubscribeOperationParams): Promise<void>;
45
+ /**
46
+ * No description
47
+ *
48
+ * @tags NotificationService
49
+ * @name SubscribeListOperation
50
+ * @operationId NotificationServiceController_SubscribeListOperation
51
+ * @summary Subscribe current session by subscribe tags. A subscribed session will receive all notifications added for the specified tags.
52
+ * @request POST:/notifications/subscribe-list
53
+ * @secure
54
+ * @response `200` OK
55
+ */
56
+ subscribeListOperation(data: SubscribeListOperationPayload): Promise<void>;
57
+ /**
58
+ * No description
59
+ *
60
+ * @tags NotificationService
61
+ * @name UnsubscribeListOperation
62
+ * @operationId NotificationServiceController_UnsubscribeListOperation
63
+ * @summary Unsubscribe from receiving notifications that come for the specified tags.
64
+ * @request POST:/notifications/unsubscribe-list
65
+ * @secure
66
+ * @response `200` OK
67
+ */
68
+ unsubscribeListOperation(data: UnsubscribeListOperationPayload): Promise<void>;
69
+ }
@@ -1,5 +1,5 @@
1
1
  import { Service } from './Service';
2
- import { BulkOperationResultDc, DeleteResourcesParams2, EnvelopeDc, ExtendedProjectInfoDc, ExtendedProjectLayersInfo, GetProjectEnvelopeParams, GetProjectsInfoParams, Operation, ResourceDependenciesDc, UpdateProjectV2Payload } from './data-contracts';
2
+ import { EnvelopeDc, ExtendedProjectInfoDc, ExtendedProjectLayersInfo, GetProjectEnvelopeParams, GetProjectsInfoParams, Operation, ResourceDependenciesDc, UpdateProjectV2Payload } from './data-contracts';
3
3
  /**
4
4
  * @title Spatial Processing Gateway API
5
5
  * @version 1.5.1.0
@@ -18,18 +18,6 @@ export declare class ProjectsService extends Service {
18
18
  * @response `200` OK
19
19
  */
20
20
  createProject(data: ExtendedProjectInfoDc): Promise<ExtendedProjectInfoDc>;
21
- /**
22
- * No description
23
- *
24
- * @tags Projects
25
- * @name DeleteResources
26
- * @operationId ProjectsController_DeleteResources
27
- * @summary Bulk delete resources.
28
- * @request DELETE:/projects
29
- * @secure
30
- * @response `200` OK
31
- */
32
- deleteResources(query: DeleteResourcesParams2): Promise<BulkOperationResultDc[]>;
33
21
  /**
34
22
  * No description
35
23
  *
@@ -1,5 +1,5 @@
1
1
  import { Service } from './Service';
2
- import { BulkOperationResultDc, CreateViewFromQueryDc, CreateViewFromQueryLayerDc, DeleteResourcesParams4, DeleteTableDataParams, DetailedTableInfoDc, GetTableDataParams, GetTablesInfoParams, MapTableInfoDc, MapTableParams, PagedListFeatureDc, ResourceDependenciesDc, UpdateTableDataParams, UpdateTableDataPayload, UpdateTableDc, WriteTableDataPayload } from './data-contracts';
2
+ import { CreateViewFromQueryDc, CreateViewFromQueryLayerDc, DeleteTableDataParams, DetailedTableInfoDc, GetTableDataParams, GetTablesInfoParams, MapTableInfoDc, MapTableParams, PagedListFeatureDc, ResourceDependenciesDc, UpdateTableDataParams, UpdateTableDataPayload, UpdateTableDc, WriteTableDataPayload } from './data-contracts';
3
3
  /**
4
4
  * @title Spatial Processing Gateway API
5
5
  * @version 1.5.1.0
@@ -18,18 +18,6 @@ export declare class TablesService extends Service {
18
18
  * @response `200` OK
19
19
  */
20
20
  createTable(data: DetailedTableInfoDc): Promise<DetailedTableInfoDc>;
21
- /**
22
- * No description
23
- *
24
- * @tags Tables
25
- * @name DeleteResources
26
- * @operationId TablesController_DeleteResources
27
- * @summary Bulk delete resources.
28
- * @request DELETE:/tables
29
- * @secure
30
- * @response `200` OK
31
- */
32
- deleteResources(query: DeleteResourcesParams4): Promise<BulkOperationResultDc[]>;
33
21
  /**
34
22
  * No description
35
23
  *