@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/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',
@@ -3826,6 +3852,7 @@ export default {
3826
3852
  properties: {
3827
3853
  custom_name: { type: 'string' },
3828
3854
  device_name: { type: 'string' },
3855
+ display_name: { type: 'string' },
3829
3856
  nest_device_id: { type: 'string' },
3830
3857
  },
3831
3858
  required: [
@@ -6576,14 +6603,24 @@ export default {
6576
6603
  },
6577
6604
  '/acs/access_groups/add_user': {
6578
6605
  post: {
6606
+ description:
6607
+ '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).',
6579
6608
  operationId: 'acsAccessGroupsAddUserPost',
6580
6609
  requestBody: {
6581
6610
  content: {
6582
6611
  'application/json': {
6583
6612
  schema: {
6584
6613
  properties: {
6585
- acs_access_group_id: { format: 'uuid', type: 'string' },
6586
- acs_user_id: { format: 'uuid', type: 'string' },
6614
+ acs_access_group_id: {
6615
+ description: 'ID of the desired access group.',
6616
+ format: 'uuid',
6617
+ type: 'string',
6618
+ },
6619
+ acs_user_id: {
6620
+ description: 'ID of the desired user.',
6621
+ format: 'uuid',
6622
+ type: 'string',
6623
+ },
6587
6624
  },
6588
6625
  required: ['acs_access_group_id', 'acs_user_id'],
6589
6626
  type: 'object',
@@ -6619,14 +6656,24 @@ export default {
6619
6656
  'x-response-key': null,
6620
6657
  },
6621
6658
  put: {
6659
+ description:
6660
+ '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).',
6622
6661
  operationId: 'acsAccessGroupsAddUserPut',
6623
6662
  requestBody: {
6624
6663
  content: {
6625
6664
  'application/json': {
6626
6665
  schema: {
6627
6666
  properties: {
6628
- acs_access_group_id: { format: 'uuid', type: 'string' },
6629
- acs_user_id: { format: 'uuid', type: 'string' },
6667
+ acs_access_group_id: {
6668
+ description: 'ID of the desired access group.',
6669
+ format: 'uuid',
6670
+ type: 'string',
6671
+ },
6672
+ acs_user_id: {
6673
+ description: 'ID of the desired user.',
6674
+ format: 'uuid',
6675
+ type: 'string',
6676
+ },
6630
6677
  },
6631
6678
  required: ['acs_access_group_id', 'acs_user_id'],
6632
6679
  type: 'object',
@@ -6663,13 +6710,19 @@ export default {
6663
6710
  },
6664
6711
  '/acs/access_groups/get': {
6665
6712
  post: {
6713
+ description:
6714
+ 'Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6666
6715
  operationId: 'acsAccessGroupsGetPost',
6667
6716
  requestBody: {
6668
6717
  content: {
6669
6718
  'application/json': {
6670
6719
  schema: {
6671
6720
  properties: {
6672
- acs_access_group_id: { format: 'uuid', type: 'string' },
6721
+ acs_access_group_id: {
6722
+ description: 'ID of the desired access group.',
6723
+ format: 'uuid',
6724
+ type: 'string',
6725
+ },
6673
6726
  },
6674
6727
  required: ['acs_access_group_id'],
6675
6728
  type: 'object',
@@ -6713,14 +6766,26 @@ export default {
6713
6766
  },
6714
6767
  '/acs/access_groups/list': {
6715
6768
  post: {
6769
+ description:
6770
+ 'Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6716
6771
  operationId: 'acsAccessGroupsListPost',
6717
6772
  requestBody: {
6718
6773
  content: {
6719
6774
  'application/json': {
6720
6775
  schema: {
6721
6776
  properties: {
6722
- acs_system_id: { format: 'uuid', type: 'string' },
6723
- acs_user_id: { format: 'uuid', type: 'string' },
6777
+ acs_system_id: {
6778
+ description:
6779
+ 'ID of the access control system for which you want to retrieve all access groups.',
6780
+ format: 'uuid',
6781
+ type: 'string',
6782
+ },
6783
+ acs_user_id: {
6784
+ description:
6785
+ 'ID of the user for which you want to retrieve all access groups.',
6786
+ format: 'uuid',
6787
+ type: 'string',
6788
+ },
6724
6789
  },
6725
6790
  type: 'object',
6726
6791
  },
@@ -6764,13 +6829,20 @@ export default {
6764
6829
  },
6765
6830
  '/acs/access_groups/list_accessible_entrances': {
6766
6831
  post: {
6832
+ description:
6833
+ '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).',
6767
6834
  operationId: 'acsAccessGroupsListAccessibleEntrancesPost',
6768
6835
  requestBody: {
6769
6836
  content: {
6770
6837
  'application/json': {
6771
6838
  schema: {
6772
6839
  properties: {
6773
- acs_access_group_id: { format: 'uuid', type: 'string' },
6840
+ acs_access_group_id: {
6841
+ description:
6842
+ 'ID of the access group for which you want to retrieve all accessible entrances.',
6843
+ format: 'uuid',
6844
+ type: 'string',
6845
+ },
6774
6846
  },
6775
6847
  required: ['acs_access_group_id'],
6776
6848
  type: 'object',
@@ -6815,13 +6887,20 @@ export default {
6815
6887
  },
6816
6888
  '/acs/access_groups/list_users': {
6817
6889
  post: {
6890
+ description:
6891
+ '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).',
6818
6892
  operationId: 'acsAccessGroupsListUsersPost',
6819
6893
  requestBody: {
6820
6894
  content: {
6821
6895
  'application/json': {
6822
6896
  schema: {
6823
6897
  properties: {
6824
- acs_access_group_id: { format: 'uuid', type: 'string' },
6898
+ acs_access_group_id: {
6899
+ description:
6900
+ 'ID of the access group for which you want to retrieve all users.',
6901
+ format: 'uuid',
6902
+ type: 'string',
6903
+ },
6825
6904
  },
6826
6905
  required: ['acs_access_group_id'],
6827
6906
  type: 'object',
@@ -6866,14 +6945,24 @@ export default {
6866
6945
  },
6867
6946
  '/acs/access_groups/remove_user': {
6868
6947
  post: {
6948
+ description:
6949
+ '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).',
6869
6950
  operationId: 'acsAccessGroupsRemoveUserPost',
6870
6951
  requestBody: {
6871
6952
  content: {
6872
6953
  'application/json': {
6873
6954
  schema: {
6874
6955
  properties: {
6875
- acs_access_group_id: { format: 'uuid', type: 'string' },
6876
- acs_user_id: { format: 'uuid', type: 'string' },
6956
+ acs_access_group_id: {
6957
+ description: 'ID of the desired access group.',
6958
+ format: 'uuid',
6959
+ type: 'string',
6960
+ },
6961
+ acs_user_id: {
6962
+ description: 'ID of the desired user.',
6963
+ format: 'uuid',
6964
+ type: 'string',
6965
+ },
6877
6966
  },
6878
6967
  required: ['acs_access_group_id', 'acs_user_id'],
6879
6968
  type: 'object',
@@ -6911,13 +7000,19 @@ export default {
6911
7000
  },
6912
7001
  '/acs/access_groups/unmanaged/get': {
6913
7002
  post: {
7003
+ description:
7004
+ 'Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
6914
7005
  operationId: 'acsAccessGroupsUnmanagedGetPost',
6915
7006
  requestBody: {
6916
7007
  content: {
6917
7008
  'application/json': {
6918
7009
  schema: {
6919
7010
  properties: {
6920
- acs_access_group_id: { format: 'uuid', type: 'string' },
7011
+ acs_access_group_id: {
7012
+ description: 'ID of the desired unmanaged access group.',
7013
+ format: 'uuid',
7014
+ type: 'string',
7015
+ },
6921
7016
  },
6922
7017
  required: ['acs_access_group_id'],
6923
7018
  type: 'object',
@@ -6949,11 +7044,27 @@ export default {
6949
7044
  type: 'string',
6950
7045
  'x-deprecated': 'use external_type_display_name',
6951
7046
  },
6952
- acs_access_group_id: { format: 'uuid', type: 'string' },
6953
- acs_system_id: { format: 'uuid', type: 'string' },
6954
- created_at: { format: 'date-time', type: 'string' },
7047
+ acs_access_group_id: {
7048
+ description: 'ID of the access group.',
7049
+ format: 'uuid',
7050
+ type: 'string',
7051
+ },
7052
+ acs_system_id: {
7053
+ description:
7054
+ 'ID of the access control system that contains the access group.',
7055
+ format: 'uuid',
7056
+ type: 'string',
7057
+ },
7058
+ created_at: {
7059
+ description:
7060
+ 'Date and time at which the access group was created.',
7061
+ format: 'date-time',
7062
+ type: 'string',
7063
+ },
6955
7064
  display_name: { type: 'string' },
6956
7065
  external_type: {
7066
+ description:
7067
+ 'Brand-specific terminology for the access group type.',
6957
7068
  enum: [
6958
7069
  'pti_unit',
6959
7070
  'pti_access_level',
@@ -6962,10 +7073,22 @@ export default {
6962
7073
  ],
6963
7074
  type: 'string',
6964
7075
  },
6965
- external_type_display_name: { type: 'string' },
7076
+ external_type_display_name: {
7077
+ description:
7078
+ 'Display name that corresponds to the brand-specific terminology for the access group type.',
7079
+ type: 'string',
7080
+ },
6966
7081
  is_managed: { enum: [false], type: 'boolean' },
6967
- name: { type: 'string' },
6968
- workspace_id: { format: 'uuid', type: 'string' },
7082
+ name: {
7083
+ description: 'Name of the access group.',
7084
+ type: 'string',
7085
+ },
7086
+ workspace_id: {
7087
+ description:
7088
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.',
7089
+ format: 'uuid',
7090
+ type: 'string',
7091
+ },
6969
7092
  },
6970
7093
  required: [
6971
7094
  'acs_access_group_id',
@@ -7009,14 +7132,26 @@ export default {
7009
7132
  },
7010
7133
  '/acs/access_groups/unmanaged/list': {
7011
7134
  post: {
7135
+ description:
7136
+ 'Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
7012
7137
  operationId: 'acsAccessGroupsUnmanagedListPost',
7013
7138
  requestBody: {
7014
7139
  content: {
7015
7140
  'application/json': {
7016
7141
  schema: {
7017
7142
  properties: {
7018
- acs_system_id: { format: 'uuid', type: 'string' },
7019
- acs_user_id: { format: 'uuid', type: 'string' },
7143
+ acs_system_id: {
7144
+ description:
7145
+ 'ID of the access control system for which you want to retrieve all unmanaged access groups.',
7146
+ format: 'uuid',
7147
+ type: 'string',
7148
+ },
7149
+ acs_user_id: {
7150
+ description:
7151
+ 'ID of the user for which you want to retrieve all unmanaged access groups.',
7152
+ format: 'uuid',
7153
+ type: 'string',
7154
+ },
7020
7155
  },
7021
7156
  type: 'object',
7022
7157
  },
@@ -7049,13 +7184,26 @@ export default {
7049
7184
  'x-deprecated': 'use external_type_display_name',
7050
7185
  },
7051
7186
  acs_access_group_id: {
7187
+ description: 'ID of the access group.',
7052
7188
  format: 'uuid',
7053
7189
  type: 'string',
7054
7190
  },
7055
- acs_system_id: { format: 'uuid', type: 'string' },
7056
- created_at: { format: 'date-time', type: 'string' },
7191
+ acs_system_id: {
7192
+ description:
7193
+ 'ID of the access control system that contains the access group.',
7194
+ format: 'uuid',
7195
+ type: 'string',
7196
+ },
7197
+ created_at: {
7198
+ description:
7199
+ 'Date and time at which the access group was created.',
7200
+ format: 'date-time',
7201
+ type: 'string',
7202
+ },
7057
7203
  display_name: { type: 'string' },
7058
7204
  external_type: {
7205
+ description:
7206
+ 'Brand-specific terminology for the access group type.',
7059
7207
  enum: [
7060
7208
  'pti_unit',
7061
7209
  'pti_access_level',
@@ -7064,10 +7212,22 @@ export default {
7064
7212
  ],
7065
7213
  type: 'string',
7066
7214
  },
7067
- external_type_display_name: { type: 'string' },
7215
+ external_type_display_name: {
7216
+ description:
7217
+ 'Display name that corresponds to the brand-specific terminology for the access group type.',
7218
+ type: 'string',
7219
+ },
7068
7220
  is_managed: { enum: [false], type: 'boolean' },
7069
- name: { type: 'string' },
7070
- workspace_id: { format: 'uuid', type: 'string' },
7221
+ name: {
7222
+ description: 'Name of the access group.',
7223
+ type: 'string',
7224
+ },
7225
+ workspace_id: {
7226
+ description:
7227
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.',
7228
+ format: 'uuid',
7229
+ type: 'string',
7230
+ },
7071
7231
  },
7072
7232
  required: [
7073
7233
  'acs_access_group_id',