@evergis/api 4.1.6 → 4.1.8
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 +2 -2
- package/README.md +5 -15
- package/dist/Api.d.ts +78 -78
- package/dist/ApiEvent.d.ts +5 -5
- package/dist/EventEmitter.d.ts +11 -11
- package/dist/ExtendedHttpClient.d.ts +5 -0
- package/dist/__generated__/AccountPreviewService.d.ts +81 -81
- package/dist/__generated__/AccountService.d.ts +513 -513
- package/dist/__generated__/BulkOperationsService.d.ts +21 -21
- package/dist/__generated__/CamerasService.d.ts +105 -105
- package/dist/__generated__/CatalogService.d.ts +213 -213
- package/dist/__generated__/ClientSettingsService.d.ts +57 -57
- package/dist/__generated__/DataSourceService.d.ts +201 -201
- package/dist/__generated__/EqlService.d.ts +105 -105
- package/dist/__generated__/FeedbackService.d.ts +33 -33
- package/dist/__generated__/FiltersService.d.ts +45 -45
- package/dist/__generated__/GeocodeService.d.ts +45 -45
- package/dist/__generated__/HttpClient.d.ts +27 -27
- package/dist/__generated__/ImportService.d.ts +129 -129
- package/dist/__generated__/LayersService.d.ts +573 -573
- package/dist/__generated__/NotificationService.d.ts +69 -69
- package/dist/__generated__/ProjectsService.d.ts +249 -249
- package/dist/__generated__/QueryTokenAccessService.d.ts +64 -64
- package/dist/__generated__/RemoteTaskManagerService.d.ts +213 -213
- package/dist/__generated__/SecurityService.d.ts +165 -165
- package/dist/__generated__/Service.d.ts +5 -5
- package/dist/__generated__/SpatialReferencesService.d.ts +45 -45
- package/dist/__generated__/StatisticService.d.ts +45 -45
- package/dist/__generated__/TablesService.d.ts +237 -237
- package/dist/__generated__/ToolsService.d.ts +8 -8
- package/dist/__generated__/VectorTileService.d.ts +21 -21
- package/dist/__generated__/data-contracts.d.ts +7677 -6907
- package/dist/api.esm.js +5228 -7637
- package/dist/api.esm.js.map +1 -1
- package/dist/config.d.ts +4 -0
- package/dist/constants.d.ts +3 -3
- package/dist/index.d.ts +7 -7
- package/dist/index.js +5804 -5
- package/dist/index.js.map +1 -0
- package/dist/interfaces/ResourceService.d.ts +7 -7
- package/dist/services/Account.d.ts +36 -36
- package/dist/services/AccountPreview.d.ts +3 -3
- package/dist/services/BulkOperations.d.ts +3 -3
- package/dist/services/Cameras.d.ts +3 -3
- package/dist/services/ClientSettings.d.ts +62 -62
- package/dist/services/Eql.d.ts +3 -3
- package/dist/services/Feedback.d.ts +3 -3
- package/dist/services/FileUpload.d.ts +6 -6
- package/dist/services/Filters.d.ts +3 -3
- package/dist/services/Geocode.d.ts +9 -9
- package/dist/services/Import.d.ts +3 -3
- package/dist/services/Layers.d.ts +28 -28
- package/dist/services/Names.d.ts +32 -32
- package/dist/services/Notification.d.ts +48 -48
- package/dist/services/PortalSettings.d.ts +33 -33
- package/dist/services/Projects.d.ts +20 -20
- package/dist/services/RemoteTaskManager.d.ts +3 -3
- package/dist/services/Resources.d.ts +18 -18
- package/dist/services/Security.d.ts +9 -9
- package/dist/services/Statistic.d.ts +3 -3
- package/dist/services/Tables.d.ts +11 -11
- package/dist/services/Tools.d.ts +3 -3
- package/dist/services/VectorTiles.d.ts +3 -3
- package/dist/services/index.d.ts +23 -23
- package/dist/utils/errorHandler.d.ts +26 -26
- package/dist/utils/formDataFromFile.d.ts +1 -1
- package/dist/utils/generateId.d.ts +2 -2
- package/dist/utils/index.d.ts +9 -9
- package/dist/utils/isString.d.ts +1 -1
- package/dist/utils/location.d.ts +2 -2
- package/dist/utils/parseJwt.d.ts +1 -1
- package/dist/utils/promiseAllIgnoreErrors.d.ts +1 -1
- package/dist/utils/stripUselessSlashes.d.ts +1 -1
- package/dist/utils/unique.d.ts +1 -1
- package/dist/utils/user.d.ts +3 -3
- package/package.json +15 -27
- package/dist/__generated__/PythonService.d.ts +0 -33
- package/dist/__generated__/SymbolStorageService.d.ts +0 -225
- package/dist/__generated__/WfsServerService.d.ts +0 -45
- package/dist/__generated__/WmtsService.d.ts +0 -21
- package/dist/api.cjs.development.js +0 -7636
- package/dist/api.cjs.development.js.map +0 -1
- package/dist/api.cjs.production.min.js +0 -2
- package/dist/api.cjs.production.min.js.map +0 -1
|
@@ -1,69 +1,69 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
/**
|
|
4
|
-
* @title Spatial Processing Core 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
|
+
import { Service } from './Service';
|
|
2
|
+
import { SubscribeListOperationPayload, SubscribeOperationParams, UnsubscribeListOperationPayload, UnsubscribeOperationParams } from './data-contracts';
|
|
3
|
+
/**
|
|
4
|
+
* @title Spatial Processing Core 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,249 +1,249 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
/**
|
|
4
|
-
* @title Spatial Processing Core API
|
|
5
|
-
* @version 1.5.1.0
|
|
6
|
-
* @baseUrl /sp
|
|
7
|
-
*/
|
|
8
|
-
export declare class ProjectsService extends Service {
|
|
9
|
-
/**
|
|
10
|
-
* No description
|
|
11
|
-
*
|
|
12
|
-
* @tags Projects
|
|
13
|
-
* @name GetProjectsList
|
|
14
|
-
* @operationId ProjectsController_GetProjectsList
|
|
15
|
-
* @summary Returns the list of projects.
|
|
16
|
-
* @request GET:/projects
|
|
17
|
-
* @secure
|
|
18
|
-
* @response `200` OK
|
|
19
|
-
*/
|
|
20
|
-
getProjectsList(query: GetProjectsListParams): Promise<PagedListProjectInfoDc>;
|
|
21
|
-
/**
|
|
22
|
-
* No description
|
|
23
|
-
*
|
|
24
|
-
* @tags Projects
|
|
25
|
-
* @name CreateProject
|
|
26
|
-
* @operationId ProjectsController_CreateProject
|
|
27
|
-
* @summary Creates a new project.
|
|
28
|
-
* @request POST:/projects
|
|
29
|
-
* @secure
|
|
30
|
-
* @response `200` OK
|
|
31
|
-
*/
|
|
32
|
-
createProject(data: ExtendedProjectInfoDc): Promise<ExtendedProjectInfoDc>;
|
|
33
|
-
/**
|
|
34
|
-
* No description
|
|
35
|
-
*
|
|
36
|
-
* @tags Projects
|
|
37
|
-
* @name DeleteResources
|
|
38
|
-
* @operationId ProjectsController_DeleteResources
|
|
39
|
-
* @summary Bulk delete resources.
|
|
40
|
-
* @request DELETE:/projects
|
|
41
|
-
* @secure
|
|
42
|
-
* @response `200` OK
|
|
43
|
-
*/
|
|
44
|
-
deleteResources(query:
|
|
45
|
-
/**
|
|
46
|
-
* No description
|
|
47
|
-
*
|
|
48
|
-
* @tags Projects
|
|
49
|
-
* @name UpdateProject
|
|
50
|
-
* @operationId ProjectsController_UpdateProject
|
|
51
|
-
* @summary Update table.
|
|
52
|
-
* @request PATCH:/projects/{name}
|
|
53
|
-
* @secure
|
|
54
|
-
* @response `200` OK
|
|
55
|
-
*/
|
|
56
|
-
updateProject(name: string, data: ExtendedProjectInfoDc): Promise<ExtendedProjectInfoDc>;
|
|
57
|
-
/**
|
|
58
|
-
* No description
|
|
59
|
-
*
|
|
60
|
-
* @tags Projects
|
|
61
|
-
* @name GetProjectInfo
|
|
62
|
-
* @operationId ProjectsController_GetProjectInfo
|
|
63
|
-
* @summary Returns the project and it's content information.
|
|
64
|
-
* @request GET:/projects/{name}
|
|
65
|
-
* @secure
|
|
66
|
-
* @response `200` OK
|
|
67
|
-
*/
|
|
68
|
-
getProjectInfo(name: string): Promise<ExtendedProjectInfoDc>;
|
|
69
|
-
/**
|
|
70
|
-
* No description
|
|
71
|
-
*
|
|
72
|
-
* @tags Projects
|
|
73
|
-
* @name DeleteResource
|
|
74
|
-
* @operationId ProjectsController_DeleteResource
|
|
75
|
-
* @summary Deletes resource.
|
|
76
|
-
* @request DELETE:/projects/{name}
|
|
77
|
-
* @secure
|
|
78
|
-
* @response `200` OK
|
|
79
|
-
*/
|
|
80
|
-
deleteResource(name: string): Promise<void>;
|
|
81
|
-
/**
|
|
82
|
-
* No description
|
|
83
|
-
*
|
|
84
|
-
* @tags Projects
|
|
85
|
-
* @name UpdateProjectV2
|
|
86
|
-
* @operationId ProjectsController_UpdateProjectV2
|
|
87
|
-
* @summary Update table.
|
|
88
|
-
* @request PATCH:/projects/{name}/v2
|
|
89
|
-
* @secure
|
|
90
|
-
* @response `200` OK
|
|
91
|
-
*/
|
|
92
|
-
updateProjectV2(name: string, data: UpdateProjectV2Payload): Promise<
|
|
93
|
-
/**
|
|
94
|
-
* No description
|
|
95
|
-
*
|
|
96
|
-
* @tags Projects
|
|
97
|
-
* @name GetProjectsInfo
|
|
98
|
-
* @operationId ProjectsController_GetProjectsInfoAsync
|
|
99
|
-
* @summary Returns the projects information.
|
|
100
|
-
* @request GET:/projects/batchInfo
|
|
101
|
-
* @secure
|
|
102
|
-
* @response `200` OK
|
|
103
|
-
*/
|
|
104
|
-
getProjectsInfo(query: GetProjectsInfoParams): Promise<ExtendedProjectInfoDc[]>;
|
|
105
|
-
/**
|
|
106
|
-
* No description
|
|
107
|
-
*
|
|
108
|
-
* @tags Projects
|
|
109
|
-
* @name GetProjectEnvelope
|
|
110
|
-
* @operationId ProjectsController_GetProjectEnvelope
|
|
111
|
-
* @summary Get project extent.
|
|
112
|
-
* @request GET:/projects/{name}/extent
|
|
113
|
-
* @secure
|
|
114
|
-
* @response `200` OK
|
|
115
|
-
*/
|
|
116
|
-
getProjectEnvelope({ name, ...query }: GetProjectEnvelopeParams): Promise<EnvelopeDc>;
|
|
117
|
-
/**
|
|
118
|
-
* No description
|
|
119
|
-
*
|
|
120
|
-
* @tags Projects
|
|
121
|
-
* @name GetProjectLayersExtendedInfo
|
|
122
|
-
* @operationId ProjectsController_GetProjectLayersExtendedInfo
|
|
123
|
-
* @summary Gets extended project info with layers info.
|
|
124
|
-
* @request GET:/projects/{name}/extended-info
|
|
125
|
-
* @secure
|
|
126
|
-
* @response `200` OK
|
|
127
|
-
*/
|
|
128
|
-
getProjectLayersExtendedInfo(name: string): Promise<ExtendedProjectLayersInfo>;
|
|
129
|
-
/**
|
|
130
|
-
* No description
|
|
131
|
-
*
|
|
132
|
-
* @tags Projects
|
|
133
|
-
* @name PatchProjectConfiguration
|
|
134
|
-
* @operationId ProjectsController_PatchProjectConfiguration
|
|
135
|
-
* @summary Applies partial updates using JSON Patch.
|
|
136
|
-
* @request PATCH:/projects/{name}/configuration/{type}
|
|
137
|
-
* @secure
|
|
138
|
-
* @response `200` OK
|
|
139
|
-
*/
|
|
140
|
-
patchProjectConfiguration(name: string, type: ConfigurationType, data: PatchProjectConfigurationPayload): Promise<CatalogConfigurationDc>;
|
|
141
|
-
/**
|
|
142
|
-
* No description
|
|
143
|
-
*
|
|
144
|
-
* @tags Projects
|
|
145
|
-
* @name PutProjectConfiguration
|
|
146
|
-
* @operationId ProjectsController_PutProjectConfiguration
|
|
147
|
-
* @summary Creates or updates configuration (full replacement).
|
|
148
|
-
* @request PUT:/projects/{name}/configuration/{type}
|
|
149
|
-
* @secure
|
|
150
|
-
* @response `200` OK
|
|
151
|
-
*/
|
|
152
|
-
putProjectConfiguration(name: string, type: ConfigurationType, data: PutProjectConfigurationPayload): Promise<CatalogConfigurationDc>;
|
|
153
|
-
/**
|
|
154
|
-
* No description
|
|
155
|
-
*
|
|
156
|
-
* @tags Projects
|
|
157
|
-
* @name GetProjectConfiguration
|
|
158
|
-
* @operationId ProjectsController_GetProjectConfiguration
|
|
159
|
-
* @summary Gets configuration for a resource and type.
|
|
160
|
-
* @request GET:/projects/{name}/configuration/{type}
|
|
161
|
-
* @secure
|
|
162
|
-
* @response `200` OK
|
|
163
|
-
*/
|
|
164
|
-
getProjectConfiguration(name: string, type: ConfigurationType): Promise<CatalogConfigurationDc>;
|
|
165
|
-
/**
|
|
166
|
-
* No description
|
|
167
|
-
*
|
|
168
|
-
* @tags Projects
|
|
169
|
-
* @name DeleteProjectConfiguration
|
|
170
|
-
* @operationId ProjectsController_DeleteProjectConfiguration
|
|
171
|
-
* @summary Creates or updates configuration (full replacement).
|
|
172
|
-
* @request DELETE:/projects/{name}/configuration/{type}
|
|
173
|
-
* @secure
|
|
174
|
-
* @response `200` OK
|
|
175
|
-
*/
|
|
176
|
-
deleteProjectConfiguration(name: string, type: ConfigurationType): Promise<CatalogConfigurationDc>;
|
|
177
|
-
/**
|
|
178
|
-
* No description
|
|
179
|
-
*
|
|
180
|
-
* @tags Projects
|
|
181
|
-
* @name GetTilesLayerImage
|
|
182
|
-
* @operationId ProjectsController_GetTilesLayerImage
|
|
183
|
-
* @summary Render tile.
|
|
184
|
-
* @request GET:/projects/{name}/tile/{z}/{x}/{y}
|
|
185
|
-
* @secure
|
|
186
|
-
* @response `200` OK
|
|
187
|
-
*/
|
|
188
|
-
getTilesLayerImage(name: string, x: number, y: number, z: number): string;
|
|
189
|
-
/**
|
|
190
|
-
* No description
|
|
191
|
-
*
|
|
192
|
-
* @tags Projects
|
|
193
|
-
* @name GetTilesLayerImageWithFormat
|
|
194
|
-
* @operationId ProjectsController_GetTilesLayerImageWithFormat
|
|
195
|
-
* @summary Render tile.
|
|
196
|
-
* @request GET:/projects/{name}/tile/{z}/{x}/{y}.{format}
|
|
197
|
-
* @secure
|
|
198
|
-
* @response `200` OK
|
|
199
|
-
*/
|
|
200
|
-
getTilesLayerImageWithFormat(name: string, x: number, y: number, z: number, format: string): string;
|
|
201
|
-
/**
|
|
202
|
-
* No description
|
|
203
|
-
*
|
|
204
|
-
* @tags Projects
|
|
205
|
-
* @name GetTilesLayerImageWithFormatAndDpi
|
|
206
|
-
* @operationId ProjectsController_GetTilesLayerImageWithFormatAndDpi
|
|
207
|
-
* @summary Render tile.
|
|
208
|
-
* @request GET:/projects/{name}/tile/{z}/{x}/{y}@{dpi}x.{format}
|
|
209
|
-
* @secure
|
|
210
|
-
* @response `200` OK
|
|
211
|
-
*/
|
|
212
|
-
getTilesLayerImageWithFormatAndDpi(name: string, x: number, y: number, z: number, dpi: number, format: string): string;
|
|
213
|
-
/**
|
|
214
|
-
* No description
|
|
215
|
-
*
|
|
216
|
-
* @tags Projects
|
|
217
|
-
* @name IsExists
|
|
218
|
-
* @operationId ProjectsController_IsExistsAsync
|
|
219
|
-
* @summary Check is resource exists.
|
|
220
|
-
* @request GET:/projects/{name}/exists
|
|
221
|
-
* @secure
|
|
222
|
-
* @response `200` OK
|
|
223
|
-
*/
|
|
224
|
-
isExists(name: string): Promise<void>;
|
|
225
|
-
/**
|
|
226
|
-
* No description
|
|
227
|
-
*
|
|
228
|
-
* @tags Projects
|
|
229
|
-
* @name GetResourceDependencies
|
|
230
|
-
* @operationId ProjectsController_GetResourceDependencies
|
|
231
|
-
* @summary Get resource dependencies.
|
|
232
|
-
* @request GET:/projects/{name}/dependencies
|
|
233
|
-
* @secure
|
|
234
|
-
* @response `200` OK
|
|
235
|
-
*/
|
|
236
|
-
getResourceDependencies(name: string): Promise<ResourceDependenciesDc>;
|
|
237
|
-
/**
|
|
238
|
-
* No description
|
|
239
|
-
*
|
|
240
|
-
* @tags Projects
|
|
241
|
-
* @name GetResourceReferences
|
|
242
|
-
* @operationId ProjectsController_GetResourceReferences
|
|
243
|
-
* @summary Returns the resource dependency information.
|
|
244
|
-
* @request GET:/projects/{name}/references
|
|
245
|
-
* @secure
|
|
246
|
-
* @response `200` OK
|
|
247
|
-
*/
|
|
248
|
-
getResourceReferences(name: string): Promise<ResourceDependenciesDc>;
|
|
249
|
-
}
|
|
1
|
+
import { Service } from './Service';
|
|
2
|
+
import { BulkOperationResultDc, CatalogConfigurationDc, ConfigurationType, DeleteResourcesParams2, EnvelopeDc, ExtendedProjectInfoDc, ExtendedProjectLayersInfo, GetProjectEnvelopeParams, GetProjectsInfoParams, GetProjectsListParams, Operation, PagedListProjectInfoDc, PatchProjectConfigurationPayload, PutProjectConfigurationPayload, ResourceDependenciesDc, UpdateProjectV2Payload } from './data-contracts';
|
|
3
|
+
/**
|
|
4
|
+
* @title Spatial Processing Core API
|
|
5
|
+
* @version 1.5.1.0
|
|
6
|
+
* @baseUrl /sp
|
|
7
|
+
*/
|
|
8
|
+
export declare class ProjectsService extends Service {
|
|
9
|
+
/**
|
|
10
|
+
* No description
|
|
11
|
+
*
|
|
12
|
+
* @tags Projects
|
|
13
|
+
* @name GetProjectsList
|
|
14
|
+
* @operationId ProjectsController_GetProjectsList
|
|
15
|
+
* @summary Returns the list of projects.
|
|
16
|
+
* @request GET:/projects
|
|
17
|
+
* @secure
|
|
18
|
+
* @response `200` OK
|
|
19
|
+
*/
|
|
20
|
+
getProjectsList(query: GetProjectsListParams): Promise<PagedListProjectInfoDc>;
|
|
21
|
+
/**
|
|
22
|
+
* No description
|
|
23
|
+
*
|
|
24
|
+
* @tags Projects
|
|
25
|
+
* @name CreateProject
|
|
26
|
+
* @operationId ProjectsController_CreateProject
|
|
27
|
+
* @summary Creates a new project.
|
|
28
|
+
* @request POST:/projects
|
|
29
|
+
* @secure
|
|
30
|
+
* @response `200` OK
|
|
31
|
+
*/
|
|
32
|
+
createProject(data: ExtendedProjectInfoDc): Promise<ExtendedProjectInfoDc>;
|
|
33
|
+
/**
|
|
34
|
+
* No description
|
|
35
|
+
*
|
|
36
|
+
* @tags Projects
|
|
37
|
+
* @name DeleteResources
|
|
38
|
+
* @operationId ProjectsController_DeleteResources
|
|
39
|
+
* @summary Bulk delete resources.
|
|
40
|
+
* @request DELETE:/projects
|
|
41
|
+
* @secure
|
|
42
|
+
* @response `200` OK
|
|
43
|
+
*/
|
|
44
|
+
deleteResources(query: DeleteResourcesParams2): Promise<BulkOperationResultDc[]>;
|
|
45
|
+
/**
|
|
46
|
+
* No description
|
|
47
|
+
*
|
|
48
|
+
* @tags Projects
|
|
49
|
+
* @name UpdateProject
|
|
50
|
+
* @operationId ProjectsController_UpdateProject
|
|
51
|
+
* @summary Update table.
|
|
52
|
+
* @request PATCH:/projects/{name}
|
|
53
|
+
* @secure
|
|
54
|
+
* @response `200` OK
|
|
55
|
+
*/
|
|
56
|
+
updateProject(name: string, data: ExtendedProjectInfoDc): Promise<ExtendedProjectInfoDc>;
|
|
57
|
+
/**
|
|
58
|
+
* No description
|
|
59
|
+
*
|
|
60
|
+
* @tags Projects
|
|
61
|
+
* @name GetProjectInfo
|
|
62
|
+
* @operationId ProjectsController_GetProjectInfo
|
|
63
|
+
* @summary Returns the project and it's content information.
|
|
64
|
+
* @request GET:/projects/{name}
|
|
65
|
+
* @secure
|
|
66
|
+
* @response `200` OK
|
|
67
|
+
*/
|
|
68
|
+
getProjectInfo(name: string): Promise<ExtendedProjectInfoDc>;
|
|
69
|
+
/**
|
|
70
|
+
* No description
|
|
71
|
+
*
|
|
72
|
+
* @tags Projects
|
|
73
|
+
* @name DeleteResource
|
|
74
|
+
* @operationId ProjectsController_DeleteResource
|
|
75
|
+
* @summary Deletes resource.
|
|
76
|
+
* @request DELETE:/projects/{name}
|
|
77
|
+
* @secure
|
|
78
|
+
* @response `200` OK
|
|
79
|
+
*/
|
|
80
|
+
deleteResource(name: string): Promise<void>;
|
|
81
|
+
/**
|
|
82
|
+
* No description
|
|
83
|
+
*
|
|
84
|
+
* @tags Projects
|
|
85
|
+
* @name UpdateProjectV2
|
|
86
|
+
* @operationId ProjectsController_UpdateProjectV2
|
|
87
|
+
* @summary Update table.
|
|
88
|
+
* @request PATCH:/projects/{name}/v2
|
|
89
|
+
* @secure
|
|
90
|
+
* @response `200` OK
|
|
91
|
+
*/
|
|
92
|
+
updateProjectV2(name: string, data: UpdateProjectV2Payload): Promise<Operation[]>;
|
|
93
|
+
/**
|
|
94
|
+
* No description
|
|
95
|
+
*
|
|
96
|
+
* @tags Projects
|
|
97
|
+
* @name GetProjectsInfo
|
|
98
|
+
* @operationId ProjectsController_GetProjectsInfoAsync
|
|
99
|
+
* @summary Returns the projects information.
|
|
100
|
+
* @request GET:/projects/batchInfo
|
|
101
|
+
* @secure
|
|
102
|
+
* @response `200` OK
|
|
103
|
+
*/
|
|
104
|
+
getProjectsInfo(query: GetProjectsInfoParams): Promise<ExtendedProjectInfoDc[]>;
|
|
105
|
+
/**
|
|
106
|
+
* No description
|
|
107
|
+
*
|
|
108
|
+
* @tags Projects
|
|
109
|
+
* @name GetProjectEnvelope
|
|
110
|
+
* @operationId ProjectsController_GetProjectEnvelope
|
|
111
|
+
* @summary Get project extent.
|
|
112
|
+
* @request GET:/projects/{name}/extent
|
|
113
|
+
* @secure
|
|
114
|
+
* @response `200` OK
|
|
115
|
+
*/
|
|
116
|
+
getProjectEnvelope({ name, ...query }: GetProjectEnvelopeParams): Promise<EnvelopeDc>;
|
|
117
|
+
/**
|
|
118
|
+
* No description
|
|
119
|
+
*
|
|
120
|
+
* @tags Projects
|
|
121
|
+
* @name GetProjectLayersExtendedInfo
|
|
122
|
+
* @operationId ProjectsController_GetProjectLayersExtendedInfo
|
|
123
|
+
* @summary Gets extended project info with layers info.
|
|
124
|
+
* @request GET:/projects/{name}/extended-info
|
|
125
|
+
* @secure
|
|
126
|
+
* @response `200` OK
|
|
127
|
+
*/
|
|
128
|
+
getProjectLayersExtendedInfo(name: string): Promise<ExtendedProjectLayersInfo>;
|
|
129
|
+
/**
|
|
130
|
+
* No description
|
|
131
|
+
*
|
|
132
|
+
* @tags Projects
|
|
133
|
+
* @name PatchProjectConfiguration
|
|
134
|
+
* @operationId ProjectsController_PatchProjectConfiguration
|
|
135
|
+
* @summary Applies partial updates using JSON Patch.
|
|
136
|
+
* @request PATCH:/projects/{name}/configuration/{type}
|
|
137
|
+
* @secure
|
|
138
|
+
* @response `200` OK
|
|
139
|
+
*/
|
|
140
|
+
patchProjectConfiguration(name: string, type: ConfigurationType, data: PatchProjectConfigurationPayload): Promise<CatalogConfigurationDc>;
|
|
141
|
+
/**
|
|
142
|
+
* No description
|
|
143
|
+
*
|
|
144
|
+
* @tags Projects
|
|
145
|
+
* @name PutProjectConfiguration
|
|
146
|
+
* @operationId ProjectsController_PutProjectConfiguration
|
|
147
|
+
* @summary Creates or updates configuration (full replacement).
|
|
148
|
+
* @request PUT:/projects/{name}/configuration/{type}
|
|
149
|
+
* @secure
|
|
150
|
+
* @response `200` OK
|
|
151
|
+
*/
|
|
152
|
+
putProjectConfiguration(name: string, type: ConfigurationType, data: PutProjectConfigurationPayload): Promise<CatalogConfigurationDc>;
|
|
153
|
+
/**
|
|
154
|
+
* No description
|
|
155
|
+
*
|
|
156
|
+
* @tags Projects
|
|
157
|
+
* @name GetProjectConfiguration
|
|
158
|
+
* @operationId ProjectsController_GetProjectConfiguration
|
|
159
|
+
* @summary Gets configuration for a resource and type.
|
|
160
|
+
* @request GET:/projects/{name}/configuration/{type}
|
|
161
|
+
* @secure
|
|
162
|
+
* @response `200` OK
|
|
163
|
+
*/
|
|
164
|
+
getProjectConfiguration(name: string, type: ConfigurationType): Promise<CatalogConfigurationDc>;
|
|
165
|
+
/**
|
|
166
|
+
* No description
|
|
167
|
+
*
|
|
168
|
+
* @tags Projects
|
|
169
|
+
* @name DeleteProjectConfiguration
|
|
170
|
+
* @operationId ProjectsController_DeleteProjectConfiguration
|
|
171
|
+
* @summary Creates or updates configuration (full replacement).
|
|
172
|
+
* @request DELETE:/projects/{name}/configuration/{type}
|
|
173
|
+
* @secure
|
|
174
|
+
* @response `200` OK
|
|
175
|
+
*/
|
|
176
|
+
deleteProjectConfiguration(name: string, type: ConfigurationType): Promise<CatalogConfigurationDc>;
|
|
177
|
+
/**
|
|
178
|
+
* No description
|
|
179
|
+
*
|
|
180
|
+
* @tags Projects
|
|
181
|
+
* @name GetTilesLayerImage
|
|
182
|
+
* @operationId ProjectsController_GetTilesLayerImage
|
|
183
|
+
* @summary Render tile.
|
|
184
|
+
* @request GET:/projects/{name}/tile/{z}/{x}/{y}
|
|
185
|
+
* @secure
|
|
186
|
+
* @response `200` OK
|
|
187
|
+
*/
|
|
188
|
+
getTilesLayerImage(name: string, x: number, y: number, z: number): string;
|
|
189
|
+
/**
|
|
190
|
+
* No description
|
|
191
|
+
*
|
|
192
|
+
* @tags Projects
|
|
193
|
+
* @name GetTilesLayerImageWithFormat
|
|
194
|
+
* @operationId ProjectsController_GetTilesLayerImageWithFormat
|
|
195
|
+
* @summary Render tile.
|
|
196
|
+
* @request GET:/projects/{name}/tile/{z}/{x}/{y}.{format}
|
|
197
|
+
* @secure
|
|
198
|
+
* @response `200` OK
|
|
199
|
+
*/
|
|
200
|
+
getTilesLayerImageWithFormat(name: string, x: number, y: number, z: number, format: string): string;
|
|
201
|
+
/**
|
|
202
|
+
* No description
|
|
203
|
+
*
|
|
204
|
+
* @tags Projects
|
|
205
|
+
* @name GetTilesLayerImageWithFormatAndDpi
|
|
206
|
+
* @operationId ProjectsController_GetTilesLayerImageWithFormatAndDpi
|
|
207
|
+
* @summary Render tile.
|
|
208
|
+
* @request GET:/projects/{name}/tile/{z}/{x}/{y}@{dpi}x.{format}
|
|
209
|
+
* @secure
|
|
210
|
+
* @response `200` OK
|
|
211
|
+
*/
|
|
212
|
+
getTilesLayerImageWithFormatAndDpi(name: string, x: number, y: number, z: number, dpi: number, format: string): string;
|
|
213
|
+
/**
|
|
214
|
+
* No description
|
|
215
|
+
*
|
|
216
|
+
* @tags Projects
|
|
217
|
+
* @name IsExists
|
|
218
|
+
* @operationId ProjectsController_IsExistsAsync
|
|
219
|
+
* @summary Check is resource exists.
|
|
220
|
+
* @request GET:/projects/{name}/exists
|
|
221
|
+
* @secure
|
|
222
|
+
* @response `200` OK
|
|
223
|
+
*/
|
|
224
|
+
isExists(name: string): Promise<void>;
|
|
225
|
+
/**
|
|
226
|
+
* No description
|
|
227
|
+
*
|
|
228
|
+
* @tags Projects
|
|
229
|
+
* @name GetResourceDependencies
|
|
230
|
+
* @operationId ProjectsController_GetResourceDependencies
|
|
231
|
+
* @summary Get resource dependencies.
|
|
232
|
+
* @request GET:/projects/{name}/dependencies
|
|
233
|
+
* @secure
|
|
234
|
+
* @response `200` OK
|
|
235
|
+
*/
|
|
236
|
+
getResourceDependencies(name: string): Promise<ResourceDependenciesDc>;
|
|
237
|
+
/**
|
|
238
|
+
* No description
|
|
239
|
+
*
|
|
240
|
+
* @tags Projects
|
|
241
|
+
* @name GetResourceReferences
|
|
242
|
+
* @operationId ProjectsController_GetResourceReferences
|
|
243
|
+
* @summary Returns the resource dependency information.
|
|
244
|
+
* @request GET:/projects/{name}/references
|
|
245
|
+
* @secure
|
|
246
|
+
* @response `200` OK
|
|
247
|
+
*/
|
|
248
|
+
getResourceReferences(name: string): Promise<ResourceDependenciesDc>;
|
|
249
|
+
}
|