@seamapi/types 1.287.3 → 1.288.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 (24) hide show
  1. package/dist/connect.cjs +50 -54
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +189 -172
  4. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +18 -18
  5. package/lib/seam/connect/models/action-attempts/action-attempt.js +4 -4
  6. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
  7. package/lib/seam/connect/models/action-attempts/{encode-credential.d.ts → encode-card.d.ts} +11 -11
  8. package/lib/seam/connect/models/action-attempts/{encode-credential.js → encode-card.js} +6 -6
  9. package/lib/seam/connect/models/action-attempts/encode-card.js.map +1 -0
  10. package/lib/seam/connect/models/action-attempts/{scan-credential.d.ts → scan-card.d.ts} +11 -11
  11. package/lib/seam/connect/models/action-attempts/{scan-credential.js → scan-card.js} +7 -7
  12. package/lib/seam/connect/models/action-attempts/scan-card.js.map +1 -0
  13. package/lib/seam/connect/openapi.d.ts +21 -6
  14. package/lib/seam/connect/openapi.js +37 -41
  15. package/lib/seam/connect/openapi.js.map +1 -1
  16. package/lib/seam/connect/route-types.d.ts +150 -148
  17. package/package.json +1 -1
  18. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +4 -4
  19. package/src/lib/seam/connect/models/action-attempts/{encode-credential.ts → encode-card.ts} +6 -8
  20. package/src/lib/seam/connect/models/action-attempts/{scan-credential.ts → scan-card.ts} +7 -9
  21. package/src/lib/seam/connect/openapi.ts +38 -46
  22. package/src/lib/seam/connect/route-types.ts +152 -148
  23. package/lib/seam/connect/models/action-attempts/encode-credential.js.map +0 -1
  24. package/lib/seam/connect/models/action-attempts/scan-credential.js.map +0 -1
package/lib/seam/connect/openapi.js CHANGED
@@ -1260,7 +1260,7 @@ export default {
1260
1260
  type: 'object',
1261
1261
  },
1262
1262
  {
1263
- description: 'Reading credential data from physical encoder.',
1263
+ description: 'Reading card data from physical encoder.',
1264
1264
  properties: {
1265
1265
  action_attempt_id: {
1266
1266
  description: 'The ID of the action attempt.',
@@ -1268,7 +1268,7 @@ export default {
1268
1268
  type: 'string',
1269
1269
  'x-title': 'Action Attempt ID',
1270
1270
  },
1271
- action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
1271
+ action_type: { enum: ['SCAN_CARD'], type: 'string' },
1272
1272
  error: { nullable: true },
1273
1273
  result: { nullable: true },
1274
1274
  status: { enum: ['pending'], type: 'string' },
@@ -1283,7 +1283,7 @@ export default {
1283
1283
  type: 'object',
1284
1284
  },
1285
1285
  {
1286
- description: 'Reading credential data from physical encoder succeeded.',
1286
+ description: 'Reading card data from physical encoder succeeded.',
1287
1287
  properties: {
1288
1288
  action_attempt_id: {
1289
1289
  description: 'The ID of the action attempt.',
@@ -1291,12 +1291,12 @@ export default {
1291
1291
  type: 'string',
1292
1292
  'x-title': 'Action Attempt ID',
1293
1293
  },
1294
- action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
1294
+ action_type: { enum: ['SCAN_CARD'], type: 'string' },
1295
1295
  error: { nullable: true },
1296
1296
  result: {
1297
1297
  properties: {
1298
1298
  acs_credential_on_encoder: {
1299
- description: 'Snapshot of credential data read from physical encoder.',
1299
+ description: 'Snapshot of the card data read from the physical encoder.',
1300
1300
  properties: {
1301
1301
  card_number: {
1302
1302
  description: 'A number or string that physically identifies this card.',
@@ -1730,7 +1730,7 @@ export default {
1730
1730
  type: 'object',
1731
1731
  },
1732
1732
  {
1733
- description: 'Reading credential data from physical encoder failed.',
1733
+ description: 'Reading card data from physical encoder failed.',
1734
1734
  properties: {
1735
1735
  action_attempt_id: {
1736
1736
  description: 'The ID of the action attempt.',
@@ -1738,7 +1738,7 @@ export default {
1738
1738
  type: 'string',
1739
1739
  'x-title': 'Action Attempt ID',
1740
1740
  },
1741
- action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
1741
+ action_type: { enum: ['SCAN_CARD'], type: 'string' },
1742
1742
  error: {
1743
1743
  oneOf: [
1744
1744
  {
@@ -1783,7 +1783,7 @@ export default {
1783
1783
  type: 'object',
1784
1784
  },
1785
1785
  {
1786
- description: 'Encoding credential data from physical encoder.',
1786
+ description: 'Encoding card data from physical encoder.',
1787
1787
  properties: {
1788
1788
  action_attempt_id: {
1789
1789
  description: 'The ID of the action attempt.',
@@ -1791,7 +1791,7 @@ export default {
1791
1791
  type: 'string',
1792
1792
  'x-title': 'Action Attempt ID',
1793
1793
  },
1794
- action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
1794
+ action_type: { enum: ['ENCODE_CARD'], type: 'string' },
1795
1795
  error: { nullable: true },
1796
1796
  result: { nullable: true },
1797
1797
  status: { enum: ['pending'], type: 'string' },
@@ -1806,7 +1806,7 @@ export default {
1806
1806
  type: 'object',
1807
1807
  },
1808
1808
  {
1809
- description: 'Encoding credential data from physical encoder succeeded.',
1809
+ description: 'Encoding card data from physical encoder succeeded.',
1810
1810
  properties: {
1811
1811
  action_attempt_id: {
1812
1812
  description: 'The ID of the action attempt.',
@@ -1814,7 +1814,7 @@ export default {
1814
1814
  type: 'string',
1815
1815
  'x-title': 'Action Attempt ID',
1816
1816
  },
1817
- action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
1817
+ action_type: { enum: ['ENCODE_CARD'], type: 'string' },
1818
1818
  error: { nullable: true },
1819
1819
  result: {
1820
1820
  description: 'Means by which a user gains access at an entrance.\nThe `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.',
@@ -2151,7 +2151,7 @@ export default {
2151
2151
  type: 'object',
2152
2152
  },
2153
2153
  {
2154
- description: 'Encoding credential data from physical encoder failed.',
2154
+ description: 'Encoding card data from physical encoder failed.',
2155
2155
  properties: {
2156
2156
  action_attempt_id: {
2157
2157
  description: 'The ID of the action attempt.',
@@ -2159,7 +2159,7 @@ export default {
2159
2159
  type: 'string',
2160
2160
  'x-title': 'Action Attempt ID',
2161
2161
  },
2162
- action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
2162
+ action_type: { enum: ['ENCODE_CARD'], type: 'string' },
2163
2163
  error: {
2164
2164
  oneOf: [
2165
2165
  {
@@ -7761,6 +7761,18 @@ export default {
7761
7761
  items: { format: 'uuid', type: 'string' },
7762
7762
  type: 'array',
7763
7763
  },
7764
+ assa_abloy_vostio_metadata: {
7765
+ description: 'Vostio-specific metadata for the new credential.',
7766
+ properties: {
7767
+ join_all_guest_acs_entrances: { type: 'boolean' },
7768
+ override_all_guest_acs_entrances: { type: 'boolean' },
7769
+ override_guest_acs_entrance_ids: {
7770
+ items: { format: 'uuid', type: 'string' },
7771
+ type: 'array',
7772
+ },
7773
+ },
7774
+ type: 'object',
7775
+ },
7764
7776
  code: {
7765
7777
  description: 'Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview).',
7766
7778
  pattern: '^\\d+$',
@@ -8859,24 +8871,16 @@ export default {
8859
8871
  'x-title': 'Update a Credential',
8860
8872
  },
8861
8873
  },
8862
- '/acs/encoders/encode_credential': {
8874
+ '/acs/encoders/encode_card': {
8863
8875
  post: {
8864
- operationId: 'acsEncodersEncodeCredentialPost',
8876
+ operationId: 'acsEncodersEncodeCardPost',
8865
8877
  requestBody: {
8866
8878
  content: {
8867
8879
  'application/json': {
8868
8880
  schema: {
8869
8881
  properties: {
8870
- acs_credential_id: {
8871
- description: 'ID of the acs_credential to encode on a physical card.',
8872
- format: 'uuid',
8873
- type: 'string',
8874
- },
8875
- device_id: {
8876
- description: 'ID of the encoder to use for the encoding.',
8877
- format: 'uuid',
8878
- type: 'string',
8879
- },
8882
+ acs_credential_id: { format: 'uuid', type: 'string' },
8883
+ device_id: { format: 'uuid', type: 'string' },
8880
8884
  },
8881
8885
  required: ['device_id', 'acs_credential_id'],
8882
8886
  type: 'object',
@@ -8910,10 +8914,10 @@ export default {
8910
8914
  { console_session: [] },
8911
8915
  { api_key: [] },
8912
8916
  ],
8913
- summary: '/acs/encoders/encode_credential',
8917
+ summary: '/acs/encoders/encode_card',
8914
8918
  tags: ['/acs'],
8915
8919
  'x-fern-sdk-group-name': ['acs', 'encoders'],
8916
- 'x-fern-sdk-method-name': 'encode_credential',
8920
+ 'x-fern-sdk-method-name': 'encode_card',
8917
8921
  'x-fern-sdk-return-value': 'action_attempt',
8918
8922
  'x-response-key': 'action_attempt',
8919
8923
  'x-undocumented': 'Encoding a card is currently unimplemented.',
@@ -9005,24 +9009,16 @@ export default {
9005
9009
  'x-undocumented': 'Encoders are in alpha.',
9006
9010
  },
9007
9011
  },
9008
- '/acs/encoders/scan_credential': {
9012
+ '/acs/encoders/scan_card': {
9009
9013
  post: {
9010
- operationId: 'acsEncodersScanCredentialPost',
9014
+ operationId: 'acsEncodersScanCardPost',
9011
9015
  requestBody: {
9012
9016
  content: {
9013
9017
  'application/json': {
9014
9018
  schema: {
9015
9019
  properties: {
9016
- acs_system_id: {
9017
- description: 'ID of the acs_system the encoder belongs to.',
9018
- format: 'uuid',
9019
- type: 'string',
9020
- },
9021
- device_id: {
9022
- description: 'ID of the encoder to use for the scan.',
9023
- format: 'uuid',
9024
- type: 'string',
9025
- },
9020
+ acs_system_id: { format: 'uuid', type: 'string' },
9021
+ device_id: { format: 'uuid', type: 'string' },
9026
9022
  },
9027
9023
  required: ['acs_system_id', 'device_id'],
9028
9024
  type: 'object',
@@ -9056,10 +9052,10 @@ export default {
9056
9052
  { console_session: [] },
9057
9053
  { api_key: [] },
9058
9054
  ],
9059
- summary: '/acs/encoders/scan_credential',
9055
+ summary: '/acs/encoders/scan_card',
9060
9056
  tags: ['/acs'],
9061
9057
  'x-fern-sdk-group-name': ['acs', 'encoders'],
9062
- 'x-fern-sdk-method-name': 'scan_credential',
9058
+ 'x-fern-sdk-method-name': 'scan_card',
9063
9059
  'x-fern-sdk-return-value': 'action_attempt',
9064
9060
  'x-response-key': 'action_attempt',
9065
9061
  'x-undocumented': 'Reading a card is currently unimplemented.',