@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/openapi.js CHANGED
@@ -169,6 +169,7 @@ export default {
169
169
  type: 'object',
170
170
  },
171
171
  acs_access_group: {
172
+ description: '\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 ',
172
173
  properties: {
173
174
  access_group_type: {
174
175
  deprecated: true,
@@ -186,11 +187,24 @@ export default {
186
187
  type: 'string',
187
188
  'x-deprecated': 'use external_type_display_name',
188
189
  },
189
- acs_access_group_id: { format: 'uuid', type: 'string' },
190
- acs_system_id: { format: 'uuid', type: 'string' },
191
- created_at: { format: 'date-time', type: 'string' },
190
+ acs_access_group_id: {
191
+ description: 'ID of the access group.',
192
+ format: 'uuid',
193
+ type: 'string',
194
+ },
195
+ acs_system_id: {
196
+ description: 'ID of the access control system that contains the access group.',
197
+ format: 'uuid',
198
+ type: 'string',
199
+ },
200
+ created_at: {
201
+ description: 'Date and time at which the access group was created.',
202
+ format: 'date-time',
203
+ type: 'string',
204
+ },
192
205
  display_name: { type: 'string' },
193
206
  external_type: {
207
+ description: 'Brand-specific terminology for the access group type.',
194
208
  enum: [
195
209
  'pti_unit',
196
210
  'pti_access_level',
@@ -199,10 +213,17 @@ export default {
199
213
  ],
200
214
  type: 'string',
201
215
  },
202
- external_type_display_name: { type: 'string' },
216
+ external_type_display_name: {
217
+ description: 'Display name that corresponds to the brand-specific terminology for the access group type.',
218
+ type: 'string',
219
+ },
203
220
  is_managed: { enum: [true], type: 'boolean' },
204
- name: { type: 'string' },
205
- workspace_id: { format: 'uuid', type: 'string' },
221
+ name: { description: 'Name of the access group.', type: 'string' },
222
+ workspace_id: {
223
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.',
224
+ format: 'uuid',
225
+ type: 'string',
226
+ },
206
227
  },
207
228
  required: [
208
229
  'acs_access_group_id',
@@ -6428,14 +6449,23 @@ export default {
6428
6449
  },
6429
6450
  '/acs/access_groups/add_user': {
6430
6451
  post: {
6452
+ 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).',
6431
6453
  operationId: 'acsAccessGroupsAddUserPost',
6432
6454
  requestBody: {
6433
6455
  content: {
6434
6456
  'application/json': {
6435
6457
  schema: {
6436
6458
  properties: {
6437
- acs_access_group_id: { format: 'uuid', type: 'string' },
6438
- acs_user_id: { format: 'uuid', type: 'string' },
6459
+ acs_access_group_id: {
6460
+ description: 'ID of the desired access group.',
6461
+ format: 'uuid',
6462
+ type: 'string',
6463
+ },
6464
+ acs_user_id: {
6465
+ description: 'ID of the desired user.',
6466
+ format: 'uuid',
6467
+ type: 'string',
6468
+ },
6439
6469
  },
6440
6470
  required: ['acs_access_group_id', 'acs_user_id'],
6441
6471
  type: 'object',
@@ -6471,14 +6501,23 @@ export default {
6471
6501
  'x-response-key': null,
6472
6502
  },
6473
6503
  put: {
6504
+ 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).',
6474
6505
  operationId: 'acsAccessGroupsAddUserPut',
6475
6506
  requestBody: {
6476
6507
  content: {
6477
6508
  'application/json': {
6478
6509
  schema: {
6479
6510
  properties: {
6480
- acs_access_group_id: { format: 'uuid', type: 'string' },
6481
- acs_user_id: { format: 'uuid', type: 'string' },
6511
+ acs_access_group_id: {
6512
+ description: 'ID of the desired access group.',
6513
+ format: 'uuid',
6514
+ type: 'string',
6515
+ },
6516
+ acs_user_id: {
6517
+ description: 'ID of the desired user.',
6518
+ format: 'uuid',
6519
+ type: 'string',
6520
+ },
6482
6521
  },
6483
6522
  required: ['acs_access_group_id', 'acs_user_id'],
6484
6523
  type: 'object',
@@ -6515,13 +6554,18 @@ export default {
6515
6554
  },
6516
6555
  '/acs/access_groups/get': {
6517
6556
  post: {
6557
+ description: 'Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6518
6558
  operationId: 'acsAccessGroupsGetPost',
6519
6559
  requestBody: {
6520
6560
  content: {
6521
6561
  'application/json': {
6522
6562
  schema: {
6523
6563
  properties: {
6524
- acs_access_group_id: { format: 'uuid', type: 'string' },
6564
+ acs_access_group_id: {
6565
+ description: 'ID of the desired access group.',
6566
+ format: 'uuid',
6567
+ type: 'string',
6568
+ },
6525
6569
  },
6526
6570
  required: ['acs_access_group_id'],
6527
6571
  type: 'object',
@@ -6565,14 +6609,23 @@ export default {
6565
6609
  },
6566
6610
  '/acs/access_groups/list': {
6567
6611
  post: {
6612
+ description: 'Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6568
6613
  operationId: 'acsAccessGroupsListPost',
6569
6614
  requestBody: {
6570
6615
  content: {
6571
6616
  'application/json': {
6572
6617
  schema: {
6573
6618
  properties: {
6574
- acs_system_id: { format: 'uuid', type: 'string' },
6575
- acs_user_id: { format: 'uuid', type: 'string' },
6619
+ acs_system_id: {
6620
+ description: 'ID of the access control system for which you want to retrieve all access groups.',
6621
+ format: 'uuid',
6622
+ type: 'string',
6623
+ },
6624
+ acs_user_id: {
6625
+ description: 'ID of the user for which you want to retrieve all access groups.',
6626
+ format: 'uuid',
6627
+ type: 'string',
6628
+ },
6576
6629
  },
6577
6630
  type: 'object',
6578
6631
  },
@@ -6616,13 +6669,18 @@ export default {
6616
6669
  },
6617
6670
  '/acs/access_groups/list_accessible_entrances': {
6618
6671
  post: {
6672
+ description: '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).',
6619
6673
  operationId: 'acsAccessGroupsListAccessibleEntrancesPost',
6620
6674
  requestBody: {
6621
6675
  content: {
6622
6676
  'application/json': {
6623
6677
  schema: {
6624
6678
  properties: {
6625
- acs_access_group_id: { format: 'uuid', type: 'string' },
6679
+ acs_access_group_id: {
6680
+ description: 'ID of the access group for which you want to retrieve all accessible entrances.',
6681
+ format: 'uuid',
6682
+ type: 'string',
6683
+ },
6626
6684
  },
6627
6685
  required: ['acs_access_group_id'],
6628
6686
  type: 'object',
@@ -6667,13 +6725,18 @@ export default {
6667
6725
  },
6668
6726
  '/acs/access_groups/list_users': {
6669
6727
  post: {
6728
+ description: '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).',
6670
6729
  operationId: 'acsAccessGroupsListUsersPost',
6671
6730
  requestBody: {
6672
6731
  content: {
6673
6732
  'application/json': {
6674
6733
  schema: {
6675
6734
  properties: {
6676
- acs_access_group_id: { format: 'uuid', type: 'string' },
6735
+ acs_access_group_id: {
6736
+ description: 'ID of the access group for which you want to retrieve all users.',
6737
+ format: 'uuid',
6738
+ type: 'string',
6739
+ },
6677
6740
  },
6678
6741
  required: ['acs_access_group_id'],
6679
6742
  type: 'object',
@@ -6718,14 +6781,23 @@ export default {
6718
6781
  },
6719
6782
  '/acs/access_groups/remove_user': {
6720
6783
  post: {
6784
+ 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).',
6721
6785
  operationId: 'acsAccessGroupsRemoveUserPost',
6722
6786
  requestBody: {
6723
6787
  content: {
6724
6788
  'application/json': {
6725
6789
  schema: {
6726
6790
  properties: {
6727
- acs_access_group_id: { format: 'uuid', type: 'string' },
6728
- acs_user_id: { format: 'uuid', type: 'string' },
6791
+ acs_access_group_id: {
6792
+ description: 'ID of the desired access group.',
6793
+ format: 'uuid',
6794
+ type: 'string',
6795
+ },
6796
+ acs_user_id: {
6797
+ description: 'ID of the desired user.',
6798
+ format: 'uuid',
6799
+ type: 'string',
6800
+ },
6729
6801
  },
6730
6802
  required: ['acs_access_group_id', 'acs_user_id'],
6731
6803
  type: 'object',
@@ -6763,13 +6835,18 @@ export default {
6763
6835
  },
6764
6836
  '/acs/access_groups/unmanaged/get': {
6765
6837
  post: {
6838
+ description: 'Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6766
6839
  operationId: 'acsAccessGroupsUnmanagedGetPost',
6767
6840
  requestBody: {
6768
6841
  content: {
6769
6842
  'application/json': {
6770
6843
  schema: {
6771
6844
  properties: {
6772
- acs_access_group_id: { format: 'uuid', type: 'string' },
6845
+ acs_access_group_id: {
6846
+ description: 'ID of the desired unmanaged access group.',
6847
+ format: 'uuid',
6848
+ type: 'string',
6849
+ },
6773
6850
  },
6774
6851
  required: ['acs_access_group_id'],
6775
6852
  type: 'object',
@@ -6801,11 +6878,24 @@ export default {
6801
6878
  type: 'string',
6802
6879
  'x-deprecated': 'use external_type_display_name',
6803
6880
  },
6804
- acs_access_group_id: { format: 'uuid', type: 'string' },
6805
- acs_system_id: { format: 'uuid', type: 'string' },
6806
- created_at: { format: 'date-time', type: 'string' },
6881
+ acs_access_group_id: {
6882
+ description: 'ID of the access group.',
6883
+ format: 'uuid',
6884
+ type: 'string',
6885
+ },
6886
+ acs_system_id: {
6887
+ description: 'ID of the access control system that contains the access group.',
6888
+ format: 'uuid',
6889
+ type: 'string',
6890
+ },
6891
+ created_at: {
6892
+ description: 'Date and time at which the access group was created.',
6893
+ format: 'date-time',
6894
+ type: 'string',
6895
+ },
6807
6896
  display_name: { type: 'string' },
6808
6897
  external_type: {
6898
+ description: 'Brand-specific terminology for the access group type.',
6809
6899
  enum: [
6810
6900
  'pti_unit',
6811
6901
  'pti_access_level',
@@ -6814,10 +6904,20 @@ export default {
6814
6904
  ],
6815
6905
  type: 'string',
6816
6906
  },
6817
- external_type_display_name: { type: 'string' },
6907
+ external_type_display_name: {
6908
+ description: 'Display name that corresponds to the brand-specific terminology for the access group type.',
6909
+ type: 'string',
6910
+ },
6818
6911
  is_managed: { enum: [false], type: 'boolean' },
6819
- name: { type: 'string' },
6820
- workspace_id: { format: 'uuid', type: 'string' },
6912
+ name: {
6913
+ description: 'Name of the access group.',
6914
+ type: 'string',
6915
+ },
6916
+ workspace_id: {
6917
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.',
6918
+ format: 'uuid',
6919
+ type: 'string',
6920
+ },
6821
6921
  },
6822
6922
  required: [
6823
6923
  'acs_access_group_id',
@@ -6861,14 +6961,23 @@ export default {
6861
6961
  },
6862
6962
  '/acs/access_groups/unmanaged/list': {
6863
6963
  post: {
6964
+ description: 'Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6864
6965
  operationId: 'acsAccessGroupsUnmanagedListPost',
6865
6966
  requestBody: {
6866
6967
  content: {
6867
6968
  'application/json': {
6868
6969
  schema: {
6869
6970
  properties: {
6870
- acs_system_id: { format: 'uuid', type: 'string' },
6871
- acs_user_id: { format: 'uuid', type: 'string' },
6971
+ acs_system_id: {
6972
+ description: 'ID of the access control system for which you want to retrieve all unmanaged access groups.',
6973
+ format: 'uuid',
6974
+ type: 'string',
6975
+ },
6976
+ acs_user_id: {
6977
+ description: 'ID of the user for which you want to retrieve all unmanaged access groups.',
6978
+ format: 'uuid',
6979
+ type: 'string',
6980
+ },
6872
6981
  },
6873
6982
  type: 'object',
6874
6983
  },
@@ -6901,13 +7010,23 @@ export default {
6901
7010
  'x-deprecated': 'use external_type_display_name',
6902
7011
  },
6903
7012
  acs_access_group_id: {
7013
+ description: 'ID of the access group.',
6904
7014
  format: 'uuid',
6905
7015
  type: 'string',
6906
7016
  },
6907
- acs_system_id: { format: 'uuid', type: 'string' },
6908
- created_at: { format: 'date-time', type: 'string' },
7017
+ acs_system_id: {
7018
+ description: 'ID of the access control system that contains the access group.',
7019
+ format: 'uuid',
7020
+ type: 'string',
7021
+ },
7022
+ created_at: {
7023
+ description: 'Date and time at which the access group was created.',
7024
+ format: 'date-time',
7025
+ type: 'string',
7026
+ },
6909
7027
  display_name: { type: 'string' },
6910
7028
  external_type: {
7029
+ description: 'Brand-specific terminology for the access group type.',
6911
7030
  enum: [
6912
7031
  'pti_unit',
6913
7032
  'pti_access_level',
@@ -6916,10 +7035,20 @@ export default {
6916
7035
  ],
6917
7036
  type: 'string',
6918
7037
  },
6919
- external_type_display_name: { type: 'string' },
7038
+ external_type_display_name: {
7039
+ description: 'Display name that corresponds to the brand-specific terminology for the access group type.',
7040
+ type: 'string',
7041
+ },
6920
7042
  is_managed: { enum: [false], type: 'boolean' },
6921
- name: { type: 'string' },
6922
- workspace_id: { format: 'uuid', type: 'string' },
7043
+ name: {
7044
+ description: 'Name of the access group.',
7045
+ type: 'string',
7046
+ },
7047
+ workspace_id: {
7048
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.',
7049
+ format: 'uuid',
7050
+ type: 'string',
7051
+ },
6923
7052
  },
6924
7053
  required: [
6925
7054
  'acs_access_group_id',