@seamapi/types 1.271.1 → 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 (20) hide show
  1. package/dist/connect.cjs +183 -40
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +119 -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/models/devices/device-metadata.d.ts +5 -0
  7. package/lib/seam/connect/models/devices/device-metadata.js +1 -0
  8. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  9. package/lib/seam/connect/models/devices/device.d.ts +7 -0
  10. package/lib/seam/connect/models/devices/phone.d.ts +5 -0
  11. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +5 -0
  12. package/lib/seam/connect/openapi.d.ts +48 -0
  13. package/lib/seam/connect/openapi.js +161 -31
  14. package/lib/seam/connect/openapi.js.map +1 -1
  15. package/lib/seam/connect/route-types.d.ts +59 -0
  16. package/package.json +1 -1
  17. package/src/lib/seam/connect/models/acs/acs-access-group.ts +31 -8
  18. package/src/lib/seam/connect/models/devices/device-metadata.ts +1 -0
  19. package/src/lib/seam/connect/openapi.ts +191 -31
  20. package/src/lib/seam/connect/route-types.ts +59 -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',
@@ -3715,6 +3736,7 @@ export default {
3715
3736
  properties: {
3716
3737
  custom_name: { type: 'string' },
3717
3738
  device_name: { type: 'string' },
3739
+ display_name: { type: 'string' },
3718
3740
  nest_device_id: { type: 'string' },
3719
3741
  },
3720
3742
  required: [
@@ -6427,14 +6449,23 @@ export default {
6427
6449
  },
6428
6450
  '/acs/access_groups/add_user': {
6429
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).',
6430
6453
  operationId: 'acsAccessGroupsAddUserPost',
6431
6454
  requestBody: {
6432
6455
  content: {
6433
6456
  'application/json': {
6434
6457
  schema: {
6435
6458
  properties: {
6436
- acs_access_group_id: { format: 'uuid', type: 'string' },
6437
- 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
+ },
6438
6469
  },
6439
6470
  required: ['acs_access_group_id', 'acs_user_id'],
6440
6471
  type: 'object',
@@ -6470,14 +6501,23 @@ export default {
6470
6501
  'x-response-key': null,
6471
6502
  },
6472
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).',
6473
6505
  operationId: 'acsAccessGroupsAddUserPut',
6474
6506
  requestBody: {
6475
6507
  content: {
6476
6508
  'application/json': {
6477
6509
  schema: {
6478
6510
  properties: {
6479
- acs_access_group_id: { format: 'uuid', type: 'string' },
6480
- 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
+ },
6481
6521
  },
6482
6522
  required: ['acs_access_group_id', 'acs_user_id'],
6483
6523
  type: 'object',
@@ -6514,13 +6554,18 @@ export default {
6514
6554
  },
6515
6555
  '/acs/access_groups/get': {
6516
6556
  post: {
6557
+ description: 'Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6517
6558
  operationId: 'acsAccessGroupsGetPost',
6518
6559
  requestBody: {
6519
6560
  content: {
6520
6561
  'application/json': {
6521
6562
  schema: {
6522
6563
  properties: {
6523
- 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
+ },
6524
6569
  },
6525
6570
  required: ['acs_access_group_id'],
6526
6571
  type: 'object',
@@ -6564,14 +6609,23 @@ export default {
6564
6609
  },
6565
6610
  '/acs/access_groups/list': {
6566
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).',
6567
6613
  operationId: 'acsAccessGroupsListPost',
6568
6614
  requestBody: {
6569
6615
  content: {
6570
6616
  'application/json': {
6571
6617
  schema: {
6572
6618
  properties: {
6573
- acs_system_id: { format: 'uuid', type: 'string' },
6574
- 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
+ },
6575
6629
  },
6576
6630
  type: 'object',
6577
6631
  },
@@ -6615,13 +6669,18 @@ export default {
6615
6669
  },
6616
6670
  '/acs/access_groups/list_accessible_entrances': {
6617
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).',
6618
6673
  operationId: 'acsAccessGroupsListAccessibleEntrancesPost',
6619
6674
  requestBody: {
6620
6675
  content: {
6621
6676
  'application/json': {
6622
6677
  schema: {
6623
6678
  properties: {
6624
- 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
+ },
6625
6684
  },
6626
6685
  required: ['acs_access_group_id'],
6627
6686
  type: 'object',
@@ -6666,13 +6725,18 @@ export default {
6666
6725
  },
6667
6726
  '/acs/access_groups/list_users': {
6668
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).',
6669
6729
  operationId: 'acsAccessGroupsListUsersPost',
6670
6730
  requestBody: {
6671
6731
  content: {
6672
6732
  'application/json': {
6673
6733
  schema: {
6674
6734
  properties: {
6675
- 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
+ },
6676
6740
  },
6677
6741
  required: ['acs_access_group_id'],
6678
6742
  type: 'object',
@@ -6717,14 +6781,23 @@ export default {
6717
6781
  },
6718
6782
  '/acs/access_groups/remove_user': {
6719
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).',
6720
6785
  operationId: 'acsAccessGroupsRemoveUserPost',
6721
6786
  requestBody: {
6722
6787
  content: {
6723
6788
  'application/json': {
6724
6789
  schema: {
6725
6790
  properties: {
6726
- acs_access_group_id: { format: 'uuid', type: 'string' },
6727
- 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
+ },
6728
6801
  },
6729
6802
  required: ['acs_access_group_id', 'acs_user_id'],
6730
6803
  type: 'object',
@@ -6762,13 +6835,18 @@ export default {
6762
6835
  },
6763
6836
  '/acs/access_groups/unmanaged/get': {
6764
6837
  post: {
6838
+ description: 'Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6765
6839
  operationId: 'acsAccessGroupsUnmanagedGetPost',
6766
6840
  requestBody: {
6767
6841
  content: {
6768
6842
  'application/json': {
6769
6843
  schema: {
6770
6844
  properties: {
6771
- 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
+ },
6772
6850
  },
6773
6851
  required: ['acs_access_group_id'],
6774
6852
  type: 'object',
@@ -6800,11 +6878,24 @@ export default {
6800
6878
  type: 'string',
6801
6879
  'x-deprecated': 'use external_type_display_name',
6802
6880
  },
6803
- acs_access_group_id: { format: 'uuid', type: 'string' },
6804
- acs_system_id: { format: 'uuid', type: 'string' },
6805
- 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
+ },
6806
6896
  display_name: { type: 'string' },
6807
6897
  external_type: {
6898
+ description: 'Brand-specific terminology for the access group type.',
6808
6899
  enum: [
6809
6900
  'pti_unit',
6810
6901
  'pti_access_level',
@@ -6813,10 +6904,20 @@ export default {
6813
6904
  ],
6814
6905
  type: 'string',
6815
6906
  },
6816
- 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
+ },
6817
6911
  is_managed: { enum: [false], type: 'boolean' },
6818
- name: { type: 'string' },
6819
- 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
+ },
6820
6921
  },
6821
6922
  required: [
6822
6923
  'acs_access_group_id',
@@ -6860,14 +6961,23 @@ export default {
6860
6961
  },
6861
6962
  '/acs/access_groups/unmanaged/list': {
6862
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).',
6863
6965
  operationId: 'acsAccessGroupsUnmanagedListPost',
6864
6966
  requestBody: {
6865
6967
  content: {
6866
6968
  'application/json': {
6867
6969
  schema: {
6868
6970
  properties: {
6869
- acs_system_id: { format: 'uuid', type: 'string' },
6870
- 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
+ },
6871
6981
  },
6872
6982
  type: 'object',
6873
6983
  },
@@ -6900,13 +7010,23 @@ export default {
6900
7010
  'x-deprecated': 'use external_type_display_name',
6901
7011
  },
6902
7012
  acs_access_group_id: {
7013
+ description: 'ID of the access group.',
6903
7014
  format: 'uuid',
6904
7015
  type: 'string',
6905
7016
  },
6906
- acs_system_id: { format: 'uuid', type: 'string' },
6907
- 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
+ },
6908
7027
  display_name: { type: 'string' },
6909
7028
  external_type: {
7029
+ description: 'Brand-specific terminology for the access group type.',
6910
7030
  enum: [
6911
7031
  'pti_unit',
6912
7032
  'pti_access_level',
@@ -6915,10 +7035,20 @@ export default {
6915
7035
  ],
6916
7036
  type: 'string',
6917
7037
  },
6918
- 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
+ },
6919
7042
  is_managed: { enum: [false], type: 'boolean' },
6920
- name: { type: 'string' },
6921
- 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
+ },
6922
7052
  },
6923
7053
  required: [
6924
7054
  'acs_access_group_id',