@knowledge-stack/ksapi 1.62.1 → 1.62.2
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/README.md +3 -3
- package/dist/apis/TenantGroupsApi.d.ts +1 -37
- package/dist/apis/TenantGroupsApi.js +3 -75
- package/dist/esm/apis/TenantGroupsApi.d.ts +1 -37
- package/dist/esm/apis/TenantGroupsApi.js +3 -75
- package/docs/TenantGroupsApi.md +13 -49
- package/package.json +1 -1
- package/src/apis/TenantGroupsApi.ts +2 -170
package/docs/TenantGroupsApi.md
CHANGED
|
@@ -12,7 +12,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
12
12
|
| [**getTenantGroup**](TenantGroupsApi.md#gettenantgroup) | **GET** /v1/tenant-groups/{group_id} | Get Tenant Group Handler |
|
|
13
13
|
| [**listGroupMembers**](TenantGroupsApi.md#listgroupmembers) | **GET** /v1/tenant-groups/{group_id}/members | List Group Members Handler |
|
|
14
14
|
| [**listGroupPermissions**](TenantGroupsApi.md#listgrouppermissions) | **GET** /v1/tenant-groups/{group_id}/permissions | List Group Permissions Handler |
|
|
15
|
-
| [**listMyGroups**](TenantGroupsApi.md#listmygroups) | **GET** /v1/tenant-groups/my-
|
|
15
|
+
| [**listMyGroups**](TenantGroupsApi.md#listmygroups) | **GET** /v1/tenant-groups/my-group | List My Groups Handler |
|
|
16
16
|
| [**listTenantGroups**](TenantGroupsApi.md#listtenantgroups) | **GET** /v1/tenant-groups | List Tenant Groups Handler |
|
|
17
17
|
| [**removeGroupMember**](TenantGroupsApi.md#removegroupmember) | **DELETE** /v1/tenant-groups/{group_id}/members/{user_id} | Remove Group Member Handler |
|
|
18
18
|
| [**updateGroupPermission**](TenantGroupsApi.md#updategrouppermissionoperation) | **PATCH** /v1/tenant-groups/{group_id}/permissions/{permission_id} | Update Group Permission Handler |
|
|
@@ -22,7 +22,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
22
22
|
|
|
23
23
|
## addGroupMember
|
|
24
24
|
|
|
25
|
-
> MembershipResponse addGroupMember(groupId,
|
|
25
|
+
> MembershipResponse addGroupMember(groupId, addMemberRequest, authorization, ksUat)
|
|
26
26
|
|
|
27
27
|
Add Group Member Handler
|
|
28
28
|
|
|
@@ -44,8 +44,6 @@ async function example() {
|
|
|
44
44
|
const body = {
|
|
45
45
|
// string
|
|
46
46
|
groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
47
|
-
// string | Tenant ID
|
|
48
|
-
tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
49
47
|
// AddMemberRequest
|
|
50
48
|
addMemberRequest: ...,
|
|
51
49
|
// string (optional)
|
|
@@ -72,7 +70,6 @@ example().catch(console.error);
|
|
|
72
70
|
| Name | Type | Description | Notes |
|
|
73
71
|
|------------- | ------------- | ------------- | -------------|
|
|
74
72
|
| **groupId** | `string` | | [Defaults to `undefined`] |
|
|
75
|
-
| **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
|
|
76
73
|
| **addMemberRequest** | [AddMemberRequest](AddMemberRequest.md) | | |
|
|
77
74
|
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
78
75
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
@@ -102,7 +99,7 @@ No authorization required
|
|
|
102
99
|
|
|
103
100
|
## createGroupPermission
|
|
104
101
|
|
|
105
|
-
> GroupPermissionResponse createGroupPermission(groupId,
|
|
102
|
+
> GroupPermissionResponse createGroupPermission(groupId, createGroupPermissionRequest, authorization, ksUat)
|
|
106
103
|
|
|
107
104
|
Create Group Permission Handler
|
|
108
105
|
|
|
@@ -124,8 +121,6 @@ async function example() {
|
|
|
124
121
|
const body = {
|
|
125
122
|
// string
|
|
126
123
|
groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
127
|
-
// string | Tenant ID
|
|
128
|
-
tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
129
124
|
// CreateGroupPermissionRequest
|
|
130
125
|
createGroupPermissionRequest: ...,
|
|
131
126
|
// string (optional)
|
|
@@ -152,7 +147,6 @@ example().catch(console.error);
|
|
|
152
147
|
| Name | Type | Description | Notes |
|
|
153
148
|
|------------- | ------------- | ------------- | -------------|
|
|
154
149
|
| **groupId** | `string` | | [Defaults to `undefined`] |
|
|
155
|
-
| **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
|
|
156
150
|
| **createGroupPermissionRequest** | [CreateGroupPermissionRequest](CreateGroupPermissionRequest.md) | | |
|
|
157
151
|
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
158
152
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
@@ -182,7 +176,7 @@ No authorization required
|
|
|
182
176
|
|
|
183
177
|
## createTenantGroup
|
|
184
178
|
|
|
185
|
-
> GroupResponse createTenantGroup(
|
|
179
|
+
> GroupResponse createTenantGroup(createGroupRequest, authorization, ksUat)
|
|
186
180
|
|
|
187
181
|
Create Tenant Group Handler
|
|
188
182
|
|
|
@@ -202,8 +196,6 @@ async function example() {
|
|
|
202
196
|
const api = new TenantGroupsApi();
|
|
203
197
|
|
|
204
198
|
const body = {
|
|
205
|
-
// string | Tenant ID
|
|
206
|
-
tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
207
199
|
// CreateGroupRequest
|
|
208
200
|
createGroupRequest: ...,
|
|
209
201
|
// string (optional)
|
|
@@ -229,7 +221,6 @@ example().catch(console.error);
|
|
|
229
221
|
|
|
230
222
|
| Name | Type | Description | Notes |
|
|
231
223
|
|------------- | ------------- | ------------- | -------------|
|
|
232
|
-
| **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
|
|
233
224
|
| **createGroupRequest** | [CreateGroupRequest](CreateGroupRequest.md) | | |
|
|
234
225
|
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
235
226
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
@@ -259,7 +250,7 @@ No authorization required
|
|
|
259
250
|
|
|
260
251
|
## deleteGroupPermission
|
|
261
252
|
|
|
262
|
-
> deleteGroupPermission(groupId, permissionId,
|
|
253
|
+
> deleteGroupPermission(groupId, permissionId, authorization, ksUat)
|
|
263
254
|
|
|
264
255
|
Delete Group Permission Handler
|
|
265
256
|
|
|
@@ -283,8 +274,6 @@ async function example() {
|
|
|
283
274
|
groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
284
275
|
// string
|
|
285
276
|
permissionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
286
|
-
// string | Tenant ID
|
|
287
|
-
tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
288
277
|
// string (optional)
|
|
289
278
|
authorization: authorization_example,
|
|
290
279
|
// string (optional)
|
|
@@ -310,7 +299,6 @@ example().catch(console.error);
|
|
|
310
299
|
|------------- | ------------- | ------------- | -------------|
|
|
311
300
|
| **groupId** | `string` | | [Defaults to `undefined`] |
|
|
312
301
|
| **permissionId** | `string` | | [Defaults to `undefined`] |
|
|
313
|
-
| **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
|
|
314
302
|
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
315
303
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
316
304
|
|
|
@@ -339,7 +327,7 @@ No authorization required
|
|
|
339
327
|
|
|
340
328
|
## deleteTenantGroup
|
|
341
329
|
|
|
342
|
-
> deleteTenantGroup(groupId,
|
|
330
|
+
> deleteTenantGroup(groupId, authorization, ksUat)
|
|
343
331
|
|
|
344
332
|
Delete Tenant Group Handler
|
|
345
333
|
|
|
@@ -361,8 +349,6 @@ async function example() {
|
|
|
361
349
|
const body = {
|
|
362
350
|
// string
|
|
363
351
|
groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
364
|
-
// string | Tenant ID
|
|
365
|
-
tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
366
352
|
// string (optional)
|
|
367
353
|
authorization: authorization_example,
|
|
368
354
|
// string (optional)
|
|
@@ -387,7 +373,6 @@ example().catch(console.error);
|
|
|
387
373
|
| Name | Type | Description | Notes |
|
|
388
374
|
|------------- | ------------- | ------------- | -------------|
|
|
389
375
|
| **groupId** | `string` | | [Defaults to `undefined`] |
|
|
390
|
-
| **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
|
|
391
376
|
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
392
377
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
393
378
|
|
|
@@ -416,7 +401,7 @@ No authorization required
|
|
|
416
401
|
|
|
417
402
|
## getTenantGroup
|
|
418
403
|
|
|
419
|
-
> GroupResponse getTenantGroup(groupId,
|
|
404
|
+
> GroupResponse getTenantGroup(groupId, authorization, ksUat)
|
|
420
405
|
|
|
421
406
|
Get Tenant Group Handler
|
|
422
407
|
|
|
@@ -438,8 +423,6 @@ async function example() {
|
|
|
438
423
|
const body = {
|
|
439
424
|
// string
|
|
440
425
|
groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
441
|
-
// string | Tenant ID
|
|
442
|
-
tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
443
426
|
// string (optional)
|
|
444
427
|
authorization: authorization_example,
|
|
445
428
|
// string (optional)
|
|
@@ -464,7 +447,6 @@ example().catch(console.error);
|
|
|
464
447
|
| Name | Type | Description | Notes |
|
|
465
448
|
|------------- | ------------- | ------------- | -------------|
|
|
466
449
|
| **groupId** | `string` | | [Defaults to `undefined`] |
|
|
467
|
-
| **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
|
|
468
450
|
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
469
451
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
470
452
|
|
|
@@ -493,7 +475,7 @@ No authorization required
|
|
|
493
475
|
|
|
494
476
|
## listGroupMembers
|
|
495
477
|
|
|
496
|
-
> PaginatedResponseMembershipResponse listGroupMembers(groupId,
|
|
478
|
+
> PaginatedResponseMembershipResponse listGroupMembers(groupId, limit, offset, authorization, ksUat)
|
|
497
479
|
|
|
498
480
|
List Group Members Handler
|
|
499
481
|
|
|
@@ -515,8 +497,6 @@ async function example() {
|
|
|
515
497
|
const body = {
|
|
516
498
|
// string
|
|
517
499
|
groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
518
|
-
// string | Tenant ID
|
|
519
|
-
tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
520
500
|
// number | Number of items per page (optional)
|
|
521
501
|
limit: 56,
|
|
522
502
|
// number | Number of items to skip (optional)
|
|
@@ -545,7 +525,6 @@ example().catch(console.error);
|
|
|
545
525
|
| Name | Type | Description | Notes |
|
|
546
526
|
|------------- | ------------- | ------------- | -------------|
|
|
547
527
|
| **groupId** | `string` | | [Defaults to `undefined`] |
|
|
548
|
-
| **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
|
|
549
528
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
550
529
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
551
530
|
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
@@ -576,7 +555,7 @@ No authorization required
|
|
|
576
555
|
|
|
577
556
|
## listGroupPermissions
|
|
578
557
|
|
|
579
|
-
> PaginatedResponseGroupPermissionResponse listGroupPermissions(groupId,
|
|
558
|
+
> PaginatedResponseGroupPermissionResponse listGroupPermissions(groupId, limit, offset, authorization, ksUat)
|
|
580
559
|
|
|
581
560
|
List Group Permissions Handler
|
|
582
561
|
|
|
@@ -598,8 +577,6 @@ async function example() {
|
|
|
598
577
|
const body = {
|
|
599
578
|
// string
|
|
600
579
|
groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
601
|
-
// string | Tenant ID
|
|
602
|
-
tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
603
580
|
// number | Number of items per page (optional)
|
|
604
581
|
limit: 56,
|
|
605
582
|
// number | Number of items to skip (optional)
|
|
@@ -628,7 +605,6 @@ example().catch(console.error);
|
|
|
628
605
|
| Name | Type | Description | Notes |
|
|
629
606
|
|------------- | ------------- | ------------- | -------------|
|
|
630
607
|
| **groupId** | `string` | | [Defaults to `undefined`] |
|
|
631
|
-
| **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
|
|
632
608
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
633
609
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
634
610
|
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
@@ -730,7 +706,7 @@ No authorization required
|
|
|
730
706
|
|
|
731
707
|
## listTenantGroups
|
|
732
708
|
|
|
733
|
-
> PaginatedResponseGroupResponse listTenantGroups(
|
|
709
|
+
> PaginatedResponseGroupResponse listTenantGroups(limit, offset, authorization, ksUat)
|
|
734
710
|
|
|
735
711
|
List Tenant Groups Handler
|
|
736
712
|
|
|
@@ -750,8 +726,6 @@ async function example() {
|
|
|
750
726
|
const api = new TenantGroupsApi();
|
|
751
727
|
|
|
752
728
|
const body = {
|
|
753
|
-
// string | Tenant ID
|
|
754
|
-
tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
755
729
|
// number | Number of items per page (optional)
|
|
756
730
|
limit: 56,
|
|
757
731
|
// number | Number of items to skip (optional)
|
|
@@ -779,7 +753,6 @@ example().catch(console.error);
|
|
|
779
753
|
|
|
780
754
|
| Name | Type | Description | Notes |
|
|
781
755
|
|------------- | ------------- | ------------- | -------------|
|
|
782
|
-
| **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
|
|
783
756
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
784
757
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
785
758
|
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
@@ -810,7 +783,7 @@ No authorization required
|
|
|
810
783
|
|
|
811
784
|
## removeGroupMember
|
|
812
785
|
|
|
813
|
-
> removeGroupMember(groupId, userId,
|
|
786
|
+
> removeGroupMember(groupId, userId, authorization, ksUat)
|
|
814
787
|
|
|
815
788
|
Remove Group Member Handler
|
|
816
789
|
|
|
@@ -834,8 +807,6 @@ async function example() {
|
|
|
834
807
|
groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
835
808
|
// string
|
|
836
809
|
userId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
837
|
-
// string | Tenant ID
|
|
838
|
-
tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
839
810
|
// string (optional)
|
|
840
811
|
authorization: authorization_example,
|
|
841
812
|
// string (optional)
|
|
@@ -861,7 +832,6 @@ example().catch(console.error);
|
|
|
861
832
|
|------------- | ------------- | ------------- | -------------|
|
|
862
833
|
| **groupId** | `string` | | [Defaults to `undefined`] |
|
|
863
834
|
| **userId** | `string` | | [Defaults to `undefined`] |
|
|
864
|
-
| **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
|
|
865
835
|
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
866
836
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
867
837
|
|
|
@@ -890,7 +860,7 @@ No authorization required
|
|
|
890
860
|
|
|
891
861
|
## updateGroupPermission
|
|
892
862
|
|
|
893
|
-
> GroupPermissionResponse updateGroupPermission(groupId, permissionId,
|
|
863
|
+
> GroupPermissionResponse updateGroupPermission(groupId, permissionId, updateGroupPermissionRequest, authorization, ksUat)
|
|
894
864
|
|
|
895
865
|
Update Group Permission Handler
|
|
896
866
|
|
|
@@ -914,8 +884,6 @@ async function example() {
|
|
|
914
884
|
groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
915
885
|
// string
|
|
916
886
|
permissionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
917
|
-
// string | Tenant ID
|
|
918
|
-
tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
919
887
|
// UpdateGroupPermissionRequest
|
|
920
888
|
updateGroupPermissionRequest: ...,
|
|
921
889
|
// string (optional)
|
|
@@ -943,7 +911,6 @@ example().catch(console.error);
|
|
|
943
911
|
|------------- | ------------- | ------------- | -------------|
|
|
944
912
|
| **groupId** | `string` | | [Defaults to `undefined`] |
|
|
945
913
|
| **permissionId** | `string` | | [Defaults to `undefined`] |
|
|
946
|
-
| **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
|
|
947
914
|
| **updateGroupPermissionRequest** | [UpdateGroupPermissionRequest](UpdateGroupPermissionRequest.md) | | |
|
|
948
915
|
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
949
916
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
@@ -973,7 +940,7 @@ No authorization required
|
|
|
973
940
|
|
|
974
941
|
## updateTenantGroup
|
|
975
942
|
|
|
976
|
-
> GroupResponse updateTenantGroup(groupId,
|
|
943
|
+
> GroupResponse updateTenantGroup(groupId, updateGroupRequest, authorization, ksUat)
|
|
977
944
|
|
|
978
945
|
Update Tenant Group Handler
|
|
979
946
|
|
|
@@ -995,8 +962,6 @@ async function example() {
|
|
|
995
962
|
const body = {
|
|
996
963
|
// string
|
|
997
964
|
groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
998
|
-
// string | Tenant ID
|
|
999
|
-
tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1000
965
|
// UpdateGroupRequest
|
|
1001
966
|
updateGroupRequest: ...,
|
|
1002
967
|
// string (optional)
|
|
@@ -1023,7 +988,6 @@ example().catch(console.error);
|
|
|
1023
988
|
| Name | Type | Description | Notes |
|
|
1024
989
|
|------------- | ------------- | ------------- | -------------|
|
|
1025
990
|
| **groupId** | `string` | | [Defaults to `undefined`] |
|
|
1026
|
-
| **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
|
|
1027
991
|
| **updateGroupRequest** | [UpdateGroupRequest](UpdateGroupRequest.md) | | |
|
|
1028
992
|
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1029
993
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|