@seamapi/types 1.272.0 → 1.274.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 (21) hide show
  1. package/dist/connect.cjs +210 -39
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +394 -19
  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/acs/acs-entrance.d.ts +19 -19
  7. package/lib/seam/connect/models/devices/device-metadata.d.ts +38 -0
  8. package/lib/seam/connect/models/devices/device-metadata.js +11 -0
  9. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  10. package/lib/seam/connect/models/devices/device.d.ts +54 -0
  11. package/lib/seam/connect/models/devices/phone.d.ts +38 -0
  12. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +38 -0
  13. package/lib/seam/connect/openapi.d.ts +70 -0
  14. package/lib/seam/connect/openapi.js +179 -31
  15. package/lib/seam/connect/openapi.js.map +1 -1
  16. package/lib/seam/connect/route-types.d.ts +213 -0
  17. package/package.json +1 -1
  18. package/src/lib/seam/connect/models/acs/acs-access-group.ts +31 -8
  19. package/src/lib/seam/connect/models/devices/device-metadata.ts +11 -1
  20. package/src/lib/seam/connect/openapi.ts +210 -31
  21. package/src/lib/seam/connect/route-types.ts +241 -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',
@@ -3759,7 +3780,26 @@ export default {
3759
3780
  required: ['device_id', 'device_name'],
3760
3781
  type: 'object',
3761
3782
  },
3783
+ salto_ks_metadata: {
3784
+ properties: {
3785
+ battery_level: { type: 'string' },
3786
+ customer_reference: { type: 'string' },
3787
+ lock_id: { type: 'string' },
3788
+ lock_type: { type: 'string' },
3789
+ locked_state: { type: 'string' },
3790
+ model: { type: 'string' },
3791
+ },
3792
+ required: [
3793
+ 'lock_id',
3794
+ 'customer_reference',
3795
+ 'lock_type',
3796
+ 'battery_level',
3797
+ 'locked_state',
3798
+ ],
3799
+ type: 'object',
3800
+ },
3762
3801
  salto_metadata: {
3802
+ description: '\n ---\n deprecated: Use `salto_ks_metadata ` instead.\n ',
3763
3803
  properties: {
3764
3804
  battery_level: { type: 'string' },
3765
3805
  customer_reference: { type: 'string' },
@@ -6428,14 +6468,23 @@ export default {
6428
6468
  },
6429
6469
  '/acs/access_groups/add_user': {
6430
6470
  post: {
6471
+ 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
6472
  operationId: 'acsAccessGroupsAddUserPost',
6432
6473
  requestBody: {
6433
6474
  content: {
6434
6475
  'application/json': {
6435
6476
  schema: {
6436
6477
  properties: {
6437
- acs_access_group_id: { format: 'uuid', type: 'string' },
6438
- acs_user_id: { format: 'uuid', type: 'string' },
6478
+ acs_access_group_id: {
6479
+ description: 'ID of the desired access group.',
6480
+ format: 'uuid',
6481
+ type: 'string',
6482
+ },
6483
+ acs_user_id: {
6484
+ description: 'ID of the desired user.',
6485
+ format: 'uuid',
6486
+ type: 'string',
6487
+ },
6439
6488
  },
6440
6489
  required: ['acs_access_group_id', 'acs_user_id'],
6441
6490
  type: 'object',
@@ -6471,14 +6520,23 @@ export default {
6471
6520
  'x-response-key': null,
6472
6521
  },
6473
6522
  put: {
6523
+ 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
6524
  operationId: 'acsAccessGroupsAddUserPut',
6475
6525
  requestBody: {
6476
6526
  content: {
6477
6527
  'application/json': {
6478
6528
  schema: {
6479
6529
  properties: {
6480
- acs_access_group_id: { format: 'uuid', type: 'string' },
6481
- acs_user_id: { format: 'uuid', type: 'string' },
6530
+ acs_access_group_id: {
6531
+ description: 'ID of the desired access group.',
6532
+ format: 'uuid',
6533
+ type: 'string',
6534
+ },
6535
+ acs_user_id: {
6536
+ description: 'ID of the desired user.',
6537
+ format: 'uuid',
6538
+ type: 'string',
6539
+ },
6482
6540
  },
6483
6541
  required: ['acs_access_group_id', 'acs_user_id'],
6484
6542
  type: 'object',
@@ -6515,13 +6573,18 @@ export default {
6515
6573
  },
6516
6574
  '/acs/access_groups/get': {
6517
6575
  post: {
6576
+ description: 'Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6518
6577
  operationId: 'acsAccessGroupsGetPost',
6519
6578
  requestBody: {
6520
6579
  content: {
6521
6580
  'application/json': {
6522
6581
  schema: {
6523
6582
  properties: {
6524
- acs_access_group_id: { format: 'uuid', type: 'string' },
6583
+ acs_access_group_id: {
6584
+ description: 'ID of the desired access group.',
6585
+ format: 'uuid',
6586
+ type: 'string',
6587
+ },
6525
6588
  },
6526
6589
  required: ['acs_access_group_id'],
6527
6590
  type: 'object',
@@ -6565,14 +6628,23 @@ export default {
6565
6628
  },
6566
6629
  '/acs/access_groups/list': {
6567
6630
  post: {
6631
+ description: 'Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6568
6632
  operationId: 'acsAccessGroupsListPost',
6569
6633
  requestBody: {
6570
6634
  content: {
6571
6635
  'application/json': {
6572
6636
  schema: {
6573
6637
  properties: {
6574
- acs_system_id: { format: 'uuid', type: 'string' },
6575
- acs_user_id: { format: 'uuid', type: 'string' },
6638
+ acs_system_id: {
6639
+ description: 'ID of the access control system for which you want to retrieve all access groups.',
6640
+ format: 'uuid',
6641
+ type: 'string',
6642
+ },
6643
+ acs_user_id: {
6644
+ description: 'ID of the user for which you want to retrieve all access groups.',
6645
+ format: 'uuid',
6646
+ type: 'string',
6647
+ },
6576
6648
  },
6577
6649
  type: 'object',
6578
6650
  },
@@ -6616,13 +6688,18 @@ export default {
6616
6688
  },
6617
6689
  '/acs/access_groups/list_accessible_entrances': {
6618
6690
  post: {
6691
+ 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
6692
  operationId: 'acsAccessGroupsListAccessibleEntrancesPost',
6620
6693
  requestBody: {
6621
6694
  content: {
6622
6695
  'application/json': {
6623
6696
  schema: {
6624
6697
  properties: {
6625
- acs_access_group_id: { format: 'uuid', type: 'string' },
6698
+ acs_access_group_id: {
6699
+ description: 'ID of the access group for which you want to retrieve all accessible entrances.',
6700
+ format: 'uuid',
6701
+ type: 'string',
6702
+ },
6626
6703
  },
6627
6704
  required: ['acs_access_group_id'],
6628
6705
  type: 'object',
@@ -6667,13 +6744,18 @@ export default {
6667
6744
  },
6668
6745
  '/acs/access_groups/list_users': {
6669
6746
  post: {
6747
+ 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
6748
  operationId: 'acsAccessGroupsListUsersPost',
6671
6749
  requestBody: {
6672
6750
  content: {
6673
6751
  'application/json': {
6674
6752
  schema: {
6675
6753
  properties: {
6676
- acs_access_group_id: { format: 'uuid', type: 'string' },
6754
+ acs_access_group_id: {
6755
+ description: 'ID of the access group for which you want to retrieve all users.',
6756
+ format: 'uuid',
6757
+ type: 'string',
6758
+ },
6677
6759
  },
6678
6760
  required: ['acs_access_group_id'],
6679
6761
  type: 'object',
@@ -6718,14 +6800,23 @@ export default {
6718
6800
  },
6719
6801
  '/acs/access_groups/remove_user': {
6720
6802
  post: {
6803
+ 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
6804
  operationId: 'acsAccessGroupsRemoveUserPost',
6722
6805
  requestBody: {
6723
6806
  content: {
6724
6807
  'application/json': {
6725
6808
  schema: {
6726
6809
  properties: {
6727
- acs_access_group_id: { format: 'uuid', type: 'string' },
6728
- acs_user_id: { format: 'uuid', type: 'string' },
6810
+ acs_access_group_id: {
6811
+ description: 'ID of the desired access group.',
6812
+ format: 'uuid',
6813
+ type: 'string',
6814
+ },
6815
+ acs_user_id: {
6816
+ description: 'ID of the desired user.',
6817
+ format: 'uuid',
6818
+ type: 'string',
6819
+ },
6729
6820
  },
6730
6821
  required: ['acs_access_group_id', 'acs_user_id'],
6731
6822
  type: 'object',
@@ -6763,13 +6854,18 @@ export default {
6763
6854
  },
6764
6855
  '/acs/access_groups/unmanaged/get': {
6765
6856
  post: {
6857
+ description: 'Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6766
6858
  operationId: 'acsAccessGroupsUnmanagedGetPost',
6767
6859
  requestBody: {
6768
6860
  content: {
6769
6861
  'application/json': {
6770
6862
  schema: {
6771
6863
  properties: {
6772
- acs_access_group_id: { format: 'uuid', type: 'string' },
6864
+ acs_access_group_id: {
6865
+ description: 'ID of the desired unmanaged access group.',
6866
+ format: 'uuid',
6867
+ type: 'string',
6868
+ },
6773
6869
  },
6774
6870
  required: ['acs_access_group_id'],
6775
6871
  type: 'object',
@@ -6801,11 +6897,24 @@ export default {
6801
6897
  type: 'string',
6802
6898
  'x-deprecated': 'use external_type_display_name',
6803
6899
  },
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' },
6900
+ acs_access_group_id: {
6901
+ description: 'ID of the access group.',
6902
+ format: 'uuid',
6903
+ type: 'string',
6904
+ },
6905
+ acs_system_id: {
6906
+ description: 'ID of the access control system that contains the access group.',
6907
+ format: 'uuid',
6908
+ type: 'string',
6909
+ },
6910
+ created_at: {
6911
+ description: 'Date and time at which the access group was created.',
6912
+ format: 'date-time',
6913
+ type: 'string',
6914
+ },
6807
6915
  display_name: { type: 'string' },
6808
6916
  external_type: {
6917
+ description: 'Brand-specific terminology for the access group type.',
6809
6918
  enum: [
6810
6919
  'pti_unit',
6811
6920
  'pti_access_level',
@@ -6814,10 +6923,20 @@ export default {
6814
6923
  ],
6815
6924
  type: 'string',
6816
6925
  },
6817
- external_type_display_name: { type: 'string' },
6926
+ external_type_display_name: {
6927
+ description: 'Display name that corresponds to the brand-specific terminology for the access group type.',
6928
+ type: 'string',
6929
+ },
6818
6930
  is_managed: { enum: [false], type: 'boolean' },
6819
- name: { type: 'string' },
6820
- workspace_id: { format: 'uuid', type: 'string' },
6931
+ name: {
6932
+ description: 'Name of the access group.',
6933
+ type: 'string',
6934
+ },
6935
+ workspace_id: {
6936
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.',
6937
+ format: 'uuid',
6938
+ type: 'string',
6939
+ },
6821
6940
  },
6822
6941
  required: [
6823
6942
  'acs_access_group_id',
@@ -6861,14 +6980,23 @@ export default {
6861
6980
  },
6862
6981
  '/acs/access_groups/unmanaged/list': {
6863
6982
  post: {
6983
+ description: 'Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6864
6984
  operationId: 'acsAccessGroupsUnmanagedListPost',
6865
6985
  requestBody: {
6866
6986
  content: {
6867
6987
  'application/json': {
6868
6988
  schema: {
6869
6989
  properties: {
6870
- acs_system_id: { format: 'uuid', type: 'string' },
6871
- acs_user_id: { format: 'uuid', type: 'string' },
6990
+ acs_system_id: {
6991
+ description: 'ID of the access control system for which you want to retrieve all unmanaged access groups.',
6992
+ format: 'uuid',
6993
+ type: 'string',
6994
+ },
6995
+ acs_user_id: {
6996
+ description: 'ID of the user for which you want to retrieve all unmanaged access groups.',
6997
+ format: 'uuid',
6998
+ type: 'string',
6999
+ },
6872
7000
  },
6873
7001
  type: 'object',
6874
7002
  },
@@ -6901,13 +7029,23 @@ export default {
6901
7029
  'x-deprecated': 'use external_type_display_name',
6902
7030
  },
6903
7031
  acs_access_group_id: {
7032
+ description: 'ID of the access group.',
6904
7033
  format: 'uuid',
6905
7034
  type: 'string',
6906
7035
  },
6907
- acs_system_id: { format: 'uuid', type: 'string' },
6908
- created_at: { format: 'date-time', type: 'string' },
7036
+ acs_system_id: {
7037
+ description: 'ID of the access control system that contains the access group.',
7038
+ format: 'uuid',
7039
+ type: 'string',
7040
+ },
7041
+ created_at: {
7042
+ description: 'Date and time at which the access group was created.',
7043
+ format: 'date-time',
7044
+ type: 'string',
7045
+ },
6909
7046
  display_name: { type: 'string' },
6910
7047
  external_type: {
7048
+ description: 'Brand-specific terminology for the access group type.',
6911
7049
  enum: [
6912
7050
  'pti_unit',
6913
7051
  'pti_access_level',
@@ -6916,10 +7054,20 @@ export default {
6916
7054
  ],
6917
7055
  type: 'string',
6918
7056
  },
6919
- external_type_display_name: { type: 'string' },
7057
+ external_type_display_name: {
7058
+ description: 'Display name that corresponds to the brand-specific terminology for the access group type.',
7059
+ type: 'string',
7060
+ },
6920
7061
  is_managed: { enum: [false], type: 'boolean' },
6921
- name: { type: 'string' },
6922
- workspace_id: { format: 'uuid', type: 'string' },
7062
+ name: {
7063
+ description: 'Name of the access group.',
7064
+ type: 'string',
7065
+ },
7066
+ workspace_id: {
7067
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.',
7068
+ format: 'uuid',
7069
+ type: 'string',
7070
+ },
6923
7071
  },
6924
7072
  required: [
6925
7073
  'acs_access_group_id',