@seamapi/types 1.272.0 → 1.273.0

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 (13) hide show
  1. package/dist/connect.cjs +180 -39
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +90 -0
  4. package/lib/seam/connect/models/acs/acs-access-group.js +23 -8
  5. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  6. package/lib/seam/connect/openapi.d.ts +45 -0
  7. package/lib/seam/connect/openapi.js +160 -31
  8. package/lib/seam/connect/openapi.js.map +1 -1
  9. package/lib/seam/connect/route-types.d.ts +45 -0
  10. package/package.json +1 -1
  11. package/src/lib/seam/connect/models/acs/acs-access-group.ts +31 -8
  12. package/src/lib/seam/connect/openapi.ts +190 -31
  13. package/src/lib/seam/connect/route-types.ts +45 -0
package/lib/seam/connect/route-types.d.ts CHANGED
@@ -3204,7 +3204,9 @@ export interface Routes {
3204
3204
  queryParams: {};
3205
3205
  jsonBody: {};
3206
3206
  commonParams: {
3207
+ /** ID of the desired access group. */
3207
3208
  acs_access_group_id: string;
3209
+ /** ID of the desired user. */
3208
3210
  acs_user_id: string;
3209
3211
  };
3210
3212
  formData: {};
@@ -3216,14 +3218,24 @@ export interface Routes {
3216
3218
  queryParams: {};
3217
3219
  jsonBody: {};
3218
3220
  commonParams: {
3221
+ /** ID of the desired access group. */
3219
3222
  acs_access_group_id: string;
3220
3223
  };
3221
3224
  formData: {};
3222
3225
  jsonResponse: {
3226
+ /**
3227
+ Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
3228
+
3229
+ The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
3230
+ */
3223
3231
  acs_access_group: {
3232
+ /** ID of the access group. */
3224
3233
  acs_access_group_id: string;
3234
+ /** ID of the access control system that contains the access group. */
3225
3235
  acs_system_id: string;
3236
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
3226
3237
  workspace_id: string;
3238
+ /** Name of the access group. */
3227
3239
  name: string;
3228
3240
  /**
3229
3241
  * @deprecated use external_type */
@@ -3232,8 +3244,11 @@ export interface Routes {
3232
3244
  * @deprecated use external_type_display_name */
3233
3245
  access_group_type_display_name: string;
3234
3246
  display_name: string;
3247
+ /** Brand-specific terminology for the access group type. */
3235
3248
  external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
3249
+ /** Display name that corresponds to the brand-specific terminology for the access group type. */
3236
3250
  external_type_display_name: string;
3251
+ /** Date and time at which the access group was created. */
3237
3252
  created_at: string;
3238
3253
  is_managed: true;
3239
3254
  };
@@ -3245,15 +3260,21 @@ export interface Routes {
3245
3260
  queryParams: {};
3246
3261
  jsonBody: {};
3247
3262
  commonParams: {
3263
+ /** ID of the access control system for which you want to retrieve all access groups. */
3248
3264
  acs_system_id?: string | undefined;
3265
+ /** ID of the user for which you want to retrieve all access groups. */
3249
3266
  acs_user_id?: string | undefined;
3250
3267
  };
3251
3268
  formData: {};
3252
3269
  jsonResponse: {
3253
3270
  acs_access_groups: Array<{
3271
+ /** ID of the access group. */
3254
3272
  acs_access_group_id: string;
3273
+ /** ID of the access control system that contains the access group. */
3255
3274
  acs_system_id: string;
3275
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
3256
3276
  workspace_id: string;
3277
+ /** Name of the access group. */
3257
3278
  name: string;
3258
3279
  /**
3259
3280
  * @deprecated use external_type */
@@ -3262,8 +3283,11 @@ export interface Routes {
3262
3283
  * @deprecated use external_type_display_name */
3263
3284
  access_group_type_display_name: string;
3264
3285
  display_name: string;
3286
+ /** Brand-specific terminology for the access group type. */
3265
3287
  external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
3288
+ /** Display name that corresponds to the brand-specific terminology for the access group type. */
3266
3289
  external_type_display_name: string;
3290
+ /** Date and time at which the access group was created. */
3267
3291
  created_at: string;
3268
3292
  is_managed: true;
3269
3293
  }>;
@@ -3275,6 +3299,7 @@ export interface Routes {
3275
3299
  queryParams: {};
3276
3300
  jsonBody: {};
3277
3301
  commonParams: {
3302
+ /** ID of the access group for which you want to retrieve all accessible entrances. */
3278
3303
  acs_access_group_id: string;
3279
3304
  };
3280
3305
  formData: {};
@@ -3325,6 +3350,7 @@ export interface Routes {
3325
3350
  queryParams: {};
3326
3351
  jsonBody: {};
3327
3352
  commonParams: {
3353
+ /** ID of the access group for which you want to retrieve all users. */
3328
3354
  acs_access_group_id: string;
3329
3355
  };
3330
3356
  formData: {};
@@ -3425,7 +3451,9 @@ export interface Routes {
3425
3451
  queryParams: {};
3426
3452
  jsonBody: {};
3427
3453
  commonParams: {
3454
+ /** ID of the desired access group. */
3428
3455
  acs_access_group_id: string;
3456
+ /** ID of the desired user. */
3429
3457
  acs_user_id: string;
3430
3458
  };
3431
3459
  formData: {};
@@ -3437,14 +3465,19 @@ export interface Routes {
3437
3465
  queryParams: {};
3438
3466
  jsonBody: {};
3439
3467
  commonParams: {
3468
+ /** ID of the desired unmanaged access group. */
3440
3469
  acs_access_group_id: string;
3441
3470
  };
3442
3471
  formData: {};
3443
3472
  jsonResponse: {
3444
3473
  acs_access_group: {
3474
+ /** ID of the access group. */
3445
3475
  acs_access_group_id: string;
3476
+ /** ID of the access control system that contains the access group. */
3446
3477
  acs_system_id: string;
3478
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
3447
3479
  workspace_id: string;
3480
+ /** Name of the access group. */
3448
3481
  name: string;
3449
3482
  /**
3450
3483
  * @deprecated use external_type */
@@ -3453,8 +3486,11 @@ export interface Routes {
3453
3486
  * @deprecated use external_type_display_name */
3454
3487
  access_group_type_display_name: string;
3455
3488
  display_name: string;
3489
+ /** Brand-specific terminology for the access group type. */
3456
3490
  external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
3491
+ /** Display name that corresponds to the brand-specific terminology for the access group type. */
3457
3492
  external_type_display_name: string;
3493
+ /** Date and time at which the access group was created. */
3458
3494
  created_at: string;
3459
3495
  is_managed: false;
3460
3496
  };
@@ -3466,15 +3502,21 @@ export interface Routes {
3466
3502
  queryParams: {};
3467
3503
  jsonBody: {};
3468
3504
  commonParams: {
3505
+ /** ID of the access control system for which you want to retrieve all unmanaged access groups. */
3469
3506
  acs_system_id?: string | undefined;
3507
+ /** ID of the user for which you want to retrieve all unmanaged access groups. */
3470
3508
  acs_user_id?: string | undefined;
3471
3509
  };
3472
3510
  formData: {};
3473
3511
  jsonResponse: {
3474
3512
  acs_access_groups: Array<{
3513
+ /** ID of the access group. */
3475
3514
  acs_access_group_id: string;
3515
+ /** ID of the access control system that contains the access group. */
3476
3516
  acs_system_id: string;
3517
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
3477
3518
  workspace_id: string;
3519
+ /** Name of the access group. */
3478
3520
  name: string;
3479
3521
  /**
3480
3522
  * @deprecated use external_type */
@@ -3483,8 +3525,11 @@ export interface Routes {
3483
3525
  * @deprecated use external_type_display_name */
3484
3526
  access_group_type_display_name: string;
3485
3527
  display_name: string;
3528
+ /** Brand-specific terminology for the access group type. */
3486
3529
  external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
3530
+ /** Display name that corresponds to the brand-specific terminology for the access group type. */
3487
3531
  external_type_display_name: string;
3532
+ /** Date and time at which the access group was created. */
3488
3533
  created_at: string;
3489
3534
  is_managed: false;
3490
3535
  }>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.272.0",
3
+ "version": "1.273.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
package/src/lib/seam/connect/models/acs/acs-access-group.ts CHANGED
@@ -13,10 +13,20 @@ export type AcsAccessGroupExternalType = z.infer<
13
13
  >
14
14
 
15
15
  const common_acs_access_group = z.object({
16
- acs_access_group_id: z.string().uuid(),
17
- acs_system_id: z.string().uuid(),
18
- workspace_id: z.string().uuid(),
19
- name: z.string(),
16
+ acs_access_group_id: z.string().uuid().describe('ID of the access group.'),
17
+ acs_system_id: z
18
+ .string()
19
+ .uuid()
20
+ .describe(
21
+ 'ID of the access control system that contains the access group.',
22
+ ),
23
+ workspace_id: z
24
+ .string()
25
+ .uuid()
26
+ .describe(
27
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.',
28
+ ),
29
+ name: z.string().describe('Name of the access group.'),
20
30
  access_group_type: acs_access_group_external_type.describe(`
21
31
  ---
22
32
  deprecated: use external_type
@@ -28,14 +38,27 @@ const common_acs_access_group = z.object({
28
38
  ---
29
39
  `),
30
40
  display_name: z.string(),
31
- external_type: acs_access_group_external_type,
32
- external_type_display_name: z.string(),
33
- created_at: z.string().datetime(),
41
+ external_type: acs_access_group_external_type.describe(
42
+ 'Brand-specific terminology for the access group type.',
43
+ ),
44
+ external_type_display_name: z
45
+ .string()
46
+ .describe(
47
+ 'Display name that corresponds to the brand-specific terminology for the access group type.',
48
+ ),
49
+ created_at: z
50
+ .string()
51
+ .datetime()
52
+ .describe('Date and time at which the access group was created.'),
34
53
  })
35
54
 
36
55
  export const acs_access_group = common_acs_access_group.extend({
37
56
  is_managed: z.literal(true),
38
- })
57
+ }).describe(`
58
+ Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
59
+
60
+ The \`acs_access_group\` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
61
+ `)
39
62
  export const unmanaged_acs_access_group = common_acs_access_group.extend({
40
63
  is_managed: z.literal(false),
41
64
  })
package/src/lib/seam/connect/openapi.ts CHANGED
@@ -186,6 +186,8 @@ export default {
186
186
  type: 'object',
187
187
  },
188
188
  acs_access_group: {
189
+ description:
190
+ '\n Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\n \n The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n ',
189
191
  properties: {
190
192
  access_group_type: {
191
193
  deprecated: true,
@@ -203,11 +205,26 @@ export default {
203
205
  type: 'string',
204
206
  'x-deprecated': 'use external_type_display_name',
205
207
  },
206
- acs_access_group_id: { format: 'uuid', type: 'string' },
207
- acs_system_id: { format: 'uuid', type: 'string' },
208
- created_at: { format: 'date-time', type: 'string' },
208
+ acs_access_group_id: {
209
+ description: 'ID of the access group.',
210
+ format: 'uuid',
211
+ type: 'string',
212
+ },
213
+ acs_system_id: {
214
+ description:
215
+ 'ID of the access control system that contains the access group.',
216
+ format: 'uuid',
217
+ type: 'string',
218
+ },
219
+ created_at: {
220
+ description: 'Date and time at which the access group was created.',
221
+ format: 'date-time',
222
+ type: 'string',
223
+ },
209
224
  display_name: { type: 'string' },
210
225
  external_type: {
226
+ description:
227
+ 'Brand-specific terminology for the access group type.',
211
228
  enum: [
212
229
  'pti_unit',
213
230
  'pti_access_level',
@@ -216,10 +233,19 @@ export default {
216
233
  ],
217
234
  type: 'string',
218
235
  },
219
- external_type_display_name: { type: 'string' },
236
+ external_type_display_name: {
237
+ description:
238
+ 'Display name that corresponds to the brand-specific terminology for the access group type.',
239
+ type: 'string',
240
+ },
220
241
  is_managed: { enum: [true], type: 'boolean' },
221
- name: { type: 'string' },
222
- workspace_id: { format: 'uuid', type: 'string' },
242
+ name: { description: 'Name of the access group.', type: 'string' },
243
+ workspace_id: {
244
+ description:
245
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.',
246
+ format: 'uuid',
247
+ type: 'string',
248
+ },
223
249
  },
224
250
  required: [
225
251
  'acs_access_group_id',
@@ -6577,14 +6603,24 @@ export default {
6577
6603
  },
6578
6604
  '/acs/access_groups/add_user': {
6579
6605
  post: {
6606
+ description:
6607
+ 'Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6580
6608
  operationId: 'acsAccessGroupsAddUserPost',
6581
6609
  requestBody: {
6582
6610
  content: {
6583
6611
  'application/json': {
6584
6612
  schema: {
6585
6613
  properties: {
6586
- acs_access_group_id: { format: 'uuid', type: 'string' },
6587
- acs_user_id: { format: 'uuid', type: 'string' },
6614
+ acs_access_group_id: {
6615
+ description: 'ID of the desired access group.',
6616
+ format: 'uuid',
6617
+ type: 'string',
6618
+ },
6619
+ acs_user_id: {
6620
+ description: 'ID of the desired user.',
6621
+ format: 'uuid',
6622
+ type: 'string',
6623
+ },
6588
6624
  },
6589
6625
  required: ['acs_access_group_id', 'acs_user_id'],
6590
6626
  type: 'object',
@@ -6620,14 +6656,24 @@ export default {
6620
6656
  'x-response-key': null,
6621
6657
  },
6622
6658
  put: {
6659
+ description:
6660
+ 'Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6623
6661
  operationId: 'acsAccessGroupsAddUserPut',
6624
6662
  requestBody: {
6625
6663
  content: {
6626
6664
  'application/json': {
6627
6665
  schema: {
6628
6666
  properties: {
6629
- acs_access_group_id: { format: 'uuid', type: 'string' },
6630
- acs_user_id: { format: 'uuid', type: 'string' },
6667
+ acs_access_group_id: {
6668
+ description: 'ID of the desired access group.',
6669
+ format: 'uuid',
6670
+ type: 'string',
6671
+ },
6672
+ acs_user_id: {
6673
+ description: 'ID of the desired user.',
6674
+ format: 'uuid',
6675
+ type: 'string',
6676
+ },
6631
6677
  },
6632
6678
  required: ['acs_access_group_id', 'acs_user_id'],
6633
6679
  type: 'object',
@@ -6664,13 +6710,19 @@ export default {
6664
6710
  },
6665
6711
  '/acs/access_groups/get': {
6666
6712
  post: {
6713
+ description:
6714
+ 'Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6667
6715
  operationId: 'acsAccessGroupsGetPost',
6668
6716
  requestBody: {
6669
6717
  content: {
6670
6718
  'application/json': {
6671
6719
  schema: {
6672
6720
  properties: {
6673
- acs_access_group_id: { format: 'uuid', type: 'string' },
6721
+ acs_access_group_id: {
6722
+ description: 'ID of the desired access group.',
6723
+ format: 'uuid',
6724
+ type: 'string',
6725
+ },
6674
6726
  },
6675
6727
  required: ['acs_access_group_id'],
6676
6728
  type: 'object',
@@ -6714,14 +6766,26 @@ export default {
6714
6766
  },
6715
6767
  '/acs/access_groups/list': {
6716
6768
  post: {
6769
+ description:
6770
+ 'Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6717
6771
  operationId: 'acsAccessGroupsListPost',
6718
6772
  requestBody: {
6719
6773
  content: {
6720
6774
  'application/json': {
6721
6775
  schema: {
6722
6776
  properties: {
6723
- acs_system_id: { format: 'uuid', type: 'string' },
6724
- acs_user_id: { format: 'uuid', type: 'string' },
6777
+ acs_system_id: {
6778
+ description:
6779
+ 'ID of the access control system for which you want to retrieve all access groups.',
6780
+ format: 'uuid',
6781
+ type: 'string',
6782
+ },
6783
+ acs_user_id: {
6784
+ description:
6785
+ 'ID of the user for which you want to retrieve all access groups.',
6786
+ format: 'uuid',
6787
+ type: 'string',
6788
+ },
6725
6789
  },
6726
6790
  type: 'object',
6727
6791
  },
@@ -6765,13 +6829,20 @@ export default {
6765
6829
  },
6766
6830
  '/acs/access_groups/list_accessible_entrances': {
6767
6831
  post: {
6832
+ description:
6833
+ 'Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6768
6834
  operationId: 'acsAccessGroupsListAccessibleEntrancesPost',
6769
6835
  requestBody: {
6770
6836
  content: {
6771
6837
  'application/json': {
6772
6838
  schema: {
6773
6839
  properties: {
6774
- acs_access_group_id: { format: 'uuid', type: 'string' },
6840
+ acs_access_group_id: {
6841
+ description:
6842
+ 'ID of the access group for which you want to retrieve all accessible entrances.',
6843
+ format: 'uuid',
6844
+ type: 'string',
6845
+ },
6775
6846
  },
6776
6847
  required: ['acs_access_group_id'],
6777
6848
  type: 'object',
@@ -6816,13 +6887,20 @@ export default {
6816
6887
  },
6817
6888
  '/acs/access_groups/list_users': {
6818
6889
  post: {
6890
+ description:
6891
+ 'Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6819
6892
  operationId: 'acsAccessGroupsListUsersPost',
6820
6893
  requestBody: {
6821
6894
  content: {
6822
6895
  'application/json': {
6823
6896
  schema: {
6824
6897
  properties: {
6825
- acs_access_group_id: { format: 'uuid', type: 'string' },
6898
+ acs_access_group_id: {
6899
+ description:
6900
+ 'ID of the access group for which you want to retrieve all users.',
6901
+ format: 'uuid',
6902
+ type: 'string',
6903
+ },
6826
6904
  },
6827
6905
  required: ['acs_access_group_id'],
6828
6906
  type: 'object',
@@ -6867,14 +6945,24 @@ export default {
6867
6945
  },
6868
6946
  '/acs/access_groups/remove_user': {
6869
6947
  post: {
6948
+ description:
6949
+ 'Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6870
6950
  operationId: 'acsAccessGroupsRemoveUserPost',
6871
6951
  requestBody: {
6872
6952
  content: {
6873
6953
  'application/json': {
6874
6954
  schema: {
6875
6955
  properties: {
6876
- acs_access_group_id: { format: 'uuid', type: 'string' },
6877
- acs_user_id: { format: 'uuid', type: 'string' },
6956
+ acs_access_group_id: {
6957
+ description: 'ID of the desired access group.',
6958
+ format: 'uuid',
6959
+ type: 'string',
6960
+ },
6961
+ acs_user_id: {
6962
+ description: 'ID of the desired user.',
6963
+ format: 'uuid',
6964
+ type: 'string',
6965
+ },
6878
6966
  },
6879
6967
  required: ['acs_access_group_id', 'acs_user_id'],
6880
6968
  type: 'object',
@@ -6912,13 +7000,19 @@ export default {
6912
7000
  },
6913
7001
  '/acs/access_groups/unmanaged/get': {
6914
7002
  post: {
7003
+ description:
7004
+ 'Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6915
7005
  operationId: 'acsAccessGroupsUnmanagedGetPost',
6916
7006
  requestBody: {
6917
7007
  content: {
6918
7008
  'application/json': {
6919
7009
  schema: {
6920
7010
  properties: {
6921
- acs_access_group_id: { format: 'uuid', type: 'string' },
7011
+ acs_access_group_id: {
7012
+ description: 'ID of the desired unmanaged access group.',
7013
+ format: 'uuid',
7014
+ type: 'string',
7015
+ },
6922
7016
  },
6923
7017
  required: ['acs_access_group_id'],
6924
7018
  type: 'object',
@@ -6950,11 +7044,27 @@ export default {
6950
7044
  type: 'string',
6951
7045
  'x-deprecated': 'use external_type_display_name',
6952
7046
  },
6953
- acs_access_group_id: { format: 'uuid', type: 'string' },
6954
- acs_system_id: { format: 'uuid', type: 'string' },
6955
- created_at: { format: 'date-time', type: 'string' },
7047
+ acs_access_group_id: {
7048
+ description: 'ID of the access group.',
7049
+ format: 'uuid',
7050
+ type: 'string',
7051
+ },
7052
+ acs_system_id: {
7053
+ description:
7054
+ 'ID of the access control system that contains the access group.',
7055
+ format: 'uuid',
7056
+ type: 'string',
7057
+ },
7058
+ created_at: {
7059
+ description:
7060
+ 'Date and time at which the access group was created.',
7061
+ format: 'date-time',
7062
+ type: 'string',
7063
+ },
6956
7064
  display_name: { type: 'string' },
6957
7065
  external_type: {
7066
+ description:
7067
+ 'Brand-specific terminology for the access group type.',
6958
7068
  enum: [
6959
7069
  'pti_unit',
6960
7070
  'pti_access_level',
@@ -6963,10 +7073,22 @@ export default {
6963
7073
  ],
6964
7074
  type: 'string',
6965
7075
  },
6966
- external_type_display_name: { type: 'string' },
7076
+ external_type_display_name: {
7077
+ description:
7078
+ 'Display name that corresponds to the brand-specific terminology for the access group type.',
7079
+ type: 'string',
7080
+ },
6967
7081
  is_managed: { enum: [false], type: 'boolean' },
6968
- name: { type: 'string' },
6969
- workspace_id: { format: 'uuid', type: 'string' },
7082
+ name: {
7083
+ description: 'Name of the access group.',
7084
+ type: 'string',
7085
+ },
7086
+ workspace_id: {
7087
+ description:
7088
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.',
7089
+ format: 'uuid',
7090
+ type: 'string',
7091
+ },
6970
7092
  },
6971
7093
  required: [
6972
7094
  'acs_access_group_id',
@@ -7010,14 +7132,26 @@ export default {
7010
7132
  },
7011
7133
  '/acs/access_groups/unmanaged/list': {
7012
7134
  post: {
7135
+ description:
7136
+ 'Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
7013
7137
  operationId: 'acsAccessGroupsUnmanagedListPost',
7014
7138
  requestBody: {
7015
7139
  content: {
7016
7140
  'application/json': {
7017
7141
  schema: {
7018
7142
  properties: {
7019
- acs_system_id: { format: 'uuid', type: 'string' },
7020
- acs_user_id: { format: 'uuid', type: 'string' },
7143
+ acs_system_id: {
7144
+ description:
7145
+ 'ID of the access control system for which you want to retrieve all unmanaged access groups.',
7146
+ format: 'uuid',
7147
+ type: 'string',
7148
+ },
7149
+ acs_user_id: {
7150
+ description:
7151
+ 'ID of the user for which you want to retrieve all unmanaged access groups.',
7152
+ format: 'uuid',
7153
+ type: 'string',
7154
+ },
7021
7155
  },
7022
7156
  type: 'object',
7023
7157
  },
@@ -7050,13 +7184,26 @@ export default {
7050
7184
  'x-deprecated': 'use external_type_display_name',
7051
7185
  },
7052
7186
  acs_access_group_id: {
7187
+ description: 'ID of the access group.',
7053
7188
  format: 'uuid',
7054
7189
  type: 'string',
7055
7190
  },
7056
- acs_system_id: { format: 'uuid', type: 'string' },
7057
- created_at: { format: 'date-time', type: 'string' },
7191
+ acs_system_id: {
7192
+ description:
7193
+ 'ID of the access control system that contains the access group.',
7194
+ format: 'uuid',
7195
+ type: 'string',
7196
+ },
7197
+ created_at: {
7198
+ description:
7199
+ 'Date and time at which the access group was created.',
7200
+ format: 'date-time',
7201
+ type: 'string',
7202
+ },
7058
7203
  display_name: { type: 'string' },
7059
7204
  external_type: {
7205
+ description:
7206
+ 'Brand-specific terminology for the access group type.',
7060
7207
  enum: [
7061
7208
  'pti_unit',
7062
7209
  'pti_access_level',
@@ -7065,10 +7212,22 @@ export default {
7065
7212
  ],
7066
7213
  type: 'string',
7067
7214
  },
7068
- external_type_display_name: { type: 'string' },
7215
+ external_type_display_name: {
7216
+ description:
7217
+ 'Display name that corresponds to the brand-specific terminology for the access group type.',
7218
+ type: 'string',
7219
+ },
7069
7220
  is_managed: { enum: [false], type: 'boolean' },
7070
- name: { type: 'string' },
7071
- workspace_id: { format: 'uuid', type: 'string' },
7221
+ name: {
7222
+ description: 'Name of the access group.',
7223
+ type: 'string',
7224
+ },
7225
+ workspace_id: {
7226
+ description:
7227
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.',
7228
+ format: 'uuid',
7229
+ type: 'string',
7230
+ },
7072
7231
  },
7073
7232
  required: [
7074
7233
  'acs_access_group_id',