@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/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',
@@ -3870,7 +3896,27 @@ export default {
3870
3896
  required: ['device_id', 'device_name'],
3871
3897
  type: 'object',
3872
3898
  },
3899
+ salto_ks_metadata: {
3900
+ properties: {
3901
+ battery_level: { type: 'string' },
3902
+ customer_reference: { type: 'string' },
3903
+ lock_id: { type: 'string' },
3904
+ lock_type: { type: 'string' },
3905
+ locked_state: { type: 'string' },
3906
+ model: { type: 'string' },
3907
+ },
3908
+ required: [
3909
+ 'lock_id',
3910
+ 'customer_reference',
3911
+ 'lock_type',
3912
+ 'battery_level',
3913
+ 'locked_state',
3914
+ ],
3915
+ type: 'object',
3916
+ },
3873
3917
  salto_metadata: {
3918
+ description:
3919
+ '\n ---\n deprecated: Use `salto_ks_metadata ` instead.\n ',
3874
3920
  properties: {
3875
3921
  battery_level: { type: 'string' },
3876
3922
  customer_reference: { type: 'string' },
@@ -6577,14 +6623,24 @@ export default {
6577
6623
  },
6578
6624
  '/acs/access_groups/add_user': {
6579
6625
  post: {
6626
+ description:
6627
+ '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
6628
  operationId: 'acsAccessGroupsAddUserPost',
6581
6629
  requestBody: {
6582
6630
  content: {
6583
6631
  'application/json': {
6584
6632
  schema: {
6585
6633
  properties: {
6586
- acs_access_group_id: { format: 'uuid', type: 'string' },
6587
- acs_user_id: { format: 'uuid', type: 'string' },
6634
+ acs_access_group_id: {
6635
+ description: 'ID of the desired access group.',
6636
+ format: 'uuid',
6637
+ type: 'string',
6638
+ },
6639
+ acs_user_id: {
6640
+ description: 'ID of the desired user.',
6641
+ format: 'uuid',
6642
+ type: 'string',
6643
+ },
6588
6644
  },
6589
6645
  required: ['acs_access_group_id', 'acs_user_id'],
6590
6646
  type: 'object',
@@ -6620,14 +6676,24 @@ export default {
6620
6676
  'x-response-key': null,
6621
6677
  },
6622
6678
  put: {
6679
+ description:
6680
+ '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
6681
  operationId: 'acsAccessGroupsAddUserPut',
6624
6682
  requestBody: {
6625
6683
  content: {
6626
6684
  'application/json': {
6627
6685
  schema: {
6628
6686
  properties: {
6629
- acs_access_group_id: { format: 'uuid', type: 'string' },
6630
- acs_user_id: { format: 'uuid', type: 'string' },
6687
+ acs_access_group_id: {
6688
+ description: 'ID of the desired access group.',
6689
+ format: 'uuid',
6690
+ type: 'string',
6691
+ },
6692
+ acs_user_id: {
6693
+ description: 'ID of the desired user.',
6694
+ format: 'uuid',
6695
+ type: 'string',
6696
+ },
6631
6697
  },
6632
6698
  required: ['acs_access_group_id', 'acs_user_id'],
6633
6699
  type: 'object',
@@ -6664,13 +6730,19 @@ export default {
6664
6730
  },
6665
6731
  '/acs/access_groups/get': {
6666
6732
  post: {
6733
+ description:
6734
+ 'Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6667
6735
  operationId: 'acsAccessGroupsGetPost',
6668
6736
  requestBody: {
6669
6737
  content: {
6670
6738
  'application/json': {
6671
6739
  schema: {
6672
6740
  properties: {
6673
- acs_access_group_id: { format: 'uuid', type: 'string' },
6741
+ acs_access_group_id: {
6742
+ description: 'ID of the desired access group.',
6743
+ format: 'uuid',
6744
+ type: 'string',
6745
+ },
6674
6746
  },
6675
6747
  required: ['acs_access_group_id'],
6676
6748
  type: 'object',
@@ -6714,14 +6786,26 @@ export default {
6714
6786
  },
6715
6787
  '/acs/access_groups/list': {
6716
6788
  post: {
6789
+ description:
6790
+ 'Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6717
6791
  operationId: 'acsAccessGroupsListPost',
6718
6792
  requestBody: {
6719
6793
  content: {
6720
6794
  'application/json': {
6721
6795
  schema: {
6722
6796
  properties: {
6723
- acs_system_id: { format: 'uuid', type: 'string' },
6724
- acs_user_id: { format: 'uuid', type: 'string' },
6797
+ acs_system_id: {
6798
+ description:
6799
+ 'ID of the access control system for which you want to retrieve all access groups.',
6800
+ format: 'uuid',
6801
+ type: 'string',
6802
+ },
6803
+ acs_user_id: {
6804
+ description:
6805
+ 'ID of the user for which you want to retrieve all access groups.',
6806
+ format: 'uuid',
6807
+ type: 'string',
6808
+ },
6725
6809
  },
6726
6810
  type: 'object',
6727
6811
  },
@@ -6765,13 +6849,20 @@ export default {
6765
6849
  },
6766
6850
  '/acs/access_groups/list_accessible_entrances': {
6767
6851
  post: {
6852
+ description:
6853
+ '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
6854
  operationId: 'acsAccessGroupsListAccessibleEntrancesPost',
6769
6855
  requestBody: {
6770
6856
  content: {
6771
6857
  'application/json': {
6772
6858
  schema: {
6773
6859
  properties: {
6774
- acs_access_group_id: { format: 'uuid', type: 'string' },
6860
+ acs_access_group_id: {
6861
+ description:
6862
+ 'ID of the access group for which you want to retrieve all accessible entrances.',
6863
+ format: 'uuid',
6864
+ type: 'string',
6865
+ },
6775
6866
  },
6776
6867
  required: ['acs_access_group_id'],
6777
6868
  type: 'object',
@@ -6816,13 +6907,20 @@ export default {
6816
6907
  },
6817
6908
  '/acs/access_groups/list_users': {
6818
6909
  post: {
6910
+ description:
6911
+ '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
6912
  operationId: 'acsAccessGroupsListUsersPost',
6820
6913
  requestBody: {
6821
6914
  content: {
6822
6915
  'application/json': {
6823
6916
  schema: {
6824
6917
  properties: {
6825
- acs_access_group_id: { format: 'uuid', type: 'string' },
6918
+ acs_access_group_id: {
6919
+ description:
6920
+ 'ID of the access group for which you want to retrieve all users.',
6921
+ format: 'uuid',
6922
+ type: 'string',
6923
+ },
6826
6924
  },
6827
6925
  required: ['acs_access_group_id'],
6828
6926
  type: 'object',
@@ -6867,14 +6965,24 @@ export default {
6867
6965
  },
6868
6966
  '/acs/access_groups/remove_user': {
6869
6967
  post: {
6968
+ description:
6969
+ '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
6970
  operationId: 'acsAccessGroupsRemoveUserPost',
6871
6971
  requestBody: {
6872
6972
  content: {
6873
6973
  'application/json': {
6874
6974
  schema: {
6875
6975
  properties: {
6876
- acs_access_group_id: { format: 'uuid', type: 'string' },
6877
- acs_user_id: { format: 'uuid', type: 'string' },
6976
+ acs_access_group_id: {
6977
+ description: 'ID of the desired access group.',
6978
+ format: 'uuid',
6979
+ type: 'string',
6980
+ },
6981
+ acs_user_id: {
6982
+ description: 'ID of the desired user.',
6983
+ format: 'uuid',
6984
+ type: 'string',
6985
+ },
6878
6986
  },
6879
6987
  required: ['acs_access_group_id', 'acs_user_id'],
6880
6988
  type: 'object',
@@ -6912,13 +7020,19 @@ export default {
6912
7020
  },
6913
7021
  '/acs/access_groups/unmanaged/get': {
6914
7022
  post: {
7023
+ description:
7024
+ 'Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6915
7025
  operationId: 'acsAccessGroupsUnmanagedGetPost',
6916
7026
  requestBody: {
6917
7027
  content: {
6918
7028
  'application/json': {
6919
7029
  schema: {
6920
7030
  properties: {
6921
- acs_access_group_id: { format: 'uuid', type: 'string' },
7031
+ acs_access_group_id: {
7032
+ description: 'ID of the desired unmanaged access group.',
7033
+ format: 'uuid',
7034
+ type: 'string',
7035
+ },
6922
7036
  },
6923
7037
  required: ['acs_access_group_id'],
6924
7038
  type: 'object',
@@ -6950,11 +7064,27 @@ export default {
6950
7064
  type: 'string',
6951
7065
  'x-deprecated': 'use external_type_display_name',
6952
7066
  },
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' },
7067
+ acs_access_group_id: {
7068
+ description: 'ID of the access group.',
7069
+ format: 'uuid',
7070
+ type: 'string',
7071
+ },
7072
+ acs_system_id: {
7073
+ description:
7074
+ 'ID of the access control system that contains the access group.',
7075
+ format: 'uuid',
7076
+ type: 'string',
7077
+ },
7078
+ created_at: {
7079
+ description:
7080
+ 'Date and time at which the access group was created.',
7081
+ format: 'date-time',
7082
+ type: 'string',
7083
+ },
6956
7084
  display_name: { type: 'string' },
6957
7085
  external_type: {
7086
+ description:
7087
+ 'Brand-specific terminology for the access group type.',
6958
7088
  enum: [
6959
7089
  'pti_unit',
6960
7090
  'pti_access_level',
@@ -6963,10 +7093,22 @@ export default {
6963
7093
  ],
6964
7094
  type: 'string',
6965
7095
  },
6966
- external_type_display_name: { type: 'string' },
7096
+ external_type_display_name: {
7097
+ description:
7098
+ 'Display name that corresponds to the brand-specific terminology for the access group type.',
7099
+ type: 'string',
7100
+ },
6967
7101
  is_managed: { enum: [false], type: 'boolean' },
6968
- name: { type: 'string' },
6969
- workspace_id: { format: 'uuid', type: 'string' },
7102
+ name: {
7103
+ description: 'Name of the access group.',
7104
+ type: 'string',
7105
+ },
7106
+ workspace_id: {
7107
+ description:
7108
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.',
7109
+ format: 'uuid',
7110
+ type: 'string',
7111
+ },
6970
7112
  },
6971
7113
  required: [
6972
7114
  'acs_access_group_id',
@@ -7010,14 +7152,26 @@ export default {
7010
7152
  },
7011
7153
  '/acs/access_groups/unmanaged/list': {
7012
7154
  post: {
7155
+ description:
7156
+ 'Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
7013
7157
  operationId: 'acsAccessGroupsUnmanagedListPost',
7014
7158
  requestBody: {
7015
7159
  content: {
7016
7160
  'application/json': {
7017
7161
  schema: {
7018
7162
  properties: {
7019
- acs_system_id: { format: 'uuid', type: 'string' },
7020
- acs_user_id: { format: 'uuid', type: 'string' },
7163
+ acs_system_id: {
7164
+ description:
7165
+ 'ID of the access control system for which you want to retrieve all unmanaged access groups.',
7166
+ format: 'uuid',
7167
+ type: 'string',
7168
+ },
7169
+ acs_user_id: {
7170
+ description:
7171
+ 'ID of the user for which you want to retrieve all unmanaged access groups.',
7172
+ format: 'uuid',
7173
+ type: 'string',
7174
+ },
7021
7175
  },
7022
7176
  type: 'object',
7023
7177
  },
@@ -7050,13 +7204,26 @@ export default {
7050
7204
  'x-deprecated': 'use external_type_display_name',
7051
7205
  },
7052
7206
  acs_access_group_id: {
7207
+ description: 'ID of the access group.',
7053
7208
  format: 'uuid',
7054
7209
  type: 'string',
7055
7210
  },
7056
- acs_system_id: { format: 'uuid', type: 'string' },
7057
- created_at: { format: 'date-time', type: 'string' },
7211
+ acs_system_id: {
7212
+ description:
7213
+ 'ID of the access control system that contains the access group.',
7214
+ format: 'uuid',
7215
+ type: 'string',
7216
+ },
7217
+ created_at: {
7218
+ description:
7219
+ 'Date and time at which the access group was created.',
7220
+ format: 'date-time',
7221
+ type: 'string',
7222
+ },
7058
7223
  display_name: { type: 'string' },
7059
7224
  external_type: {
7225
+ description:
7226
+ 'Brand-specific terminology for the access group type.',
7060
7227
  enum: [
7061
7228
  'pti_unit',
7062
7229
  'pti_access_level',
@@ -7065,10 +7232,22 @@ export default {
7065
7232
  ],
7066
7233
  type: 'string',
7067
7234
  },
7068
- external_type_display_name: { type: 'string' },
7235
+ external_type_display_name: {
7236
+ description:
7237
+ 'Display name that corresponds to the brand-specific terminology for the access group type.',
7238
+ type: 'string',
7239
+ },
7069
7240
  is_managed: { enum: [false], type: 'boolean' },
7070
- name: { type: 'string' },
7071
- workspace_id: { format: 'uuid', type: 'string' },
7241
+ name: {
7242
+ description: 'Name of the access group.',
7243
+ type: 'string',
7244
+ },
7245
+ workspace_id: {
7246
+ description:
7247
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.',
7248
+ format: 'uuid',
7249
+ type: 'string',
7250
+ },
7072
7251
  },
7073
7252
  required: [
7074
7253
  'acs_access_group_id',