-
Notifications
You must be signed in to change notification settings - Fork 3
/
licenses.d.ts
461 lines (459 loc) · 15 KB
/
licenses.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
import { A as ApiCallOptions } from './global.types--37uwGji.js';
import './auth-types-PkN9CAF_.js';
type AssignmentsActionsAddRequest = {
add: {
/** User name */
name?: string;
/** User subject */
subject: string;
/** Allotment type */
type: string;
/** @deprecated
* User ID */
userId?: string;
}[];
};
type AssignmentsActionsAddResponse = {
data: {
/** Error code */
code?: string;
/** Response status */
status: number;
/** Subject */
subject: string;
/** Error title */
title?: string;
/** Allotment type */
type?: string;
}[];
};
type AssignmentsActionsDeleteRequest = {
delete: {
/** User subject */
subject: string;
/** Allotment type */
type: string;
}[];
};
type AssignmentsActionsDeleteResponse = {
data: {
/** Error code */
code?: string;
/** Response status */
status: number;
/** Subject */
subject?: string;
/** Error title */
title?: string;
/** Allotment type */
type?: string;
}[];
};
type AssignmentsActionsUpdateRequest = {
update: {
/** The current user subject, in case that should be patched. */
sourceSubject?: string;
/** Current assignment type. */
sourceType?: string;
/** User subject, the current or the desired after the patch. */
subject: string;
/** Target assignment type. */
type?: string;
}[];
};
type AssignmentsActionsUpdateResponse = {
data: {
/** Error code */
code?: string;
/** Current subject. */
sourceSubject?: string;
/** Current allotment type. */
sourceType?: string;
/** Response status */
status: number;
/** Target subject. */
subject?: string;
/** Error title */
title?: string;
/** Target allotment type. */
type?: string;
}[];
};
type AssignmentsResponse = {
data: {
/** Assignment created date. */
created: string;
/** Assignment excess status. */
excess: boolean;
/** Subject */
subject: string;
/** Allotment type */
type: string;
}[];
links: {
next?: Href;
prev?: Href;
};
};
type ConsumptionEventsResponse = {
data: {
/** Allotment ID */
allotmentId?: string;
/** App ID */
appId?: string;
/** Analyzer capacity chunks consumed. */
capacityUsed?: number;
/** Engine session duration. */
duration?: string;
/** Engine session end time. */
endTime?: string;
/** ID */
id?: string;
/** License usage */
licenseUsage?: string;
/** Analyzer capacity minutes consumed. */
minutesUsed?: number;
/** Engine session ID. */
sessionId?: string;
/** User ID */
userId?: string;
}[];
links: {
next?: Href;
prev?: Href;
};
};
type ErrorResponse = {
/** @deprecated
* Error type */
error: string;
errors: {
/** Error code */
code: string;
/** Additional error detail. */
detail?: string;
/** Error title */
title: string;
}[];
/** @deprecated
* Error message */
message: string;
};
type Href = {
/** link */
href?: string;
};
type LicenseOverview = {
allotments: {
name: "professional" | "analyzer" | "analyzer_time";
/** Overage value; -1 means unbounded overage. */
overage?: number;
units: number;
unitsUsed: number;
usageClass: string;
}[];
/** An ISO 8601 timestamp for when the license was last changed. */
changeTime?: string;
/** An ISO 8601 timestamp for when the latest time the license has been known to be valid, a missing value indicates the indefinite future. */
latestValidTime?: string;
licenseKey: string;
licenseNumber: string;
licenseType?: string;
/** Origin of license key. */
origin: "Internal" | "External";
/** The license parameters. */
parameters: {
/** Parameters for licenses to control access to the parameters. */
access?: {
/** Name of an allotment that the user must have access to. to */
allotment?: string;
};
/** Parameter set (provision) name. */
name: string;
/** Time interval for parameter validity. */
valid: string;
/** Parameter values */
values?: unknown;
}[];
/** The product the license is valid for. */
product: string;
/** The secondary number of a definition. */
secondaryNumber: string;
/** Enum with status of license. Only status Ok grants license. access. */
status: "Ok" | "Blacklisted" | "Expired";
/** Boolean indicating if it is a trial license. */
trial: boolean;
/** An ISO 8601 timestamp for when the license was last updated. */
updated: string;
/** Period that the license is currently set to be active. Represented as an ISO 8601 time interval with start and end. */
valid: string;
};
type LicenseStatus = {
/** Origin of license key. */
origin: "Internal" | "External";
/** The product the license is valid for. */
product: string;
/** Enum with status of license. Only status Ok grants license. access. */
status: "Ok" | "Blacklisted" | "Expired" | "Missing";
/** Boolean indicating if it is a trial license. */
trial: boolean;
/** Type of license key. */
type: "Signed" | "Plain";
/** Period that the license is currently set to be active. Represented as an ISO 8601 time interval with start and end. */
valid: string;
};
type SettingsBody = {
/** If analyzer users are available, they will be automatically assigned. Otherwise, analyzer capacity will be assigned, if available. */
autoAssignAnalyzer?: boolean;
/** If professional users are available, they will be automatically assigned. Otherwise, analyzer capacity will be assigned, if available. */
autoAssignProfessional?: boolean;
};
/**
* Retrieves assignments for the current tenant
*
* @param query an object with query parameters
* @throws GetLicenseAssignmentsHttpError
*/
declare const getLicenseAssignments: (query: {
/** The filter for finding entries. */
filter?: string;
/** The preferred number of entries to return. */
limit?: number;
/** Only return assignments which are 'orphans' in the current tenant. */
orphans?: boolean;
/** The requested page. */
page?: string;
/** The field to sort on; can be prefixed with +/- for ascending/descending sort order. */
sort?: string;
}, options?: ApiCallOptions) => Promise<GetLicenseAssignmentsHttpResponse>;
type GetLicenseAssignmentsHttpResponse = {
data: AssignmentsResponse;
headers: Headers;
status: number;
prev?: (options?: ApiCallOptions) => Promise<GetLicenseAssignmentsHttpResponse>;
next?: (options?: ApiCallOptions) => Promise<GetLicenseAssignmentsHttpResponse>;
};
type GetLicenseAssignmentsHttpError = {
data: ErrorResponse;
headers: Headers;
status: number;
};
/**
* Assigns license access to the given users
*
* @param body an object with the body content
* @throws AddLicenseAssignmentsHttpError
*/
declare const addLicenseAssignments: (body: AssignmentsActionsAddRequest, options?: ApiCallOptions) => Promise<AddLicenseAssignmentsHttpResponse>;
type AddLicenseAssignmentsHttpResponse = {
data: AssignmentsActionsAddResponse;
headers: Headers;
status: number;
};
type AddLicenseAssignmentsHttpError = {
data: ErrorResponse;
headers: Headers;
status: number;
};
/**
* Removes license access for the given users
*
* @param body an object with the body content
* @throws DeleteLicenseAssignmentsHttpError
*/
declare const deleteLicenseAssignments: (body: AssignmentsActionsDeleteRequest, options?: ApiCallOptions) => Promise<DeleteLicenseAssignmentsHttpResponse>;
type DeleteLicenseAssignmentsHttpResponse = {
data: AssignmentsActionsDeleteResponse;
headers: Headers;
status: number;
};
type DeleteLicenseAssignmentsHttpError = {
data: ErrorResponse;
headers: Headers;
status: number;
};
/**
* Updates license access for the given users
*
* @param body an object with the body content
* @throws UpdateLicenseAssignmentsHttpError
*/
declare const updateLicenseAssignments: (body: AssignmentsActionsUpdateRequest, options?: ApiCallOptions) => Promise<UpdateLicenseAssignmentsHttpResponse>;
type UpdateLicenseAssignmentsHttpResponse = {
data: AssignmentsActionsUpdateResponse;
headers: Headers;
status: number;
};
type UpdateLicenseAssignmentsHttpError = {
data: ErrorResponse;
headers: Headers;
status: number;
};
/**
* Retrieves license consumption for the current tenant
*
* @param query an object with query parameters
* @throws GetLicenseConsumptionHttpError
*/
declare const getLicenseConsumption: (query: {
/** The SCIM filter for the query. Filterable property is "endTime". */
filter?: string;
/** The preferred number of entries to return. */
limit?: number;
/** The requested page. */
page?: string;
/** The field to sort on; can be prefixed with +/- for ascending/descending sort order. */
sort?: string;
}, options?: ApiCallOptions) => Promise<GetLicenseConsumptionHttpResponse>;
type GetLicenseConsumptionHttpResponse = {
data: ConsumptionEventsResponse;
headers: Headers;
status: number;
prev?: (options?: ApiCallOptions) => Promise<GetLicenseConsumptionHttpResponse>;
next?: (options?: ApiCallOptions) => Promise<GetLicenseConsumptionHttpResponse>;
};
type GetLicenseConsumptionHttpError = {
data: ErrorResponse;
headers: Headers;
status: number;
};
/**
* Gets the general information of the license applied to the current tenant
*
* @throws GetLicenseOverviewHttpError
*/
declare const getLicenseOverview: (options?: ApiCallOptions) => Promise<GetLicenseOverviewHttpResponse>;
type GetLicenseOverviewHttpResponse = {
data: LicenseOverview;
headers: Headers;
status: number;
};
type GetLicenseOverviewHttpError = {
data: ErrorResponse;
headers: Headers;
status: number;
};
/**
* Get auto assign settings for tenant.
*
* @throws GetLicenseSettingsHttpError
*/
declare const getLicenseSettings: (options?: ApiCallOptions) => Promise<GetLicenseSettingsHttpResponse>;
type GetLicenseSettingsHttpResponse = {
data: SettingsBody;
headers: Headers;
status: number;
};
type GetLicenseSettingsHttpError = {
data: ErrorResponse;
headers: Headers;
status: number;
};
/**
* Set auto assign settings for tenant
*
* @param body an object with the body content
* @throws UpdateLicenseSettingsHttpError
*/
declare const updateLicenseSettings: (body: SettingsBody, options?: ApiCallOptions) => Promise<UpdateLicenseSettingsHttpResponse>;
type UpdateLicenseSettingsHttpResponse = {
data: SettingsBody;
headers: Headers;
status: number;
};
type UpdateLicenseSettingsHttpError = {
data: ErrorResponse;
headers: Headers;
status: number;
};
/**
* Gets the license status information of the current tenant
*
* @throws GetLicenseStatusHttpError
*/
declare const getLicenseStatus: (options?: ApiCallOptions) => Promise<GetLicenseStatusHttpResponse>;
type GetLicenseStatusHttpResponse = {
data: LicenseStatus;
headers: Headers;
status: number;
};
type GetLicenseStatusHttpError = {
data: ErrorResponse;
headers: Headers;
status: number;
};
/**
* Clears the cache for licenses api requests.
*/
declare function clearCache(): void;
interface LicensesAPI {
/**
* Retrieves assignments for the current tenant
*
* @param query an object with query parameters
* @throws GetLicenseAssignmentsHttpError
*/
getLicenseAssignments: typeof getLicenseAssignments;
/**
* Assigns license access to the given users
*
* @param body an object with the body content
* @throws AddLicenseAssignmentsHttpError
*/
addLicenseAssignments: typeof addLicenseAssignments;
/**
* Removes license access for the given users
*
* @param body an object with the body content
* @throws DeleteLicenseAssignmentsHttpError
*/
deleteLicenseAssignments: typeof deleteLicenseAssignments;
/**
* Updates license access for the given users
*
* @param body an object with the body content
* @throws UpdateLicenseAssignmentsHttpError
*/
updateLicenseAssignments: typeof updateLicenseAssignments;
/**
* Retrieves license consumption for the current tenant
*
* @param query an object with query parameters
* @throws GetLicenseConsumptionHttpError
*/
getLicenseConsumption: typeof getLicenseConsumption;
/**
* Gets the general information of the license applied to the current tenant
*
* @throws GetLicenseOverviewHttpError
*/
getLicenseOverview: typeof getLicenseOverview;
/**
* Get auto assign settings for tenant.
*
* @throws GetLicenseSettingsHttpError
*/
getLicenseSettings: typeof getLicenseSettings;
/**
* Set auto assign settings for tenant
*
* @param body an object with the body content
* @throws UpdateLicenseSettingsHttpError
*/
updateLicenseSettings: typeof updateLicenseSettings;
/**
* Gets the license status information of the current tenant
*
* @throws GetLicenseStatusHttpError
*/
getLicenseStatus: typeof getLicenseStatus;
/**
* Clears the cache for licenses api requests.
*/
clearCache: typeof clearCache;
}
/**
* Functions for the licenses api
*/
declare const licensesExport: LicensesAPI;
export { type AddLicenseAssignmentsHttpError, type AddLicenseAssignmentsHttpResponse, type AssignmentsActionsAddRequest, type AssignmentsActionsAddResponse, type AssignmentsActionsDeleteRequest, type AssignmentsActionsDeleteResponse, type AssignmentsActionsUpdateRequest, type AssignmentsActionsUpdateResponse, type AssignmentsResponse, type ConsumptionEventsResponse, type DeleteLicenseAssignmentsHttpError, type DeleteLicenseAssignmentsHttpResponse, type ErrorResponse, type GetLicenseAssignmentsHttpError, type GetLicenseAssignmentsHttpResponse, type GetLicenseConsumptionHttpError, type GetLicenseConsumptionHttpResponse, type GetLicenseOverviewHttpError, type GetLicenseOverviewHttpResponse, type GetLicenseSettingsHttpError, type GetLicenseSettingsHttpResponse, type GetLicenseStatusHttpError, type GetLicenseStatusHttpResponse, type Href, type LicenseOverview, type LicenseStatus, type LicensesAPI, type SettingsBody, type UpdateLicenseAssignmentsHttpError, type UpdateLicenseAssignmentsHttpResponse, type UpdateLicenseSettingsHttpError, type UpdateLicenseSettingsHttpResponse, addLicenseAssignments, clearCache, licensesExport as default, deleteLicenseAssignments, getLicenseAssignments, getLicenseConsumption, getLicenseOverview, getLicenseSettings, getLicenseStatus, updateLicenseAssignments, updateLicenseSettings };