@seamapi/types 1.322.2 → 1.323.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 (18) hide show
  1. package/dist/connect.cjs +112 -24
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +59 -10
  4. package/lib/seam/connect/models/acs/acs-user.d.ts +53 -0
  5. package/lib/seam/connect/models/acs/acs-user.js +23 -0
  6. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  7. package/lib/seam/connect/models/devices/device-provider.d.ts +1 -1
  8. package/lib/seam/connect/models/devices/device-provider.js +0 -1
  9. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  10. package/lib/seam/connect/openapi.d.ts +34 -7
  11. package/lib/seam/connect/openapi.js +94 -23
  12. package/lib/seam/connect/openapi.js.map +1 -1
  13. package/lib/seam/connect/route-types.d.ts +25 -3
  14. package/package.json +1 -1
  15. package/src/lib/seam/connect/models/acs/acs-user.ts +35 -0
  16. package/src/lib/seam/connect/models/devices/device-provider.ts +0 -1
  17. package/src/lib/seam/connect/openapi.ts +114 -23
  18. package/src/lib/seam/connect/route-types.ts +25 -3
package/lib/seam/connect/openapi.d.ts CHANGED
@@ -11766,6 +11766,7 @@ declare const _default: {
11766
11766
  };
11767
11767
  '/acs/encoders/encode_credential': {
11768
11768
  post: {
11769
+ description: string;
11769
11770
  operationId: string;
11770
11771
  requestBody: {
11771
11772
  content: {
@@ -11835,11 +11836,12 @@ declare const _default: {
11835
11836
  'x-fern-sdk-method-name': string;
11836
11837
  'x-fern-sdk-return-value': string;
11837
11838
  'x-response-key': string;
11838
- 'x-undocumented': string;
11839
+ 'x-title': string;
11839
11840
  };
11840
11841
  };
11841
11842
  '/acs/encoders/list': {
11842
11843
  post: {
11844
+ description: string;
11843
11845
  operationId: string;
11844
11846
  requestBody: {
11845
11847
  content: {
@@ -11848,11 +11850,13 @@ declare const _default: {
11848
11850
  oneOf: ({
11849
11851
  properties: {
11850
11852
  acs_system_id: {
11853
+ description: string;
11851
11854
  format: string;
11852
11855
  type: string;
11853
11856
  };
11854
11857
  limit: {
11855
11858
  default: number;
11859
+ description: string;
11856
11860
  format: string;
11857
11861
  type: string;
11858
11862
  };
@@ -11864,6 +11868,7 @@ declare const _default: {
11864
11868
  } | {
11865
11869
  properties: {
11866
11870
  acs_system_ids: {
11871
+ description: string;
11867
11872
  items: {
11868
11873
  format: string;
11869
11874
  type: string;
@@ -11872,6 +11877,7 @@ declare const _default: {
11872
11877
  };
11873
11878
  limit: {
11874
11879
  default: number;
11880
+ description: string;
11875
11881
  format: string;
11876
11882
  type: string;
11877
11883
  };
@@ -11883,6 +11889,7 @@ declare const _default: {
11883
11889
  } | {
11884
11890
  properties: {
11885
11891
  acs_encoder_ids: {
11892
+ description: string;
11886
11893
  items: {
11887
11894
  format: string;
11888
11895
  type: string;
@@ -11891,6 +11898,7 @@ declare const _default: {
11891
11898
  };
11892
11899
  limit: {
11893
11900
  default: number;
11901
+ description: string;
11894
11902
  format: string;
11895
11903
  type: string;
11896
11904
  };
@@ -12005,11 +12013,12 @@ declare const _default: {
12005
12013
  'x-fern-sdk-method-name': string;
12006
12014
  'x-fern-sdk-return-value': string;
12007
12015
  'x-response-key': string;
12008
- 'x-undocumented': string;
12016
+ 'x-title': string;
12009
12017
  };
12010
12018
  };
12011
12019
  '/acs/encoders/scan_credential': {
12012
12020
  post: {
12021
+ description: string;
12013
12022
  operationId: string;
12014
12023
  requestBody: {
12015
12024
  content: {
@@ -12074,11 +12083,12 @@ declare const _default: {
12074
12083
  'x-fern-sdk-method-name': string;
12075
12084
  'x-fern-sdk-return-value': string;
12076
12085
  'x-response-key': string;
12077
- 'x-undocumented': string;
12086
+ 'x-title': string;
12078
12087
  };
12079
12088
  };
12080
12089
  '/acs/encoders/simulate/next_credential_encode_will_fail': {
12081
12090
  post: {
12091
+ description: string;
12082
12092
  operationId: string;
12083
12093
  requestBody: {
12084
12094
  content: {
@@ -12088,11 +12098,13 @@ declare const _default: {
12088
12098
  additionalProperties: boolean;
12089
12099
  properties: {
12090
12100
  acs_encoder_id: {
12101
+ description: string;
12091
12102
  format: string;
12092
12103
  type: string;
12093
12104
  };
12094
12105
  error_code: {
12095
12106
  default: string;
12107
+ description: string;
12096
12108
  enum: string[];
12097
12109
  type: string;
12098
12110
  };
@@ -12104,14 +12116,17 @@ declare const _default: {
12104
12116
  additionalProperties: boolean;
12105
12117
  properties: {
12106
12118
  acs_credential_id: {
12119
+ description: string;
12107
12120
  format: string;
12108
12121
  type: string;
12109
12122
  };
12110
12123
  acs_encoder_id: {
12124
+ description: string;
12111
12125
  format: string;
12112
12126
  type: string;
12113
12127
  };
12114
12128
  error_code: {
12129
+ description: string;
12115
12130
  enum: string[];
12116
12131
  type: string;
12117
12132
  default?: never;
@@ -12166,11 +12181,12 @@ declare const _default: {
12166
12181
  'x-fern-sdk-group-name': string[];
12167
12182
  'x-fern-sdk-method-name': string;
12168
12183
  'x-response-key': null;
12169
- 'x-undocumented': string;
12184
+ 'x-title': string;
12170
12185
  };
12171
12186
  };
12172
12187
  '/acs/encoders/simulate/next_credential_encode_will_succeed': {
12173
12188
  post: {
12189
+ description: string;
12174
12190
  operationId: string;
12175
12191
  requestBody: {
12176
12192
  content: {
@@ -12179,11 +12195,13 @@ declare const _default: {
12179
12195
  additionalProperties: boolean;
12180
12196
  properties: {
12181
12197
  acs_encoder_id: {
12198
+ description: string;
12182
12199
  format: string;
12183
12200
  type: string;
12184
12201
  };
12185
12202
  scenario: {
12186
12203
  default: string;
12204
+ description: string;
12187
12205
  enum: string[];
12188
12206
  type: string;
12189
12207
  };
@@ -12236,11 +12254,12 @@ declare const _default: {
12236
12254
  'x-fern-sdk-group-name': string[];
12237
12255
  'x-fern-sdk-method-name': string;
12238
12256
  'x-response-key': null;
12239
- 'x-undocumented': string;
12257
+ 'x-title': string;
12240
12258
  };
12241
12259
  };
12242
12260
  '/acs/encoders/simulate/next_credential_scan_will_fail': {
12243
12261
  post: {
12262
+ description: string;
12244
12263
  operationId: string;
12245
12264
  requestBody: {
12246
12265
  content: {
@@ -12250,6 +12269,7 @@ declare const _default: {
12250
12269
  additionalProperties: boolean;
12251
12270
  properties: {
12252
12271
  acs_encoder_id: {
12272
+ description: string;
12253
12273
  format: string;
12254
12274
  type: string;
12255
12275
  };
@@ -12270,6 +12290,7 @@ declare const _default: {
12270
12290
  type: string;
12271
12291
  };
12272
12292
  acs_encoder_id: {
12293
+ description: string;
12273
12294
  format: string;
12274
12295
  type: string;
12275
12296
  };
@@ -12328,11 +12349,12 @@ declare const _default: {
12328
12349
  'x-fern-sdk-group-name': string[];
12329
12350
  'x-fern-sdk-method-name': string;
12330
12351
  'x-response-key': null;
12331
- 'x-undocumented': string;
12352
+ 'x-title': string;
12332
12353
  };
12333
12354
  };
12334
12355
  '/acs/encoders/simulate/next_credential_scan_will_succeed': {
12335
12356
  post: {
12357
+ description: string;
12336
12358
  operationId: string;
12337
12359
  requestBody: {
12338
12360
  content: {
@@ -12342,15 +12364,18 @@ declare const _default: {
12342
12364
  additionalProperties: boolean;
12343
12365
  properties: {
12344
12366
  acs_credential_id_on_seam: {
12367
+ description: string;
12345
12368
  format: string;
12346
12369
  type: string;
12347
12370
  };
12348
12371
  acs_encoder_id: {
12372
+ description: string;
12349
12373
  format: string;
12350
12374
  type: string;
12351
12375
  };
12352
12376
  scenario: {
12353
12377
  default: string;
12378
+ description: string;
12354
12379
  enum: string[];
12355
12380
  type: string;
12356
12381
  };
@@ -12361,10 +12386,12 @@ declare const _default: {
12361
12386
  additionalProperties: boolean;
12362
12387
  properties: {
12363
12388
  acs_encoder_id: {
12389
+ description: string;
12364
12390
  format: string;
12365
12391
  type: string;
12366
12392
  };
12367
12393
  scenario: {
12394
+ description: string;
12368
12395
  enum: string[];
12369
12396
  type: string;
12370
12397
  default?: never;
@@ -12420,7 +12447,7 @@ declare const _default: {
12420
12447
  'x-fern-sdk-group-name': string[];
12421
12448
  'x-fern-sdk-method-name': string;
12422
12449
  'x-response-key': null;
12423
- 'x-undocumented': string;
12450
+ 'x-title': string;
12424
12451
  };
12425
12452
  };
12426
12453
  '/acs/entrances/get': {
package/lib/seam/connect/openapi.js CHANGED
@@ -13870,6 +13870,7 @@ export default {
13870
13870
  },
13871
13871
  '/acs/encoders/encode_credential': {
13872
13872
  post: {
13873
+ description: 'Encodes an existing [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
13873
13874
  operationId: 'acsEncodersEncodeCredentialPost',
13874
13875
  requestBody: {
13875
13876
  content: {
@@ -13877,12 +13878,12 @@ export default {
13877
13878
  schema: {
13878
13879
  properties: {
13879
13880
  acs_credential_id: {
13880
- description: 'ID of the acs_credential to encode on a physical card.',
13881
+ description: 'ID of the `acs_credential` to encode onto a card.',
13881
13882
  format: 'uuid',
13882
13883
  type: 'string',
13883
13884
  },
13884
13885
  acs_encoder_id: {
13885
- description: 'ID of the acs_encoder to use for the encoding.',
13886
+ description: 'ID of the `acs_encoder` to use to encode the `acs_credential`.',
13886
13887
  format: 'uuid',
13887
13888
  type: 'string',
13888
13889
  },
@@ -13925,11 +13926,12 @@ export default {
13925
13926
  'x-fern-sdk-method-name': 'encode_credential',
13926
13927
  'x-fern-sdk-return-value': 'action_attempt',
13927
13928
  'x-response-key': 'action_attempt',
13928
- 'x-undocumented': 'Encoders are in alpha.',
13929
+ 'x-title': 'Encode a Credential',
13929
13930
  },
13930
13931
  },
13931
13932
  '/acs/encoders/list': {
13932
13933
  post: {
13934
+ description: 'Returns a list of all [encoders](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
13933
13935
  operationId: 'acsEncodersListPost',
13934
13936
  requestBody: {
13935
13937
  content: {
@@ -13938,8 +13940,17 @@ export default {
13938
13940
  oneOf: [
13939
13941
  {
13940
13942
  properties: {
13941
- acs_system_id: { format: 'uuid', type: 'string' },
13942
- limit: { default: 500, format: 'float', type: 'number' },
13943
+ acs_system_id: {
13944
+ description: 'ID of the `acs_system` for which you want to retrieve all `acs_encoder`s.',
13945
+ format: 'uuid',
13946
+ type: 'string',
13947
+ },
13948
+ limit: {
13949
+ default: 500,
13950
+ description: 'Number of `acs_encoders` to return.',
13951
+ format: 'float',
13952
+ type: 'number',
13953
+ },
13943
13954
  },
13944
13955
  required: ['acs_system_id'],
13945
13956
  type: 'object',
@@ -13947,10 +13958,16 @@ export default {
13947
13958
  {
13948
13959
  properties: {
13949
13960
  acs_system_ids: {
13961
+ description: 'IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s.',
13950
13962
  items: { format: 'uuid', type: 'string' },
13951
13963
  type: 'array',
13952
13964
  },
13953
- limit: { default: 500, format: 'float', type: 'number' },
13965
+ limit: {
13966
+ default: 500,
13967
+ description: 'Number of `acs_encoders` to return.',
13968
+ format: 'float',
13969
+ type: 'number',
13970
+ },
13954
13971
  },
13955
13972
  required: ['acs_system_ids'],
13956
13973
  type: 'object',
@@ -13958,10 +13975,16 @@ export default {
13958
13975
  {
13959
13976
  properties: {
13960
13977
  acs_encoder_ids: {
13978
+ description: 'IDs of the `acs_encoder`s that you want to retrieve.',
13961
13979
  items: { format: 'uuid', type: 'string' },
13962
13980
  type: 'array',
13963
13981
  },
13964
- limit: { default: 500, format: 'float', type: 'number' },
13982
+ limit: {
13983
+ default: 500,
13984
+ description: 'Number of `acs_encoders` to return.',
13985
+ format: 'float',
13986
+ type: 'number',
13987
+ },
13965
13988
  },
13966
13989
  required: ['acs_encoder_ids'],
13967
13990
  type: 'object',
@@ -14065,11 +14088,12 @@ export default {
14065
14088
  'x-fern-sdk-method-name': 'list',
14066
14089
  'x-fern-sdk-return-value': 'acs_encoders',
14067
14090
  'x-response-key': 'acs_encoders',
14068
- 'x-undocumented': 'Encoders are in alpha.',
14091
+ 'x-title': 'List Encoders',
14069
14092
  },
14070
14093
  },
14071
14094
  '/acs/encoders/scan_credential': {
14072
14095
  post: {
14096
+ description: 'Scans an encoded [acs_credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
14073
14097
  operationId: 'acsEncodersScanCredentialPost',
14074
14098
  requestBody: {
14075
14099
  content: {
@@ -14077,7 +14101,7 @@ export default {
14077
14101
  schema: {
14078
14102
  properties: {
14079
14103
  acs_encoder_id: {
14080
- description: 'ID of the acs_encoder to use for the scan.',
14104
+ description: 'ID of the `acs_encoder` to use for the scan.',
14081
14105
  format: 'uuid',
14082
14106
  type: 'string',
14083
14107
  },
@@ -14120,11 +14144,12 @@ export default {
14120
14144
  'x-fern-sdk-method-name': 'scan_credential',
14121
14145
  'x-fern-sdk-return-value': 'action_attempt',
14122
14146
  'x-response-key': 'action_attempt',
14123
- 'x-undocumented': 'Encoders are in alpha.',
14147
+ 'x-title': 'Scan a Credential',
14124
14148
  },
14125
14149
  },
14126
14150
  '/acs/encoders/simulate/next_credential_encode_will_fail': {
14127
14151
  post: {
14152
+ description: 'Simulates that the next attempt to encode a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
14128
14153
  operationId: 'acsEncodersSimulateNextCredentialEncodeWillFailPost',
14129
14154
  requestBody: {
14130
14155
  content: {
@@ -14134,9 +14159,14 @@ export default {
14134
14159
  {
14135
14160
  additionalProperties: false,
14136
14161
  properties: {
14137
- acs_encoder_id: { format: 'uuid', type: 'string' },
14162
+ acs_encoder_id: {
14163
+ description: 'ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.',
14164
+ format: 'uuid',
14165
+ type: 'string',
14166
+ },
14138
14167
  error_code: {
14139
14168
  default: 'no_credential_on_encoder',
14169
+ description: 'Code of the error to simulate.',
14140
14170
  enum: ['no_credential_on_encoder'],
14141
14171
  type: 'string',
14142
14172
  },
@@ -14147,9 +14177,18 @@ export default {
14147
14177
  {
14148
14178
  additionalProperties: false,
14149
14179
  properties: {
14150
- acs_credential_id: { format: 'uuid', type: 'string' },
14151
- acs_encoder_id: { format: 'uuid', type: 'string' },
14180
+ acs_credential_id: {
14181
+ description: 'ID of the `acs_credential` that will fail to be encoded onto a card in the next request.',
14182
+ format: 'uuid',
14183
+ type: 'string',
14184
+ },
14185
+ acs_encoder_id: {
14186
+ description: 'ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.',
14187
+ format: 'uuid',
14188
+ type: 'string',
14189
+ },
14152
14190
  error_code: {
14191
+ description: 'Code of the error to simulate.',
14153
14192
  enum: ['uncategorized_error', 'action_attempt_expired'],
14154
14193
  type: 'string',
14155
14194
  },
@@ -14188,11 +14227,12 @@ export default {
14188
14227
  'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
14189
14228
  'x-fern-sdk-method-name': 'next_credential_encode_will_fail',
14190
14229
  'x-response-key': null,
14191
- 'x-undocumented': 'Encoder simulations are in alpha.',
14230
+ 'x-title': 'Simulate that the Next Credential Encoding Will Fail',
14192
14231
  },
14193
14232
  },
14194
14233
  '/acs/encoders/simulate/next_credential_encode_will_succeed': {
14195
14234
  post: {
14235
+ description: 'Simulates that the next attempt to encode a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
14196
14236
  operationId: 'acsEncodersSimulateNextCredentialEncodeWillSucceedPost',
14197
14237
  requestBody: {
14198
14238
  content: {
@@ -14200,9 +14240,14 @@ export default {
14200
14240
  schema: {
14201
14241
  additionalProperties: false,
14202
14242
  properties: {
14203
- acs_encoder_id: { format: 'uuid', type: 'string' },
14243
+ acs_encoder_id: {
14244
+ description: 'ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.',
14245
+ format: 'uuid',
14246
+ type: 'string',
14247
+ },
14204
14248
  scenario: {
14205
14249
  default: 'credential_is_issued',
14250
+ description: 'Scenario to simulate.',
14206
14251
  enum: ['credential_is_issued'],
14207
14252
  type: 'string',
14208
14253
  },
@@ -14239,11 +14284,12 @@ export default {
14239
14284
  'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
14240
14285
  'x-fern-sdk-method-name': 'next_credential_encode_will_succeed',
14241
14286
  'x-response-key': null,
14242
- 'x-undocumented': 'Encoder simulations are in alpha.',
14287
+ 'x-title': 'Simulate that the Next Credential Encoding Will Succeed',
14243
14288
  },
14244
14289
  },
14245
14290
  '/acs/encoders/simulate/next_credential_scan_will_fail': {
14246
14291
  post: {
14292
+ description: 'Simulates that the next attempt to scan a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
14247
14293
  operationId: 'acsEncodersSimulateNextCredentialScanWillFailPost',
14248
14294
  requestBody: {
14249
14295
  content: {
@@ -14253,7 +14299,11 @@ export default {
14253
14299
  {
14254
14300
  additionalProperties: false,
14255
14301
  properties: {
14256
- acs_encoder_id: { format: 'uuid', type: 'string' },
14302
+ acs_encoder_id: {
14303
+ description: 'ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.',
14304
+ format: 'uuid',
14305
+ type: 'string',
14306
+ },
14257
14307
  error_code: {
14258
14308
  default: 'no_credential_on_encoder',
14259
14309
  enum: ['no_credential_on_encoder'],
@@ -14270,7 +14320,11 @@ export default {
14270
14320
  format: 'uuid',
14271
14321
  type: 'string',
14272
14322
  },
14273
- acs_encoder_id: { format: 'uuid', type: 'string' },
14323
+ acs_encoder_id: {
14324
+ description: 'ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.',
14325
+ format: 'uuid',
14326
+ type: 'string',
14327
+ },
14274
14328
  error_code: {
14275
14329
  enum: ['uncategorized_error', 'action_attempt_expired'],
14276
14330
  type: 'string',
@@ -14310,11 +14364,12 @@ export default {
14310
14364
  'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
14311
14365
  'x-fern-sdk-method-name': 'next_credential_scan_will_fail',
14312
14366
  'x-response-key': null,
14313
- 'x-undocumented': 'Encoder simulations are in alpha.',
14367
+ 'x-title': 'Simulate that the Next Credential Scan Will Fail',
14314
14368
  },
14315
14369
  },
14316
14370
  '/acs/encoders/simulate/next_credential_scan_will_succeed': {
14317
14371
  post: {
14372
+ description: 'Simulates that the next attempt to scan a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
14318
14373
  operationId: 'acsEncodersSimulateNextCredentialScanWillSucceedPost',
14319
14374
  requestBody: {
14320
14375
  content: {
@@ -14325,12 +14380,18 @@ export default {
14325
14380
  additionalProperties: false,
14326
14381
  properties: {
14327
14382
  acs_credential_id_on_seam: {
14383
+ description: 'ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation.',
14384
+ format: 'uuid',
14385
+ type: 'string',
14386
+ },
14387
+ acs_encoder_id: {
14388
+ description: 'ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.',
14328
14389
  format: 'uuid',
14329
14390
  type: 'string',
14330
14391
  },
14331
- acs_encoder_id: { format: 'uuid', type: 'string' },
14332
14392
  scenario: {
14333
14393
  default: 'credential_exists_on_seam',
14394
+ description: 'Scenario to simulate.',
14334
14395
  enum: [
14335
14396
  'credential_exists_on_seam',
14336
14397
  'credential_on_encoder_needs_update',
@@ -14344,8 +14405,13 @@ export default {
14344
14405
  {
14345
14406
  additionalProperties: false,
14346
14407
  properties: {
14347
- acs_encoder_id: { format: 'uuid', type: 'string' },
14408
+ acs_encoder_id: {
14409
+ description: 'ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.',
14410
+ format: 'uuid',
14411
+ type: 'string',
14412
+ },
14348
14413
  scenario: {
14414
+ description: 'Scenario to simulate.',
14349
14415
  enum: ['credential_does_not_exist_on_seam'],
14350
14416
  type: 'string',
14351
14417
  },
@@ -14356,8 +14422,13 @@ export default {
14356
14422
  {
14357
14423
  additionalProperties: false,
14358
14424
  properties: {
14359
- acs_encoder_id: { format: 'uuid', type: 'string' },
14425
+ acs_encoder_id: {
14426
+ description: 'ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.',
14427
+ format: 'uuid',
14428
+ type: 'string',
14429
+ },
14360
14430
  scenario: {
14431
+ description: 'Scenario to simulate.',
14361
14432
  enum: ['credential_on_encoder_is_empty'],
14362
14433
  type: 'string',
14363
14434
  },
@@ -14396,7 +14467,7 @@ export default {
14396
14467
  'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
14397
14468
  'x-fern-sdk-method-name': 'next_credential_scan_will_succeed',
14398
14469
  'x-response-key': null,
14399
- 'x-undocumented': 'Encoder simulations are in alpha.',
14470
+ 'x-title': 'Simulate that the Next Credential Scan Will Succeed',
14400
14471
  },
14401
14472
  },
14402
14473
  '/acs/entrances/get': {