@seamapi/types 1.426.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 (26) hide show
  1. package/dist/connect.cjs +150 -437
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +3041 -5161
  4. package/lib/seam/connect/models/access-grants/access-grant.d.ts +3 -0
  5. package/lib/seam/connect/models/access-grants/access-grant.js +5 -0
  6. package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
  7. package/lib/seam/connect/models/access-grants/access-method.d.ts +5 -5
  8. package/lib/seam/connect/models/access-grants/access-method.js +3 -2
  9. package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
  10. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +0 -183
  11. package/lib/seam/connect/models/action-attempts/action-attempt.js +1 -3
  12. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
  13. package/lib/seam/connect/openapi.d.ts +84 -192
  14. package/lib/seam/connect/openapi.js +74 -285
  15. package/lib/seam/connect/openapi.js.map +1 -1
  16. package/lib/seam/connect/route-types.d.ts +2571 -4403
  17. package/package.json +1 -1
  18. package/src/lib/seam/connect/models/access-grants/access-grant.ts +7 -0
  19. package/src/lib/seam/connect/models/access-grants/access-method.ts +3 -2
  20. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +1 -3
  21. package/src/lib/seam/connect/openapi.ts +78 -318
  22. package/src/lib/seam/connect/route-types.ts +3617 -5657
  23. package/lib/seam/connect/models/action-attempts/encode-access-method.d.ts +0 -186
  24. package/lib/seam/connect/models/action-attempts/encode-access-method.js +0 -60
  25. package/lib/seam/connect/models/action-attempts/encode-access-method.js.map +0 -1
  26. package/src/lib/seam/connect/models/action-attempts/encode-access-method.ts +0 -101
package/lib/seam/connect/openapi.js CHANGED
@@ -1595,6 +1595,11 @@ export default {
1595
1595
  format: 'date-time',
1596
1596
  type: 'string',
1597
1597
  },
1598
+ instant_key_url: {
1599
+ description: 'Instant Key URL. Only returned if the access grant has a single mobile_key access_method. ',
1600
+ format: 'uri',
1601
+ type: 'string',
1602
+ },
1598
1603
  location_ids: {
1599
1604
  deprecated: true,
1600
1605
  items: { format: 'uuid', type: 'string' },
@@ -1690,10 +1695,11 @@ export default {
1690
1695
  },
1691
1696
  instant_key_url: {
1692
1697
  description: 'URL of the Instant Key for mobile key access methods.',
1698
+ format: 'uri',
1693
1699
  type: 'string',
1694
1700
  },
1695
- is_card_encoding_required: {
1696
- 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.',
1697
1703
  type: 'boolean',
1698
1704
  },
1699
1705
  issued_at: {
@@ -4811,228 +4817,6 @@ export default {
4811
4817
  ],
4812
4818
  type: 'object',
4813
4819
  },
4814
- {
4815
- description: 'Encoding access method data from the physical encoder onto a card is pending.',
4816
- properties: {
4817
- action_attempt_id: {
4818
- description: 'ID of the action attempt.',
4819
- format: 'uuid',
4820
- type: 'string',
4821
- },
4822
- action_type: {
4823
- description: 'Action attempt to track the status of encoding an access method from the physical encoder onto a card.',
4824
- enum: ['ENCODE_ACCESS_METHOD'],
4825
- type: 'string',
4826
- },
4827
- error: {
4828
- description: 'Errors associated with the action attempt. Null for pending action attempts.',
4829
- nullable: true,
4830
- },
4831
- result: {
4832
- description: 'Result of the action attempt. Null for pending action attempts.',
4833
- nullable: true,
4834
- },
4835
- status: { enum: ['pending'], type: 'string' },
4836
- },
4837
- required: [
4838
- 'action_attempt_id',
4839
- 'status',
4840
- 'result',
4841
- 'error',
4842
- 'action_type',
4843
- ],
4844
- type: 'object',
4845
- },
4846
- {
4847
- description: 'Encoding access method data from the physical encoder onto a card succeeded.',
4848
- properties: {
4849
- action_attempt_id: {
4850
- description: 'ID of the action attempt.',
4851
- format: 'uuid',
4852
- type: 'string',
4853
- },
4854
- action_type: {
4855
- description: 'Action attempt to track the status of encoding an access method from the physical encoder onto a card.',
4856
- enum: ['ENCODE_ACCESS_METHOD'],
4857
- type: 'string',
4858
- },
4859
- error: {
4860
- description: 'Errors associated with the action attempt. Null for successful action attempts.',
4861
- nullable: true,
4862
- },
4863
- result: {
4864
- description: 'Result of an encoding attempt. If the attempt was successful, includes the access method data that was encoded onto the card.',
4865
- properties: {
4866
- access_method_id: {
4867
- description: 'ID of the access method.',
4868
- format: 'uuid',
4869
- type: 'string',
4870
- },
4871
- created_at: {
4872
- description: 'Date and time at which the access method was created.',
4873
- format: 'date-time',
4874
- type: 'string',
4875
- },
4876
- display_name: {
4877
- description: 'Display name of the access method.',
4878
- type: 'string',
4879
- },
4880
- instant_key_url: {
4881
- description: 'URL of the Instant Key for mobile key access methods.',
4882
- type: 'string',
4883
- },
4884
- is_card_encoding_required: {
4885
- description: 'Indicates whether card encoding is required for plastic card access methods.',
4886
- type: 'boolean',
4887
- },
4888
- issued_at: {
4889
- description: 'Date and time at which the access method was issued.',
4890
- format: 'date-time',
4891
- type: 'string',
4892
- },
4893
- mode: {
4894
- description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
4895
- enum: ['code', 'card', 'mobile_key'],
4896
- type: 'string',
4897
- },
4898
- workspace_id: {
4899
- description: 'ID of the Seam workspace associated with the access method.',
4900
- format: 'uuid',
4901
- type: 'string',
4902
- },
4903
- },
4904
- required: [
4905
- 'workspace_id',
4906
- 'access_method_id',
4907
- 'display_name',
4908
- 'mode',
4909
- 'created_at',
4910
- ],
4911
- type: 'object',
4912
- },
4913
- status: { enum: ['success'], type: 'string' },
4914
- },
4915
- required: [
4916
- 'action_attempt_id',
4917
- 'status',
4918
- 'error',
4919
- 'action_type',
4920
- 'result',
4921
- ],
4922
- type: 'object',
4923
- },
4924
- {
4925
- description: 'Encoding access method data from the physical encoder onto a card failed.',
4926
- properties: {
4927
- action_attempt_id: {
4928
- description: 'ID of the action attempt.',
4929
- format: 'uuid',
4930
- type: 'string',
4931
- },
4932
- action_type: {
4933
- description: 'Action attempt to track the status of encoding an access method from the physical encoder onto a card.',
4934
- enum: ['ENCODE_ACCESS_METHOD'],
4935
- type: 'string',
4936
- },
4937
- error: {
4938
- oneOf: [
4939
- {
4940
- description: "Error that doesn't fit into other specific error categories.",
4941
- properties: {
4942
- message: {
4943
- description: 'Message for the error associated with the action attempt.',
4944
- type: 'string',
4945
- },
4946
- type: {
4947
- description: 'Type of the error associated with the action attempt.',
4948
- enum: ['uncategorized_error'],
4949
- type: 'string',
4950
- },
4951
- },
4952
- required: ['type', 'message'],
4953
- type: 'object',
4954
- },
4955
- {
4956
- description: 'Error to indicate an expired action attempt.',
4957
- properties: {
4958
- message: {
4959
- description: 'Message for the error associated with the action attempt.',
4960
- type: 'string',
4961
- },
4962
- type: {
4963
- description: 'Type of the error associated with the action attempt.',
4964
- enum: ['action_attempt_expired'],
4965
- type: 'string',
4966
- },
4967
- },
4968
- required: ['type', 'message'],
4969
- type: 'object',
4970
- },
4971
- {
4972
- description: 'Error to indicate that there is no credential on the encoder.',
4973
- properties: {
4974
- message: {
4975
- description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
4976
- type: 'string',
4977
- },
4978
- type: {
4979
- description: 'Error type to indicate that there is no credential on the encoder.',
4980
- enum: ['no_credential_on_encoder'],
4981
- type: 'string',
4982
- },
4983
- },
4984
- required: ['type', 'message'],
4985
- type: 'object',
4986
- },
4987
- {
4988
- description: 'Error to indicate an incompatible card format.',
4989
- properties: {
4990
- message: {
4991
- description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
4992
- type: 'string',
4993
- },
4994
- type: {
4995
- description: 'Error type to indicate an incompatible card format.',
4996
- enum: ['incompatible_card_format'],
4997
- type: 'string',
4998
- },
4999
- },
5000
- required: ['type', 'message'],
5001
- type: 'object',
5002
- },
5003
- {
5004
- description: 'Error to indicate that the affected credential cannot be reissued.',
5005
- properties: {
5006
- message: {
5007
- description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
5008
- type: 'string',
5009
- },
5010
- type: {
5011
- description: 'Error type to indicate that the affected credential cannot be reissued.',
5012
- enum: ['credential_cannot_be_reissued'],
5013
- type: 'string',
5014
- },
5015
- },
5016
- required: ['type', 'message'],
5017
- type: 'object',
5018
- },
5019
- ],
5020
- },
5021
- result: {
5022
- description: 'Result of the action attempt. Null for failed action attempts.',
5023
- nullable: true,
5024
- },
5025
- status: { enum: ['error'], type: 'string' },
5026
- },
5027
- required: [
5028
- 'action_attempt_id',
5029
- 'status',
5030
- 'result',
5031
- 'action_type',
5032
- 'error',
5033
- ],
5034
- type: 'object',
5035
- },
5036
4820
  {
5037
4821
  description: 'Encoding credential data from the physical encoder onto a card is pending.',
5038
4822
  properties: {
@@ -24667,6 +24451,68 @@ export default {
24667
24451
  'x-title': 'Delete an Access Method',
24668
24452
  },
24669
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
+ },
24670
24516
  '/access_methods/get': {
24671
24517
  get: {
24672
24518
  description: 'Get an access method.',
@@ -27349,10 +27195,10 @@ export default {
27349
27195
  'x-title': 'Update a Credential',
27350
27196
  },
27351
27197
  },
27352
- '/acs/encoders/encode_access_method': {
27198
+ '/acs/encoders/encode_credential': {
27353
27199
  post: {
27354
- 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).',
27355
- 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',
27356
27202
  requestBody: {
27357
27203
  content: {
27358
27204
  'application/json': {
@@ -27363,63 +27209,6 @@ export default {
27363
27209
  format: 'uuid',
27364
27210
  type: 'string',
27365
27211
  },
27366
- acs_encoder_id: {
27367
- description: 'ID of the `acs_encoder` to use to encode the `access_method`.',
27368
- format: 'uuid',
27369
- type: 'string',
27370
- },
27371
- },
27372
- required: ['acs_encoder_id', 'access_method_id'],
27373
- type: 'object',
27374
- },
27375
- },
27376
- },
27377
- },
27378
- responses: {
27379
- 200: {
27380
- content: {
27381
- 'application/json': {
27382
- schema: {
27383
- properties: {
27384
- action_attempt: {
27385
- $ref: '#/components/schemas/action_attempt',
27386
- },
27387
- ok: { type: 'boolean' },
27388
- },
27389
- required: ['action_attempt', 'ok'],
27390
- type: 'object',
27391
- },
27392
- },
27393
- },
27394
- description: 'OK',
27395
- },
27396
- 400: { description: 'Bad Request' },
27397
- 401: { description: 'Unauthorized' },
27398
- },
27399
- security: [
27400
- { pat_with_workspace: [] },
27401
- { console_session_with_workspace: [] },
27402
- { api_key: [] },
27403
- ],
27404
- summary: '/acs/encoders/encode_access_method',
27405
- tags: ['/acs'],
27406
- 'x-action-attempt-type': 'ENCODE_ACCESS_METHOD',
27407
- 'x-fern-sdk-group-name': ['acs', 'encoders'],
27408
- 'x-fern-sdk-method-name': 'encode_access_method',
27409
- 'x-fern-sdk-return-value': 'action_attempt',
27410
- 'x-response-key': 'action_attempt',
27411
- 'x-title': 'Encode an Access Method',
27412
- },
27413
- },
27414
- '/acs/encoders/encode_credential': {
27415
- post: {
27416
- 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).',
27417
- operationId: 'acsEncodersEncodeCredentialPost',
27418
- requestBody: {
27419
- content: {
27420
- 'application/json': {
27421
- schema: {
27422
- properties: {
27423
27212
  acs_credential_id: {
27424
27213
  description: 'ID of the `acs_credential` to encode onto a card.',
27425
27214
  format: 'uuid',
@@ -27431,7 +27220,7 @@ export default {
27431
27220
  type: 'string',
27432
27221
  },
27433
27222
  },
27434
- required: ['acs_encoder_id', 'acs_credential_id'],
27223
+ required: ['acs_encoder_id'],
27435
27224
  type: 'object',
27436
27225
  },
27437
27226
  },