@evergis/api 5.0.63 → 5.0.64

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) 2026 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) 2026 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__`!
package/dist/Api.d.ts CHANGED
@@ -2,10 +2,9 @@ import { Options as KyOptions } from 'ky';
2
2
  import { HttpClient } from './__generated__/HttpClient';
3
3
  import { DataSourceService } from './__generated__/DataSourceService';
4
4
  import { QueryTokenAccessService } from './__generated__/QueryTokenAccessService';
5
- import { SpatialReferencesService } from './__generated__/SpatialReferencesService';
6
5
  import { CatalogService } from './__generated__/CatalogService';
7
6
  import { EventEmitter } from './EventEmitter';
8
- import { Account, AccountPreview, External, CatalogShare, ClientSettings, Eql, Feedback, FileUpload, Filters, Geocode, History, Layers, Names, PortalSettings, Projects, RemoteTaskManager, Resources, Security, Statistic, Tables, Tools, VectorTiles } from './services';
7
+ import { Account, AccountPreview, External, CatalogShare, ClientSettings, Eql, Feedback, FileUpload, Filters, Geocode, History, Layers, Names, PortalSettings, Projects, Quotas, RemoteTaskManager, Resources, Security, Statistic, Tables, Tools, VectorTiles } from './services';
9
8
  import { AuthenticateParams, LoginDc } from './__generated__/data-contracts';
10
9
  export type ApiParams = {
11
10
  url: string;
@@ -38,7 +37,6 @@ export declare class Api extends EventEmitter {
38
37
  readonly statistic: Statistic;
39
38
  readonly feedback: Feedback;
40
39
  readonly vectorTiles: VectorTiles;
41
- readonly spatialReference: SpatialReferencesService;
42
40
  readonly eql: Eql;
43
41
  readonly catalog: CatalogService;
44
42
  readonly queryToken: QueryTokenAccessService;
@@ -46,6 +44,7 @@ export declare class Api extends EventEmitter {
46
44
  readonly remoteTaskManager: RemoteTaskManager;
47
45
  readonly catalogShare: CatalogShare;
48
46
  readonly history: History;
47
+ readonly quotas: Quotas;
49
48
  protected readonly http: HttpClient;
50
49
  private readonly urlPath;
51
50
  private refreshingToken;
@@ -1,5 +1,5 @@
1
1
  import { Service } from './Service';
2
- import { ArcGisDataSourceDc, ArcGisDataSourceInfoDc, GetDataSourcesListParams, MosRuDataSourceDc, MosRuDataSourceInfoDc, PagedListDataSourceInfoDc, PostgresDataSourceDc, PostgresDataSourceInfoDc, S3DataSourceDc, S3DataSourceInfoDc, SparkDataSourceDc, SparkDataSourceInfoDc } from './data-contracts';
2
+ import { ArcGisDataSourceDc, ArcGisDataSourceInfoDc, GetDataSourcesListParams, MosRuDataSourceDc, MosRuDataSourceInfoDc, PagedListDataSourceInfoDc, PostgresDataSourceDc, PostgresDataSourceInfoDc, S3DataSourceDc, S3DataSourceInfoDc, SparkDataSourceDc, SparkDataSourceInfoDc, WmsDataSourceDc, WmsDataSourceInfoDc } from './data-contracts';
3
3
  /**
4
4
  * @title Spatial Processing Gateway API
5
5
  * @version 1.5.1.0
@@ -89,7 +89,7 @@ export declare class DataSourceService extends Service {
89
89
  * @secure
90
90
  * @response `200` OK
91
91
  */
92
- getDataSource(name: string): Promise<ArcGisDataSourceInfoDc | MosRuDataSourceInfoDc | PostgresDataSourceInfoDc | S3DataSourceInfoDc | SparkDataSourceInfoDc>;
92
+ getDataSource(name: string): Promise<ArcGisDataSourceInfoDc | MosRuDataSourceInfoDc | PostgresDataSourceInfoDc | S3DataSourceInfoDc | SparkDataSourceInfoDc | WmsDataSourceInfoDc>;
93
93
  /**
94
94
  * No description
95
95
  *
@@ -210,4 +210,40 @@ export declare class DataSourceService extends Service {
210
210
  * @response `200` OK
211
211
  */
212
212
  updateSparkDataSource(data: SparkDataSourceDc): Promise<void>;
213
+ /**
214
+ * No description
215
+ *
216
+ * @tags DataSource
217
+ * @name TestConnection4
218
+ * @operationId DataSourceController_TestConnection_4
219
+ * @summary Test WMS data source connection.
220
+ * @request POST:/ds/wms/test-connection
221
+ * @secure
222
+ * @response `200` OK
223
+ */
224
+ testConnection4(data: WmsDataSourceDc): Promise<void>;
225
+ /**
226
+ * No description
227
+ *
228
+ * @tags DataSource
229
+ * @name CreateWmsDataSource
230
+ * @operationId DataSourceController_CreateWMSDataSource
231
+ * @summary Create ArcGIS data source.
232
+ * @request POST:/ds/wms
233
+ * @secure
234
+ * @response `200` OK
235
+ */
236
+ createWmsDataSource(data: WmsDataSourceDc): Promise<void>;
237
+ /**
238
+ * No description
239
+ *
240
+ * @tags DataSource
241
+ * @name UpdateWmsDataSource
242
+ * @operationId DataSourceController_UpdateWMSDataSource
243
+ * @summary Update ArcGIS data source.
244
+ * @request PATCH:/ds/wms
245
+ * @secure
246
+ * @response `200` OK
247
+ */
248
+ updateWmsDataSource(data: WmsDataSourceDc): Promise<void>;
213
249
  }
@@ -1,5 +1,5 @@
1
1
  import { Service } from './Service';
2
- import { AggregateAttributeParams, AggregationDataResultDc, AttributeDistinctsDc, BulkExtentsDc, BulkFilteredFeaturesCountDc, ClassifyDc, ClassifyParams, CreateFeaturesParams, CreateFeaturesPayload, DeleteByConditionParams, DeleteFeatureParams, DeleteFeaturesParams, DetailedTableInfoDc, DistinctsParams, EditAttributesInfoDc, EnvelopeDc, ExpressionValidationResultDc, ExtendedProjectInfoDc, FailedServiceInfoDc, FeatureDc, GetBulkExtentsParams, GetBulkExtentsPayload, GetBulkFeaturesPayload, GetByIdParams, GetFeatures1Params, GetFeaturesParametersDc, GetFilteredFeaturesCount1Params, GetFilteredFeaturesCountDc, GetFilteredFeaturesCountPayload, GetLayerExtentParams, GetLayersInfoParams, GetTilesLayerImage1Params, GetTilesLayerImageParams, GetTilesLayerImageWithFormatAndDpiParams, LayerUpdateInfoDc, Operation, PagedBulkFeaturesListDc, PagedFeaturesListDc, PatchQueryLayerService1Payload, PatchQueryLayerServicePayload, PbfServiceInfoDc, ProxyServiceInfoDc, PublishLayerInfoDc, PythonServiceInfoDc, QueryLayerServiceInfoDc, 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, FailedServiceInfoDc, GetBulkExtentsParams, GetBulkExtentsPayload, GetBulkFeaturesPayload, GetFeatures1Params, GetFeaturesParametersDc, GetFilteredFeaturesCount1Params, GetFilteredFeaturesCountDc, GetFilteredFeaturesCountPayload, GetLayerExtentParams, GetLayersInfoParams, GetTilesLayerImage1Params, GetTilesLayerImageParams, GetTilesLayerImageWithFormatAndDpiParams, LayerUpdateInfoDc, Operation, PagedBulkFeaturesListDc, PagedFeaturesListDc, PbfServiceInfoDc, ProxyServiceInfoDc, PublishLayerInfoDc, PythonServiceInfoDc, QueryLayerServiceInfoDc, RemoteTileServiceInfoDc, ResourceDependenciesDc, ServiceInfoDc, TileCatalogServiceInfoDc, UpdateFeaturePayload, UpdateService1Payload, UpdateServicePayload, UpdateTableDc, ValidateExpressionParams } from './data-contracts';
3
3
  /**
4
4
  * @title Spatial Processing Gateway API
5
5
  * @version 1.5.1.0
@@ -58,14 +58,14 @@ export declare class LayersService extends Service {
58
58
  * No description
59
59
  *
60
60
  * @tags Layers
61
- * @name PatchQueryLayerService
62
- * @operationId LayersController_PatchQueryLayerService
61
+ * @name UpdateService
62
+ * @operationId LayersController_UpdateServiceAsync
63
63
  * @summary Patch EQL-based Query Layer Service.
64
64
  * @request PATCH:/layers/{name}
65
65
  * @secure
66
66
  * @response `200` OK
67
67
  */
68
- patchQueryLayerService(name: string, data: PatchQueryLayerServicePayload): Promise<ServiceInfoDc | RemoteTileServiceInfoDc | ProxyServiceInfoDc | PythonServiceInfoDc | ExtendedProjectInfoDc | PbfServiceInfoDc | FailedServiceInfoDc | QueryLayerServiceInfoDc | TileCatalogServiceInfoDc | DetailedTableInfoDc | UpdateTableDc>;
68
+ updateService(name: string, data: UpdateServicePayload): Promise<ServiceInfoDc | RemoteTileServiceInfoDc | ProxyServiceInfoDc | PythonServiceInfoDc | ExtendedProjectInfoDc | PbfServiceInfoDc | FailedServiceInfoDc | QueryLayerServiceInfoDc | TileCatalogServiceInfoDc | DetailedTableInfoDc | UpdateTableDc>;
69
69
  /**
70
70
  * No description
71
71
  *
@@ -94,14 +94,14 @@ export declare class LayersService extends Service {
94
94
  * No description
95
95
  *
96
96
  * @tags Layers
97
- * @name PatchQueryLayerService1
98
- * @operationId LayersController_PatchQueryLayerService_1
97
+ * @name UpdateService1
98
+ * @operationId LayersController_UpdateServiceAsync_1
99
99
  * @summary Patch EQL-based Query Layer Service.
100
100
  * @request PATCH:/layers/{name}/v2
101
101
  * @secure
102
102
  * @response `200` OK
103
103
  */
104
- patchQueryLayerService1(name: string, data: PatchQueryLayerService1Payload): Promise<Operation[]>;
104
+ updateService1(name: string, data: UpdateService1Payload): Promise<Operation[]>;
105
105
  /**
106
106
  * No description
107
107
  *
@@ -174,18 +174,6 @@ export declare class LayersService extends Service {
174
174
  * @response `200` OK
175
175
  */
176
176
  updateFeature(name: string, data: UpdateFeaturePayload): Promise<LayerUpdateInfoDc>;
177
- /**
178
- * No description
179
- *
180
- * @tags Layers
181
- * @name GetById
182
- * @operationId LayersController_GetByIdAsync
183
- * @summary Gets feature by id.
184
- * @request GET:/layers/{name}/features/{id}
185
- * @secure
186
- * @response `200` OK
187
- */
188
- getById({ name, id, ...query }: GetByIdParams): Promise<FeatureDc>;
189
177
  /**
190
178
  * No description
191
179
  *
@@ -0,0 +1,155 @@
1
+ import { Service } from './Service';
2
+ import { DeleteRuleParams, GetGrantsParams, GetRuleHistoryParams, GetRulesParams, GetUsageParams, GrantCreditDc, GrantDc, LimitKindDc, PagedListRuleChangeDc, RevokeGrantParams, RuleDc, SetKindActiveParams, UpsertRuleDc, UsageDc } from './data-contracts';
3
+ /**
4
+ * @title Spatial Processing Gateway API
5
+ * @version 1.5.1.0
6
+ * @baseUrl /sp
7
+ */
8
+ export declare class QuotasService extends Service {
9
+ /**
10
+ * No description
11
+ *
12
+ * @tags Quotas
13
+ * @name GetKinds
14
+ * @operationId QuotasController_GetKinds
15
+ * @summary Every limit kind.
16
+ * @request GET:/quotas/kinds
17
+ * @secure
18
+ * @response `200` OK
19
+ */
20
+ getKinds(): Promise<LimitKindDc[]>;
21
+ /**
22
+ * No description
23
+ *
24
+ * @tags Quotas
25
+ * @name GetKind
26
+ * @operationId QuotasController_GetKind
27
+ * @summary One limit kind.
28
+ * @request GET:/quotas/kinds/{code}
29
+ * @secure
30
+ * @response `200` OK
31
+ */
32
+ getKind(code: string): Promise<LimitKindDc>;
33
+ /**
34
+ * No description
35
+ *
36
+ * @tags Quotas
37
+ * @name DeleteKind
38
+ * @operationId QuotasController_DeleteKind
39
+ * @summary Deletes a kind nobody declared within the grace period and nobody consumed; otherwise 409 with `KIND_IN_USE`.
40
+ * @request DELETE:/quotas/kinds/{code}
41
+ * @secure
42
+ * @response `200` OK
43
+ */
44
+ deleteKind(code: string): Promise<void>;
45
+ /**
46
+ * No description
47
+ *
48
+ * @tags Quotas
49
+ * @name SetKindActive
50
+ * @operationId QuotasController_SetKindActive
51
+ * @summary Switches enforcement of a kind on or off: the way to retire a kind.
52
+ * @request PUT:/quotas/kinds/{code}/active
53
+ * @secure
54
+ * @response `200` OK
55
+ */
56
+ setKindActive({ code, ...query }: SetKindActiveParams): Promise<LimitKindDc>;
57
+ /**
58
+ * No description
59
+ *
60
+ * @tags Quotas
61
+ * @name GetRules
62
+ * @operationId QuotasController_GetRules
63
+ * @summary Rules matching the filter.
64
+ * @request GET:/quotas/rules
65
+ * @secure
66
+ * @response `200` OK
67
+ */
68
+ getRules(query: GetRulesParams): Promise<RuleDc[]>;
69
+ /**
70
+ * No description
71
+ *
72
+ * @tags Quotas
73
+ * @name UpsertRule
74
+ * @operationId QuotasController_UpsertRule
75
+ * @summary Writes a rule, replacing whatever stands at the same kind, subject and qualifier. Repeating the same plan changes nothing.
76
+ * @request PUT:/quotas/rules
77
+ * @secure
78
+ * @response `200` OK
79
+ */
80
+ upsertRule(data: UpsertRuleDc): Promise<RuleDc>;
81
+ /**
82
+ * No description
83
+ *
84
+ * @tags Quotas
85
+ * @name DeleteRule
86
+ * @operationId QuotasController_DeleteRule
87
+ * @summary Deletes a rule.
88
+ * @request DELETE:/quotas/rules
89
+ * @secure
90
+ * @response `200` OK
91
+ */
92
+ deleteRule(query: DeleteRuleParams): Promise<void>;
93
+ /**
94
+ * No description
95
+ *
96
+ * @tags Quotas
97
+ * @name GetRuleHistory
98
+ * @operationId QuotasController_GetRuleHistory
99
+ * @summary Changes of the rules matching the filter, newest first.
100
+ * @request GET:/quotas/rules/history
101
+ * @secure
102
+ * @response `200` OK
103
+ */
104
+ getRuleHistory(query: GetRuleHistoryParams): Promise<PagedListRuleChangeDc>;
105
+ /**
106
+ * No description
107
+ *
108
+ * @tags Quotas
109
+ * @name GetGrants
110
+ * @operationId QuotasController_GetGrants
111
+ * @summary Grants of credit matching the filter, newest first.
112
+ * @request GET:/quotas/grants
113
+ * @secure
114
+ * @response `200` OK
115
+ */
116
+ getGrants(query: GetGrantsParams): Promise<GrantDc[]>;
117
+ /**
118
+ * No description
119
+ *
120
+ * @tags Quotas
121
+ * @name GrantCredit
122
+ * @operationId QuotasController_GrantCredit
123
+ * @summary Grants credit on top of a rate plan, spent after the plan, the soonest to burn first.
124
+ Granting again with the same key returns the first grant.
125
+ * @request POST:/quotas/grants
126
+ * @secure
127
+ * @response `200` OK
128
+ */
129
+ grantCredit(data: GrantCreditDc): Promise<GrantDc>;
130
+ /**
131
+ * No description
132
+ *
133
+ * @tags Quotas
134
+ * @name RevokeGrant
135
+ * @operationId QuotasController_RevokeGrant
136
+ * @summary Revokes a grant: what is left of it burns now, what it paid for stays paid. Revoking twice changes nothing.
137
+ * @request POST:/quotas/grants/{id}/revoke
138
+ * @secure
139
+ * @response `200` OK
140
+ */
141
+ revokeGrant({ id, ...query }: RevokeGrantParams): Promise<GrantDc>;
142
+ /**
143
+ * No description
144
+ *
145
+ * @tags Quotas
146
+ * @name GetUsage
147
+ * @operationId QuotasController_GetUsage
148
+ * @summary What a user has left: the plan in force for each kind, what is spent in the current window and the grants
149
+ of credit on top of it.
150
+ * @request GET:/quotas/usage
151
+ * @secure
152
+ * @response `200` OK
153
+ */
154
+ getUsage(query: GetUsageParams): Promise<UsageDc[]>;
155
+ }