@seamapi/types 1.286.1 → 1.286.3

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 (49) hide show
  1. package/dist/connect.cjs +205 -60
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +458 -211
  4. package/lib/seam/connect/models/acs/acs-entrance.d.ts +14 -14
  5. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +18 -18
  6. package/lib/seam/connect/models/action-attempts/action-attempt.js +4 -4
  7. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
  8. package/lib/seam/connect/models/action-attempts/{encode-card.d.ts → encode-credential.d.ts} +11 -11
  9. package/lib/seam/connect/models/action-attempts/{encode-card.js → encode-credential.js} +6 -6
  10. package/lib/seam/connect/models/action-attempts/encode-credential.js.map +1 -0
  11. package/lib/seam/connect/models/action-attempts/{scan-card.d.ts → scan-credential.d.ts} +11 -11
  12. package/lib/seam/connect/models/action-attempts/{scan-card.js → scan-credential.js} +7 -7
  13. package/lib/seam/connect/models/action-attempts/scan-credential.js.map +1 -0
  14. package/lib/seam/connect/models/devices/device-metadata.d.ts +13 -0
  15. package/lib/seam/connect/models/devices/device-metadata.js +3 -0
  16. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  17. package/lib/seam/connect/models/devices/device-type.d.ts +5 -3
  18. package/lib/seam/connect/models/devices/device-type.js +1 -0
  19. package/lib/seam/connect/models/devices/device-type.js.map +1 -1
  20. package/lib/seam/connect/models/devices/device.d.ts +22 -3
  21. package/lib/seam/connect/models/devices/phone.d.ts +14 -1
  22. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +16 -3
  23. package/lib/seam/connect/models/events/acs/credentials.d.ts +61 -0
  24. package/lib/seam/connect/models/events/acs/credentials.js +9 -1
  25. package/lib/seam/connect/models/events/acs/credentials.js.map +1 -1
  26. package/lib/seam/connect/models/events/acs/index.d.ts +30 -0
  27. package/lib/seam/connect/models/events/action-attempts.d.ts +177 -0
  28. package/lib/seam/connect/models/events/action-attempts.js +16 -0
  29. package/lib/seam/connect/models/events/action-attempts.js.map +1 -1
  30. package/lib/seam/connect/models/events/seam-event.d.ts +147 -1
  31. package/lib/seam/connect/models/events/seam-event.js +2 -0
  32. package/lib/seam/connect/models/events/seam-event.js.map +1 -1
  33. package/lib/seam/connect/openapi.d.ts +24 -2
  34. package/lib/seam/connect/openapi.js +133 -37
  35. package/lib/seam/connect/openapi.js.map +1 -1
  36. package/lib/seam/connect/route-types.d.ts +217 -170
  37. package/package.json +1 -1
  38. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +4 -4
  39. package/src/lib/seam/connect/models/action-attempts/{encode-card.ts → encode-credential.ts} +8 -6
  40. package/src/lib/seam/connect/models/action-attempts/{scan-card.ts → scan-credential.ts} +9 -7
  41. package/src/lib/seam/connect/models/devices/device-metadata.ts +3 -0
  42. package/src/lib/seam/connect/models/devices/device-type.ts +1 -0
  43. package/src/lib/seam/connect/models/events/acs/credentials.ts +10 -1
  44. package/src/lib/seam/connect/models/events/action-attempts.ts +19 -0
  45. package/src/lib/seam/connect/models/events/seam-event.ts +2 -0
  46. package/src/lib/seam/connect/openapi.ts +138 -37
  47. package/src/lib/seam/connect/route-types.ts +245 -170
  48. package/lib/seam/connect/models/action-attempts/encode-card.js.map +0 -1
  49. package/lib/seam/connect/models/action-attempts/scan-card.js.map +0 -1
package/lib/seam/connect/openapi.js CHANGED
@@ -1251,7 +1251,7 @@ export default {
1251
1251
  type: 'object',
1252
1252
  },
1253
1253
  {
1254
- description: 'Reading card data from physical encoder.',
1254
+ description: 'Reading credential data from physical encoder.',
1255
1255
  properties: {
1256
1256
  action_attempt_id: {
1257
1257
  description: 'The ID of the action attempt.',
@@ -1259,7 +1259,7 @@ export default {
1259
1259
  type: 'string',
1260
1260
  'x-title': 'Action Attempt ID',
1261
1261
  },
1262
- action_type: { enum: ['SCAN_CARD'], type: 'string' },
1262
+ action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
1263
1263
  error: { nullable: true },
1264
1264
  result: { nullable: true },
1265
1265
  status: { enum: ['pending'], type: 'string' },
@@ -1274,7 +1274,7 @@ export default {
1274
1274
  type: 'object',
1275
1275
  },
1276
1276
  {
1277
- description: 'Reading card data from physical encoder succeeded.',
1277
+ description: 'Reading credential data from physical encoder succeeded.',
1278
1278
  properties: {
1279
1279
  action_attempt_id: {
1280
1280
  description: 'The ID of the action attempt.',
@@ -1282,12 +1282,12 @@ export default {
1282
1282
  type: 'string',
1283
1283
  'x-title': 'Action Attempt ID',
1284
1284
  },
1285
- action_type: { enum: ['SCAN_CARD'], type: 'string' },
1285
+ action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
1286
1286
  error: { nullable: true },
1287
1287
  result: {
1288
1288
  properties: {
1289
1289
  acs_credential_on_encoder: {
1290
- description: 'Snapshot of the card data read from the physical encoder.',
1290
+ description: 'Snapshot of credential data read from physical encoder.',
1291
1291
  properties: {
1292
1292
  card_number: {
1293
1293
  description: 'A number or string that physically identifies this card.',
@@ -1721,7 +1721,7 @@ export default {
1721
1721
  type: 'object',
1722
1722
  },
1723
1723
  {
1724
- description: 'Reading card data from physical encoder failed.',
1724
+ description: 'Reading credential data from physical encoder failed.',
1725
1725
  properties: {
1726
1726
  action_attempt_id: {
1727
1727
  description: 'The ID of the action attempt.',
@@ -1729,7 +1729,7 @@ export default {
1729
1729
  type: 'string',
1730
1730
  'x-title': 'Action Attempt ID',
1731
1731
  },
1732
- action_type: { enum: ['SCAN_CARD'], type: 'string' },
1732
+ action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
1733
1733
  error: {
1734
1734
  oneOf: [
1735
1735
  {
@@ -1774,7 +1774,7 @@ export default {
1774
1774
  type: 'object',
1775
1775
  },
1776
1776
  {
1777
- description: 'Encoding card data from physical encoder.',
1777
+ description: 'Encoding credential data from physical encoder.',
1778
1778
  properties: {
1779
1779
  action_attempt_id: {
1780
1780
  description: 'The ID of the action attempt.',
@@ -1782,7 +1782,7 @@ export default {
1782
1782
  type: 'string',
1783
1783
  'x-title': 'Action Attempt ID',
1784
1784
  },
1785
- action_type: { enum: ['ENCODE_CARD'], type: 'string' },
1785
+ action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
1786
1786
  error: { nullable: true },
1787
1787
  result: { nullable: true },
1788
1788
  status: { enum: ['pending'], type: 'string' },
@@ -1797,7 +1797,7 @@ export default {
1797
1797
  type: 'object',
1798
1798
  },
1799
1799
  {
1800
- description: 'Encoding card data from physical encoder succeeded.',
1800
+ description: 'Encoding credential data from physical encoder succeeded.',
1801
1801
  properties: {
1802
1802
  action_attempt_id: {
1803
1803
  description: 'The ID of the action attempt.',
@@ -1805,7 +1805,7 @@ export default {
1805
1805
  type: 'string',
1806
1806
  'x-title': 'Action Attempt ID',
1807
1807
  },
1808
- action_type: { enum: ['ENCODE_CARD'], type: 'string' },
1808
+ action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
1809
1809
  error: { nullable: true },
1810
1810
  result: {
1811
1811
  description: 'Means by which a user gains access at an entrance.\n\n The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
@@ -2142,7 +2142,7 @@ export default {
2142
2142
  type: 'object',
2143
2143
  },
2144
2144
  {
2145
- description: 'Encoding card data from physical encoder failed.',
2145
+ description: 'Encoding credential data from physical encoder failed.',
2146
2146
  properties: {
2147
2147
  action_attempt_id: {
2148
2148
  description: 'The ID of the action attempt.',
@@ -2150,7 +2150,7 @@ export default {
2150
2150
  type: 'string',
2151
2151
  'x-title': 'Action Attempt ID',
2152
2152
  },
2153
- action_type: { enum: ['ENCODE_CARD'], type: 'string' },
2153
+ action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
2154
2154
  error: {
2155
2155
  oneOf: [
2156
2156
  {
@@ -3533,7 +3533,10 @@ export default {
3533
3533
  type: 'string',
3534
3534
  },
3535
3535
  { enum: ['ios_phone', 'android_phone'], type: 'string' },
3536
- { enum: ['visionline_encoder'], type: 'string' },
3536
+ {
3537
+ enum: ['visionline_encoder', 'assa_abloy_vostio_encoder'],
3538
+ type: 'string',
3539
+ },
3537
3540
  ],
3538
3541
  },
3539
3542
  display_name: {
@@ -3800,6 +3803,11 @@ export default {
3800
3803
  required: ['gadget_name', 'gadget_id'],
3801
3804
  type: 'object',
3802
3805
  },
3806
+ assa_abloy_vostio_metadata: {
3807
+ properties: { encoder_id: { type: 'string' } },
3808
+ required: ['encoder_id'],
3809
+ type: 'object',
3810
+ },
3803
3811
  august_metadata: {
3804
3812
  properties: {
3805
3813
  has_keypad: { type: 'boolean' },
@@ -5273,7 +5281,10 @@ export default {
5273
5281
  type: 'string',
5274
5282
  },
5275
5283
  { enum: ['ios_phone', 'android_phone'], type: 'string' },
5276
- { enum: ['visionline_encoder'], type: 'string' },
5284
+ {
5285
+ enum: ['visionline_encoder', 'assa_abloy_vostio_encoder'],
5286
+ type: 'string',
5287
+ },
5277
5288
  ],
5278
5289
  },
5279
5290
  errors: {
@@ -6894,6 +6905,7 @@ export default {
6894
6905
  'x-fern-sdk-group-name': ['acs', 'access_groups'],
6895
6906
  'x-fern-sdk-method-name': 'add_user',
6896
6907
  'x-response-key': null,
6908
+ 'x-title': 'Add an ACS User to an Access Group',
6897
6909
  },
6898
6910
  put: {
6899
6911
  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).',
@@ -6945,6 +6957,7 @@ export default {
6945
6957
  tags: ['/acs'],
6946
6958
  'x-fern-ignore': true,
6947
6959
  'x-response-key': null,
6960
+ 'x-title': 'Add an ACS User to an Access Group',
6948
6961
  },
6949
6962
  },
6950
6963
  '/acs/access_groups/get': {
@@ -7000,6 +7013,7 @@ export default {
7000
7013
  'x-fern-sdk-method-name': 'get',
7001
7014
  'x-fern-sdk-return-value': 'acs_access_group',
7002
7015
  'x-response-key': 'acs_access_group',
7016
+ 'x-title': 'Get an Access Group',
7003
7017
  },
7004
7018
  },
7005
7019
  '/acs/access_groups/list': {
@@ -7060,6 +7074,7 @@ export default {
7060
7074
  'x-fern-sdk-method-name': 'list',
7061
7075
  'x-fern-sdk-return-value': 'acs_access_groups',
7062
7076
  'x-response-key': 'acs_access_groups',
7077
+ 'x-title': 'List Access Groups',
7063
7078
  },
7064
7079
  },
7065
7080
  '/acs/access_groups/list_accessible_entrances': {
@@ -7116,6 +7131,7 @@ export default {
7116
7131
  'x-fern-sdk-method-name': 'list_accessible_entrances',
7117
7132
  'x-fern-sdk-return-value': 'acs_entrances',
7118
7133
  'x-response-key': 'acs_entrances',
7134
+ 'x-title': 'List Entrances Accessible to an Access Group',
7119
7135
  },
7120
7136
  },
7121
7137
  '/acs/access_groups/list_users': {
@@ -7172,6 +7188,7 @@ export default {
7172
7188
  'x-fern-sdk-method-name': 'list_users',
7173
7189
  'x-fern-sdk-return-value': 'acs_users',
7174
7190
  'x-response-key': 'acs_users',
7191
+ 'x-title': 'List ACS Users in an Access Group',
7175
7192
  },
7176
7193
  },
7177
7194
  '/acs/access_groups/remove_user': {
@@ -7226,6 +7243,7 @@ export default {
7226
7243
  'x-fern-sdk-group-name': ['acs', 'access_groups'],
7227
7244
  'x-fern-sdk-method-name': 'remove_user',
7228
7245
  'x-response-key': null,
7246
+ 'x-title': 'Remove an ACS User from an Access Group',
7229
7247
  },
7230
7248
  },
7231
7249
  '/acs/access_groups/unmanaged/get': {
@@ -7780,6 +7798,7 @@ export default {
7780
7798
  description: 'Visionline-specific metadata for the new credential.',
7781
7799
  properties: {
7782
7800
  assa_abloy_credential_service_mobile_endpoint_id: {
7801
+ description: 'DEPRECATED: DO NOT USE',
7783
7802
  format: 'uuid',
7784
7803
  type: 'string',
7785
7804
  },
@@ -8848,16 +8867,24 @@ export default {
8848
8867
  'x-title': 'Update a Credential',
8849
8868
  },
8850
8869
  },
8851
- '/acs/encoders/encode_card': {
8870
+ '/acs/encoders/encode_credential': {
8852
8871
  post: {
8853
- operationId: 'acsEncodersEncodeCardPost',
8872
+ operationId: 'acsEncodersEncodeCredentialPost',
8854
8873
  requestBody: {
8855
8874
  content: {
8856
8875
  'application/json': {
8857
8876
  schema: {
8858
8877
  properties: {
8859
- acs_credential_id: { format: 'uuid', type: 'string' },
8860
- device_id: { format: 'uuid', type: 'string' },
8878
+ acs_credential_id: {
8879
+ description: 'ID of the acs_credential to encode on a physical card.',
8880
+ format: 'uuid',
8881
+ type: 'string',
8882
+ },
8883
+ device_id: {
8884
+ description: 'ID of the encoder to use for the encoding.',
8885
+ format: 'uuid',
8886
+ type: 'string',
8887
+ },
8861
8888
  },
8862
8889
  required: ['device_id', 'acs_credential_id'],
8863
8890
  type: 'object',
@@ -8891,10 +8918,10 @@ export default {
8891
8918
  { console_session: [] },
8892
8919
  { api_key: [] },
8893
8920
  ],
8894
- summary: '/acs/encoders/encode_card',
8921
+ summary: '/acs/encoders/encode_credential',
8895
8922
  tags: ['/acs'],
8896
8923
  'x-fern-sdk-group-name': ['acs', 'encoders'],
8897
- 'x-fern-sdk-method-name': 'encode_card',
8924
+ 'x-fern-sdk-method-name': 'encode_credential',
8898
8925
  'x-fern-sdk-return-value': 'action_attempt',
8899
8926
  'x-response-key': 'action_attempt',
8900
8927
  'x-undocumented': 'Encoding a card is currently unimplemented.',
@@ -8986,16 +9013,24 @@ export default {
8986
9013
  'x-undocumented': 'Encoders are in alpha.',
8987
9014
  },
8988
9015
  },
8989
- '/acs/encoders/scan_card': {
9016
+ '/acs/encoders/scan_credential': {
8990
9017
  post: {
8991
- operationId: 'acsEncodersScanCardPost',
9018
+ operationId: 'acsEncodersScanCredentialPost',
8992
9019
  requestBody: {
8993
9020
  content: {
8994
9021
  'application/json': {
8995
9022
  schema: {
8996
9023
  properties: {
8997
- acs_system_id: { format: 'uuid', type: 'string' },
8998
- device_id: { format: 'uuid', type: 'string' },
9024
+ acs_system_id: {
9025
+ description: 'ID of the acs_system the encoder belongs to.',
9026
+ format: 'uuid',
9027
+ type: 'string',
9028
+ },
9029
+ device_id: {
9030
+ description: 'ID of the encoder to use for the scan.',
9031
+ format: 'uuid',
9032
+ type: 'string',
9033
+ },
8999
9034
  },
9000
9035
  required: ['acs_system_id', 'device_id'],
9001
9036
  type: 'object',
@@ -9029,10 +9064,10 @@ export default {
9029
9064
  { console_session: [] },
9030
9065
  { api_key: [] },
9031
9066
  ],
9032
- summary: '/acs/encoders/scan_card',
9067
+ summary: '/acs/encoders/scan_credential',
9033
9068
  tags: ['/acs'],
9034
9069
  'x-fern-sdk-group-name': ['acs', 'encoders'],
9035
- 'x-fern-sdk-method-name': 'scan_card',
9070
+ 'x-fern-sdk-method-name': 'scan_credential',
9036
9071
  'x-fern-sdk-return-value': 'action_attempt',
9037
9072
  'x-response-key': 'action_attempt',
9038
9073
  'x-undocumented': 'Reading a card is currently unimplemented.',
@@ -9132,6 +9167,7 @@ export default {
9132
9167
  'x-fern-sdk-group-name': ['acs', 'entrances'],
9133
9168
  'x-fern-sdk-method-name': 'grant_access',
9134
9169
  'x-response-key': null,
9170
+ 'x-title': 'Grant an ACS User Access to an Entrance',
9135
9171
  },
9136
9172
  },
9137
9173
  '/acs/entrances/list': {
@@ -12232,7 +12268,13 @@ export default {
12232
12268
  type: 'string',
12233
12269
  },
12234
12270
  { enum: ['ios_phone', 'android_phone'], type: 'string' },
12235
- { enum: ['visionline_encoder'], type: 'string' },
12271
+ {
12272
+ enum: [
12273
+ 'visionline_encoder',
12274
+ 'assa_abloy_vostio_encoder',
12275
+ ],
12276
+ type: 'string',
12277
+ },
12236
12278
  ],
12237
12279
  },
12238
12280
  device_types: {
@@ -12286,7 +12328,13 @@ export default {
12286
12328
  enum: ['ios_phone', 'android_phone'],
12287
12329
  type: 'string',
12288
12330
  },
12289
- { enum: ['visionline_encoder'], type: 'string' },
12331
+ {
12332
+ enum: [
12333
+ 'visionline_encoder',
12334
+ 'assa_abloy_vostio_encoder',
12335
+ ],
12336
+ type: 'string',
12337
+ },
12290
12338
  ],
12291
12339
  },
12292
12340
  type: 'array',
@@ -12724,7 +12772,13 @@ export default {
12724
12772
  type: 'string',
12725
12773
  },
12726
12774
  { enum: ['ios_phone', 'android_phone'], type: 'string' },
12727
- { enum: ['visionline_encoder'], type: 'string' },
12775
+ {
12776
+ enum: [
12777
+ 'visionline_encoder',
12778
+ 'assa_abloy_vostio_encoder',
12779
+ ],
12780
+ type: 'string',
12781
+ },
12728
12782
  ],
12729
12783
  },
12730
12784
  device_types: {
@@ -12778,7 +12832,13 @@ export default {
12778
12832
  enum: ['ios_phone', 'android_phone'],
12779
12833
  type: 'string',
12780
12834
  },
12781
- { enum: ['visionline_encoder'], type: 'string' },
12835
+ {
12836
+ enum: [
12837
+ 'visionline_encoder',
12838
+ 'assa_abloy_vostio_encoder',
12839
+ ],
12840
+ type: 'string',
12841
+ },
12782
12842
  ],
12783
12843
  },
12784
12844
  type: 'array',
@@ -13516,7 +13576,13 @@ export default {
13516
13576
  type: 'string',
13517
13577
  },
13518
13578
  { enum: ['ios_phone', 'android_phone'], type: 'string' },
13519
- { enum: ['visionline_encoder'], type: 'string' },
13579
+ {
13580
+ enum: [
13581
+ 'visionline_encoder',
13582
+ 'assa_abloy_vostio_encoder',
13583
+ ],
13584
+ type: 'string',
13585
+ },
13520
13586
  ],
13521
13587
  },
13522
13588
  device_types: {
@@ -13570,7 +13636,13 @@ export default {
13570
13636
  enum: ['ios_phone', 'android_phone'],
13571
13637
  type: 'string',
13572
13638
  },
13573
- { enum: ['visionline_encoder'], type: 'string' },
13639
+ {
13640
+ enum: [
13641
+ 'visionline_encoder',
13642
+ 'assa_abloy_vostio_encoder',
13643
+ ],
13644
+ type: 'string',
13645
+ },
13574
13646
  ],
13575
13647
  },
13576
13648
  type: 'array',
@@ -13970,7 +14042,13 @@ export default {
13970
14042
  type: 'string',
13971
14043
  },
13972
14044
  { enum: ['ios_phone', 'android_phone'], type: 'string' },
13973
- { enum: ['visionline_encoder'], type: 'string' },
14045
+ {
14046
+ enum: [
14047
+ 'visionline_encoder',
14048
+ 'assa_abloy_vostio_encoder',
14049
+ ],
14050
+ type: 'string',
14051
+ },
13974
14052
  ],
13975
14053
  },
13976
14054
  device_types: {
@@ -14024,7 +14102,13 @@ export default {
14024
14102
  enum: ['ios_phone', 'android_phone'],
14025
14103
  type: 'string',
14026
14104
  },
14027
- { enum: ['visionline_encoder'], type: 'string' },
14105
+ {
14106
+ enum: [
14107
+ 'visionline_encoder',
14108
+ 'assa_abloy_vostio_encoder',
14109
+ ],
14110
+ type: 'string',
14111
+ },
14028
14112
  ],
14029
14113
  },
14030
14114
  type: 'array',
@@ -15236,7 +15320,13 @@ export default {
15236
15320
  type: 'string',
15237
15321
  },
15238
15322
  { enum: ['ios_phone', 'android_phone'], type: 'string' },
15239
- { enum: ['visionline_encoder'], type: 'string' },
15323
+ {
15324
+ enum: [
15325
+ 'visionline_encoder',
15326
+ 'assa_abloy_vostio_encoder',
15327
+ ],
15328
+ type: 'string',
15329
+ },
15240
15330
  ],
15241
15331
  },
15242
15332
  device_types: {
@@ -15290,7 +15380,13 @@ export default {
15290
15380
  enum: ['ios_phone', 'android_phone'],
15291
15381
  type: 'string',
15292
15382
  },
15293
- { enum: ['visionline_encoder'], type: 'string' },
15383
+ {
15384
+ enum: [
15385
+ 'visionline_encoder',
15386
+ 'assa_abloy_vostio_encoder',
15387
+ ],
15388
+ type: 'string',
15389
+ },
15294
15390
  ],
15295
15391
  },
15296
15392
  type: 'array',