@seamapi/types 1.427.0 → 1.428.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 (22) hide show
  1. package/dist/connect.cjs +144 -438
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +3013 -5155
  4. package/lib/seam/connect/models/access-grants/access-method.d.ts +3 -3
  5. package/lib/seam/connect/models/access-grants/access-method.js +2 -2
  6. package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
  7. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +0 -183
  8. package/lib/seam/connect/models/action-attempts/action-attempt.js +1 -3
  9. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
  10. package/lib/seam/connect/openapi.d.ts +78 -193
  11. package/lib/seam/connect/openapi.js +68 -286
  12. package/lib/seam/connect/openapi.js.map +1 -1
  13. package/lib/seam/connect/route-types.d.ts +3019 -4863
  14. package/package.json +1 -1
  15. package/src/lib/seam/connect/models/access-grants/access-method.ts +2 -2
  16. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +1 -3
  17. package/src/lib/seam/connect/openapi.ts +71 -319
  18. package/src/lib/seam/connect/route-types.ts +3604 -5656
  19. package/lib/seam/connect/models/action-attempts/encode-access-method.d.ts +0 -186
  20. package/lib/seam/connect/models/action-attempts/encode-access-method.js +0 -60
  21. package/lib/seam/connect/models/action-attempts/encode-access-method.js.map +0 -1
  22. package/src/lib/seam/connect/models/action-attempts/encode-access-method.ts +0 -101
package/lib/seam/connect/openapi.js CHANGED
@@ -1698,8 +1698,8 @@ export default {
1698
1698
  format: 'uri',
1699
1699
  type: 'string',
1700
1700
  },
1701
- is_card_encoding_required: {
1702
- description: 'Indicates whether card encoding is required for plastic card access methods.',
1701
+ is_encoding_required: {
1702
+ description: 'Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.',
1703
1703
  type: 'boolean',
1704
1704
  },
1705
1705
  issued_at: {
@@ -4817,229 +4817,6 @@ export default {
4817
4817
  ],
4818
4818
  type: 'object',
4819
4819
  },
4820
- {
4821
- description: 'Encoding access method data from the physical encoder onto a card is pending.',
4822
- properties: {
4823
- action_attempt_id: {
4824
- description: 'ID of the action attempt.',
4825
- format: 'uuid',
4826
- type: 'string',
4827
- },
4828
- action_type: {
4829
- description: 'Action attempt to track the status of encoding an access method from the physical encoder onto a card.',
4830
- enum: ['ENCODE_ACCESS_METHOD'],
4831
- type: 'string',
4832
- },
4833
- error: {
4834
- description: 'Errors associated with the action attempt. Null for pending action attempts.',
4835
- nullable: true,
4836
- },
4837
- result: {
4838
- description: 'Result of the action attempt. Null for pending action attempts.',
4839
- nullable: true,
4840
- },
4841
- status: { enum: ['pending'], type: 'string' },
4842
- },
4843
- required: [
4844
- 'action_attempt_id',
4845
- 'status',
4846
- 'result',
4847
- 'error',
4848
- 'action_type',
4849
- ],
4850
- type: 'object',
4851
- },
4852
- {
4853
- description: 'Encoding access method data from the physical encoder onto a card succeeded.',
4854
- properties: {
4855
- action_attempt_id: {
4856
- description: 'ID of the action attempt.',
4857
- format: 'uuid',
4858
- type: 'string',
4859
- },
4860
- action_type: {
4861
- description: 'Action attempt to track the status of encoding an access method from the physical encoder onto a card.',
4862
- enum: ['ENCODE_ACCESS_METHOD'],
4863
- type: 'string',
4864
- },
4865
- error: {
4866
- description: 'Errors associated with the action attempt. Null for successful action attempts.',
4867
- nullable: true,
4868
- },
4869
- result: {
4870
- description: 'Result of an encoding attempt. If the attempt was successful, includes the access method data that was encoded onto the card.',
4871
- properties: {
4872
- access_method_id: {
4873
- description: 'ID of the access method.',
4874
- format: 'uuid',
4875
- type: 'string',
4876
- },
4877
- created_at: {
4878
- description: 'Date and time at which the access method was created.',
4879
- format: 'date-time',
4880
- type: 'string',
4881
- },
4882
- display_name: {
4883
- description: 'Display name of the access method.',
4884
- type: 'string',
4885
- },
4886
- instant_key_url: {
4887
- description: 'URL of the Instant Key for mobile key access methods.',
4888
- format: 'uri',
4889
- type: 'string',
4890
- },
4891
- is_card_encoding_required: {
4892
- description: 'Indicates whether card encoding is required for plastic card access methods.',
4893
- type: 'boolean',
4894
- },
4895
- issued_at: {
4896
- description: 'Date and time at which the access method was issued.',
4897
- format: 'date-time',
4898
- type: 'string',
4899
- },
4900
- mode: {
4901
- description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
4902
- enum: ['code', 'card', 'mobile_key'],
4903
- type: 'string',
4904
- },
4905
- workspace_id: {
4906
- description: 'ID of the Seam workspace associated with the access method.',
4907
- format: 'uuid',
4908
- type: 'string',
4909
- },
4910
- },
4911
- required: [
4912
- 'workspace_id',
4913
- 'access_method_id',
4914
- 'display_name',
4915
- 'mode',
4916
- 'created_at',
4917
- ],
4918
- type: 'object',
4919
- },
4920
- status: { enum: ['success'], type: 'string' },
4921
- },
4922
- required: [
4923
- 'action_attempt_id',
4924
- 'status',
4925
- 'error',
4926
- 'action_type',
4927
- 'result',
4928
- ],
4929
- type: 'object',
4930
- },
4931
- {
4932
- description: 'Encoding access method data from the physical encoder onto a card failed.',
4933
- properties: {
4934
- action_attempt_id: {
4935
- description: 'ID of the action attempt.',
4936
- format: 'uuid',
4937
- type: 'string',
4938
- },
4939
- action_type: {
4940
- description: 'Action attempt to track the status of encoding an access method from the physical encoder onto a card.',
4941
- enum: ['ENCODE_ACCESS_METHOD'],
4942
- type: 'string',
4943
- },
4944
- error: {
4945
- oneOf: [
4946
- {
4947
- description: "Error that doesn't fit into other specific error categories.",
4948
- properties: {
4949
- message: {
4950
- description: 'Message for the error associated with the action attempt.',
4951
- type: 'string',
4952
- },
4953
- type: {
4954
- description: 'Type of the error associated with the action attempt.',
4955
- enum: ['uncategorized_error'],
4956
- type: 'string',
4957
- },
4958
- },
4959
- required: ['type', 'message'],
4960
- type: 'object',
4961
- },
4962
- {
4963
- description: 'Error to indicate an expired action attempt.',
4964
- properties: {
4965
- message: {
4966
- description: 'Message for the error associated with the action attempt.',
4967
- type: 'string',
4968
- },
4969
- type: {
4970
- description: 'Type of the error associated with the action attempt.',
4971
- enum: ['action_attempt_expired'],
4972
- type: 'string',
4973
- },
4974
- },
4975
- required: ['type', 'message'],
4976
- type: 'object',
4977
- },
4978
- {
4979
- description: 'Error to indicate that there is no credential on the encoder.',
4980
- properties: {
4981
- message: {
4982
- description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
4983
- type: 'string',
4984
- },
4985
- type: {
4986
- description: 'Error type to indicate that there is no credential on the encoder.',
4987
- enum: ['no_credential_on_encoder'],
4988
- type: 'string',
4989
- },
4990
- },
4991
- required: ['type', 'message'],
4992
- type: 'object',
4993
- },
4994
- {
4995
- description: 'Error to indicate an incompatible card format.',
4996
- properties: {
4997
- message: {
4998
- description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
4999
- type: 'string',
5000
- },
5001
- type: {
5002
- description: 'Error type to indicate an incompatible card format.',
5003
- enum: ['incompatible_card_format'],
5004
- type: 'string',
5005
- },
5006
- },
5007
- required: ['type', 'message'],
5008
- type: 'object',
5009
- },
5010
- {
5011
- description: 'Error to indicate that the affected credential cannot be reissued.',
5012
- properties: {
5013
- message: {
5014
- description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
5015
- type: 'string',
5016
- },
5017
- type: {
5018
- description: 'Error type to indicate that the affected credential cannot be reissued.',
5019
- enum: ['credential_cannot_be_reissued'],
5020
- type: 'string',
5021
- },
5022
- },
5023
- required: ['type', 'message'],
5024
- type: 'object',
5025
- },
5026
- ],
5027
- },
5028
- result: {
5029
- description: 'Result of the action attempt. Null for failed action attempts.',
5030
- nullable: true,
5031
- },
5032
- status: { enum: ['error'], type: 'string' },
5033
- },
5034
- required: [
5035
- 'action_attempt_id',
5036
- 'status',
5037
- 'result',
5038
- 'action_type',
5039
- 'error',
5040
- ],
5041
- type: 'object',
5042
- },
5043
4820
  {
5044
4821
  description: 'Encoding credential data from the physical encoder onto a card is pending.',
5045
4822
  properties: {
@@ -24674,6 +24451,68 @@ export default {
24674
24451
  'x-title': 'Delete an Access Method',
24675
24452
  },
24676
24453
  },
24454
+ '/access_methods/encode': {
24455
+ post: {
24456
+ 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).',
24457
+ operationId: 'accessMethodsEncodePost',
24458
+ requestBody: {
24459
+ content: {
24460
+ 'application/json': {
24461
+ schema: {
24462
+ properties: {
24463
+ access_method_id: {
24464
+ description: 'ID of the `access_method` to encode onto a card.',
24465
+ format: 'uuid',
24466
+ type: 'string',
24467
+ },
24468
+ acs_encoder_id: {
24469
+ description: 'ID of the `acs_encoder` to use to encode the `acs_credential`.',
24470
+ format: 'uuid',
24471
+ type: 'string',
24472
+ },
24473
+ },
24474
+ required: ['acs_encoder_id', 'access_method_id'],
24475
+ type: 'object',
24476
+ },
24477
+ },
24478
+ },
24479
+ },
24480
+ responses: {
24481
+ 200: {
24482
+ content: {
24483
+ 'application/json': {
24484
+ schema: {
24485
+ properties: {
24486
+ action_attempt: {
24487
+ $ref: '#/components/schemas/action_attempt',
24488
+ },
24489
+ ok: { type: 'boolean' },
24490
+ },
24491
+ required: ['action_attempt', 'ok'],
24492
+ type: 'object',
24493
+ },
24494
+ },
24495
+ },
24496
+ description: 'OK',
24497
+ },
24498
+ 400: { description: 'Bad Request' },
24499
+ 401: { description: 'Unauthorized' },
24500
+ },
24501
+ security: [
24502
+ { pat_with_workspace: [] },
24503
+ { console_session_with_workspace: [] },
24504
+ { api_key: [] },
24505
+ ],
24506
+ summary: '/access_methods/encode',
24507
+ tags: [],
24508
+ 'x-action-attempt-type': 'ENCODE_CREDENTIAL',
24509
+ 'x-fern-sdk-group-name': ['access_methods'],
24510
+ 'x-fern-sdk-method-name': 'encode',
24511
+ 'x-fern-sdk-return-value': 'action_attempt',
24512
+ 'x-response-key': 'action_attempt',
24513
+ 'x-title': 'Encode an Access Method',
24514
+ },
24515
+ },
24677
24516
  '/access_methods/get': {
24678
24517
  get: {
24679
24518
  description: 'Get an access method.',
@@ -27356,10 +27195,10 @@ export default {
27356
27195
  'x-title': 'Update a Credential',
27357
27196
  },
27358
27197
  },
27359
- '/acs/encoders/encode_access_method': {
27198
+ '/acs/encoders/encode_credential': {
27360
27199
  post: {
27361
- description: 'Encodes an existing access method onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
27362
- operationId: 'acsEncodersEncodeAccessMethodPost',
27200
+ 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). Either provide an `acs_credential_id` or an `access_method_id`',
27201
+ operationId: 'acsEncodersEncodeCredentialPost',
27363
27202
  requestBody: {
27364
27203
  content: {
27365
27204
  'application/json': {
@@ -27370,63 +27209,6 @@ export default {
27370
27209
  format: 'uuid',
27371
27210
  type: 'string',
27372
27211
  },
27373
- acs_encoder_id: {
27374
- description: 'ID of the `acs_encoder` to use to encode the `access_method`.',
27375
- format: 'uuid',
27376
- type: 'string',
27377
- },
27378
- },
27379
- required: ['acs_encoder_id', 'access_method_id'],
27380
- type: 'object',
27381
- },
27382
- },
27383
- },
27384
- },
27385
- responses: {
27386
- 200: {
27387
- content: {
27388
- 'application/json': {
27389
- schema: {
27390
- properties: {
27391
- action_attempt: {
27392
- $ref: '#/components/schemas/action_attempt',
27393
- },
27394
- ok: { type: 'boolean' },
27395
- },
27396
- required: ['action_attempt', 'ok'],
27397
- type: 'object',
27398
- },
27399
- },
27400
- },
27401
- description: 'OK',
27402
- },
27403
- 400: { description: 'Bad Request' },
27404
- 401: { description: 'Unauthorized' },
27405
- },
27406
- security: [
27407
- { pat_with_workspace: [] },
27408
- { console_session_with_workspace: [] },
27409
- { api_key: [] },
27410
- ],
27411
- summary: '/acs/encoders/encode_access_method',
27412
- tags: ['/acs'],
27413
- 'x-action-attempt-type': 'ENCODE_ACCESS_METHOD',
27414
- 'x-fern-sdk-group-name': ['acs', 'encoders'],
27415
- 'x-fern-sdk-method-name': 'encode_access_method',
27416
- 'x-fern-sdk-return-value': 'action_attempt',
27417
- 'x-response-key': 'action_attempt',
27418
- 'x-title': 'Encode an Access Method',
27419
- },
27420
- },
27421
- '/acs/encoders/encode_credential': {
27422
- post: {
27423
- 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).',
27424
- operationId: 'acsEncodersEncodeCredentialPost',
27425
- requestBody: {
27426
- content: {
27427
- 'application/json': {
27428
- schema: {
27429
- properties: {
27430
27212
  acs_credential_id: {
27431
27213
  description: 'ID of the `acs_credential` to encode onto a card.',
27432
27214
  format: 'uuid',
@@ -27438,7 +27220,7 @@ export default {
27438
27220
  type: 'string',
27439
27221
  },
27440
27222
  },
27441
- required: ['acs_encoder_id', 'acs_credential_id'],
27223
+ required: ['acs_encoder_id'],
27442
27224
  type: 'object',
27443
27225
  },
27444
27226
  },