@seamapi/types 1.286.0 → 1.286.2

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 +197 -56
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +454 -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 +20 -2
  34. package/lib/seam/connect/openapi.js +129 -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 +136 -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: {
@@ -7352,6 +7363,7 @@ export default {
7352
7363
  'x-fern-sdk-method-name': 'get',
7353
7364
  'x-fern-sdk-return-value': 'acs_access_group',
7354
7365
  'x-response-key': 'acs_access_group',
7366
+ 'x-undocumented': 'No unmanaged access groups are currently implemented.',
7355
7367
  },
7356
7368
  },
7357
7369
  '/acs/access_groups/unmanaged/list': {
@@ -7485,6 +7497,7 @@ export default {
7485
7497
  'x-fern-sdk-method-name': 'list',
7486
7498
  'x-fern-sdk-return-value': 'acs_access_groups',
7487
7499
  'x-response-key': 'acs_access_groups',
7500
+ 'x-undocumented': 'No unmanaged access groups are currently implemented.',
7488
7501
  },
7489
7502
  },
7490
7503
  '/acs/credential_pools/list': {
@@ -7778,6 +7791,7 @@ export default {
7778
7791
  description: 'Visionline-specific metadata for the new credential.',
7779
7792
  properties: {
7780
7793
  assa_abloy_credential_service_mobile_endpoint_id: {
7794
+ description: 'DEPRECATED: DO NOT USE',
7781
7795
  format: 'uuid',
7782
7796
  type: 'string',
7783
7797
  },
@@ -8460,6 +8474,7 @@ export default {
8460
8474
  'x-fern-sdk-return-value': 'acs_credential',
8461
8475
  'x-response-key': 'acs_credential',
8462
8476
  'x-title': 'Get an Unmanaged Credential',
8477
+ 'x-undocumented': 'No unmanaged credentials are currently implemented.',
8463
8478
  },
8464
8479
  },
8465
8480
  '/acs/credentials/unmanaged/list': {
@@ -8717,6 +8732,7 @@ export default {
8717
8732
  'x-fern-sdk-return-value': 'acs_credentials',
8718
8733
  'x-response-key': 'acs_credentials',
8719
8734
  'x-title': 'List Unmanaged Credentials',
8735
+ 'x-undocumented': 'No unmanaged credentials are currently implemented.',
8720
8736
  },
8721
8737
  },
8722
8738
  '/acs/credentials/update': {
@@ -8844,16 +8860,24 @@ export default {
8844
8860
  'x-title': 'Update a Credential',
8845
8861
  },
8846
8862
  },
8847
- '/acs/encoders/encode_card': {
8863
+ '/acs/encoders/encode_credential': {
8848
8864
  post: {
8849
- operationId: 'acsEncodersEncodeCardPost',
8865
+ operationId: 'acsEncodersEncodeCredentialPost',
8850
8866
  requestBody: {
8851
8867
  content: {
8852
8868
  'application/json': {
8853
8869
  schema: {
8854
8870
  properties: {
8855
- acs_credential_id: { format: 'uuid', type: 'string' },
8856
- device_id: { format: 'uuid', type: 'string' },
8871
+ acs_credential_id: {
8872
+ description: 'ID of the acs_credential to encode on a physical card.',
8873
+ format: 'uuid',
8874
+ type: 'string',
8875
+ },
8876
+ device_id: {
8877
+ description: 'ID of the encoder to use for the encoding.',
8878
+ format: 'uuid',
8879
+ type: 'string',
8880
+ },
8857
8881
  },
8858
8882
  required: ['device_id', 'acs_credential_id'],
8859
8883
  type: 'object',
@@ -8887,10 +8911,10 @@ export default {
8887
8911
  { console_session: [] },
8888
8912
  { api_key: [] },
8889
8913
  ],
8890
- summary: '/acs/encoders/encode_card',
8914
+ summary: '/acs/encoders/encode_credential',
8891
8915
  tags: ['/acs'],
8892
8916
  'x-fern-sdk-group-name': ['acs', 'encoders'],
8893
- 'x-fern-sdk-method-name': 'encode_card',
8917
+ 'x-fern-sdk-method-name': 'encode_credential',
8894
8918
  'x-fern-sdk-return-value': 'action_attempt',
8895
8919
  'x-response-key': 'action_attempt',
8896
8920
  'x-undocumented': 'Encoding a card is currently unimplemented.',
@@ -8982,16 +9006,24 @@ export default {
8982
9006
  'x-undocumented': 'Encoders are in alpha.',
8983
9007
  },
8984
9008
  },
8985
- '/acs/encoders/scan_card': {
9009
+ '/acs/encoders/scan_credential': {
8986
9010
  post: {
8987
- operationId: 'acsEncodersScanCardPost',
9011
+ operationId: 'acsEncodersScanCredentialPost',
8988
9012
  requestBody: {
8989
9013
  content: {
8990
9014
  'application/json': {
8991
9015
  schema: {
8992
9016
  properties: {
8993
- acs_system_id: { format: 'uuid', type: 'string' },
8994
- device_id: { format: 'uuid', type: 'string' },
9017
+ acs_system_id: {
9018
+ description: 'ID of the acs_system the encoder belongs to.',
9019
+ format: 'uuid',
9020
+ type: 'string',
9021
+ },
9022
+ device_id: {
9023
+ description: 'ID of the encoder to use for the scan.',
9024
+ format: 'uuid',
9025
+ type: 'string',
9026
+ },
8995
9027
  },
8996
9028
  required: ['acs_system_id', 'device_id'],
8997
9029
  type: 'object',
@@ -9025,10 +9057,10 @@ export default {
9025
9057
  { console_session: [] },
9026
9058
  { api_key: [] },
9027
9059
  ],
9028
- summary: '/acs/encoders/scan_card',
9060
+ summary: '/acs/encoders/scan_credential',
9029
9061
  tags: ['/acs'],
9030
9062
  'x-fern-sdk-group-name': ['acs', 'encoders'],
9031
- 'x-fern-sdk-method-name': 'scan_card',
9063
+ 'x-fern-sdk-method-name': 'scan_credential',
9032
9064
  'x-fern-sdk-return-value': 'action_attempt',
9033
9065
  'x-response-key': 'action_attempt',
9034
9066
  'x-undocumented': 'Reading a card is currently unimplemented.',
@@ -12228,7 +12260,13 @@ export default {
12228
12260
  type: 'string',
12229
12261
  },
12230
12262
  { enum: ['ios_phone', 'android_phone'], type: 'string' },
12231
- { enum: ['visionline_encoder'], type: 'string' },
12263
+ {
12264
+ enum: [
12265
+ 'visionline_encoder',
12266
+ 'assa_abloy_vostio_encoder',
12267
+ ],
12268
+ type: 'string',
12269
+ },
12232
12270
  ],
12233
12271
  },
12234
12272
  device_types: {
@@ -12282,7 +12320,13 @@ export default {
12282
12320
  enum: ['ios_phone', 'android_phone'],
12283
12321
  type: 'string',
12284
12322
  },
12285
- { enum: ['visionline_encoder'], type: 'string' },
12323
+ {
12324
+ enum: [
12325
+ 'visionline_encoder',
12326
+ 'assa_abloy_vostio_encoder',
12327
+ ],
12328
+ type: 'string',
12329
+ },
12286
12330
  ],
12287
12331
  },
12288
12332
  type: 'array',
@@ -12720,7 +12764,13 @@ export default {
12720
12764
  type: 'string',
12721
12765
  },
12722
12766
  { enum: ['ios_phone', 'android_phone'], type: 'string' },
12723
- { enum: ['visionline_encoder'], type: 'string' },
12767
+ {
12768
+ enum: [
12769
+ 'visionline_encoder',
12770
+ 'assa_abloy_vostio_encoder',
12771
+ ],
12772
+ type: 'string',
12773
+ },
12724
12774
  ],
12725
12775
  },
12726
12776
  device_types: {
@@ -12774,7 +12824,13 @@ export default {
12774
12824
  enum: ['ios_phone', 'android_phone'],
12775
12825
  type: 'string',
12776
12826
  },
12777
- { enum: ['visionline_encoder'], type: 'string' },
12827
+ {
12828
+ enum: [
12829
+ 'visionline_encoder',
12830
+ 'assa_abloy_vostio_encoder',
12831
+ ],
12832
+ type: 'string',
12833
+ },
12778
12834
  ],
12779
12835
  },
12780
12836
  type: 'array',
@@ -13512,7 +13568,13 @@ export default {
13512
13568
  type: 'string',
13513
13569
  },
13514
13570
  { enum: ['ios_phone', 'android_phone'], type: 'string' },
13515
- { enum: ['visionline_encoder'], type: 'string' },
13571
+ {
13572
+ enum: [
13573
+ 'visionline_encoder',
13574
+ 'assa_abloy_vostio_encoder',
13575
+ ],
13576
+ type: 'string',
13577
+ },
13516
13578
  ],
13517
13579
  },
13518
13580
  device_types: {
@@ -13566,7 +13628,13 @@ export default {
13566
13628
  enum: ['ios_phone', 'android_phone'],
13567
13629
  type: 'string',
13568
13630
  },
13569
- { enum: ['visionline_encoder'], type: 'string' },
13631
+ {
13632
+ enum: [
13633
+ 'visionline_encoder',
13634
+ 'assa_abloy_vostio_encoder',
13635
+ ],
13636
+ type: 'string',
13637
+ },
13570
13638
  ],
13571
13639
  },
13572
13640
  type: 'array',
@@ -13966,7 +14034,13 @@ export default {
13966
14034
  type: 'string',
13967
14035
  },
13968
14036
  { enum: ['ios_phone', 'android_phone'], type: 'string' },
13969
- { enum: ['visionline_encoder'], type: 'string' },
14037
+ {
14038
+ enum: [
14039
+ 'visionline_encoder',
14040
+ 'assa_abloy_vostio_encoder',
14041
+ ],
14042
+ type: 'string',
14043
+ },
13970
14044
  ],
13971
14045
  },
13972
14046
  device_types: {
@@ -14020,7 +14094,13 @@ export default {
14020
14094
  enum: ['ios_phone', 'android_phone'],
14021
14095
  type: 'string',
14022
14096
  },
14023
- { enum: ['visionline_encoder'], type: 'string' },
14097
+ {
14098
+ enum: [
14099
+ 'visionline_encoder',
14100
+ 'assa_abloy_vostio_encoder',
14101
+ ],
14102
+ type: 'string',
14103
+ },
14024
14104
  ],
14025
14105
  },
14026
14106
  type: 'array',
@@ -15232,7 +15312,13 @@ export default {
15232
15312
  type: 'string',
15233
15313
  },
15234
15314
  { enum: ['ios_phone', 'android_phone'], type: 'string' },
15235
- { enum: ['visionline_encoder'], type: 'string' },
15315
+ {
15316
+ enum: [
15317
+ 'visionline_encoder',
15318
+ 'assa_abloy_vostio_encoder',
15319
+ ],
15320
+ type: 'string',
15321
+ },
15236
15322
  ],
15237
15323
  },
15238
15324
  device_types: {
@@ -15286,7 +15372,13 @@ export default {
15286
15372
  enum: ['ios_phone', 'android_phone'],
15287
15373
  type: 'string',
15288
15374
  },
15289
- { enum: ['visionline_encoder'], type: 'string' },
15375
+ {
15376
+ enum: [
15377
+ 'visionline_encoder',
15378
+ 'assa_abloy_vostio_encoder',
15379
+ ],
15380
+ type: 'string',
15381
+ },
15290
15382
  ],
15291
15383
  },
15292
15384
  type: 'array',