@seamapi/types 1.289.0 → 1.290.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 (28) hide show
  1. package/dist/connect.cjs +70 -38
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +212 -164
  4. package/lib/seam/connect/models/acs/acs-system.d.ts +20 -0
  5. package/lib/seam/connect/models/acs/acs-system.js +7 -0
  6. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  7. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +18 -18
  8. package/lib/seam/connect/models/action-attempts/action-attempt.js +4 -4
  9. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
  10. package/lib/seam/connect/models/action-attempts/{encode-card.d.ts → encode-credential.d.ts} +11 -11
  11. package/lib/seam/connect/models/action-attempts/{encode-card.js → encode-credential.js} +6 -6
  12. package/lib/seam/connect/models/action-attempts/encode-credential.js.map +1 -0
  13. package/lib/seam/connect/models/action-attempts/{scan-card.d.ts → scan-credential.d.ts} +11 -11
  14. package/lib/seam/connect/models/action-attempts/{scan-card.js → scan-credential.js} +7 -7
  15. package/lib/seam/connect/models/action-attempts/scan-credential.js.map +1 -0
  16. package/lib/seam/connect/openapi.d.ts +17 -2
  17. package/lib/seam/connect/openapi.js +53 -25
  18. package/lib/seam/connect/openapi.js.map +1 -1
  19. package/lib/seam/connect/route-types.d.ts +164 -144
  20. package/package.json +1 -1
  21. package/src/lib/seam/connect/models/acs/acs-system.ts +8 -0
  22. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +4 -4
  23. package/src/lib/seam/connect/models/action-attempts/{encode-card.ts → encode-credential.ts} +8 -6
  24. package/src/lib/seam/connect/models/action-attempts/{scan-card.ts → scan-credential.ts} +9 -7
  25. package/src/lib/seam/connect/openapi.ts +58 -25
  26. package/src/lib/seam/connect/route-types.ts +164 -144
  27. package/lib/seam/connect/models/action-attempts/encode-card.js.map +0 -1
  28. package/lib/seam/connect/models/action-attempts/scan-card.js.map +0 -1
package/lib/seam/connect/openapi.js CHANGED
@@ -746,6 +746,17 @@ export default {
746
746
  description: 'Indicates if the `acs_system` is a credential manager.',
747
747
  type: 'boolean',
748
748
  },
749
+ location: {
750
+ properties: {
751
+ time_zone: {
752
+ description: 'Time zone in which the `acs_system` is located.',
753
+ nullable: true,
754
+ type: 'string',
755
+ },
756
+ },
757
+ required: ['time_zone'],
758
+ type: 'object',
759
+ },
749
760
  name: { description: 'Name of the `acs_system`.', type: 'string' },
750
761
  system_type: {
751
762
  deprecated: true,
@@ -823,6 +834,7 @@ export default {
823
834
  required: [
824
835
  'acs_system_id',
825
836
  'is_credential_manager',
837
+ 'location',
826
838
  'name',
827
839
  'created_at',
828
840
  'workspace_id',
@@ -1256,7 +1268,7 @@ export default {
1256
1268
  type: 'object',
1257
1269
  },
1258
1270
  {
1259
- description: 'Reading card data from physical encoder.',
1271
+ description: 'Reading credential data from physical encoder.',
1260
1272
  properties: {
1261
1273
  action_attempt_id: {
1262
1274
  description: 'The ID of the action attempt.',
@@ -1264,7 +1276,7 @@ export default {
1264
1276
  type: 'string',
1265
1277
  'x-title': 'Action Attempt ID',
1266
1278
  },
1267
- action_type: { enum: ['SCAN_CARD'], type: 'string' },
1279
+ action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
1268
1280
  error: { nullable: true },
1269
1281
  result: { nullable: true },
1270
1282
  status: { enum: ['pending'], type: 'string' },
@@ -1279,7 +1291,7 @@ export default {
1279
1291
  type: 'object',
1280
1292
  },
1281
1293
  {
1282
- description: 'Reading card data from physical encoder succeeded.',
1294
+ description: 'Reading credential data from physical encoder succeeded.',
1283
1295
  properties: {
1284
1296
  action_attempt_id: {
1285
1297
  description: 'The ID of the action attempt.',
@@ -1287,12 +1299,12 @@ export default {
1287
1299
  type: 'string',
1288
1300
  'x-title': 'Action Attempt ID',
1289
1301
  },
1290
- action_type: { enum: ['SCAN_CARD'], type: 'string' },
1302
+ action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
1291
1303
  error: { nullable: true },
1292
1304
  result: {
1293
1305
  properties: {
1294
1306
  acs_credential_on_encoder: {
1295
- description: 'Snapshot of the card data read from the physical encoder.',
1307
+ description: 'Snapshot of credential data read from physical encoder.',
1296
1308
  properties: {
1297
1309
  card_number: {
1298
1310
  description: 'A number or string that physically identifies this card.',
@@ -1726,7 +1738,7 @@ export default {
1726
1738
  type: 'object',
1727
1739
  },
1728
1740
  {
1729
- description: 'Reading card data from physical encoder failed.',
1741
+ description: 'Reading credential data from physical encoder failed.',
1730
1742
  properties: {
1731
1743
  action_attempt_id: {
1732
1744
  description: 'The ID of the action attempt.',
@@ -1734,7 +1746,7 @@ export default {
1734
1746
  type: 'string',
1735
1747
  'x-title': 'Action Attempt ID',
1736
1748
  },
1737
- action_type: { enum: ['SCAN_CARD'], type: 'string' },
1749
+ action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
1738
1750
  error: {
1739
1751
  oneOf: [
1740
1752
  {
@@ -1779,7 +1791,7 @@ export default {
1779
1791
  type: 'object',
1780
1792
  },
1781
1793
  {
1782
- description: 'Encoding card data from physical encoder.',
1794
+ description: 'Encoding credential data from physical encoder.',
1783
1795
  properties: {
1784
1796
  action_attempt_id: {
1785
1797
  description: 'The ID of the action attempt.',
@@ -1787,7 +1799,7 @@ export default {
1787
1799
  type: 'string',
1788
1800
  'x-title': 'Action Attempt ID',
1789
1801
  },
1790
- action_type: { enum: ['ENCODE_CARD'], type: 'string' },
1802
+ action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
1791
1803
  error: { nullable: true },
1792
1804
  result: { nullable: true },
1793
1805
  status: { enum: ['pending'], type: 'string' },
@@ -1802,7 +1814,7 @@ export default {
1802
1814
  type: 'object',
1803
1815
  },
1804
1816
  {
1805
- description: 'Encoding card data from physical encoder succeeded.',
1817
+ description: 'Encoding credential data from physical encoder succeeded.',
1806
1818
  properties: {
1807
1819
  action_attempt_id: {
1808
1820
  description: 'The ID of the action attempt.',
@@ -1810,7 +1822,7 @@ export default {
1810
1822
  type: 'string',
1811
1823
  'x-title': 'Action Attempt ID',
1812
1824
  },
1813
- action_type: { enum: ['ENCODE_CARD'], type: 'string' },
1825
+ action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
1814
1826
  error: { nullable: true },
1815
1827
  result: {
1816
1828
  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 +2159,7 @@ export default {
2147
2159
  type: 'object',
2148
2160
  },
2149
2161
  {
2150
- description: 'Encoding card data from physical encoder failed.',
2162
+ description: 'Encoding credential data from physical encoder failed.',
2151
2163
  properties: {
2152
2164
  action_attempt_id: {
2153
2165
  description: 'The ID of the action attempt.',
@@ -2155,7 +2167,7 @@ export default {
2155
2167
  type: 'string',
2156
2168
  'x-title': 'Action Attempt ID',
2157
2169
  },
2158
- action_type: { enum: ['ENCODE_CARD'], type: 'string' },
2170
+ action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
2159
2171
  error: {
2160
2172
  oneOf: [
2161
2173
  {
@@ -8867,16 +8879,24 @@ export default {
8867
8879
  'x-title': 'Update a Credential',
8868
8880
  },
8869
8881
  },
8870
- '/acs/encoders/encode_card': {
8882
+ '/acs/encoders/encode_credential': {
8871
8883
  post: {
8872
- operationId: 'acsEncodersEncodeCardPost',
8884
+ operationId: 'acsEncodersEncodeCredentialPost',
8873
8885
  requestBody: {
8874
8886
  content: {
8875
8887
  'application/json': {
8876
8888
  schema: {
8877
8889
  properties: {
8878
- acs_credential_id: { format: 'uuid', type: 'string' },
8879
- device_id: { format: 'uuid', type: 'string' },
8890
+ acs_credential_id: {
8891
+ description: 'ID of the acs_credential to encode on a physical card.',
8892
+ format: 'uuid',
8893
+ type: 'string',
8894
+ },
8895
+ device_id: {
8896
+ description: 'ID of the encoder to use for the encoding.',
8897
+ format: 'uuid',
8898
+ type: 'string',
8899
+ },
8880
8900
  },
8881
8901
  required: ['device_id', 'acs_credential_id'],
8882
8902
  type: 'object',
@@ -8910,10 +8930,10 @@ export default {
8910
8930
  { console_session: [] },
8911
8931
  { api_key: [] },
8912
8932
  ],
8913
- summary: '/acs/encoders/encode_card',
8933
+ summary: '/acs/encoders/encode_credential',
8914
8934
  tags: ['/acs'],
8915
8935
  'x-fern-sdk-group-name': ['acs', 'encoders'],
8916
- 'x-fern-sdk-method-name': 'encode_card',
8936
+ 'x-fern-sdk-method-name': 'encode_credential',
8917
8937
  'x-fern-sdk-return-value': 'action_attempt',
8918
8938
  'x-response-key': 'action_attempt',
8919
8939
  'x-undocumented': 'Encoding a card is currently unimplemented.',
@@ -9005,16 +9025,24 @@ export default {
9005
9025
  'x-undocumented': 'Encoders are in alpha.',
9006
9026
  },
9007
9027
  },
9008
- '/acs/encoders/scan_card': {
9028
+ '/acs/encoders/scan_credential': {
9009
9029
  post: {
9010
- operationId: 'acsEncodersScanCardPost',
9030
+ operationId: 'acsEncodersScanCredentialPost',
9011
9031
  requestBody: {
9012
9032
  content: {
9013
9033
  'application/json': {
9014
9034
  schema: {
9015
9035
  properties: {
9016
- acs_system_id: { format: 'uuid', type: 'string' },
9017
- device_id: { format: 'uuid', type: 'string' },
9036
+ acs_system_id: {
9037
+ description: 'ID of the acs_system the encoder belongs to.',
9038
+ format: 'uuid',
9039
+ type: 'string',
9040
+ },
9041
+ device_id: {
9042
+ description: 'ID of the encoder to use for the scan.',
9043
+ format: 'uuid',
9044
+ type: 'string',
9045
+ },
9018
9046
  },
9019
9047
  required: ['acs_system_id', 'device_id'],
9020
9048
  type: 'object',
@@ -9048,10 +9076,10 @@ export default {
9048
9076
  { console_session: [] },
9049
9077
  { api_key: [] },
9050
9078
  ],
9051
- summary: '/acs/encoders/scan_card',
9079
+ summary: '/acs/encoders/scan_credential',
9052
9080
  tags: ['/acs'],
9053
9081
  'x-fern-sdk-group-name': ['acs', 'encoders'],
9054
- 'x-fern-sdk-method-name': 'scan_card',
9082
+ 'x-fern-sdk-method-name': 'scan_credential',
9055
9083
  'x-fern-sdk-return-value': 'action_attempt',
9056
9084
  'x-response-key': 'action_attempt',
9057
9085
  'x-undocumented': 'Reading a card is currently unimplemented.',