@iblai/iblai-api 4.251.0-core → 4.252.0-core
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/index.cjs.js +564 -1
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +565 -2
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +564 -1
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +16 -0
- package/dist/types/models/EventsEnum.d.ts +34 -0
- package/dist/types/models/PaginatedWatchedGroupListList.d.ts +7 -0
- package/dist/types/models/PaginatedWatchedUserReadList.d.ts +7 -0
- package/dist/types/models/PaginatedWatcherReadList.d.ts +7 -0
- package/dist/types/models/PatchedWatchedGroupUpdate.d.ts +8 -0
- package/dist/types/models/PatchedWatcherUpdate.d.ts +7 -0
- package/dist/types/models/WatchedGroupCreate.d.ts +21 -0
- package/dist/types/models/WatchedGroupDetail.d.ts +16 -0
- package/dist/types/models/WatchedGroupList.d.ts +8 -0
- package/dist/types/models/WatchedGroupUpdate.d.ts +8 -0
- package/dist/types/models/WatchedUserRead.d.ts +11 -0
- package/dist/types/models/WatchedUserWrite.d.ts +9 -0
- package/dist/types/models/WatcherEntry.d.ts +8 -0
- package/dist/types/models/WatcherRead.d.ts +16 -0
- package/dist/types/models/WatcherUpdate.d.ts +7 -0
- package/dist/types/models/WatcherWrite.d.ts +11 -0
- package/dist/types/services/CoreService.d.ts +364 -0
- package/package.json +1 -1
- package/sdk_schema.yml +1269 -104
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +16 -0
- package/src/models/EventsEnum.ts +38 -0
- package/src/models/PaginatedWatchedGroupListList.ts +12 -0
- package/src/models/PaginatedWatchedUserReadList.ts +12 -0
- package/src/models/PaginatedWatcherReadList.ts +12 -0
- package/src/models/PatchedWatchedGroupUpdate.ts +13 -0
- package/src/models/PatchedWatcherUpdate.ts +12 -0
- package/src/models/WatchedGroupCreate.ts +26 -0
- package/src/models/WatchedGroupDetail.ts +21 -0
- package/src/models/WatchedGroupList.ts +13 -0
- package/src/models/WatchedGroupUpdate.ts +13 -0
- package/src/models/WatchedUserRead.ts +16 -0
- package/src/models/WatchedUserWrite.ts +14 -0
- package/src/models/WatcherEntry.ts +13 -0
- package/src/models/WatcherRead.ts +21 -0
- package/src/models/WatcherUpdate.ts +12 -0
- package/src/models/WatcherWrite.ts +16 -0
- package/src/services/CoreService.ts +711 -0
|
@@ -19,6 +19,9 @@ import type { PaginatedRbacGroupList } from '../models/PaginatedRbacGroupList';
|
|
|
19
19
|
import type { PaginatedRbacPolicyList } from '../models/PaginatedRbacPolicyList';
|
|
20
20
|
import type { PaginatedRbacRoleList } from '../models/PaginatedRbacRoleList';
|
|
21
21
|
import type { PaginatedUserGroupList } from '../models/PaginatedUserGroupList';
|
|
22
|
+
import type { PaginatedWatchedGroupListList } from '../models/PaginatedWatchedGroupListList';
|
|
23
|
+
import type { PaginatedWatchedUserReadList } from '../models/PaginatedWatchedUserReadList';
|
|
24
|
+
import type { PaginatedWatcherReadList } from '../models/PaginatedWatcherReadList';
|
|
22
25
|
import type { PatchedDemographicsFieldDefinitionWrite } from '../models/PatchedDemographicsFieldDefinitionWrite';
|
|
23
26
|
import type { PatchedPlatformPublicImageAsset } from '../models/PatchedPlatformPublicImageAsset';
|
|
24
27
|
import type { PatchedPlatformPublicMetadata } from '../models/PatchedPlatformPublicMetadata';
|
|
@@ -27,6 +30,8 @@ import type { PatchedRbacPolicy } from '../models/PatchedRbacPolicy';
|
|
|
27
30
|
import type { PatchedRbacRole } from '../models/PatchedRbacRole';
|
|
28
31
|
import type { PatchedUserGroup } from '../models/PatchedUserGroup';
|
|
29
32
|
import type { PatchedUserPlatformMetadataUpdate } from '../models/PatchedUserPlatformMetadataUpdate';
|
|
33
|
+
import type { PatchedWatchedGroupUpdate } from '../models/PatchedWatchedGroupUpdate';
|
|
34
|
+
import type { PatchedWatcherUpdate } from '../models/PatchedWatcherUpdate';
|
|
30
35
|
import type { PermissionCheckRequest } from '../models/PermissionCheckRequest';
|
|
31
36
|
import type { PlatformApiKey } from '../models/PlatformApiKey';
|
|
32
37
|
import type { PlatformConfigurationList } from '../models/PlatformConfigurationList';
|
|
@@ -71,6 +76,14 @@ import type { UserProxyGetResponse } from '../models/UserProxyGetResponse';
|
|
|
71
76
|
import type { UserProxyPostRequest } from '../models/UserProxyPostRequest';
|
|
72
77
|
import type { UserProxyPostResponse } from '../models/UserProxyPostResponse';
|
|
73
78
|
import type { UserSearchViewGetResponse } from '../models/UserSearchViewGetResponse';
|
|
79
|
+
import type { WatchedGroupCreate } from '../models/WatchedGroupCreate';
|
|
80
|
+
import type { WatchedGroupDetail } from '../models/WatchedGroupDetail';
|
|
81
|
+
import type { WatchedGroupUpdate } from '../models/WatchedGroupUpdate';
|
|
82
|
+
import type { WatchedUserRead } from '../models/WatchedUserRead';
|
|
83
|
+
import type { WatchedUserWrite } from '../models/WatchedUserWrite';
|
|
84
|
+
import type { WatcherRead } from '../models/WatcherRead';
|
|
85
|
+
import type { WatcherUpdate } from '../models/WatcherUpdate';
|
|
86
|
+
import type { WatcherWrite } from '../models/WatcherWrite';
|
|
74
87
|
import type { WhitelistedDomain } from '../models/WhitelistedDomain';
|
|
75
88
|
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
76
89
|
import { OpenAPI } from '../core/OpenAPI';
|
|
@@ -3302,6 +3315,704 @@ export class CoreService {
|
|
|
3302
3315
|
},
|
|
3303
3316
|
});
|
|
3304
3317
|
}
|
|
3318
|
+
/**
|
|
3319
|
+
* List watched groups visible to the caller
|
|
3320
|
+
* CRUD for WatchedGroup. Watcher mutations live on the nested /watchers/ endpoint;
|
|
3321
|
+
* POST here accepts an optional `watchers` array as a create-time convenience.
|
|
3322
|
+
* @returns PaginatedWatchedGroupListList
|
|
3323
|
+
* @throws ApiError
|
|
3324
|
+
*/
|
|
3325
|
+
public static coreWatchedGroupsList({
|
|
3326
|
+
limit,
|
|
3327
|
+
offset,
|
|
3328
|
+
platformKey,
|
|
3329
|
+
}: {
|
|
3330
|
+
/**
|
|
3331
|
+
* Number of results to return per page.
|
|
3332
|
+
*/
|
|
3333
|
+
limit?: number,
|
|
3334
|
+
/**
|
|
3335
|
+
* The initial index from which to return the results.
|
|
3336
|
+
*/
|
|
3337
|
+
offset?: number,
|
|
3338
|
+
/**
|
|
3339
|
+
* Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
|
|
3340
|
+
*/
|
|
3341
|
+
platformKey?: string,
|
|
3342
|
+
}): CancelablePromise<PaginatedWatchedGroupListList> {
|
|
3343
|
+
return __request(OpenAPI, {
|
|
3344
|
+
method: 'GET',
|
|
3345
|
+
url: '/api/core/watched-groups/',
|
|
3346
|
+
query: {
|
|
3347
|
+
'limit': limit,
|
|
3348
|
+
'offset': offset,
|
|
3349
|
+
'platform_key': platformKey,
|
|
3350
|
+
},
|
|
3351
|
+
errors: {
|
|
3352
|
+
403: `Permission denied`,
|
|
3353
|
+
404: `Platform not found`,
|
|
3354
|
+
},
|
|
3355
|
+
});
|
|
3356
|
+
}
|
|
3357
|
+
/**
|
|
3358
|
+
* Create a watched group
|
|
3359
|
+
* CRUD for WatchedGroup. Watcher mutations live on the nested /watchers/ endpoint;
|
|
3360
|
+
* POST here accepts an optional `watchers` array as a create-time convenience.
|
|
3361
|
+
* @returns WatchedGroupDetail
|
|
3362
|
+
* @throws ApiError
|
|
3363
|
+
*/
|
|
3364
|
+
public static coreWatchedGroupsCreate({
|
|
3365
|
+
requestBody,
|
|
3366
|
+
platformKey,
|
|
3367
|
+
watchedUserLimit,
|
|
3368
|
+
watcherLimit,
|
|
3369
|
+
}: {
|
|
3370
|
+
requestBody: WatchedGroupCreate,
|
|
3371
|
+
/**
|
|
3372
|
+
* Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
|
|
3373
|
+
*/
|
|
3374
|
+
platformKey?: string,
|
|
3375
|
+
/**
|
|
3376
|
+
* Inline up to N watched users in the response (0 = none, max 100). Use the nested /watched-users/ endpoint for paginated walks.
|
|
3377
|
+
*/
|
|
3378
|
+
watchedUserLimit?: number,
|
|
3379
|
+
/**
|
|
3380
|
+
* Inline up to N watchers in the response (0 = none, max 100). Use the nested /watchers/ endpoint for paginated walks.
|
|
3381
|
+
*/
|
|
3382
|
+
watcherLimit?: number,
|
|
3383
|
+
}): CancelablePromise<WatchedGroupDetail> {
|
|
3384
|
+
return __request(OpenAPI, {
|
|
3385
|
+
method: 'POST',
|
|
3386
|
+
url: '/api/core/watched-groups/',
|
|
3387
|
+
query: {
|
|
3388
|
+
'platform_key': platformKey,
|
|
3389
|
+
'watched_user_limit': watchedUserLimit,
|
|
3390
|
+
'watcher_limit': watcherLimit,
|
|
3391
|
+
},
|
|
3392
|
+
body: requestBody,
|
|
3393
|
+
mediaType: 'application/json',
|
|
3394
|
+
errors: {
|
|
3395
|
+
400: `Invalid request`,
|
|
3396
|
+
403: `Permission denied`,
|
|
3397
|
+
},
|
|
3398
|
+
});
|
|
3399
|
+
}
|
|
3400
|
+
/**
|
|
3401
|
+
* Retrieve a watched group
|
|
3402
|
+
* CRUD for WatchedGroup. Watcher mutations live on the nested /watchers/ endpoint;
|
|
3403
|
+
* POST here accepts an optional `watchers` array as a create-time convenience.
|
|
3404
|
+
* @returns WatchedGroupDetail
|
|
3405
|
+
* @throws ApiError
|
|
3406
|
+
*/
|
|
3407
|
+
public static coreWatchedGroupsRetrieve({
|
|
3408
|
+
id,
|
|
3409
|
+
platformKey,
|
|
3410
|
+
watchedUserLimit,
|
|
3411
|
+
watcherLimit,
|
|
3412
|
+
}: {
|
|
3413
|
+
/**
|
|
3414
|
+
* A unique integer value identifying this Watched Group.
|
|
3415
|
+
*/
|
|
3416
|
+
id: number,
|
|
3417
|
+
/**
|
|
3418
|
+
* Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
|
|
3419
|
+
*/
|
|
3420
|
+
platformKey?: string,
|
|
3421
|
+
/**
|
|
3422
|
+
* Inline up to N watched users in the response (0 = none, max 100). Use the nested /watched-users/ endpoint for paginated walks.
|
|
3423
|
+
*/
|
|
3424
|
+
watchedUserLimit?: number,
|
|
3425
|
+
/**
|
|
3426
|
+
* Inline up to N watchers in the response (0 = none, max 100). Use the nested /watchers/ endpoint for paginated walks.
|
|
3427
|
+
*/
|
|
3428
|
+
watcherLimit?: number,
|
|
3429
|
+
}): CancelablePromise<WatchedGroupDetail> {
|
|
3430
|
+
return __request(OpenAPI, {
|
|
3431
|
+
method: 'GET',
|
|
3432
|
+
url: '/api/core/watched-groups/{id}/',
|
|
3433
|
+
path: {
|
|
3434
|
+
'id': id,
|
|
3435
|
+
},
|
|
3436
|
+
query: {
|
|
3437
|
+
'platform_key': platformKey,
|
|
3438
|
+
'watched_user_limit': watchedUserLimit,
|
|
3439
|
+
'watcher_limit': watcherLimit,
|
|
3440
|
+
},
|
|
3441
|
+
errors: {
|
|
3442
|
+
403: `Permission denied`,
|
|
3443
|
+
404: `Not found`,
|
|
3444
|
+
},
|
|
3445
|
+
});
|
|
3446
|
+
}
|
|
3447
|
+
/**
|
|
3448
|
+
* Update a watched group's name
|
|
3449
|
+
* CRUD for WatchedGroup. Watcher mutations live on the nested /watchers/ endpoint;
|
|
3450
|
+
* POST here accepts an optional `watchers` array as a create-time convenience.
|
|
3451
|
+
* @returns WatchedGroupDetail
|
|
3452
|
+
* @throws ApiError
|
|
3453
|
+
*/
|
|
3454
|
+
public static coreWatchedGroupsUpdate({
|
|
3455
|
+
id,
|
|
3456
|
+
platformKey,
|
|
3457
|
+
watchedUserLimit,
|
|
3458
|
+
watcherLimit,
|
|
3459
|
+
requestBody,
|
|
3460
|
+
}: {
|
|
3461
|
+
/**
|
|
3462
|
+
* A unique integer value identifying this Watched Group.
|
|
3463
|
+
*/
|
|
3464
|
+
id: number,
|
|
3465
|
+
/**
|
|
3466
|
+
* Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
|
|
3467
|
+
*/
|
|
3468
|
+
platformKey?: string,
|
|
3469
|
+
/**
|
|
3470
|
+
* Inline up to N watched users in the response (0 = none, max 100). Use the nested /watched-users/ endpoint for paginated walks.
|
|
3471
|
+
*/
|
|
3472
|
+
watchedUserLimit?: number,
|
|
3473
|
+
/**
|
|
3474
|
+
* Inline up to N watchers in the response (0 = none, max 100). Use the nested /watchers/ endpoint for paginated walks.
|
|
3475
|
+
*/
|
|
3476
|
+
watcherLimit?: number,
|
|
3477
|
+
requestBody?: WatchedGroupUpdate,
|
|
3478
|
+
}): CancelablePromise<WatchedGroupDetail> {
|
|
3479
|
+
return __request(OpenAPI, {
|
|
3480
|
+
method: 'PUT',
|
|
3481
|
+
url: '/api/core/watched-groups/{id}/',
|
|
3482
|
+
path: {
|
|
3483
|
+
'id': id,
|
|
3484
|
+
},
|
|
3485
|
+
query: {
|
|
3486
|
+
'platform_key': platformKey,
|
|
3487
|
+
'watched_user_limit': watchedUserLimit,
|
|
3488
|
+
'watcher_limit': watcherLimit,
|
|
3489
|
+
},
|
|
3490
|
+
body: requestBody,
|
|
3491
|
+
mediaType: 'application/json',
|
|
3492
|
+
errors: {
|
|
3493
|
+
400: `Invalid request`,
|
|
3494
|
+
403: `Permission denied`,
|
|
3495
|
+
404: `Not found`,
|
|
3496
|
+
},
|
|
3497
|
+
});
|
|
3498
|
+
}
|
|
3499
|
+
/**
|
|
3500
|
+
* Partially update a watched group's name
|
|
3501
|
+
* CRUD for WatchedGroup. Watcher mutations live on the nested /watchers/ endpoint;
|
|
3502
|
+
* POST here accepts an optional `watchers` array as a create-time convenience.
|
|
3503
|
+
* @returns WatchedGroupDetail
|
|
3504
|
+
* @throws ApiError
|
|
3505
|
+
*/
|
|
3506
|
+
public static coreWatchedGroupsPartialUpdate({
|
|
3507
|
+
id,
|
|
3508
|
+
platformKey,
|
|
3509
|
+
watchedUserLimit,
|
|
3510
|
+
watcherLimit,
|
|
3511
|
+
requestBody,
|
|
3512
|
+
}: {
|
|
3513
|
+
/**
|
|
3514
|
+
* A unique integer value identifying this Watched Group.
|
|
3515
|
+
*/
|
|
3516
|
+
id: number,
|
|
3517
|
+
/**
|
|
3518
|
+
* Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
|
|
3519
|
+
*/
|
|
3520
|
+
platformKey?: string,
|
|
3521
|
+
/**
|
|
3522
|
+
* Inline up to N watched users in the response (0 = none, max 100). Use the nested /watched-users/ endpoint for paginated walks.
|
|
3523
|
+
*/
|
|
3524
|
+
watchedUserLimit?: number,
|
|
3525
|
+
/**
|
|
3526
|
+
* Inline up to N watchers in the response (0 = none, max 100). Use the nested /watchers/ endpoint for paginated walks.
|
|
3527
|
+
*/
|
|
3528
|
+
watcherLimit?: number,
|
|
3529
|
+
requestBody?: PatchedWatchedGroupUpdate,
|
|
3530
|
+
}): CancelablePromise<WatchedGroupDetail> {
|
|
3531
|
+
return __request(OpenAPI, {
|
|
3532
|
+
method: 'PATCH',
|
|
3533
|
+
url: '/api/core/watched-groups/{id}/',
|
|
3534
|
+
path: {
|
|
3535
|
+
'id': id,
|
|
3536
|
+
},
|
|
3537
|
+
query: {
|
|
3538
|
+
'platform_key': platformKey,
|
|
3539
|
+
'watched_user_limit': watchedUserLimit,
|
|
3540
|
+
'watcher_limit': watcherLimit,
|
|
3541
|
+
},
|
|
3542
|
+
body: requestBody,
|
|
3543
|
+
mediaType: 'application/json',
|
|
3544
|
+
errors: {
|
|
3545
|
+
400: `Invalid request`,
|
|
3546
|
+
403: `Permission denied`,
|
|
3547
|
+
404: `Not found`,
|
|
3548
|
+
},
|
|
3549
|
+
});
|
|
3550
|
+
}
|
|
3551
|
+
/**
|
|
3552
|
+
* Delete a watched group
|
|
3553
|
+
* CRUD for WatchedGroup. Watcher mutations live on the nested /watchers/ endpoint;
|
|
3554
|
+
* POST here accepts an optional `watchers` array as a create-time convenience.
|
|
3555
|
+
* @returns void
|
|
3556
|
+
* @throws ApiError
|
|
3557
|
+
*/
|
|
3558
|
+
public static coreWatchedGroupsDestroy({
|
|
3559
|
+
id,
|
|
3560
|
+
platformKey,
|
|
3561
|
+
}: {
|
|
3562
|
+
/**
|
|
3563
|
+
* A unique integer value identifying this Watched Group.
|
|
3564
|
+
*/
|
|
3565
|
+
id: number,
|
|
3566
|
+
/**
|
|
3567
|
+
* Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
|
|
3568
|
+
*/
|
|
3569
|
+
platformKey?: string,
|
|
3570
|
+
}): CancelablePromise<void> {
|
|
3571
|
+
return __request(OpenAPI, {
|
|
3572
|
+
method: 'DELETE',
|
|
3573
|
+
url: '/api/core/watched-groups/{id}/',
|
|
3574
|
+
path: {
|
|
3575
|
+
'id': id,
|
|
3576
|
+
},
|
|
3577
|
+
query: {
|
|
3578
|
+
'platform_key': platformKey,
|
|
3579
|
+
},
|
|
3580
|
+
errors: {
|
|
3581
|
+
403: `Permission denied`,
|
|
3582
|
+
404: `Not found`,
|
|
3583
|
+
},
|
|
3584
|
+
});
|
|
3585
|
+
}
|
|
3586
|
+
/**
|
|
3587
|
+
* List watched users in a watched group (paginated)
|
|
3588
|
+
* CRUD-minus-update for watched users (UserGroupLink rows) under a WatchedGroup.
|
|
3589
|
+
*
|
|
3590
|
+
* Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchedusers/{link_id}/
|
|
3591
|
+
* No PATCH/PUT — there's nothing meaningful to update on a UserGroupLink for
|
|
3592
|
+
* this feature. Add via POST, remove via DELETE.
|
|
3593
|
+
* @returns PaginatedWatchedUserReadList
|
|
3594
|
+
* @throws ApiError
|
|
3595
|
+
*/
|
|
3596
|
+
public static coreWatchedGroupsWatchedUsersList({
|
|
3597
|
+
watchedGroupPk,
|
|
3598
|
+
limit,
|
|
3599
|
+
offset,
|
|
3600
|
+
platformKey,
|
|
3601
|
+
}: {
|
|
3602
|
+
watchedGroupPk: number,
|
|
3603
|
+
/**
|
|
3604
|
+
* Number of results to return per page.
|
|
3605
|
+
*/
|
|
3606
|
+
limit?: number,
|
|
3607
|
+
/**
|
|
3608
|
+
* The initial index from which to return the results.
|
|
3609
|
+
*/
|
|
3610
|
+
offset?: number,
|
|
3611
|
+
/**
|
|
3612
|
+
* Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
|
|
3613
|
+
*/
|
|
3614
|
+
platformKey?: string,
|
|
3615
|
+
}): CancelablePromise<PaginatedWatchedUserReadList> {
|
|
3616
|
+
return __request(OpenAPI, {
|
|
3617
|
+
method: 'GET',
|
|
3618
|
+
url: '/api/core/watched-groups/{watched_group_pk}/watched-users/',
|
|
3619
|
+
path: {
|
|
3620
|
+
'watched_group_pk': watchedGroupPk,
|
|
3621
|
+
},
|
|
3622
|
+
query: {
|
|
3623
|
+
'limit': limit,
|
|
3624
|
+
'offset': offset,
|
|
3625
|
+
'platform_key': platformKey,
|
|
3626
|
+
},
|
|
3627
|
+
errors: {
|
|
3628
|
+
403: `Permission denied`,
|
|
3629
|
+
404: `WatchedGroup not found`,
|
|
3630
|
+
},
|
|
3631
|
+
});
|
|
3632
|
+
}
|
|
3633
|
+
/**
|
|
3634
|
+
* Add a user to the watched group
|
|
3635
|
+
* CRUD-minus-update for watched users (UserGroupLink rows) under a WatchedGroup.
|
|
3636
|
+
*
|
|
3637
|
+
* Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchedusers/{link_id}/
|
|
3638
|
+
* No PATCH/PUT — there's nothing meaningful to update on a UserGroupLink for
|
|
3639
|
+
* this feature. Add via POST, remove via DELETE.
|
|
3640
|
+
* @returns WatchedUserRead
|
|
3641
|
+
* @throws ApiError
|
|
3642
|
+
*/
|
|
3643
|
+
public static coreWatchedGroupsWatchedUsersCreate({
|
|
3644
|
+
watchedGroupPk,
|
|
3645
|
+
requestBody,
|
|
3646
|
+
platformKey,
|
|
3647
|
+
}: {
|
|
3648
|
+
watchedGroupPk: number,
|
|
3649
|
+
requestBody: WatchedUserWrite,
|
|
3650
|
+
/**
|
|
3651
|
+
* Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
|
|
3652
|
+
*/
|
|
3653
|
+
platformKey?: string,
|
|
3654
|
+
}): CancelablePromise<WatchedUserRead> {
|
|
3655
|
+
return __request(OpenAPI, {
|
|
3656
|
+
method: 'POST',
|
|
3657
|
+
url: '/api/core/watched-groups/{watched_group_pk}/watched-users/',
|
|
3658
|
+
path: {
|
|
3659
|
+
'watched_group_pk': watchedGroupPk,
|
|
3660
|
+
},
|
|
3661
|
+
query: {
|
|
3662
|
+
'platform_key': platformKey,
|
|
3663
|
+
},
|
|
3664
|
+
body: requestBody,
|
|
3665
|
+
mediaType: 'application/json',
|
|
3666
|
+
errors: {
|
|
3667
|
+
400: `Invalid payload`,
|
|
3668
|
+
403: `Permission denied`,
|
|
3669
|
+
404: `WatchedGroup not found`,
|
|
3670
|
+
},
|
|
3671
|
+
});
|
|
3672
|
+
}
|
|
3673
|
+
/**
|
|
3674
|
+
* Retrieve a single watched-user link
|
|
3675
|
+
* CRUD-minus-update for watched users (UserGroupLink rows) under a WatchedGroup.
|
|
3676
|
+
*
|
|
3677
|
+
* Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchedusers/{link_id}/
|
|
3678
|
+
* No PATCH/PUT — there's nothing meaningful to update on a UserGroupLink for
|
|
3679
|
+
* this feature. Add via POST, remove via DELETE.
|
|
3680
|
+
* @returns WatchedUserRead
|
|
3681
|
+
* @throws ApiError
|
|
3682
|
+
*/
|
|
3683
|
+
public static coreWatchedGroupsWatchedUsersRetrieve({
|
|
3684
|
+
id,
|
|
3685
|
+
watchedGroupPk,
|
|
3686
|
+
platformKey,
|
|
3687
|
+
}: {
|
|
3688
|
+
id: number,
|
|
3689
|
+
watchedGroupPk: number,
|
|
3690
|
+
/**
|
|
3691
|
+
* Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
|
|
3692
|
+
*/
|
|
3693
|
+
platformKey?: string,
|
|
3694
|
+
}): CancelablePromise<WatchedUserRead> {
|
|
3695
|
+
return __request(OpenAPI, {
|
|
3696
|
+
method: 'GET',
|
|
3697
|
+
url: '/api/core/watched-groups/{watched_group_pk}/watched-users/{id}/',
|
|
3698
|
+
path: {
|
|
3699
|
+
'id': id,
|
|
3700
|
+
'watched_group_pk': watchedGroupPk,
|
|
3701
|
+
},
|
|
3702
|
+
query: {
|
|
3703
|
+
'platform_key': platformKey,
|
|
3704
|
+
},
|
|
3705
|
+
errors: {
|
|
3706
|
+
403: `Permission denied`,
|
|
3707
|
+
404: `Not found`,
|
|
3708
|
+
},
|
|
3709
|
+
});
|
|
3710
|
+
}
|
|
3711
|
+
/**
|
|
3712
|
+
* Remove a user from the watched group
|
|
3713
|
+
* CRUD-minus-update for watched users (UserGroupLink rows) under a WatchedGroup.
|
|
3714
|
+
*
|
|
3715
|
+
* Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchedusers/{link_id}/
|
|
3716
|
+
* No PATCH/PUT — there's nothing meaningful to update on a UserGroupLink for
|
|
3717
|
+
* this feature. Add via POST, remove via DELETE.
|
|
3718
|
+
* @returns void
|
|
3719
|
+
* @throws ApiError
|
|
3720
|
+
*/
|
|
3721
|
+
public static coreWatchedGroupsWatchedUsersDestroy({
|
|
3722
|
+
id,
|
|
3723
|
+
watchedGroupPk,
|
|
3724
|
+
platformKey,
|
|
3725
|
+
}: {
|
|
3726
|
+
id: number,
|
|
3727
|
+
watchedGroupPk: number,
|
|
3728
|
+
/**
|
|
3729
|
+
* Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
|
|
3730
|
+
*/
|
|
3731
|
+
platformKey?: string,
|
|
3732
|
+
}): CancelablePromise<void> {
|
|
3733
|
+
return __request(OpenAPI, {
|
|
3734
|
+
method: 'DELETE',
|
|
3735
|
+
url: '/api/core/watched-groups/{watched_group_pk}/watched-users/{id}/',
|
|
3736
|
+
path: {
|
|
3737
|
+
'id': id,
|
|
3738
|
+
'watched_group_pk': watchedGroupPk,
|
|
3739
|
+
},
|
|
3740
|
+
query: {
|
|
3741
|
+
'platform_key': platformKey,
|
|
3742
|
+
},
|
|
3743
|
+
errors: {
|
|
3744
|
+
403: `Permission denied`,
|
|
3745
|
+
404: `Not found`,
|
|
3746
|
+
},
|
|
3747
|
+
});
|
|
3748
|
+
}
|
|
3749
|
+
/**
|
|
3750
|
+
* List watchers of a watched group (paginated)
|
|
3751
|
+
* CRUD for watchers nested under a WatchedGroup.
|
|
3752
|
+
*
|
|
3753
|
+
* Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchers/{watcher_id}/
|
|
3754
|
+
* `is_owner` here covers two cases that both deserve owner-level perms on a
|
|
3755
|
+
* watcher row:
|
|
3756
|
+
* - the watcher themselves (WATCHER_OWNER well-known role)
|
|
3757
|
+
* - the parent WatchedGroup's owner (WATCHED_GROUP_OWNER role grants
|
|
3758
|
+
* `Ibl.Core/Watchers*`)
|
|
3759
|
+
* @returns PaginatedWatcherReadList
|
|
3760
|
+
* @throws ApiError
|
|
3761
|
+
*/
|
|
3762
|
+
public static coreWatchedGroupsWatchersList({
|
|
3763
|
+
watchedGroupPk,
|
|
3764
|
+
limit,
|
|
3765
|
+
offset,
|
|
3766
|
+
platformKey,
|
|
3767
|
+
}: {
|
|
3768
|
+
watchedGroupPk: number,
|
|
3769
|
+
/**
|
|
3770
|
+
* Number of results to return per page.
|
|
3771
|
+
*/
|
|
3772
|
+
limit?: number,
|
|
3773
|
+
/**
|
|
3774
|
+
* The initial index from which to return the results.
|
|
3775
|
+
*/
|
|
3776
|
+
offset?: number,
|
|
3777
|
+
/**
|
|
3778
|
+
* Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
|
|
3779
|
+
*/
|
|
3780
|
+
platformKey?: string,
|
|
3781
|
+
}): CancelablePromise<PaginatedWatcherReadList> {
|
|
3782
|
+
return __request(OpenAPI, {
|
|
3783
|
+
method: 'GET',
|
|
3784
|
+
url: '/api/core/watched-groups/{watched_group_pk}/watchers/',
|
|
3785
|
+
path: {
|
|
3786
|
+
'watched_group_pk': watchedGroupPk,
|
|
3787
|
+
},
|
|
3788
|
+
query: {
|
|
3789
|
+
'limit': limit,
|
|
3790
|
+
'offset': offset,
|
|
3791
|
+
'platform_key': platformKey,
|
|
3792
|
+
},
|
|
3793
|
+
errors: {
|
|
3794
|
+
403: `Permission denied`,
|
|
3795
|
+
404: `WatchedGroup not found`,
|
|
3796
|
+
},
|
|
3797
|
+
});
|
|
3798
|
+
}
|
|
3799
|
+
/**
|
|
3800
|
+
* Add a watcher to a watched group
|
|
3801
|
+
* CRUD for watchers nested under a WatchedGroup.
|
|
3802
|
+
*
|
|
3803
|
+
* Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchers/{watcher_id}/
|
|
3804
|
+
* `is_owner` here covers two cases that both deserve owner-level perms on a
|
|
3805
|
+
* watcher row:
|
|
3806
|
+
* - the watcher themselves (WATCHER_OWNER well-known role)
|
|
3807
|
+
* - the parent WatchedGroup's owner (WATCHED_GROUP_OWNER role grants
|
|
3808
|
+
* `Ibl.Core/Watchers*`)
|
|
3809
|
+
* @returns WatcherRead
|
|
3810
|
+
* @throws ApiError
|
|
3811
|
+
*/
|
|
3812
|
+
public static coreWatchedGroupsWatchersCreate({
|
|
3813
|
+
watchedGroupPk,
|
|
3814
|
+
requestBody,
|
|
3815
|
+
platformKey,
|
|
3816
|
+
}: {
|
|
3817
|
+
watchedGroupPk: number,
|
|
3818
|
+
requestBody: WatcherWrite,
|
|
3819
|
+
/**
|
|
3820
|
+
* Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
|
|
3821
|
+
*/
|
|
3822
|
+
platformKey?: string,
|
|
3823
|
+
}): CancelablePromise<WatcherRead> {
|
|
3824
|
+
return __request(OpenAPI, {
|
|
3825
|
+
method: 'POST',
|
|
3826
|
+
url: '/api/core/watched-groups/{watched_group_pk}/watchers/',
|
|
3827
|
+
path: {
|
|
3828
|
+
'watched_group_pk': watchedGroupPk,
|
|
3829
|
+
},
|
|
3830
|
+
query: {
|
|
3831
|
+
'platform_key': platformKey,
|
|
3832
|
+
},
|
|
3833
|
+
body: requestBody,
|
|
3834
|
+
mediaType: 'application/json',
|
|
3835
|
+
errors: {
|
|
3836
|
+
400: `Invalid payload`,
|
|
3837
|
+
403: `Permission denied`,
|
|
3838
|
+
404: `WatchedGroup not found`,
|
|
3839
|
+
},
|
|
3840
|
+
});
|
|
3841
|
+
}
|
|
3842
|
+
/**
|
|
3843
|
+
* Retrieve a single watcher
|
|
3844
|
+
* CRUD for watchers nested under a WatchedGroup.
|
|
3845
|
+
*
|
|
3846
|
+
* Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchers/{watcher_id}/
|
|
3847
|
+
* `is_owner` here covers two cases that both deserve owner-level perms on a
|
|
3848
|
+
* watcher row:
|
|
3849
|
+
* - the watcher themselves (WATCHER_OWNER well-known role)
|
|
3850
|
+
* - the parent WatchedGroup's owner (WATCHED_GROUP_OWNER role grants
|
|
3851
|
+
* `Ibl.Core/Watchers*`)
|
|
3852
|
+
* @returns WatcherRead
|
|
3853
|
+
* @throws ApiError
|
|
3854
|
+
*/
|
|
3855
|
+
public static coreWatchedGroupsWatchersRetrieve({
|
|
3856
|
+
id,
|
|
3857
|
+
watchedGroupPk,
|
|
3858
|
+
platformKey,
|
|
3859
|
+
}: {
|
|
3860
|
+
id: number,
|
|
3861
|
+
watchedGroupPk: number,
|
|
3862
|
+
/**
|
|
3863
|
+
* Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
|
|
3864
|
+
*/
|
|
3865
|
+
platformKey?: string,
|
|
3866
|
+
}): CancelablePromise<WatcherRead> {
|
|
3867
|
+
return __request(OpenAPI, {
|
|
3868
|
+
method: 'GET',
|
|
3869
|
+
url: '/api/core/watched-groups/{watched_group_pk}/watchers/{id}/',
|
|
3870
|
+
path: {
|
|
3871
|
+
'id': id,
|
|
3872
|
+
'watched_group_pk': watchedGroupPk,
|
|
3873
|
+
},
|
|
3874
|
+
query: {
|
|
3875
|
+
'platform_key': platformKey,
|
|
3876
|
+
},
|
|
3877
|
+
errors: {
|
|
3878
|
+
403: `Permission denied`,
|
|
3879
|
+
404: `Not found`,
|
|
3880
|
+
},
|
|
3881
|
+
});
|
|
3882
|
+
}
|
|
3883
|
+
/**
|
|
3884
|
+
* Replace a watcher's events
|
|
3885
|
+
* CRUD for watchers nested under a WatchedGroup.
|
|
3886
|
+
*
|
|
3887
|
+
* Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchers/{watcher_id}/
|
|
3888
|
+
* `is_owner` here covers two cases that both deserve owner-level perms on a
|
|
3889
|
+
* watcher row:
|
|
3890
|
+
* - the watcher themselves (WATCHER_OWNER well-known role)
|
|
3891
|
+
* - the parent WatchedGroup's owner (WATCHED_GROUP_OWNER role grants
|
|
3892
|
+
* `Ibl.Core/Watchers*`)
|
|
3893
|
+
* @returns WatcherRead
|
|
3894
|
+
* @throws ApiError
|
|
3895
|
+
*/
|
|
3896
|
+
public static coreWatchedGroupsWatchersUpdate({
|
|
3897
|
+
id,
|
|
3898
|
+
watchedGroupPk,
|
|
3899
|
+
requestBody,
|
|
3900
|
+
platformKey,
|
|
3901
|
+
}: {
|
|
3902
|
+
id: number,
|
|
3903
|
+
watchedGroupPk: number,
|
|
3904
|
+
requestBody: WatcherUpdate,
|
|
3905
|
+
/**
|
|
3906
|
+
* Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
|
|
3907
|
+
*/
|
|
3908
|
+
platformKey?: string,
|
|
3909
|
+
}): CancelablePromise<WatcherRead> {
|
|
3910
|
+
return __request(OpenAPI, {
|
|
3911
|
+
method: 'PUT',
|
|
3912
|
+
url: '/api/core/watched-groups/{watched_group_pk}/watchers/{id}/',
|
|
3913
|
+
path: {
|
|
3914
|
+
'id': id,
|
|
3915
|
+
'watched_group_pk': watchedGroupPk,
|
|
3916
|
+
},
|
|
3917
|
+
query: {
|
|
3918
|
+
'platform_key': platformKey,
|
|
3919
|
+
},
|
|
3920
|
+
body: requestBody,
|
|
3921
|
+
mediaType: 'application/json',
|
|
3922
|
+
errors: {
|
|
3923
|
+
400: `Invalid payload`,
|
|
3924
|
+
403: `Permission denied`,
|
|
3925
|
+
404: `Not found`,
|
|
3926
|
+
},
|
|
3927
|
+
});
|
|
3928
|
+
}
|
|
3929
|
+
/**
|
|
3930
|
+
* Update a watcher's events
|
|
3931
|
+
* CRUD for watchers nested under a WatchedGroup.
|
|
3932
|
+
*
|
|
3933
|
+
* Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchers/{watcher_id}/
|
|
3934
|
+
* `is_owner` here covers two cases that both deserve owner-level perms on a
|
|
3935
|
+
* watcher row:
|
|
3936
|
+
* - the watcher themselves (WATCHER_OWNER well-known role)
|
|
3937
|
+
* - the parent WatchedGroup's owner (WATCHED_GROUP_OWNER role grants
|
|
3938
|
+
* `Ibl.Core/Watchers*`)
|
|
3939
|
+
* @returns WatcherRead
|
|
3940
|
+
* @throws ApiError
|
|
3941
|
+
*/
|
|
3942
|
+
public static coreWatchedGroupsWatchersPartialUpdate({
|
|
3943
|
+
id,
|
|
3944
|
+
watchedGroupPk,
|
|
3945
|
+
platformKey,
|
|
3946
|
+
requestBody,
|
|
3947
|
+
}: {
|
|
3948
|
+
id: number,
|
|
3949
|
+
watchedGroupPk: number,
|
|
3950
|
+
/**
|
|
3951
|
+
* Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
|
|
3952
|
+
*/
|
|
3953
|
+
platformKey?: string,
|
|
3954
|
+
requestBody?: PatchedWatcherUpdate,
|
|
3955
|
+
}): CancelablePromise<WatcherRead> {
|
|
3956
|
+
return __request(OpenAPI, {
|
|
3957
|
+
method: 'PATCH',
|
|
3958
|
+
url: '/api/core/watched-groups/{watched_group_pk}/watchers/{id}/',
|
|
3959
|
+
path: {
|
|
3960
|
+
'id': id,
|
|
3961
|
+
'watched_group_pk': watchedGroupPk,
|
|
3962
|
+
},
|
|
3963
|
+
query: {
|
|
3964
|
+
'platform_key': platformKey,
|
|
3965
|
+
},
|
|
3966
|
+
body: requestBody,
|
|
3967
|
+
mediaType: 'application/json',
|
|
3968
|
+
errors: {
|
|
3969
|
+
400: `Invalid payload`,
|
|
3970
|
+
403: `Permission denied`,
|
|
3971
|
+
404: `Not found`,
|
|
3972
|
+
},
|
|
3973
|
+
});
|
|
3974
|
+
}
|
|
3975
|
+
/**
|
|
3976
|
+
* Remove (or unsubscribe) a watcher from a watched group
|
|
3977
|
+
* CRUD for watchers nested under a WatchedGroup.
|
|
3978
|
+
*
|
|
3979
|
+
* Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchers/{watcher_id}/
|
|
3980
|
+
* `is_owner` here covers two cases that both deserve owner-level perms on a
|
|
3981
|
+
* watcher row:
|
|
3982
|
+
* - the watcher themselves (WATCHER_OWNER well-known role)
|
|
3983
|
+
* - the parent WatchedGroup's owner (WATCHED_GROUP_OWNER role grants
|
|
3984
|
+
* `Ibl.Core/Watchers*`)
|
|
3985
|
+
* @returns void
|
|
3986
|
+
* @throws ApiError
|
|
3987
|
+
*/
|
|
3988
|
+
public static coreWatchedGroupsWatchersDestroy({
|
|
3989
|
+
id,
|
|
3990
|
+
watchedGroupPk,
|
|
3991
|
+
platformKey,
|
|
3992
|
+
}: {
|
|
3993
|
+
id: number,
|
|
3994
|
+
watchedGroupPk: number,
|
|
3995
|
+
/**
|
|
3996
|
+
* Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
|
|
3997
|
+
*/
|
|
3998
|
+
platformKey?: string,
|
|
3999
|
+
}): CancelablePromise<void> {
|
|
4000
|
+
return __request(OpenAPI, {
|
|
4001
|
+
method: 'DELETE',
|
|
4002
|
+
url: '/api/core/watched-groups/{watched_group_pk}/watchers/{id}/',
|
|
4003
|
+
path: {
|
|
4004
|
+
'id': id,
|
|
4005
|
+
'watched_group_pk': watchedGroupPk,
|
|
4006
|
+
},
|
|
4007
|
+
query: {
|
|
4008
|
+
'platform_key': platformKey,
|
|
4009
|
+
},
|
|
4010
|
+
errors: {
|
|
4011
|
+
403: `Permission denied`,
|
|
4012
|
+
404: `Not found`,
|
|
4013
|
+
},
|
|
4014
|
+
});
|
|
4015
|
+
}
|
|
3305
4016
|
/**
|
|
3306
4017
|
* Get a list of departments with metrics and filtering options.
|
|
3307
4018
|
*
|