@evergis/api 4.0.14 → 4.0.15
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 +1 -2
- package/dist/__generated__/AccountPreviewService.d.ts +47 -8
- package/dist/__generated__/AccountService.d.ts +64 -2
- package/dist/__generated__/BulkOperationsService.d.ts +1 -0
- package/dist/__generated__/CamerasService.d.ts +8 -0
- package/dist/__generated__/CatalogService.d.ts +29 -2
- package/dist/__generated__/ClientSettingsService.d.ts +4 -0
- package/dist/__generated__/DataSourceService.d.ts +14 -0
- package/dist/__generated__/EqlService.d.ts +9 -0
- package/dist/__generated__/ExternalProvidersService.d.ts +11 -0
- package/dist/__generated__/FeedbackService.d.ts +3 -0
- package/dist/__generated__/FiltersService.d.ts +3 -0
- package/dist/__generated__/GeocodeService.d.ts +3 -0
- package/dist/__generated__/IceRouterService.d.ts +2 -0
- package/dist/__generated__/ImportService.d.ts +10 -0
- package/dist/__generated__/LayersService.d.ts +55 -2
- package/dist/__generated__/NotificationService.d.ts +5 -0
- package/dist/__generated__/PrintService.d.ts +6 -0
- package/dist/__generated__/ProjectsService.d.ts +17 -2
- package/dist/__generated__/PythonService.d.ts +2 -0
- package/dist/__generated__/QueryTokenAccessService.d.ts +5 -0
- package/dist/__generated__/RemoteTaskManagerService.d.ts +17 -0
- package/dist/__generated__/SecurityService.d.ts +37 -2
- package/dist/__generated__/SpatialReferencesService.d.ts +3 -0
- package/dist/__generated__/StatisticService.d.ts +8 -2
- package/dist/__generated__/StyleService.d.ts +6 -0
- package/dist/__generated__/SymbolStorageService.d.ts +18 -0
- package/dist/__generated__/TablesService.d.ts +21 -2
- package/dist/__generated__/VectorTileService.d.ts +1 -0
- package/dist/__generated__/WfsServerService.d.ts +3 -0
- package/dist/__generated__/WmsServerService.d.ts +5 -0
- package/dist/__generated__/WmtsService.d.ts +1 -0
- package/dist/__generated__/data-contracts.d.ts +43 -58
- package/dist/api.cjs.development.js +426 -73
- package/dist/api.cjs.development.js.map +1 -1
- package/dist/api.cjs.production.min.js +1 -1
- package/dist/api.cjs.production.min.js.map +1 -1
- package/dist/api.esm.js +427 -73
- package/dist/api.esm.js.map +1 -1
- package/dist/services/index.d.ts +0 -1
- package/package.json +2 -2
- package/dist/__generated__/ResourceCatalogService.d.ts +0 -20
- package/dist/services/ResourceCatalog.d.ts +0 -3
package/dist/Api.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ import { DataSourceService } from './__generated__/DataSourceService';
|
|
|
6
6
|
import { QueryTokenAccessService } from './__generated__/QueryTokenAccessService';
|
|
7
7
|
import { SpatialReferencesService } from './__generated__/SpatialReferencesService';
|
|
8
8
|
import { CatalogService } from './__generated__/CatalogService';
|
|
9
|
-
import { Account, AccountPreview, BulkOperations, Cameras, ClientSettings, External, Eql, Feedback, FileUpload, Filters, Geocode, IceRouter, Import, Layers, Names, Notification, PortalSettings, Print, Projects, RemoteTaskManager,
|
|
9
|
+
import { Account, AccountPreview, BulkOperations, Cameras, ClientSettings, External, Eql, Feedback, FileUpload, Filters, Geocode, IceRouter, Import, Layers, Names, Notification, PortalSettings, Print, Projects, RemoteTaskManager, Resources, Security, Statistic, Styles, Tables, Tools, VectorTiles } from './services';
|
|
10
10
|
import { AuthenticateParams, LoginDc } from './__generated__/data-contracts';
|
|
11
11
|
export declare type ApiParams = {
|
|
12
12
|
url: string;
|
|
@@ -43,7 +43,6 @@ export declare class Api extends EventEmitter {
|
|
|
43
43
|
readonly cameras: Cameras;
|
|
44
44
|
readonly print: Print;
|
|
45
45
|
readonly tools: Tools;
|
|
46
|
-
readonly resourceCatalog: ResourceCatalog;
|
|
47
46
|
readonly account: Account;
|
|
48
47
|
readonly accountPreview: AccountPreview;
|
|
49
48
|
readonly external: External;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { FileUploadResponse, UploadPreviewPayload } from './data-contracts';
|
|
1
|
+
import { FileUploadResponse, UploadPreview1Payload, UploadPreviewPayload } from './data-contracts';
|
|
2
2
|
import { Service } from './Service';
|
|
3
3
|
/**
|
|
4
4
|
* @title Spatial Processing Core API
|
|
@@ -12,31 +12,70 @@ export declare class AccountPreviewService extends Service {
|
|
|
12
12
|
* @tags AccountPreview
|
|
13
13
|
* @name GetPreview
|
|
14
14
|
* @operationId AccountPreviewController_GetPreview
|
|
15
|
-
* @summary Get user preview image.
|
|
16
|
-
* @request GET:/account/user/preview
|
|
15
|
+
* @summary Get current user preview image.
|
|
16
|
+
* @request GET:/account/user/preview
|
|
17
|
+
* @secure
|
|
17
18
|
* @response `200` OK
|
|
18
19
|
*/
|
|
19
|
-
getPreview(
|
|
20
|
+
getPreview(): string;
|
|
20
21
|
/**
|
|
21
22
|
* No description
|
|
22
23
|
*
|
|
23
24
|
* @tags AccountPreview
|
|
24
25
|
* @name UploadPreview
|
|
25
26
|
* @operationId AccountPreviewController_UploadPreview
|
|
26
|
-
* @summary Set user preview image
|
|
27
|
-
* @request POST:/account/user/preview
|
|
27
|
+
* @summary Set current user preview image.
|
|
28
|
+
* @request POST:/account/user/preview
|
|
29
|
+
* @secure
|
|
28
30
|
* @response `200` OK
|
|
29
31
|
*/
|
|
30
|
-
uploadPreview(
|
|
32
|
+
uploadPreview(data: UploadPreviewPayload | FormData): Promise<FileUploadResponse>;
|
|
31
33
|
/**
|
|
32
34
|
* No description
|
|
33
35
|
*
|
|
34
36
|
* @tags AccountPreview
|
|
35
37
|
* @name DeletePreview
|
|
36
38
|
* @operationId AccountPreviewController_DeletePreview
|
|
39
|
+
* @summary Delete current user preview.
|
|
40
|
+
* @request DELETE:/account/user/preview
|
|
41
|
+
* @secure
|
|
42
|
+
* @response `200` OK
|
|
43
|
+
*/
|
|
44
|
+
deletePreview(): Promise<void>;
|
|
45
|
+
/**
|
|
46
|
+
* No description
|
|
47
|
+
*
|
|
48
|
+
* @tags AccountPreview
|
|
49
|
+
* @name GetPreview1
|
|
50
|
+
* @operationId AccountPreviewController_GetPreview_1
|
|
51
|
+
* @summary Get user preview image.
|
|
52
|
+
* @request GET:/account/user/preview/{username}
|
|
53
|
+
* @secure
|
|
54
|
+
* @response `200` OK
|
|
55
|
+
*/
|
|
56
|
+
getPreview1(username: string): string;
|
|
57
|
+
/**
|
|
58
|
+
* No description
|
|
59
|
+
*
|
|
60
|
+
* @tags AccountPreview
|
|
61
|
+
* @name UploadPreview1
|
|
62
|
+
* @operationId AccountPreviewController_UploadPreview_1
|
|
63
|
+
* @summary Set user preview image.
|
|
64
|
+
* @request POST:/account/user/preview/{username}
|
|
65
|
+
* @secure
|
|
66
|
+
* @response `200` OK
|
|
67
|
+
*/
|
|
68
|
+
uploadPreview1(username: string, data: UploadPreview1Payload | FormData): Promise<FileUploadResponse>;
|
|
69
|
+
/**
|
|
70
|
+
* No description
|
|
71
|
+
*
|
|
72
|
+
* @tags AccountPreview
|
|
73
|
+
* @name DeletePreview1
|
|
74
|
+
* @operationId AccountPreviewController_DeletePreview_1
|
|
37
75
|
* @summary Delete user preview.
|
|
38
76
|
* @request DELETE:/account/user/preview/{username}
|
|
77
|
+
* @secure
|
|
39
78
|
* @response `200` OK
|
|
40
79
|
*/
|
|
41
|
-
|
|
80
|
+
deletePreview1(username: string): Promise<void>;
|
|
42
81
|
}
|
|
@@ -14,6 +14,7 @@ export declare class AccountService extends Service {
|
|
|
14
14
|
* @operationId AccountController_GetUsers
|
|
15
15
|
* @summary Returns the list of users that correspond to the given conditions.
|
|
16
16
|
* @request GET:/account/user/list
|
|
17
|
+
* @secure
|
|
17
18
|
* @response `200` OK
|
|
18
19
|
*/
|
|
19
20
|
getUsers(query: GetUsersParams): Promise<PagedListUserInfoDc>;
|
|
@@ -25,6 +26,7 @@ export declare class AccountService extends Service {
|
|
|
25
26
|
* @operationId AccountController_GetExtendedUsers
|
|
26
27
|
* @summary Returns the list of extended users informations that correspond to the given conditions.
|
|
27
28
|
* @request GET:/account/user/extendedlist
|
|
29
|
+
* @secure
|
|
28
30
|
* @response `200` OK
|
|
29
31
|
*/
|
|
30
32
|
getExtendedUsers(query: GetExtendedUsersParams): Promise<PagedListExtendedUserInfoDc>;
|
|
@@ -34,22 +36,48 @@ export declare class AccountService extends Service {
|
|
|
34
36
|
* @tags Account
|
|
35
37
|
* @name GetUserInfo
|
|
36
38
|
* @operationId AccountController_GetUserInfo
|
|
39
|
+
* @summary Get current user basic information.
|
|
40
|
+
* @request GET:/account
|
|
41
|
+
* @secure
|
|
42
|
+
* @response `200` OK
|
|
43
|
+
*/
|
|
44
|
+
getUserInfo(): Promise<UserInfoDc>;
|
|
45
|
+
/**
|
|
46
|
+
* No description
|
|
47
|
+
*
|
|
48
|
+
* @tags Account
|
|
49
|
+
* @name GetUserInfo1
|
|
50
|
+
* @operationId AccountController_GetUserInfo_1
|
|
37
51
|
* @summary Get user basic information.
|
|
38
52
|
* @request GET:/account/{username}
|
|
53
|
+
* @secure
|
|
39
54
|
* @response `200` OK
|
|
40
55
|
*/
|
|
41
|
-
|
|
56
|
+
getUserInfo1(username: string): Promise<UserInfoDc>;
|
|
42
57
|
/**
|
|
43
58
|
* No description
|
|
44
59
|
*
|
|
45
60
|
* @tags Account
|
|
46
61
|
* @name GetExtendedUserInfo
|
|
47
62
|
* @operationId AccountController_GetExtendedUserInfo
|
|
63
|
+
* @summary Get current user extended information.
|
|
64
|
+
* @request GET:/account/extended
|
|
65
|
+
* @secure
|
|
66
|
+
* @response `200` OK
|
|
67
|
+
*/
|
|
68
|
+
getExtendedUserInfo(): Promise<ExtendedUserInfoDc>;
|
|
69
|
+
/**
|
|
70
|
+
* No description
|
|
71
|
+
*
|
|
72
|
+
* @tags Account
|
|
73
|
+
* @name GetExtendedUserInfo1
|
|
74
|
+
* @operationId AccountController_GetExtendedUserInfo_1
|
|
48
75
|
* @summary Get user extended information.
|
|
49
76
|
* @request GET:/account/extended/{username}
|
|
77
|
+
* @secure
|
|
50
78
|
* @response `200` OK
|
|
51
79
|
*/
|
|
52
|
-
|
|
80
|
+
getExtendedUserInfo1(username: string): Promise<ExtendedUserInfoDc>;
|
|
53
81
|
/**
|
|
54
82
|
* No description
|
|
55
83
|
*
|
|
@@ -58,6 +86,7 @@ export declare class AccountService extends Service {
|
|
|
58
86
|
* @operationId AccountController_IsUsernameExists
|
|
59
87
|
* @summary Checks if the user with the given name is registered in the system.
|
|
60
88
|
* @request GET:/account/user/exists
|
|
89
|
+
* @secure
|
|
61
90
|
* @response `200` OK
|
|
62
91
|
*/
|
|
63
92
|
isUsernameExists(query: IsUsernameExistsParams): Promise<boolean>;
|
|
@@ -69,6 +98,7 @@ export declare class AccountService extends Service {
|
|
|
69
98
|
* @operationId AccountController_IsEmailExists
|
|
70
99
|
* @summary Checks if the user with the given email is registered in the system.
|
|
71
100
|
* @request GET:/account/user/email/exists
|
|
101
|
+
* @secure
|
|
72
102
|
* @response `200` OK
|
|
73
103
|
*/
|
|
74
104
|
isEmailExists(query: IsEmailExistsParams): Promise<boolean>;
|
|
@@ -80,6 +110,7 @@ export declare class AccountService extends Service {
|
|
|
80
110
|
* @operationId AccountController_RegisterUser
|
|
81
111
|
* @summary Register new user.
|
|
82
112
|
* @request POST:/account/register
|
|
113
|
+
* @secure
|
|
83
114
|
* @response `200` OK
|
|
84
115
|
*/
|
|
85
116
|
registerUser(data: RegisterUserDc): Promise<string>;
|
|
@@ -91,6 +122,7 @@ export declare class AccountService extends Service {
|
|
|
91
122
|
* @operationId AccountController_CreateUser
|
|
92
123
|
* @summary Create new user.
|
|
93
124
|
* @request POST:/account/user
|
|
125
|
+
* @secure
|
|
94
126
|
* @response `200` OK
|
|
95
127
|
*/
|
|
96
128
|
createUser(query: CreateUserParams, data: CreateUserDc): Promise<void>;
|
|
@@ -102,6 +134,7 @@ export declare class AccountService extends Service {
|
|
|
102
134
|
* @operationId AccountController_UpdateUser
|
|
103
135
|
* @summary Update exist user.
|
|
104
136
|
* @request PATCH:/account/user
|
|
137
|
+
* @secure
|
|
105
138
|
* @response `200` OK
|
|
106
139
|
*/
|
|
107
140
|
updateUser(data: UpdateUserDc): Promise<void>;
|
|
@@ -113,6 +146,7 @@ export declare class AccountService extends Service {
|
|
|
113
146
|
* @operationId AccountController_ConfirmEmail
|
|
114
147
|
* @summary Confirm user email.
|
|
115
148
|
* @request POST:/account/user/{username}/email/confirm
|
|
149
|
+
* @secure
|
|
116
150
|
* @response `200` OK
|
|
117
151
|
*/
|
|
118
152
|
confirmEmail(username: string): Promise<void>;
|
|
@@ -124,6 +158,7 @@ export declare class AccountService extends Service {
|
|
|
124
158
|
* @operationId AccountController_VerifyEmail
|
|
125
159
|
* @summary Send email with verification code.
|
|
126
160
|
* @request POST:/account/user/{username}/email/verify
|
|
161
|
+
* @secure
|
|
127
162
|
* @response `200` OK
|
|
128
163
|
*/
|
|
129
164
|
verifyEmail(username: string): Promise<void>;
|
|
@@ -135,6 +170,7 @@ export declare class AccountService extends Service {
|
|
|
135
170
|
* @operationId AccountController_SetEmail
|
|
136
171
|
* @summary For a user that does not have a set email, sets the email and password. Requires email confirmation through link.
|
|
137
172
|
* @request POST:/account/setEmail
|
|
173
|
+
* @secure
|
|
138
174
|
* @response `200` OK
|
|
139
175
|
*/
|
|
140
176
|
setEmail(data: SetEmailPayload | FormData): Promise<void>;
|
|
@@ -146,6 +182,7 @@ export declare class AccountService extends Service {
|
|
|
146
182
|
* @operationId AccountController_ConfirmEmail_1
|
|
147
183
|
* @summary Confirm user email by code.
|
|
148
184
|
* @request POST:/account/user/email/confirm
|
|
185
|
+
* @secure
|
|
149
186
|
* @response `200` OK
|
|
150
187
|
*/
|
|
151
188
|
confirmEmail1(query: ConfirmEmail1Params): Promise<void>;
|
|
@@ -157,6 +194,7 @@ export declare class AccountService extends Service {
|
|
|
157
194
|
* @operationId AccountController_ChangeEmail
|
|
158
195
|
* @summary Send email message with confirmation code to new email address.
|
|
159
196
|
* @request POST:/account/user/email/change
|
|
197
|
+
* @secure
|
|
160
198
|
* @response `200` OK
|
|
161
199
|
*/
|
|
162
200
|
changeEmail(query: ChangeEmailParams): Promise<void>;
|
|
@@ -168,6 +206,7 @@ export declare class AccountService extends Service {
|
|
|
168
206
|
* @operationId AccountController_ConfirmChangeEmail
|
|
169
207
|
* @summary Check confirmation code and change email address.
|
|
170
208
|
* @request POST:/account/user/email/change/confirm
|
|
209
|
+
* @secure
|
|
171
210
|
* @response `200` OK
|
|
172
211
|
*/
|
|
173
212
|
confirmChangeEmail(query: ConfirmChangeEmailParams): Promise<void>;
|
|
@@ -179,6 +218,7 @@ export declare class AccountService extends Service {
|
|
|
179
218
|
* @operationId AccountController_SetUserPassword
|
|
180
219
|
* @summary Set user password.
|
|
181
220
|
* @request PATCH:/account/password/set
|
|
221
|
+
* @secure
|
|
182
222
|
* @response `200` OK
|
|
183
223
|
*/
|
|
184
224
|
setUserPassword(data: LoginDc): Promise<void>;
|
|
@@ -190,6 +230,7 @@ export declare class AccountService extends Service {
|
|
|
190
230
|
* @operationId AccountController_ChangePassword
|
|
191
231
|
* @summary Change current user password.
|
|
192
232
|
* @request PATCH:/account/password/change
|
|
233
|
+
* @secure
|
|
193
234
|
* @response `200` OK
|
|
194
235
|
*/
|
|
195
236
|
changePassword(data: ChangePasswordPayload | FormData): Promise<void>;
|
|
@@ -201,6 +242,7 @@ export declare class AccountService extends Service {
|
|
|
201
242
|
* @operationId AccountController_ResetPassword
|
|
202
243
|
* @summary Send reset password message.
|
|
203
244
|
* @request POST:/account/password/reset
|
|
245
|
+
* @secure
|
|
204
246
|
* @response `200` OK
|
|
205
247
|
*/
|
|
206
248
|
resetPassword(query: ResetPasswordParams): Promise<void>;
|
|
@@ -212,6 +254,7 @@ export declare class AccountService extends Service {
|
|
|
212
254
|
* @operationId AccountController_ResetPasswordCallback
|
|
213
255
|
* @summary Reset password.
|
|
214
256
|
* @request POST:/account/password/reset/confirm
|
|
257
|
+
* @secure
|
|
215
258
|
* @response `200` OK
|
|
216
259
|
*/
|
|
217
260
|
resetPasswordCallback(data: ResetPasswordCallbackPayload | FormData): Promise<void>;
|
|
@@ -223,6 +266,7 @@ export declare class AccountService extends Service {
|
|
|
223
266
|
* @operationId AccountController_RemoveUser
|
|
224
267
|
* @summary Remove user.
|
|
225
268
|
* @request DELETE:/account/user/{username}
|
|
269
|
+
* @secure
|
|
226
270
|
* @response `200` OK
|
|
227
271
|
*/
|
|
228
272
|
removeUser(username: string): Promise<void>;
|
|
@@ -234,6 +278,7 @@ export declare class AccountService extends Service {
|
|
|
234
278
|
* @operationId AccountController_ActivateUser
|
|
235
279
|
* @summary Activate user.
|
|
236
280
|
* @request POST:/account/user/{username}/activate
|
|
281
|
+
* @secure
|
|
237
282
|
* @response `200` OK
|
|
238
283
|
*/
|
|
239
284
|
activateUser(username: string): Promise<void>;
|
|
@@ -245,6 +290,7 @@ export declare class AccountService extends Service {
|
|
|
245
290
|
* @operationId AccountController_DeactivateUser
|
|
246
291
|
* @summary Deactivate user.
|
|
247
292
|
* @request POST:/account/user/{username}/deactivate
|
|
293
|
+
* @secure
|
|
248
294
|
* @response `200` OK
|
|
249
295
|
*/
|
|
250
296
|
deactivateUser(username: string): Promise<void>;
|
|
@@ -256,6 +302,7 @@ export declare class AccountService extends Service {
|
|
|
256
302
|
* @operationId AccountController_Authenticate
|
|
257
303
|
* @summary Login.
|
|
258
304
|
* @request POST:/account/login
|
|
305
|
+
* @secure
|
|
259
306
|
* @response `200` OK
|
|
260
307
|
*/
|
|
261
308
|
authenticate(query: AuthenticateParams, data: LoginDc): Promise<LoginResultDc>;
|
|
@@ -267,6 +314,7 @@ export declare class AccountService extends Service {
|
|
|
267
314
|
* @operationId AccountController_RefreshToken
|
|
268
315
|
* @summary Refresh JWT token.
|
|
269
316
|
* @request POST:/account/refresh-token
|
|
317
|
+
* @secure
|
|
270
318
|
* @response `200` OK
|
|
271
319
|
*/
|
|
272
320
|
refreshToken(data: RefreshTokenDc): Promise<LoginResultDc>;
|
|
@@ -278,6 +326,7 @@ export declare class AccountService extends Service {
|
|
|
278
326
|
* @operationId AccountController_RevokeToken
|
|
279
327
|
* @summary Revoke refresh token.
|
|
280
328
|
* @request DELETE:/account/revoke-token
|
|
329
|
+
* @secure
|
|
281
330
|
* @response `200` OK
|
|
282
331
|
*/
|
|
283
332
|
revokeToken(): Promise<void>;
|
|
@@ -289,6 +338,7 @@ export declare class AccountService extends Service {
|
|
|
289
338
|
* @operationId AccountController_LdapLogin
|
|
290
339
|
* @summary The external login callback.
|
|
291
340
|
* @request POST:/account/external/login/ldap
|
|
341
|
+
* @secure
|
|
292
342
|
* @response `200` OK
|
|
293
343
|
*/
|
|
294
344
|
ldapLogin(data: LoginDc): Promise<LoginResultDc>;
|
|
@@ -300,6 +350,7 @@ export declare class AccountService extends Service {
|
|
|
300
350
|
* @operationId AccountController_RegisterClient
|
|
301
351
|
* @summary Register new client.
|
|
302
352
|
* @request POST:/account/oauth2/client
|
|
353
|
+
* @secure
|
|
303
354
|
* @response `200` OK
|
|
304
355
|
*/
|
|
305
356
|
registerClient(data: RegisterClientRequestDc): Promise<RegisterClientResponseDc>;
|
|
@@ -311,6 +362,7 @@ export declare class AccountService extends Service {
|
|
|
311
362
|
* @operationId AccountController_UnbindClient
|
|
312
363
|
* @summary Unbind client with id.
|
|
313
364
|
* @request DELETE:/account/oauth2/client/{clientId}
|
|
365
|
+
* @secure
|
|
314
366
|
* @response `200` OK
|
|
315
367
|
*/
|
|
316
368
|
unbindClient(clientId: string): Promise<void>;
|
|
@@ -322,6 +374,7 @@ export declare class AccountService extends Service {
|
|
|
322
374
|
* @operationId AccountController_Token
|
|
323
375
|
* @summary Get access token request.
|
|
324
376
|
* @request POST:/account/oauth2/token
|
|
377
|
+
* @secure
|
|
325
378
|
* @response `200` OK
|
|
326
379
|
*/
|
|
327
380
|
token(data: TokenRequestDc): Promise<TokenResponseDc>;
|
|
@@ -333,6 +386,7 @@ export declare class AccountService extends Service {
|
|
|
333
386
|
* @operationId AccountController_GetRoles
|
|
334
387
|
* @summary Enumerate exist roles.
|
|
335
388
|
* @request GET:/account/role/list
|
|
389
|
+
* @secure
|
|
336
390
|
* @response `200` OK
|
|
337
391
|
*/
|
|
338
392
|
getRoles(query: GetRolesParams): Promise<PagedListRoleInfoDc>;
|
|
@@ -344,6 +398,7 @@ export declare class AccountService extends Service {
|
|
|
344
398
|
* @operationId AccountController_CreateRole
|
|
345
399
|
* @summary Create new role.
|
|
346
400
|
* @request POST:/account/role
|
|
401
|
+
* @secure
|
|
347
402
|
* @response `200` OK
|
|
348
403
|
*/
|
|
349
404
|
createRole(data: CreateRoleDc): Promise<void>;
|
|
@@ -355,6 +410,7 @@ export declare class AccountService extends Service {
|
|
|
355
410
|
* @operationId AccountController_UpdateRole
|
|
356
411
|
* @summary Update exist role.
|
|
357
412
|
* @request PATCH:/account/role
|
|
413
|
+
* @secure
|
|
358
414
|
* @response `200` OK
|
|
359
415
|
*/
|
|
360
416
|
updateRole(data: UpdateRoleDc): Promise<void>;
|
|
@@ -366,6 +422,7 @@ export declare class AccountService extends Service {
|
|
|
366
422
|
* @operationId AccountController_RemoveRole
|
|
367
423
|
* @summary Remove role.
|
|
368
424
|
* @request DELETE:/account/role/{rolename}
|
|
425
|
+
* @secure
|
|
369
426
|
* @response `200` OK
|
|
370
427
|
*/
|
|
371
428
|
removeRole(rolename: string): Promise<void>;
|
|
@@ -377,6 +434,7 @@ export declare class AccountService extends Service {
|
|
|
377
434
|
* @operationId AccountController_AddToRole
|
|
378
435
|
* @summary Add user to role.
|
|
379
436
|
* @request POST:/account/user/{username}/role/{role}
|
|
437
|
+
* @secure
|
|
380
438
|
* @response `200` OK
|
|
381
439
|
*/
|
|
382
440
|
addToRole(username: string, role: string): Promise<void>;
|
|
@@ -388,6 +446,7 @@ export declare class AccountService extends Service {
|
|
|
388
446
|
* @operationId AccountController_RemoveFromRole
|
|
389
447
|
* @summary Remove user from role.
|
|
390
448
|
* @request DELETE:/account/user/{username}/role/{role}
|
|
449
|
+
* @secure
|
|
391
450
|
* @response `200` OK
|
|
392
451
|
*/
|
|
393
452
|
removeFromRole(username: string, role: string): Promise<void>;
|
|
@@ -399,6 +458,7 @@ export declare class AccountService extends Service {
|
|
|
399
458
|
* @operationId AccountController_PostUsedProjects
|
|
400
459
|
* @summary Set used project.
|
|
401
460
|
* @request POST:/account/latest_projects
|
|
461
|
+
* @secure
|
|
402
462
|
* @response `200` OK
|
|
403
463
|
*/
|
|
404
464
|
postUsedProjects(data: UsedProjectDc): Promise<UsedProjectDc>;
|
|
@@ -410,6 +470,7 @@ export declare class AccountService extends Service {
|
|
|
410
470
|
* @operationId AccountController_GetUsedProjects
|
|
411
471
|
* @summary Get used projects.
|
|
412
472
|
* @request GET:/account/latest_projects
|
|
473
|
+
* @secure
|
|
413
474
|
* @response `200` OK
|
|
414
475
|
*/
|
|
415
476
|
getUsedProjects(): Promise<UsedProjectDc[]>;
|
|
@@ -421,6 +482,7 @@ export declare class AccountService extends Service {
|
|
|
421
482
|
* @operationId AccountController_TruncateUsedProjects
|
|
422
483
|
* @summary Truncate used projects.
|
|
423
484
|
* @request DELETE:/account/latest_projects
|
|
485
|
+
* @secure
|
|
424
486
|
* @response `200` OK
|
|
425
487
|
*/
|
|
426
488
|
truncateUsedProjects(): Promise<void>;
|
|
@@ -14,6 +14,7 @@ export declare class BulkOperationsService extends Service {
|
|
|
14
14
|
* @operationId BulkOperationsController_BatchResourcesPermissionsSet
|
|
15
15
|
* @summary Perform resources set acl access batch operation.
|
|
16
16
|
* @request PUT:/bulk/resources/permissions
|
|
17
|
+
* @secure
|
|
17
18
|
* @response `200` OK
|
|
18
19
|
*/
|
|
19
20
|
batchResourcesPermissionsSet(data: BatchResourcesAclDc): Promise<BulkOperationResultDc[]>;
|
|
@@ -14,6 +14,7 @@ export declare class CamerasService extends Service {
|
|
|
14
14
|
* @operationId CamerasController_GetCameras
|
|
15
15
|
* @summary Get cameras list.
|
|
16
16
|
* @request GET:/cameras
|
|
17
|
+
* @secure
|
|
17
18
|
* @response `200` OK
|
|
18
19
|
*/
|
|
19
20
|
getCameras(query: GetCamerasParams): Promise<CameraListDc>;
|
|
@@ -25,6 +26,7 @@ export declare class CamerasService extends Service {
|
|
|
25
26
|
* @operationId CamerasController_GetArchiveFeed
|
|
26
27
|
* @summary Streams an FLV-over-HTTP archive feed starting at specific time.
|
|
27
28
|
* @request GET:/cameras/{cameraId}/archiveFeed
|
|
29
|
+
* @secure
|
|
28
30
|
* @response `200` OK
|
|
29
31
|
*/
|
|
30
32
|
getArchiveFeed({ cameraId, ...query }: GetArchiveFeedParams): Promise<Blob>;
|
|
@@ -36,6 +38,7 @@ export declare class CamerasService extends Service {
|
|
|
36
38
|
* @operationId CamerasController_GetArchiveTimeline
|
|
37
39
|
* @summary Returns a list of records available within a given timeframe.
|
|
38
40
|
* @request GET:/cameras/{cameraId}/archiveTimeline
|
|
41
|
+
* @secure
|
|
39
42
|
* @response `200` OK
|
|
40
43
|
*/
|
|
41
44
|
getArchiveTimeline({ cameraId, ...query }: GetArchiveTimelineParams): Promise<ArchiveTimelineDc>;
|
|
@@ -47,6 +50,7 @@ export declare class CamerasService extends Service {
|
|
|
47
50
|
* @operationId CamerasController_GetArchiveCalendar
|
|
48
51
|
* @summary Returns a list of records available within a given timeframe.
|
|
49
52
|
* @request GET:/cameras/{cameraId}/archiveCalendar
|
|
53
|
+
* @secure
|
|
50
54
|
* @response `200` OK
|
|
51
55
|
*/
|
|
52
56
|
getArchiveCalendar({ cameraId, ...query }: GetArchiveCalendarParams): Promise<ArchiveCalendarDc>;
|
|
@@ -58,6 +62,7 @@ export declare class CamerasService extends Service {
|
|
|
58
62
|
* @operationId CamerasController_GetArchiveSnapshot
|
|
59
63
|
* @summary Returns a JPEG image from the Camera’s archive.
|
|
60
64
|
* @request GET:/cameras/{cameraId}/archiveSnapshot
|
|
65
|
+
* @secure
|
|
61
66
|
* @response `200` OK
|
|
62
67
|
*/
|
|
63
68
|
getArchiveSnapshot({ cameraId, ...query }: GetArchiveSnapshotParams): Promise<Blob>;
|
|
@@ -69,6 +74,7 @@ export declare class CamerasService extends Service {
|
|
|
69
74
|
* @operationId CamerasController_GetLiveFeed
|
|
70
75
|
* @summary Streams live video feed from the Camera.
|
|
71
76
|
* @request GET:/cameras/{cameraId}/liveFeed
|
|
77
|
+
* @secure
|
|
72
78
|
* @response `200` OK
|
|
73
79
|
*/
|
|
74
80
|
getLiveFeed({ cameraId, ...query }: GetLiveFeedParams): Promise<Blob>;
|
|
@@ -80,6 +86,7 @@ export declare class CamerasService extends Service {
|
|
|
80
86
|
* @operationId CamerasController_GetLiveSnapshot
|
|
81
87
|
* @summary Returns a JPEG image from the Camera’s live feed.
|
|
82
88
|
* @request GET:/cameras/{cameraId}/liveSnapshot
|
|
89
|
+
* @secure
|
|
83
90
|
* @response `200` OK
|
|
84
91
|
*/
|
|
85
92
|
getLiveSnapshot(cameraId: string): Promise<Blob>;
|
|
@@ -91,6 +98,7 @@ export declare class CamerasService extends Service {
|
|
|
91
98
|
* @operationId CamerasController_GetLivePreviewStream
|
|
92
99
|
* @summary Get live preview stream.
|
|
93
100
|
* @request GET:/cameras/{cameraId}/getLivePreviewsStream
|
|
101
|
+
* @secure
|
|
94
102
|
* @response `200` OK
|
|
95
103
|
*/
|
|
96
104
|
getLivePreviewStream({ cameraId, ...query }: GetLivePreviewStreamParams): Promise<object>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AccessControlListDc, CatalogResourceDc, CreateDirectoryDc, CreateFilePayload, GetTagsParams,
|
|
1
|
+
import { AccessControlListDc, CatalogResourceDc, CopyResourceResultDc, CopyResourcesPayload, CreateDirectoryDc, CreateFilePayload, GetTagsParams, ListResourcesDc, MoveResourceDc, PagedResourcesListDc, PagedTagsListDc, PatchResourceDc, PostGetAllParams, PutTagsPayload, ResourceParentDc, SetPermissionsPayload } from './data-contracts';
|
|
2
2
|
import { Service } from './Service';
|
|
3
3
|
/**
|
|
4
4
|
* @title Spatial Processing Core API
|
|
@@ -14,6 +14,7 @@ export declare class CatalogService extends Service {
|
|
|
14
14
|
* @operationId CatalogController_GetParents
|
|
15
15
|
* @summary Get parents.
|
|
16
16
|
* @request GET:/resources/{resourceId}/parents
|
|
17
|
+
* @secure
|
|
17
18
|
* @response `200` OK
|
|
18
19
|
*/
|
|
19
20
|
getParents(resourceId: string): Promise<ResourceParentDc[]>;
|
|
@@ -25,6 +26,7 @@ export declare class CatalogService extends Service {
|
|
|
25
26
|
* @operationId CatalogController_GetTags
|
|
26
27
|
* @summary Get all tags of given user.
|
|
27
28
|
* @request GET:/resources/tags
|
|
29
|
+
* @secure
|
|
28
30
|
* @response `200` OK
|
|
29
31
|
*/
|
|
30
32
|
getTags(query: GetTagsParams): Promise<PagedTagsListDc>;
|
|
@@ -36,6 +38,7 @@ export declare class CatalogService extends Service {
|
|
|
36
38
|
* @operationId CatalogController_PutTags
|
|
37
39
|
* @summary Put tags to resource.
|
|
38
40
|
* @request PUT:/resources/{resourceId}/tags
|
|
41
|
+
* @secure
|
|
39
42
|
* @response `200` OK
|
|
40
43
|
*/
|
|
41
44
|
putTags(resourceId: string, data: PutTagsPayload): Promise<CatalogResourceDc>;
|
|
@@ -47,9 +50,10 @@ export declare class CatalogService extends Service {
|
|
|
47
50
|
* @operationId CatalogController_PostGetAll
|
|
48
51
|
* @summary Get all resource with given.
|
|
49
52
|
* @request POST:/resources
|
|
53
|
+
* @secure
|
|
50
54
|
* @response `200` OK
|
|
51
55
|
*/
|
|
52
|
-
postGetAll(query: PostGetAllParams, data:
|
|
56
|
+
postGetAll(query: PostGetAllParams, data: ListResourcesDc): Promise<PagedResourcesListDc>;
|
|
53
57
|
/**
|
|
54
58
|
* No description
|
|
55
59
|
*
|
|
@@ -58,6 +62,7 @@ export declare class CatalogService extends Service {
|
|
|
58
62
|
* @operationId CatalogController_GetResource
|
|
59
63
|
* @summary Get resource with given id.
|
|
60
64
|
* @request GET:/resources/{resourceId}
|
|
65
|
+
* @secure
|
|
61
66
|
* @response `200` OK
|
|
62
67
|
*/
|
|
63
68
|
getResource(resourceId: string): Promise<CatalogResourceDc>;
|
|
@@ -69,6 +74,7 @@ export declare class CatalogService extends Service {
|
|
|
69
74
|
* @operationId CatalogController_PatchResource
|
|
70
75
|
* @summary Update directory.
|
|
71
76
|
* @request PATCH:/resources/{resourceId}
|
|
77
|
+
* @secure
|
|
72
78
|
* @response `200` OK
|
|
73
79
|
*/
|
|
74
80
|
patchResource(resourceId: string, data: PatchResourceDc): Promise<CatalogResourceDc>;
|
|
@@ -80,6 +86,7 @@ export declare class CatalogService extends Service {
|
|
|
80
86
|
* @operationId CatalogController_DeleteResource
|
|
81
87
|
* @summary Delete resource.
|
|
82
88
|
* @request DELETE:/resources/{resourceId}
|
|
89
|
+
* @secure
|
|
83
90
|
* @response `200` OK
|
|
84
91
|
*/
|
|
85
92
|
deleteResource(resourceId: string): Promise<void>;
|
|
@@ -91,6 +98,7 @@ export declare class CatalogService extends Service {
|
|
|
91
98
|
* @operationId CatalogController_MoveResource
|
|
92
99
|
* @summary Rename resource with given id.
|
|
93
100
|
* @request POST:/resources/{resourceId}/move
|
|
101
|
+
* @secure
|
|
94
102
|
* @response `200` OK
|
|
95
103
|
*/
|
|
96
104
|
moveResource(resourceId: string, data: MoveResourceDc): Promise<CatalogResourceDc>;
|
|
@@ -102,6 +110,7 @@ export declare class CatalogService extends Service {
|
|
|
102
110
|
* @operationId CatalogController_CreateDirectory
|
|
103
111
|
* @summary Create directory.
|
|
104
112
|
* @request POST:/resources/directory
|
|
113
|
+
* @secure
|
|
105
114
|
* @response `200` OK
|
|
106
115
|
*/
|
|
107
116
|
createDirectory(data: CreateDirectoryDc): Promise<CatalogResourceDc>;
|
|
@@ -113,6 +122,7 @@ export declare class CatalogService extends Service {
|
|
|
113
122
|
* @operationId CatalogController_CreateFile
|
|
114
123
|
* @summary Create new file.
|
|
115
124
|
* @request POST:/resources/file
|
|
125
|
+
* @secure
|
|
116
126
|
* @response `200` OK
|
|
117
127
|
*/
|
|
118
128
|
createFile(data: CreateFilePayload | FormData): Promise<CatalogResourceDc>;
|
|
@@ -124,6 +134,7 @@ export declare class CatalogService extends Service {
|
|
|
124
134
|
* @operationId CatalogController_GetPermissions
|
|
125
135
|
* @summary Set permissions to the resource.
|
|
126
136
|
* @request GET:/resources/{resourceId}/permissions
|
|
137
|
+
* @secure
|
|
127
138
|
* @response `200` OK
|
|
128
139
|
*/
|
|
129
140
|
getPermissions(resourceId: string): Promise<AccessControlListDc>;
|
|
@@ -135,6 +146,7 @@ export declare class CatalogService extends Service {
|
|
|
135
146
|
* @operationId CatalogController_SetPermissions_1
|
|
136
147
|
* @summary Set permissions to the resource.
|
|
137
148
|
* @request PUT:/resources/{resourceId}/permissions
|
|
149
|
+
* @secure
|
|
138
150
|
* @response `200` OK
|
|
139
151
|
*/
|
|
140
152
|
setPermissions1(resourceId: string, data: AccessControlListDc): Promise<void>;
|
|
@@ -146,6 +158,7 @@ export declare class CatalogService extends Service {
|
|
|
146
158
|
* @operationId CatalogController_SetPermissions
|
|
147
159
|
* @summary Set permissions to the resource.
|
|
148
160
|
* @request PUT:/resources/permissions
|
|
161
|
+
* @secure
|
|
149
162
|
* @response `200` OK
|
|
150
163
|
*/
|
|
151
164
|
setPermissions(data: SetPermissionsPayload): Promise<void>;
|
|
@@ -157,6 +170,7 @@ export declare class CatalogService extends Service {
|
|
|
157
170
|
* @operationId CatalogController_DownloadFile
|
|
158
171
|
* @summary Download file.
|
|
159
172
|
* @request GET:/resources/{resourceId}/download
|
|
173
|
+
* @secure
|
|
160
174
|
* @response `200` OK
|
|
161
175
|
*/
|
|
162
176
|
downloadFile(resourceId: string): Promise<Blob>;
|
|
@@ -168,7 +182,20 @@ export declare class CatalogService extends Service {
|
|
|
168
182
|
* @operationId CatalogController_CleanResources
|
|
169
183
|
* @summary Clean user resources.
|
|
170
184
|
* @request POST:/resources/clean
|
|
185
|
+
* @secure
|
|
171
186
|
* @response `200` OK
|
|
172
187
|
*/
|
|
173
188
|
cleanResources(): Promise<void>;
|
|
189
|
+
/**
|
|
190
|
+
* No description
|
|
191
|
+
*
|
|
192
|
+
* @tags Catalog
|
|
193
|
+
* @name CopyResources
|
|
194
|
+
* @operationId CatalogController_CopyResources
|
|
195
|
+
* @summary Copy a set of resources.
|
|
196
|
+
* @request POST:/resources/copy
|
|
197
|
+
* @secure
|
|
198
|
+
* @response `200` OK
|
|
199
|
+
*/
|
|
200
|
+
copyResources(data: CopyResourcesPayload): Promise<CopyResourceResultDc[]>;
|
|
174
201
|
}
|
|
@@ -14,6 +14,7 @@ export declare class ClientSettingsService extends Service {
|
|
|
14
14
|
* @operationId ClientSettingsController_GetConfigurationsList
|
|
15
15
|
* @summary Get client configurations.
|
|
16
16
|
* @request GET:/settings/config
|
|
17
|
+
* @secure
|
|
17
18
|
* @response `200` OK
|
|
18
19
|
*/
|
|
19
20
|
getConfigurationsList(query: GetConfigurationsListParams): Promise<PagedListConfigDc>;
|
|
@@ -25,6 +26,7 @@ export declare class ClientSettingsService extends Service {
|
|
|
25
26
|
* @operationId ClientSettingsController_GetConfiguration
|
|
26
27
|
* @summary Get config for urlPath.
|
|
27
28
|
* @request GET:/settings
|
|
29
|
+
* @secure
|
|
28
30
|
* @response `200` OK
|
|
29
31
|
*/
|
|
30
32
|
getConfiguration(query: GetConfigurationParams): Promise<string>;
|
|
@@ -36,6 +38,7 @@ export declare class ClientSettingsService extends Service {
|
|
|
36
38
|
* @operationId ClientSettingsController_SetConfiguration
|
|
37
39
|
* @summary Set config for urlPath.
|
|
38
40
|
* @request POST:/settings
|
|
41
|
+
* @secure
|
|
39
42
|
* @response `200` OK
|
|
40
43
|
*/
|
|
41
44
|
setConfiguration(query: SetConfigurationParams, data: SetConfigurationPayload): Promise<void>;
|
|
@@ -47,6 +50,7 @@ export declare class ClientSettingsService extends Service {
|
|
|
47
50
|
* @operationId ClientSettingsController_RemoveConfiguration
|
|
48
51
|
* @summary Remove config for urlPath.
|
|
49
52
|
* @request DELETE:/settings
|
|
53
|
+
* @secure
|
|
50
54
|
* @response `200` OK
|
|
51
55
|
*/
|
|
52
56
|
removeConfiguration(query: RemoveConfigurationParams): Promise<void>;
|