@knowledge-stack/ksapi 1.61.10 → 1.62.1

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.
Files changed (91) hide show
  1. package/.openapi-generator/FILES +24 -0
  2. package/README.md +26 -2
  3. package/dist/apis/FoldersApi.d.ts +4 -4
  4. package/dist/apis/FoldersApi.js +2 -2
  5. package/dist/apis/TenantGroupsApi.d.ts +667 -0
  6. package/dist/apis/TenantGroupsApi.js +717 -0
  7. package/dist/apis/index.d.ts +1 -0
  8. package/dist/apis/index.js +1 -0
  9. package/dist/esm/apis/FoldersApi.d.ts +4 -4
  10. package/dist/esm/apis/FoldersApi.js +2 -2
  11. package/dist/esm/apis/TenantGroupsApi.d.ts +667 -0
  12. package/dist/esm/apis/TenantGroupsApi.js +713 -0
  13. package/dist/esm/apis/index.d.ts +1 -0
  14. package/dist/esm/apis/index.js +1 -0
  15. package/dist/esm/models/AddMemberRequest.d.ts +47 -0
  16. package/dist/esm/models/AddMemberRequest.js +44 -0
  17. package/dist/esm/models/CreateGroupPermissionRequest.d.ts +54 -0
  18. package/dist/esm/models/CreateGroupPermissionRequest.js +49 -0
  19. package/dist/esm/models/CreateGroupRequest.d.ts +53 -0
  20. package/dist/esm/models/CreateGroupRequest.js +54 -0
  21. package/dist/esm/models/GroupPermissionResponse.d.ts +90 -0
  22. package/dist/esm/models/GroupPermissionResponse.js +73 -0
  23. package/dist/esm/models/GroupResponse.d.ts +83 -0
  24. package/dist/esm/models/GroupResponse.js +66 -0
  25. package/dist/esm/models/MembershipResponse.d.ts +77 -0
  26. package/dist/esm/models/MembershipResponse.js +64 -0
  27. package/dist/esm/models/PaginatedResponseGroupPermissionResponse.d.ts +66 -0
  28. package/dist/esm/models/PaginatedResponseGroupPermissionResponse.js +70 -0
  29. package/dist/esm/models/PaginatedResponseGroupResponse.d.ts +66 -0
  30. package/dist/esm/models/PaginatedResponseGroupResponse.js +70 -0
  31. package/dist/esm/models/PaginatedResponseMembershipResponse.d.ts +66 -0
  32. package/dist/esm/models/PaginatedResponseMembershipResponse.js +70 -0
  33. package/dist/esm/models/UpdateGroupPermissionRequest.d.ts +54 -0
  34. package/dist/esm/models/UpdateGroupPermissionRequest.js +45 -0
  35. package/dist/esm/models/UpdateGroupRequest.d.ts +53 -0
  36. package/dist/esm/models/UpdateGroupRequest.js +49 -0
  37. package/dist/esm/models/index.d.ts +11 -0
  38. package/dist/esm/models/index.js +11 -0
  39. package/dist/models/AddMemberRequest.d.ts +47 -0
  40. package/dist/models/AddMemberRequest.js +52 -0
  41. package/dist/models/CreateGroupPermissionRequest.d.ts +54 -0
  42. package/dist/models/CreateGroupPermissionRequest.js +57 -0
  43. package/dist/models/CreateGroupRequest.d.ts +53 -0
  44. package/dist/models/CreateGroupRequest.js +62 -0
  45. package/dist/models/GroupPermissionResponse.d.ts +90 -0
  46. package/dist/models/GroupPermissionResponse.js +81 -0
  47. package/dist/models/GroupResponse.d.ts +83 -0
  48. package/dist/models/GroupResponse.js +74 -0
  49. package/dist/models/MembershipResponse.d.ts +77 -0
  50. package/dist/models/MembershipResponse.js +72 -0
  51. package/dist/models/PaginatedResponseGroupPermissionResponse.d.ts +66 -0
  52. package/dist/models/PaginatedResponseGroupPermissionResponse.js +78 -0
  53. package/dist/models/PaginatedResponseGroupResponse.d.ts +66 -0
  54. package/dist/models/PaginatedResponseGroupResponse.js +78 -0
  55. package/dist/models/PaginatedResponseMembershipResponse.d.ts +66 -0
  56. package/dist/models/PaginatedResponseMembershipResponse.js +78 -0
  57. package/dist/models/UpdateGroupPermissionRequest.d.ts +54 -0
  58. package/dist/models/UpdateGroupPermissionRequest.js +53 -0
  59. package/dist/models/UpdateGroupRequest.d.ts +53 -0
  60. package/dist/models/UpdateGroupRequest.js +57 -0
  61. package/dist/models/index.d.ts +11 -0
  62. package/dist/models/index.js +11 -0
  63. package/docs/AddMemberRequest.md +34 -0
  64. package/docs/CreateGroupPermissionRequest.md +36 -0
  65. package/docs/CreateGroupRequest.md +36 -0
  66. package/docs/FoldersApi.md +1 -1
  67. package/docs/GroupPermissionResponse.md +48 -0
  68. package/docs/GroupResponse.md +46 -0
  69. package/docs/MembershipResponse.md +44 -0
  70. package/docs/PaginatedResponseGroupPermissionResponse.md +40 -0
  71. package/docs/PaginatedResponseGroupResponse.md +40 -0
  72. package/docs/PaginatedResponseMembershipResponse.md +40 -0
  73. package/docs/TenantGroupsApi.md +1052 -0
  74. package/docs/UpdateGroupPermissionRequest.md +36 -0
  75. package/docs/UpdateGroupRequest.md +36 -0
  76. package/package.json +1 -1
  77. package/src/apis/FoldersApi.ts +4 -4
  78. package/src/apis/TenantGroupsApi.ts +1449 -0
  79. package/src/apis/index.ts +1 -0
  80. package/src/models/AddMemberRequest.ts +83 -0
  81. package/src/models/CreateGroupPermissionRequest.ts +102 -0
  82. package/src/models/CreateGroupRequest.ts +98 -0
  83. package/src/models/GroupPermissionResponse.ts +156 -0
  84. package/src/models/GroupResponse.ts +136 -0
  85. package/src/models/MembershipResponse.ts +128 -0
  86. package/src/models/PaginatedResponseGroupPermissionResponse.ts +130 -0
  87. package/src/models/PaginatedResponseGroupResponse.ts +130 -0
  88. package/src/models/PaginatedResponseMembershipResponse.ts +130 -0
  89. package/src/models/UpdateGroupPermissionRequest.ts +100 -0
  90. package/src/models/UpdateGroupRequest.ts +94 -0
  91. package/src/models/index.ts +11 -0
@@ -0,0 +1,1052 @@
1
+ # TenantGroupsApi
2
+
3
+ All URIs are relative to *http://localhost:8000*
4
+
5
+ | Method | HTTP request | Description |
6
+ |------------- | ------------- | -------------|
7
+ | [**addGroupMember**](TenantGroupsApi.md#addgroupmember) | **POST** /v1/tenant-groups/{group_id}/members | Add Group Member Handler |
8
+ | [**createGroupPermission**](TenantGroupsApi.md#creategrouppermissionoperation) | **POST** /v1/tenant-groups/{group_id}/permissions | Create Group Permission Handler |
9
+ | [**createTenantGroup**](TenantGroupsApi.md#createtenantgroup) | **POST** /v1/tenant-groups | Create Tenant Group Handler |
10
+ | [**deleteGroupPermission**](TenantGroupsApi.md#deletegrouppermission) | **DELETE** /v1/tenant-groups/{group_id}/permissions/{permission_id} | Delete Group Permission Handler |
11
+ | [**deleteTenantGroup**](TenantGroupsApi.md#deletetenantgroup) | **DELETE** /v1/tenant-groups/{group_id} | Delete Tenant Group Handler |
12
+ | [**getTenantGroup**](TenantGroupsApi.md#gettenantgroup) | **GET** /v1/tenant-groups/{group_id} | Get Tenant Group Handler |
13
+ | [**listGroupMembers**](TenantGroupsApi.md#listgroupmembers) | **GET** /v1/tenant-groups/{group_id}/members | List Group Members Handler |
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-groups | List My Groups Handler |
16
+ | [**listTenantGroups**](TenantGroupsApi.md#listtenantgroups) | **GET** /v1/tenant-groups | List Tenant Groups Handler |
17
+ | [**removeGroupMember**](TenantGroupsApi.md#removegroupmember) | **DELETE** /v1/tenant-groups/{group_id}/members/{user_id} | Remove Group Member Handler |
18
+ | [**updateGroupPermission**](TenantGroupsApi.md#updategrouppermissionoperation) | **PATCH** /v1/tenant-groups/{group_id}/permissions/{permission_id} | Update Group Permission Handler |
19
+ | [**updateTenantGroup**](TenantGroupsApi.md#updatetenantgroup) | **PATCH** /v1/tenant-groups/{group_id} | Update Tenant Group Handler |
20
+
21
+
22
+
23
+ ## addGroupMember
24
+
25
+ > MembershipResponse addGroupMember(groupId, tenantId, addMemberRequest, authorization, ksUat)
26
+
27
+ Add Group Member Handler
28
+
29
+ Add a user to a group (admin/owner only).
30
+
31
+ ### Example
32
+
33
+ ```ts
34
+ import {
35
+ Configuration,
36
+ TenantGroupsApi,
37
+ } from '@knowledge-stack/ksapi';
38
+ import type { AddGroupMemberRequest } from '@knowledge-stack/ksapi';
39
+
40
+ async function example() {
41
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
42
+ const api = new TenantGroupsApi();
43
+
44
+ const body = {
45
+ // string
46
+ groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
47
+ // string | Tenant ID
48
+ tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
49
+ // AddMemberRequest
50
+ addMemberRequest: ...,
51
+ // string (optional)
52
+ authorization: authorization_example,
53
+ // string (optional)
54
+ ksUat: ksUat_example,
55
+ } satisfies AddGroupMemberRequest;
56
+
57
+ try {
58
+ const data = await api.addGroupMember(body);
59
+ console.log(data);
60
+ } catch (error) {
61
+ console.error(error);
62
+ }
63
+ }
64
+
65
+ // Run the test
66
+ example().catch(console.error);
67
+ ```
68
+
69
+ ### Parameters
70
+
71
+
72
+ | Name | Type | Description | Notes |
73
+ |------------- | ------------- | ------------- | -------------|
74
+ | **groupId** | `string` | | [Defaults to `undefined`] |
75
+ | **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
76
+ | **addMemberRequest** | [AddMemberRequest](AddMemberRequest.md) | | |
77
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
78
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
79
+
80
+ ### Return type
81
+
82
+ [**MembershipResponse**](MembershipResponse.md)
83
+
84
+ ### Authorization
85
+
86
+ No authorization required
87
+
88
+ ### HTTP request headers
89
+
90
+ - **Content-Type**: `application/json`
91
+ - **Accept**: `application/json`
92
+
93
+
94
+ ### HTTP response details
95
+ | Status code | Description | Response headers |
96
+ |-------------|-------------|------------------|
97
+ | **201** | Successful Response | - |
98
+ | **422** | Validation Error | - |
99
+
100
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
101
+
102
+
103
+ ## createGroupPermission
104
+
105
+ > GroupPermissionResponse createGroupPermission(groupId, tenantId, createGroupPermissionRequest, authorization, ksUat)
106
+
107
+ Create Group Permission Handler
108
+
109
+ Create a path permission for a group (admin/owner only).
110
+
111
+ ### Example
112
+
113
+ ```ts
114
+ import {
115
+ Configuration,
116
+ TenantGroupsApi,
117
+ } from '@knowledge-stack/ksapi';
118
+ import type { CreateGroupPermissionOperationRequest } from '@knowledge-stack/ksapi';
119
+
120
+ async function example() {
121
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
122
+ const api = new TenantGroupsApi();
123
+
124
+ const body = {
125
+ // string
126
+ groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
127
+ // string | Tenant ID
128
+ tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
129
+ // CreateGroupPermissionRequest
130
+ createGroupPermissionRequest: ...,
131
+ // string (optional)
132
+ authorization: authorization_example,
133
+ // string (optional)
134
+ ksUat: ksUat_example,
135
+ } satisfies CreateGroupPermissionOperationRequest;
136
+
137
+ try {
138
+ const data = await api.createGroupPermission(body);
139
+ console.log(data);
140
+ } catch (error) {
141
+ console.error(error);
142
+ }
143
+ }
144
+
145
+ // Run the test
146
+ example().catch(console.error);
147
+ ```
148
+
149
+ ### Parameters
150
+
151
+
152
+ | Name | Type | Description | Notes |
153
+ |------------- | ------------- | ------------- | -------------|
154
+ | **groupId** | `string` | | [Defaults to `undefined`] |
155
+ | **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
156
+ | **createGroupPermissionRequest** | [CreateGroupPermissionRequest](CreateGroupPermissionRequest.md) | | |
157
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
158
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
159
+
160
+ ### Return type
161
+
162
+ [**GroupPermissionResponse**](GroupPermissionResponse.md)
163
+
164
+ ### Authorization
165
+
166
+ No authorization required
167
+
168
+ ### HTTP request headers
169
+
170
+ - **Content-Type**: `application/json`
171
+ - **Accept**: `application/json`
172
+
173
+
174
+ ### HTTP response details
175
+ | Status code | Description | Response headers |
176
+ |-------------|-------------|------------------|
177
+ | **201** | Successful Response | - |
178
+ | **422** | Validation Error | - |
179
+
180
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
181
+
182
+
183
+ ## createTenantGroup
184
+
185
+ > GroupResponse createTenantGroup(tenantId, createGroupRequest, authorization, ksUat)
186
+
187
+ Create Tenant Group Handler
188
+
189
+ Create a new tenant group (admin/owner only).
190
+
191
+ ### Example
192
+
193
+ ```ts
194
+ import {
195
+ Configuration,
196
+ TenantGroupsApi,
197
+ } from '@knowledge-stack/ksapi';
198
+ import type { CreateTenantGroupRequest } from '@knowledge-stack/ksapi';
199
+
200
+ async function example() {
201
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
202
+ const api = new TenantGroupsApi();
203
+
204
+ const body = {
205
+ // string | Tenant ID
206
+ tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
207
+ // CreateGroupRequest
208
+ createGroupRequest: ...,
209
+ // string (optional)
210
+ authorization: authorization_example,
211
+ // string (optional)
212
+ ksUat: ksUat_example,
213
+ } satisfies CreateTenantGroupRequest;
214
+
215
+ try {
216
+ const data = await api.createTenantGroup(body);
217
+ console.log(data);
218
+ } catch (error) {
219
+ console.error(error);
220
+ }
221
+ }
222
+
223
+ // Run the test
224
+ example().catch(console.error);
225
+ ```
226
+
227
+ ### Parameters
228
+
229
+
230
+ | Name | Type | Description | Notes |
231
+ |------------- | ------------- | ------------- | -------------|
232
+ | **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
233
+ | **createGroupRequest** | [CreateGroupRequest](CreateGroupRequest.md) | | |
234
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
235
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
236
+
237
+ ### Return type
238
+
239
+ [**GroupResponse**](GroupResponse.md)
240
+
241
+ ### Authorization
242
+
243
+ No authorization required
244
+
245
+ ### HTTP request headers
246
+
247
+ - **Content-Type**: `application/json`
248
+ - **Accept**: `application/json`
249
+
250
+
251
+ ### HTTP response details
252
+ | Status code | Description | Response headers |
253
+ |-------------|-------------|------------------|
254
+ | **201** | Successful Response | - |
255
+ | **422** | Validation Error | - |
256
+
257
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
258
+
259
+
260
+ ## deleteGroupPermission
261
+
262
+ > deleteGroupPermission(groupId, permissionId, tenantId, authorization, ksUat)
263
+
264
+ Delete Group Permission Handler
265
+
266
+ Delete a path permission from a group (admin/owner only).
267
+
268
+ ### Example
269
+
270
+ ```ts
271
+ import {
272
+ Configuration,
273
+ TenantGroupsApi,
274
+ } from '@knowledge-stack/ksapi';
275
+ import type { DeleteGroupPermissionRequest } from '@knowledge-stack/ksapi';
276
+
277
+ async function example() {
278
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
279
+ const api = new TenantGroupsApi();
280
+
281
+ const body = {
282
+ // string
283
+ groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
284
+ // string
285
+ permissionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
286
+ // string | Tenant ID
287
+ tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
288
+ // string (optional)
289
+ authorization: authorization_example,
290
+ // string (optional)
291
+ ksUat: ksUat_example,
292
+ } satisfies DeleteGroupPermissionRequest;
293
+
294
+ try {
295
+ const data = await api.deleteGroupPermission(body);
296
+ console.log(data);
297
+ } catch (error) {
298
+ console.error(error);
299
+ }
300
+ }
301
+
302
+ // Run the test
303
+ example().catch(console.error);
304
+ ```
305
+
306
+ ### Parameters
307
+
308
+
309
+ | Name | Type | Description | Notes |
310
+ |------------- | ------------- | ------------- | -------------|
311
+ | **groupId** | `string` | | [Defaults to `undefined`] |
312
+ | **permissionId** | `string` | | [Defaults to `undefined`] |
313
+ | **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
314
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
315
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
316
+
317
+ ### Return type
318
+
319
+ `void` (Empty response body)
320
+
321
+ ### Authorization
322
+
323
+ No authorization required
324
+
325
+ ### HTTP request headers
326
+
327
+ - **Content-Type**: Not defined
328
+ - **Accept**: `application/json`
329
+
330
+
331
+ ### HTTP response details
332
+ | Status code | Description | Response headers |
333
+ |-------------|-------------|------------------|
334
+ | **204** | Successful Response | - |
335
+ | **422** | Validation Error | - |
336
+
337
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
338
+
339
+
340
+ ## deleteTenantGroup
341
+
342
+ > deleteTenantGroup(groupId, tenantId, authorization, ksUat)
343
+
344
+ Delete Tenant Group Handler
345
+
346
+ Delete a tenant group (admin/owner only).
347
+
348
+ ### Example
349
+
350
+ ```ts
351
+ import {
352
+ Configuration,
353
+ TenantGroupsApi,
354
+ } from '@knowledge-stack/ksapi';
355
+ import type { DeleteTenantGroupRequest } from '@knowledge-stack/ksapi';
356
+
357
+ async function example() {
358
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
359
+ const api = new TenantGroupsApi();
360
+
361
+ const body = {
362
+ // string
363
+ groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
364
+ // string | Tenant ID
365
+ tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
366
+ // string (optional)
367
+ authorization: authorization_example,
368
+ // string (optional)
369
+ ksUat: ksUat_example,
370
+ } satisfies DeleteTenantGroupRequest;
371
+
372
+ try {
373
+ const data = await api.deleteTenantGroup(body);
374
+ console.log(data);
375
+ } catch (error) {
376
+ console.error(error);
377
+ }
378
+ }
379
+
380
+ // Run the test
381
+ example().catch(console.error);
382
+ ```
383
+
384
+ ### Parameters
385
+
386
+
387
+ | Name | Type | Description | Notes |
388
+ |------------- | ------------- | ------------- | -------------|
389
+ | **groupId** | `string` | | [Defaults to `undefined`] |
390
+ | **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
391
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
392
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
393
+
394
+ ### Return type
395
+
396
+ `void` (Empty response body)
397
+
398
+ ### Authorization
399
+
400
+ No authorization required
401
+
402
+ ### HTTP request headers
403
+
404
+ - **Content-Type**: Not defined
405
+ - **Accept**: `application/json`
406
+
407
+
408
+ ### HTTP response details
409
+ | Status code | Description | Response headers |
410
+ |-------------|-------------|------------------|
411
+ | **204** | Successful Response | - |
412
+ | **422** | Validation Error | - |
413
+
414
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
415
+
416
+
417
+ ## getTenantGroup
418
+
419
+ > GroupResponse getTenantGroup(groupId, tenantId, authorization, ksUat)
420
+
421
+ Get Tenant Group Handler
422
+
423
+ Get a tenant group by ID (group member or admin/owner).
424
+
425
+ ### Example
426
+
427
+ ```ts
428
+ import {
429
+ Configuration,
430
+ TenantGroupsApi,
431
+ } from '@knowledge-stack/ksapi';
432
+ import type { GetTenantGroupRequest } from '@knowledge-stack/ksapi';
433
+
434
+ async function example() {
435
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
436
+ const api = new TenantGroupsApi();
437
+
438
+ const body = {
439
+ // string
440
+ groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
441
+ // string | Tenant ID
442
+ tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
443
+ // string (optional)
444
+ authorization: authorization_example,
445
+ // string (optional)
446
+ ksUat: ksUat_example,
447
+ } satisfies GetTenantGroupRequest;
448
+
449
+ try {
450
+ const data = await api.getTenantGroup(body);
451
+ console.log(data);
452
+ } catch (error) {
453
+ console.error(error);
454
+ }
455
+ }
456
+
457
+ // Run the test
458
+ example().catch(console.error);
459
+ ```
460
+
461
+ ### Parameters
462
+
463
+
464
+ | Name | Type | Description | Notes |
465
+ |------------- | ------------- | ------------- | -------------|
466
+ | **groupId** | `string` | | [Defaults to `undefined`] |
467
+ | **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
468
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
469
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
470
+
471
+ ### Return type
472
+
473
+ [**GroupResponse**](GroupResponse.md)
474
+
475
+ ### Authorization
476
+
477
+ No authorization required
478
+
479
+ ### HTTP request headers
480
+
481
+ - **Content-Type**: Not defined
482
+ - **Accept**: `application/json`
483
+
484
+
485
+ ### HTTP response details
486
+ | Status code | Description | Response headers |
487
+ |-------------|-------------|------------------|
488
+ | **200** | Successful Response | - |
489
+ | **422** | Validation Error | - |
490
+
491
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
492
+
493
+
494
+ ## listGroupMembers
495
+
496
+ > PaginatedResponseMembershipResponse listGroupMembers(groupId, tenantId, limit, offset, authorization, ksUat)
497
+
498
+ List Group Members Handler
499
+
500
+ List members of a group (group members or admin/owner).
501
+
502
+ ### Example
503
+
504
+ ```ts
505
+ import {
506
+ Configuration,
507
+ TenantGroupsApi,
508
+ } from '@knowledge-stack/ksapi';
509
+ import type { ListGroupMembersRequest } from '@knowledge-stack/ksapi';
510
+
511
+ async function example() {
512
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
513
+ const api = new TenantGroupsApi();
514
+
515
+ const body = {
516
+ // string
517
+ groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
518
+ // string | Tenant ID
519
+ tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
520
+ // number | Number of items per page (optional)
521
+ limit: 56,
522
+ // number | Number of items to skip (optional)
523
+ offset: 56,
524
+ // string (optional)
525
+ authorization: authorization_example,
526
+ // string (optional)
527
+ ksUat: ksUat_example,
528
+ } satisfies ListGroupMembersRequest;
529
+
530
+ try {
531
+ const data = await api.listGroupMembers(body);
532
+ console.log(data);
533
+ } catch (error) {
534
+ console.error(error);
535
+ }
536
+ }
537
+
538
+ // Run the test
539
+ example().catch(console.error);
540
+ ```
541
+
542
+ ### Parameters
543
+
544
+
545
+ | Name | Type | Description | Notes |
546
+ |------------- | ------------- | ------------- | -------------|
547
+ | **groupId** | `string` | | [Defaults to `undefined`] |
548
+ | **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
549
+ | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
550
+ | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
551
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
552
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
553
+
554
+ ### Return type
555
+
556
+ [**PaginatedResponseMembershipResponse**](PaginatedResponseMembershipResponse.md)
557
+
558
+ ### Authorization
559
+
560
+ No authorization required
561
+
562
+ ### HTTP request headers
563
+
564
+ - **Content-Type**: Not defined
565
+ - **Accept**: `application/json`
566
+
567
+
568
+ ### HTTP response details
569
+ | Status code | Description | Response headers |
570
+ |-------------|-------------|------------------|
571
+ | **200** | Successful Response | - |
572
+ | **422** | Validation Error | - |
573
+
574
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
575
+
576
+
577
+ ## listGroupPermissions
578
+
579
+ > PaginatedResponseGroupPermissionResponse listGroupPermissions(groupId, tenantId, limit, offset, authorization, ksUat)
580
+
581
+ List Group Permissions Handler
582
+
583
+ List path permissions for a group (group member or admin/owner).
584
+
585
+ ### Example
586
+
587
+ ```ts
588
+ import {
589
+ Configuration,
590
+ TenantGroupsApi,
591
+ } from '@knowledge-stack/ksapi';
592
+ import type { ListGroupPermissionsRequest } from '@knowledge-stack/ksapi';
593
+
594
+ async function example() {
595
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
596
+ const api = new TenantGroupsApi();
597
+
598
+ const body = {
599
+ // string
600
+ groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
601
+ // string | Tenant ID
602
+ tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
603
+ // number | Number of items per page (optional)
604
+ limit: 56,
605
+ // number | Number of items to skip (optional)
606
+ offset: 56,
607
+ // string (optional)
608
+ authorization: authorization_example,
609
+ // string (optional)
610
+ ksUat: ksUat_example,
611
+ } satisfies ListGroupPermissionsRequest;
612
+
613
+ try {
614
+ const data = await api.listGroupPermissions(body);
615
+ console.log(data);
616
+ } catch (error) {
617
+ console.error(error);
618
+ }
619
+ }
620
+
621
+ // Run the test
622
+ example().catch(console.error);
623
+ ```
624
+
625
+ ### Parameters
626
+
627
+
628
+ | Name | Type | Description | Notes |
629
+ |------------- | ------------- | ------------- | -------------|
630
+ | **groupId** | `string` | | [Defaults to `undefined`] |
631
+ | **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
632
+ | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
633
+ | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
634
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
635
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
636
+
637
+ ### Return type
638
+
639
+ [**PaginatedResponseGroupPermissionResponse**](PaginatedResponseGroupPermissionResponse.md)
640
+
641
+ ### Authorization
642
+
643
+ No authorization required
644
+
645
+ ### HTTP request headers
646
+
647
+ - **Content-Type**: Not defined
648
+ - **Accept**: `application/json`
649
+
650
+
651
+ ### HTTP response details
652
+ | Status code | Description | Response headers |
653
+ |-------------|-------------|------------------|
654
+ | **200** | Successful Response | - |
655
+ | **422** | Validation Error | - |
656
+
657
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
658
+
659
+
660
+ ## listMyGroups
661
+
662
+ > Array<GroupResponse> listMyGroups(authorization, ksUat)
663
+
664
+ List My Groups Handler
665
+
666
+ List groups the current user belongs to.
667
+
668
+ ### Example
669
+
670
+ ```ts
671
+ import {
672
+ Configuration,
673
+ TenantGroupsApi,
674
+ } from '@knowledge-stack/ksapi';
675
+ import type { ListMyGroupsRequest } from '@knowledge-stack/ksapi';
676
+
677
+ async function example() {
678
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
679
+ const api = new TenantGroupsApi();
680
+
681
+ const body = {
682
+ // string (optional)
683
+ authorization: authorization_example,
684
+ // string (optional)
685
+ ksUat: ksUat_example,
686
+ } satisfies ListMyGroupsRequest;
687
+
688
+ try {
689
+ const data = await api.listMyGroups(body);
690
+ console.log(data);
691
+ } catch (error) {
692
+ console.error(error);
693
+ }
694
+ }
695
+
696
+ // Run the test
697
+ example().catch(console.error);
698
+ ```
699
+
700
+ ### Parameters
701
+
702
+
703
+ | Name | Type | Description | Notes |
704
+ |------------- | ------------- | ------------- | -------------|
705
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
706
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
707
+
708
+ ### Return type
709
+
710
+ [**Array<GroupResponse>**](GroupResponse.md)
711
+
712
+ ### Authorization
713
+
714
+ No authorization required
715
+
716
+ ### HTTP request headers
717
+
718
+ - **Content-Type**: Not defined
719
+ - **Accept**: `application/json`
720
+
721
+
722
+ ### HTTP response details
723
+ | Status code | Description | Response headers |
724
+ |-------------|-------------|------------------|
725
+ | **200** | Successful Response | - |
726
+ | **422** | Validation Error | - |
727
+
728
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
729
+
730
+
731
+ ## listTenantGroups
732
+
733
+ > PaginatedResponseGroupResponse listTenantGroups(tenantId, limit, offset, authorization, ksUat)
734
+
735
+ List Tenant Groups Handler
736
+
737
+ List tenant groups. Admin/owner see all groups; other members see only groups they belong to.
738
+
739
+ ### Example
740
+
741
+ ```ts
742
+ import {
743
+ Configuration,
744
+ TenantGroupsApi,
745
+ } from '@knowledge-stack/ksapi';
746
+ import type { ListTenantGroupsRequest } from '@knowledge-stack/ksapi';
747
+
748
+ async function example() {
749
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
750
+ const api = new TenantGroupsApi();
751
+
752
+ const body = {
753
+ // string | Tenant ID
754
+ tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
755
+ // number | Number of items per page (optional)
756
+ limit: 56,
757
+ // number | Number of items to skip (optional)
758
+ offset: 56,
759
+ // string (optional)
760
+ authorization: authorization_example,
761
+ // string (optional)
762
+ ksUat: ksUat_example,
763
+ } satisfies ListTenantGroupsRequest;
764
+
765
+ try {
766
+ const data = await api.listTenantGroups(body);
767
+ console.log(data);
768
+ } catch (error) {
769
+ console.error(error);
770
+ }
771
+ }
772
+
773
+ // Run the test
774
+ example().catch(console.error);
775
+ ```
776
+
777
+ ### Parameters
778
+
779
+
780
+ | Name | Type | Description | Notes |
781
+ |------------- | ------------- | ------------- | -------------|
782
+ | **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
783
+ | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
784
+ | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
785
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
786
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
787
+
788
+ ### Return type
789
+
790
+ [**PaginatedResponseGroupResponse**](PaginatedResponseGroupResponse.md)
791
+
792
+ ### Authorization
793
+
794
+ No authorization required
795
+
796
+ ### HTTP request headers
797
+
798
+ - **Content-Type**: Not defined
799
+ - **Accept**: `application/json`
800
+
801
+
802
+ ### HTTP response details
803
+ | Status code | Description | Response headers |
804
+ |-------------|-------------|------------------|
805
+ | **200** | Successful Response | - |
806
+ | **422** | Validation Error | - |
807
+
808
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
809
+
810
+
811
+ ## removeGroupMember
812
+
813
+ > removeGroupMember(groupId, userId, tenantId, authorization, ksUat)
814
+
815
+ Remove Group Member Handler
816
+
817
+ Remove a user from a group (admin/owner only).
818
+
819
+ ### Example
820
+
821
+ ```ts
822
+ import {
823
+ Configuration,
824
+ TenantGroupsApi,
825
+ } from '@knowledge-stack/ksapi';
826
+ import type { RemoveGroupMemberRequest } from '@knowledge-stack/ksapi';
827
+
828
+ async function example() {
829
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
830
+ const api = new TenantGroupsApi();
831
+
832
+ const body = {
833
+ // string
834
+ groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
835
+ // string
836
+ userId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
837
+ // string | Tenant ID
838
+ tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
839
+ // string (optional)
840
+ authorization: authorization_example,
841
+ // string (optional)
842
+ ksUat: ksUat_example,
843
+ } satisfies RemoveGroupMemberRequest;
844
+
845
+ try {
846
+ const data = await api.removeGroupMember(body);
847
+ console.log(data);
848
+ } catch (error) {
849
+ console.error(error);
850
+ }
851
+ }
852
+
853
+ // Run the test
854
+ example().catch(console.error);
855
+ ```
856
+
857
+ ### Parameters
858
+
859
+
860
+ | Name | Type | Description | Notes |
861
+ |------------- | ------------- | ------------- | -------------|
862
+ | **groupId** | `string` | | [Defaults to `undefined`] |
863
+ | **userId** | `string` | | [Defaults to `undefined`] |
864
+ | **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
865
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
866
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
867
+
868
+ ### Return type
869
+
870
+ `void` (Empty response body)
871
+
872
+ ### Authorization
873
+
874
+ No authorization required
875
+
876
+ ### HTTP request headers
877
+
878
+ - **Content-Type**: Not defined
879
+ - **Accept**: `application/json`
880
+
881
+
882
+ ### HTTP response details
883
+ | Status code | Description | Response headers |
884
+ |-------------|-------------|------------------|
885
+ | **204** | Successful Response | - |
886
+ | **422** | Validation Error | - |
887
+
888
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
889
+
890
+
891
+ ## updateGroupPermission
892
+
893
+ > GroupPermissionResponse updateGroupPermission(groupId, permissionId, tenantId, updateGroupPermissionRequest, authorization, ksUat)
894
+
895
+ Update Group Permission Handler
896
+
897
+ Update a path permission for a group (admin/owner only).
898
+
899
+ ### Example
900
+
901
+ ```ts
902
+ import {
903
+ Configuration,
904
+ TenantGroupsApi,
905
+ } from '@knowledge-stack/ksapi';
906
+ import type { UpdateGroupPermissionOperationRequest } from '@knowledge-stack/ksapi';
907
+
908
+ async function example() {
909
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
910
+ const api = new TenantGroupsApi();
911
+
912
+ const body = {
913
+ // string
914
+ groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
915
+ // string
916
+ permissionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
917
+ // string | Tenant ID
918
+ tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
919
+ // UpdateGroupPermissionRequest
920
+ updateGroupPermissionRequest: ...,
921
+ // string (optional)
922
+ authorization: authorization_example,
923
+ // string (optional)
924
+ ksUat: ksUat_example,
925
+ } satisfies UpdateGroupPermissionOperationRequest;
926
+
927
+ try {
928
+ const data = await api.updateGroupPermission(body);
929
+ console.log(data);
930
+ } catch (error) {
931
+ console.error(error);
932
+ }
933
+ }
934
+
935
+ // Run the test
936
+ example().catch(console.error);
937
+ ```
938
+
939
+ ### Parameters
940
+
941
+
942
+ | Name | Type | Description | Notes |
943
+ |------------- | ------------- | ------------- | -------------|
944
+ | **groupId** | `string` | | [Defaults to `undefined`] |
945
+ | **permissionId** | `string` | | [Defaults to `undefined`] |
946
+ | **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
947
+ | **updateGroupPermissionRequest** | [UpdateGroupPermissionRequest](UpdateGroupPermissionRequest.md) | | |
948
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
949
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
950
+
951
+ ### Return type
952
+
953
+ [**GroupPermissionResponse**](GroupPermissionResponse.md)
954
+
955
+ ### Authorization
956
+
957
+ No authorization required
958
+
959
+ ### HTTP request headers
960
+
961
+ - **Content-Type**: `application/json`
962
+ - **Accept**: `application/json`
963
+
964
+
965
+ ### HTTP response details
966
+ | Status code | Description | Response headers |
967
+ |-------------|-------------|------------------|
968
+ | **200** | Successful Response | - |
969
+ | **422** | Validation Error | - |
970
+
971
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
972
+
973
+
974
+ ## updateTenantGroup
975
+
976
+ > GroupResponse updateTenantGroup(groupId, tenantId, updateGroupRequest, authorization, ksUat)
977
+
978
+ Update Tenant Group Handler
979
+
980
+ Update a tenant group (admin/owner only).
981
+
982
+ ### Example
983
+
984
+ ```ts
985
+ import {
986
+ Configuration,
987
+ TenantGroupsApi,
988
+ } from '@knowledge-stack/ksapi';
989
+ import type { UpdateTenantGroupRequest } from '@knowledge-stack/ksapi';
990
+
991
+ async function example() {
992
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
993
+ const api = new TenantGroupsApi();
994
+
995
+ const body = {
996
+ // string
997
+ groupId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
998
+ // string | Tenant ID
999
+ tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1000
+ // UpdateGroupRequest
1001
+ updateGroupRequest: ...,
1002
+ // string (optional)
1003
+ authorization: authorization_example,
1004
+ // string (optional)
1005
+ ksUat: ksUat_example,
1006
+ } satisfies UpdateTenantGroupRequest;
1007
+
1008
+ try {
1009
+ const data = await api.updateTenantGroup(body);
1010
+ console.log(data);
1011
+ } catch (error) {
1012
+ console.error(error);
1013
+ }
1014
+ }
1015
+
1016
+ // Run the test
1017
+ example().catch(console.error);
1018
+ ```
1019
+
1020
+ ### Parameters
1021
+
1022
+
1023
+ | Name | Type | Description | Notes |
1024
+ |------------- | ------------- | ------------- | -------------|
1025
+ | **groupId** | `string` | | [Defaults to `undefined`] |
1026
+ | **tenantId** | `string` | Tenant ID | [Defaults to `undefined`] |
1027
+ | **updateGroupRequest** | [UpdateGroupRequest](UpdateGroupRequest.md) | | |
1028
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
1029
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
1030
+
1031
+ ### Return type
1032
+
1033
+ [**GroupResponse**](GroupResponse.md)
1034
+
1035
+ ### Authorization
1036
+
1037
+ No authorization required
1038
+
1039
+ ### HTTP request headers
1040
+
1041
+ - **Content-Type**: `application/json`
1042
+ - **Accept**: `application/json`
1043
+
1044
+
1045
+ ### HTTP response details
1046
+ | Status code | Description | Response headers |
1047
+ |-------------|-------------|------------------|
1048
+ | **200** | Successful Response | - |
1049
+ | **422** | Validation Error | - |
1050
+
1051
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1052
+