@seamapi/types 1.289.0 → 1.289.1

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 +54 -38
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +172 -164
  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-card.d.ts → encode-credential.d.ts} +11 -11
  8. package/lib/seam/connect/models/action-attempts/{encode-card.js → encode-credential.js} +6 -6
  9. package/lib/seam/connect/models/action-attempts/encode-credential.js.map +1 -0
  10. package/lib/seam/connect/models/action-attempts/{scan-card.d.ts → scan-credential.d.ts} +11 -11
  11. package/lib/seam/connect/models/action-attempts/{scan-card.js → scan-credential.js} +7 -7
  12. package/lib/seam/connect/models/action-attempts/scan-credential.js.map +1 -0
  13. package/lib/seam/connect/openapi.d.ts +6 -2
  14. package/lib/seam/connect/openapi.js +41 -25
  15. package/lib/seam/connect/openapi.js.map +1 -1
  16. package/lib/seam/connect/route-types.d.ts +148 -144
  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-card.ts → encode-credential.ts} +8 -6
  20. package/src/lib/seam/connect/models/action-attempts/{scan-card.ts → scan-credential.ts} +9 -7
  21. package/src/lib/seam/connect/openapi.ts +46 -25
  22. package/src/lib/seam/connect/route-types.ts +148 -144
  23. package/lib/seam/connect/models/action-attempts/encode-card.js.map +0 -1
  24. package/lib/seam/connect/models/action-attempts/scan-card.js.map +0 -1
package/lib/seam/connect/openapi.js CHANGED
@@ -1256,7 +1256,7 @@ export default {
1256
1256
  type: 'object',
1257
1257
  },
1258
1258
  {
1259
- description: 'Reading card data from physical encoder.',
1259
+ description: 'Reading credential data from physical encoder.',
1260
1260
  properties: {
1261
1261
  action_attempt_id: {
1262
1262
  description: 'The ID of the action attempt.',
@@ -1264,7 +1264,7 @@ export default {
1264
1264
  type: 'string',
1265
1265
  'x-title': 'Action Attempt ID',
1266
1266
  },
1267
- action_type: { enum: ['SCAN_CARD'], type: 'string' },
1267
+ action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
1268
1268
  error: { nullable: true },
1269
1269
  result: { nullable: true },
1270
1270
  status: { enum: ['pending'], type: 'string' },
@@ -1279,7 +1279,7 @@ export default {
1279
1279
  type: 'object',
1280
1280
  },
1281
1281
  {
1282
- description: 'Reading card data from physical encoder succeeded.',
1282
+ description: 'Reading credential data from physical encoder succeeded.',
1283
1283
  properties: {
1284
1284
  action_attempt_id: {
1285
1285
  description: 'The ID of the action attempt.',
@@ -1287,12 +1287,12 @@ export default {
1287
1287
  type: 'string',
1288
1288
  'x-title': 'Action Attempt ID',
1289
1289
  },
1290
- action_type: { enum: ['SCAN_CARD'], type: 'string' },
1290
+ action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
1291
1291
  error: { nullable: true },
1292
1292
  result: {
1293
1293
  properties: {
1294
1294
  acs_credential_on_encoder: {
1295
- description: 'Snapshot of the card data read from the physical encoder.',
1295
+ description: 'Snapshot of credential data read from physical encoder.',
1296
1296
  properties: {
1297
1297
  card_number: {
1298
1298
  description: 'A number or string that physically identifies this card.',
@@ -1726,7 +1726,7 @@ export default {
1726
1726
  type: 'object',
1727
1727
  },
1728
1728
  {
1729
- description: 'Reading card data from physical encoder failed.',
1729
+ description: 'Reading credential data from physical encoder failed.',
1730
1730
  properties: {
1731
1731
  action_attempt_id: {
1732
1732
  description: 'The ID of the action attempt.',
@@ -1734,7 +1734,7 @@ export default {
1734
1734
  type: 'string',
1735
1735
  'x-title': 'Action Attempt ID',
1736
1736
  },
1737
- action_type: { enum: ['SCAN_CARD'], type: 'string' },
1737
+ action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
1738
1738
  error: {
1739
1739
  oneOf: [
1740
1740
  {
@@ -1779,7 +1779,7 @@ export default {
1779
1779
  type: 'object',
1780
1780
  },
1781
1781
  {
1782
- description: 'Encoding card data from physical encoder.',
1782
+ description: 'Encoding credential data from physical encoder.',
1783
1783
  properties: {
1784
1784
  action_attempt_id: {
1785
1785
  description: 'The ID of the action attempt.',
@@ -1787,7 +1787,7 @@ export default {
1787
1787
  type: 'string',
1788
1788
  'x-title': 'Action Attempt ID',
1789
1789
  },
1790
- action_type: { enum: ['ENCODE_CARD'], type: 'string' },
1790
+ action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
1791
1791
  error: { nullable: true },
1792
1792
  result: { nullable: true },
1793
1793
  status: { enum: ['pending'], type: 'string' },
@@ -1802,7 +1802,7 @@ export default {
1802
1802
  type: 'object',
1803
1803
  },
1804
1804
  {
1805
- description: 'Encoding card data from physical encoder succeeded.',
1805
+ description: 'Encoding credential data from physical encoder succeeded.',
1806
1806
  properties: {
1807
1807
  action_attempt_id: {
1808
1808
  description: 'The ID of the action attempt.',
@@ -1810,7 +1810,7 @@ export default {
1810
1810
  type: 'string',
1811
1811
  'x-title': 'Action Attempt ID',
1812
1812
  },
1813
- action_type: { enum: ['ENCODE_CARD'], type: 'string' },
1813
+ action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
1814
1814
  error: { nullable: true },
1815
1815
  result: {
1816
1816
  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.',
@@ -2147,7 +2147,7 @@ export default {
2147
2147
  type: 'object',
2148
2148
  },
2149
2149
  {
2150
- description: 'Encoding card data from physical encoder failed.',
2150
+ description: 'Encoding credential data from physical encoder failed.',
2151
2151
  properties: {
2152
2152
  action_attempt_id: {
2153
2153
  description: 'The ID of the action attempt.',
@@ -2155,7 +2155,7 @@ export default {
2155
2155
  type: 'string',
2156
2156
  'x-title': 'Action Attempt ID',
2157
2157
  },
2158
- action_type: { enum: ['ENCODE_CARD'], type: 'string' },
2158
+ action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
2159
2159
  error: {
2160
2160
  oneOf: [
2161
2161
  {
@@ -8867,16 +8867,24 @@ export default {
8867
8867
  'x-title': 'Update a Credential',
8868
8868
  },
8869
8869
  },
8870
- '/acs/encoders/encode_card': {
8870
+ '/acs/encoders/encode_credential': {
8871
8871
  post: {
8872
- operationId: 'acsEncodersEncodeCardPost',
8872
+ operationId: 'acsEncodersEncodeCredentialPost',
8873
8873
  requestBody: {
8874
8874
  content: {
8875
8875
  'application/json': {
8876
8876
  schema: {
8877
8877
  properties: {
8878
- acs_credential_id: { format: 'uuid', type: 'string' },
8879
- 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
+ },
8880
8888
  },
8881
8889
  required: ['device_id', 'acs_credential_id'],
8882
8890
  type: 'object',
@@ -8910,10 +8918,10 @@ export default {
8910
8918
  { console_session: [] },
8911
8919
  { api_key: [] },
8912
8920
  ],
8913
- summary: '/acs/encoders/encode_card',
8921
+ summary: '/acs/encoders/encode_credential',
8914
8922
  tags: ['/acs'],
8915
8923
  'x-fern-sdk-group-name': ['acs', 'encoders'],
8916
- 'x-fern-sdk-method-name': 'encode_card',
8924
+ 'x-fern-sdk-method-name': 'encode_credential',
8917
8925
  'x-fern-sdk-return-value': 'action_attempt',
8918
8926
  'x-response-key': 'action_attempt',
8919
8927
  'x-undocumented': 'Encoding a card is currently unimplemented.',
@@ -9005,16 +9013,24 @@ export default {
9005
9013
  'x-undocumented': 'Encoders are in alpha.',
9006
9014
  },
9007
9015
  },
9008
- '/acs/encoders/scan_card': {
9016
+ '/acs/encoders/scan_credential': {
9009
9017
  post: {
9010
- operationId: 'acsEncodersScanCardPost',
9018
+ operationId: 'acsEncodersScanCredentialPost',
9011
9019
  requestBody: {
9012
9020
  content: {
9013
9021
  'application/json': {
9014
9022
  schema: {
9015
9023
  properties: {
9016
- acs_system_id: { format: 'uuid', type: 'string' },
9017
- 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
+ },
9018
9034
  },
9019
9035
  required: ['acs_system_id', 'device_id'],
9020
9036
  type: 'object',
@@ -9048,10 +9064,10 @@ export default {
9048
9064
  { console_session: [] },
9049
9065
  { api_key: [] },
9050
9066
  ],
9051
- summary: '/acs/encoders/scan_card',
9067
+ summary: '/acs/encoders/scan_credential',
9052
9068
  tags: ['/acs'],
9053
9069
  'x-fern-sdk-group-name': ['acs', 'encoders'],
9054
- 'x-fern-sdk-method-name': 'scan_card',
9070
+ 'x-fern-sdk-method-name': 'scan_credential',
9055
9071
  'x-fern-sdk-return-value': 'action_attempt',
9056
9072
  'x-response-key': 'action_attempt',
9057
9073
  'x-undocumented': 'Reading a card is currently unimplemented.',