@seamapi/types 1.245.1 → 1.246.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 (10) hide show
  1. package/dist/connect.cjs +147 -31
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +71 -0
  4. package/lib/seam/connect/openapi.d.ts +52 -0
  5. package/lib/seam/connect/openapi.js +134 -18
  6. package/lib/seam/connect/openapi.js.map +1 -1
  7. package/lib/seam/connect/route-types.d.ts +19 -0
  8. package/package.json +2 -2
  9. package/src/lib/seam/connect/openapi.ts +157 -18
  10. package/src/lib/seam/connect/route-types.ts +19 -0
package/lib/seam/connect/openapi.js CHANGED
@@ -7397,14 +7397,23 @@ export default {
7397
7397
  },
7398
7398
  '/acs/users/add_to_access_group': {
7399
7399
  post: {
7400
+ description: '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).',
7400
7401
  operationId: 'acsUsersAddToAccessGroupPost',
7401
7402
  requestBody: {
7402
7403
  content: {
7403
7404
  'application/json': {
7404
7405
  schema: {
7405
7406
  properties: {
7406
- acs_access_group_id: { format: 'uuid', type: 'string' },
7407
- acs_user_id: { format: 'uuid', type: 'string' },
7407
+ acs_access_group_id: {
7408
+ description: 'ID of the desired access group.',
7409
+ format: 'uuid',
7410
+ type: 'string',
7411
+ },
7412
+ acs_user_id: {
7413
+ description: 'ID of the desired `acs_user`.',
7414
+ format: 'uuid',
7415
+ type: 'string',
7416
+ },
7408
7417
  },
7409
7418
  required: ['acs_user_id', 'acs_access_group_id'],
7410
7419
  type: 'object',
@@ -7437,16 +7446,26 @@ export default {
7437
7446
  tags: ['/acs'],
7438
7447
  'x-fern-sdk-group-name': ['acs', 'users'],
7439
7448
  'x-fern-sdk-method-name': 'add_to_access_group',
7449
+ 'x-title': 'Add an ACS User to an Access Group',
7440
7450
  },
7441
7451
  put: {
7452
+ description: '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).',
7442
7453
  operationId: 'acsUsersAddToAccessGroupPut',
7443
7454
  requestBody: {
7444
7455
  content: {
7445
7456
  'application/json': {
7446
7457
  schema: {
7447
7458
  properties: {
7448
- acs_access_group_id: { format: 'uuid', type: 'string' },
7449
- acs_user_id: { format: 'uuid', type: 'string' },
7459
+ acs_access_group_id: {
7460
+ description: 'ID of the desired access group.',
7461
+ format: 'uuid',
7462
+ type: 'string',
7463
+ },
7464
+ acs_user_id: {
7465
+ description: 'ID of the desired `acs_user`.',
7466
+ format: 'uuid',
7467
+ type: 'string',
7468
+ },
7450
7469
  },
7451
7470
  required: ['acs_user_id', 'acs_access_group_id'],
7452
7471
  type: 'object',
@@ -7478,10 +7497,12 @@ export default {
7478
7497
  summary: '/acs/users/add_to_access_group',
7479
7498
  tags: ['/acs'],
7480
7499
  'x-fern-ignore': true,
7500
+ 'x-title': 'Add an ACS User to an Access Group',
7481
7501
  },
7482
7502
  },
7483
7503
  '/acs/users/create': {
7484
7504
  post: {
7505
+ description: 'Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
7485
7506
  operationId: 'acsUsersCreatePost',
7486
7507
  requestBody: {
7487
7508
  content: {
@@ -7489,6 +7510,7 @@ export default {
7489
7510
  schema: {
7490
7511
  properties: {
7491
7512
  access_schedule: {
7513
+ description: "`starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems.",
7492
7514
  properties: {
7493
7515
  ends_at: { format: 'date-time', type: 'string' },
7494
7516
  starts_at: { format: 'date-time', type: 'string' },
@@ -7498,10 +7520,15 @@ export default {
7498
7520
  },
7499
7521
  acs_access_group_ids: {
7500
7522
  default: [],
7523
+ description: 'Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`.',
7501
7524
  items: { format: 'uuid', type: 'string' },
7502
7525
  type: 'array',
7503
7526
  },
7504
- acs_system_id: { format: 'uuid', type: 'string' },
7527
+ acs_system_id: {
7528
+ description: 'ID of the `acs_system` to which to add the new `acs_user`.',
7529
+ format: 'uuid',
7530
+ type: 'string',
7531
+ },
7505
7532
  email: {
7506
7533
  deprecated: true,
7507
7534
  format: 'email',
@@ -7511,7 +7538,11 @@ export default {
7511
7538
  email_address: { format: 'email', type: 'string' },
7512
7539
  full_name: { type: 'string' },
7513
7540
  phone_number: { type: 'string' },
7514
- user_identity_id: { format: 'uuid', type: 'string' },
7541
+ user_identity_id: {
7542
+ description: 'ID of the user identity with which to associate the new `acs_user`.',
7543
+ format: 'uuid',
7544
+ type: 'string',
7545
+ },
7515
7546
  },
7516
7547
  required: ['acs_system_id'],
7517
7548
  type: 'object',
@@ -7548,16 +7579,25 @@ export default {
7548
7579
  'x-fern-sdk-group-name': ['acs', 'users'],
7549
7580
  'x-fern-sdk-method-name': 'create',
7550
7581
  'x-fern-sdk-return-value': 'acs_user',
7582
+ 'x-response-key': 'acs_user',
7583
+ 'x-title': 'Create an ACS User',
7551
7584
  },
7552
7585
  },
7553
7586
  '/acs/users/delete': {
7554
7587
  post: {
7588
+ description: "Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
7555
7589
  operationId: 'acsUsersDeletePost',
7556
7590
  requestBody: {
7557
7591
  content: {
7558
7592
  'application/json': {
7559
7593
  schema: {
7560
- properties: { acs_user_id: { format: 'uuid', type: 'string' } },
7594
+ properties: {
7595
+ acs_user_id: {
7596
+ description: 'ID of the desired `acs_user`.',
7597
+ format: 'uuid',
7598
+ type: 'string',
7599
+ },
7600
+ },
7561
7601
  required: ['acs_user_id'],
7562
7602
  type: 'object',
7563
7603
  },
@@ -7589,16 +7629,24 @@ export default {
7589
7629
  tags: ['/acs'],
7590
7630
  'x-fern-sdk-group-name': ['acs', 'users'],
7591
7631
  'x-fern-sdk-method-name': 'delete',
7632
+ 'x-title': 'Delete an ACS User',
7592
7633
  },
7593
7634
  },
7594
7635
  '/acs/users/get': {
7595
7636
  post: {
7637
+ description: 'Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
7596
7638
  operationId: 'acsUsersGetPost',
7597
7639
  requestBody: {
7598
7640
  content: {
7599
7641
  'application/json': {
7600
7642
  schema: {
7601
- properties: { acs_user_id: { format: 'uuid', type: 'string' } },
7643
+ properties: {
7644
+ acs_user_id: {
7645
+ description: 'ID of the desired `acs_user`.',
7646
+ format: 'uuid',
7647
+ type: 'string',
7648
+ },
7649
+ },
7602
7650
  required: ['acs_user_id'],
7603
7651
  type: 'object',
7604
7652
  },
@@ -7634,22 +7682,39 @@ export default {
7634
7682
  'x-fern-sdk-group-name': ['acs', 'users'],
7635
7683
  'x-fern-sdk-method-name': 'get',
7636
7684
  'x-fern-sdk-return-value': 'acs_user',
7685
+ 'x-response-key': 'acs_user',
7686
+ 'x-title': 'Get an ACS User',
7637
7687
  },
7638
7688
  },
7639
7689
  '/acs/users/list': {
7640
7690
  post: {
7691
+ description: 'Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
7641
7692
  operationId: 'acsUsersListPost',
7642
7693
  requestBody: {
7643
7694
  content: {
7644
7695
  'application/json': {
7645
7696
  schema: {
7646
7697
  properties: {
7647
- acs_system_id: { format: 'uuid', type: 'string' },
7698
+ acs_system_id: {
7699
+ description: 'ID of the `acs_system` for which you want to retrieve all `acs_user`s.',
7700
+ format: 'uuid',
7701
+ type: 'string',
7702
+ },
7648
7703
  created_before: { format: 'date-time', type: 'string' },
7649
7704
  limit: { default: 500, format: 'float', type: 'number' },
7650
- user_identity_email_address: { type: 'string' },
7651
- user_identity_id: { format: 'uuid', type: 'string' },
7652
- user_identity_phone_number: { type: 'string' },
7705
+ user_identity_email_address: {
7706
+ description: 'Email address of the user identity for which you want to retrieve all `acs_user`s.',
7707
+ type: 'string',
7708
+ },
7709
+ user_identity_id: {
7710
+ description: 'ID of the user identity for which you want to retrieve all `acs_user`s.',
7711
+ format: 'uuid',
7712
+ type: 'string',
7713
+ },
7714
+ user_identity_phone_number: {
7715
+ description: 'Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).',
7716
+ type: 'string',
7717
+ },
7653
7718
  },
7654
7719
  type: 'object',
7655
7720
  },
@@ -7689,16 +7754,25 @@ export default {
7689
7754
  'x-fern-sdk-group-name': ['acs', 'users'],
7690
7755
  'x-fern-sdk-method-name': 'list',
7691
7756
  'x-fern-sdk-return-value': 'acs_users',
7757
+ 'x-response-key': 'acs_users',
7758
+ 'x-title': 'List ACS Users',
7692
7759
  },
7693
7760
  },
7694
7761
  '/acs/users/list_accessible_entrances': {
7695
7762
  post: {
7763
+ description: 'Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access.',
7696
7764
  operationId: 'acsUsersListAccessibleEntrancesPost',
7697
7765
  requestBody: {
7698
7766
  content: {
7699
7767
  'application/json': {
7700
7768
  schema: {
7701
- properties: { acs_user_id: { format: 'uuid', type: 'string' } },
7769
+ properties: {
7770
+ acs_user_id: {
7771
+ description: 'ID of the desired `acs_user`.',
7772
+ format: 'uuid',
7773
+ type: 'string',
7774
+ },
7775
+ },
7702
7776
  required: ['acs_user_id'],
7703
7777
  type: 'object',
7704
7778
  },
@@ -7738,18 +7812,29 @@ export default {
7738
7812
  'x-fern-sdk-group-name': ['acs', 'users'],
7739
7813
  'x-fern-sdk-method-name': 'list_accessible_entrances',
7740
7814
  'x-fern-sdk-return-value': 'acs_entrances',
7815
+ 'x-response-key': 'acs_entrances',
7816
+ 'x-title': 'List ACS User-Accessible Entrances',
7741
7817
  },
7742
7818
  },
7743
7819
  '/acs/users/remove_from_access_group': {
7744
7820
  post: {
7821
+ description: '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).',
7745
7822
  operationId: 'acsUsersRemoveFromAccessGroupPost',
7746
7823
  requestBody: {
7747
7824
  content: {
7748
7825
  'application/json': {
7749
7826
  schema: {
7750
7827
  properties: {
7751
- acs_access_group_id: { format: 'uuid', type: 'string' },
7752
- acs_user_id: { format: 'uuid', type: 'string' },
7828
+ acs_access_group_id: {
7829
+ description: 'ID of the desired access group.',
7830
+ format: 'uuid',
7831
+ type: 'string',
7832
+ },
7833
+ acs_user_id: {
7834
+ description: 'ID of the desired `acs_user`.',
7835
+ format: 'uuid',
7836
+ type: 'string',
7837
+ },
7753
7838
  },
7754
7839
  required: ['acs_user_id', 'acs_access_group_id'],
7755
7840
  type: 'object',
@@ -7782,16 +7867,24 @@ export default {
7782
7867
  tags: ['/acs'],
7783
7868
  'x-fern-sdk-group-name': ['acs', 'users'],
7784
7869
  'x-fern-sdk-method-name': 'remove_from_access_group',
7870
+ 'x-title': 'Remove an ACS User from an Access Group',
7785
7871
  },
7786
7872
  },
7787
7873
  '/acs/users/revoke_access_to_all_entrances': {
7788
7874
  post: {
7875
+ description: 'Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
7789
7876
  operationId: 'acsUsersRevokeAccessToAllEntrancesPost',
7790
7877
  requestBody: {
7791
7878
  content: {
7792
7879
  'application/json': {
7793
7880
  schema: {
7794
- properties: { acs_user_id: { format: 'uuid', type: 'string' } },
7881
+ properties: {
7882
+ acs_user_id: {
7883
+ description: 'ID of the desired `acs_user`.',
7884
+ format: 'uuid',
7885
+ type: 'string',
7886
+ },
7887
+ },
7795
7888
  required: ['acs_user_id'],
7796
7889
  type: 'object',
7797
7890
  },
@@ -7823,16 +7916,24 @@ export default {
7823
7916
  tags: ['/acs'],
7824
7917
  'x-fern-sdk-group-name': ['acs', 'users'],
7825
7918
  'x-fern-sdk-method-name': 'revoke_access_to_all_entrances',
7919
+ 'x-title': 'Revoke ACS User Access to All Entrances',
7826
7920
  },
7827
7921
  },
7828
7922
  '/acs/users/suspend': {
7829
7923
  post: {
7924
+ description: "[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them.",
7830
7925
  operationId: 'acsUsersSuspendPost',
7831
7926
  requestBody: {
7832
7927
  content: {
7833
7928
  'application/json': {
7834
7929
  schema: {
7835
- properties: { acs_user_id: { format: 'uuid', type: 'string' } },
7930
+ properties: {
7931
+ acs_user_id: {
7932
+ description: 'ID of the desired `acs_user`.',
7933
+ format: 'uuid',
7934
+ type: 'string',
7935
+ },
7936
+ },
7836
7937
  required: ['acs_user_id'],
7837
7938
  type: 'object',
7838
7939
  },
@@ -7864,6 +7965,7 @@ export default {
7864
7965
  tags: ['/acs'],
7865
7966
  'x-fern-sdk-group-name': ['acs', 'users'],
7866
7967
  'x-fern-sdk-method-name': 'suspend',
7968
+ 'x-title': 'Suspend an ACS User',
7867
7969
  },
7868
7970
  },
7869
7971
  '/acs/users/unmanaged/get': {
@@ -8456,12 +8558,19 @@ export default {
8456
8558
  },
8457
8559
  '/acs/users/unsuspend': {
8458
8560
  post: {
8561
+ description: '[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access.',
8459
8562
  operationId: 'acsUsersUnsuspendPost',
8460
8563
  requestBody: {
8461
8564
  content: {
8462
8565
  'application/json': {
8463
8566
  schema: {
8464
- properties: { acs_user_id: { format: 'uuid', type: 'string' } },
8567
+ properties: {
8568
+ acs_user_id: {
8569
+ description: 'ID of the desired `acs_user`.',
8570
+ format: 'uuid',
8571
+ type: 'string',
8572
+ },
8573
+ },
8465
8574
  required: ['acs_user_id'],
8466
8575
  type: 'object',
8467
8576
  },
@@ -8493,10 +8602,12 @@ export default {
8493
8602
  tags: ['/acs'],
8494
8603
  'x-fern-sdk-group-name': ['acs', 'users'],
8495
8604
  'x-fern-sdk-method-name': 'unsuspend',
8605
+ 'x-title': 'Unsuspend an ACS User',
8496
8606
  },
8497
8607
  },
8498
8608
  '/acs/users/update': {
8499
8609
  patch: {
8610
+ description: 'Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
8500
8611
  operationId: 'acsUsersUpdatePatch',
8501
8612
  requestBody: {
8502
8613
  content: {
@@ -8504,6 +8615,7 @@ export default {
8504
8615
  schema: {
8505
8616
  properties: {
8506
8617
  access_schedule: {
8618
+ description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems.",
8507
8619
  nullable: true,
8508
8620
  properties: {
8509
8621
  ends_at: { format: 'date-time', type: 'string' },
@@ -8554,8 +8666,10 @@ export default {
8554
8666
  summary: '/acs/users/update',
8555
8667
  tags: ['/acs'],
8556
8668
  'x-fern-ignore': true,
8669
+ 'x-title': 'Update an ACS User',
8557
8670
  },
8558
8671
  post: {
8672
+ description: 'Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
8559
8673
  operationId: 'acsUsersUpdatePost',
8560
8674
  requestBody: {
8561
8675
  content: {
@@ -8563,6 +8677,7 @@ export default {
8563
8677
  schema: {
8564
8678
  properties: {
8565
8679
  access_schedule: {
8680
+ description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems.",
8566
8681
  nullable: true,
8567
8682
  properties: {
8568
8683
  ends_at: { format: 'date-time', type: 'string' },
@@ -8614,6 +8729,7 @@ export default {
8614
8729
  tags: ['/acs'],
8615
8730
  'x-fern-sdk-group-name': ['acs', 'users'],
8616
8731
  'x-fern-sdk-method-name': 'update',
8732
+ 'x-title': 'Update an ACS User',
8617
8733
  },
8618
8734
  },
8619
8735
  '/action_attempts/get': {