@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.
package/dist/connect.cjs CHANGED
@@ -2404,26 +2404,6 @@ var unmanaged_access_code = access_code.pick({
2404
2404
 
2405
2405
  - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks)
2406
2406
  `);
2407
- var access_method = zod.z.object({
2408
- workspace_id: zod.z.string().uuid().describe("ID of the Seam workspace associated with the access method."),
2409
- access_method_id: zod.z.string().uuid().describe("ID of the access method."),
2410
- display_name: zod.z.string().describe("Display name of the access method."),
2411
- mode: zod.z.enum(["code", "card", "mobile_key"]).describe(
2412
- "Access method mode. Supported values: `code`, `card`, `mobile_key`."
2413
- ),
2414
- created_at: zod.z.string().datetime().describe("Date and time at which the access method was created."),
2415
- issued_at: zod.z.string().datetime().optional().describe("Date and time at which the access method was issued."),
2416
- instant_key_url: zod.z.string().url().optional().describe("URL of the Instant Key for mobile key access methods."),
2417
- is_card_encoding_required: zod.z.boolean().optional().describe(
2418
- "Indicates whether card encoding is required for plastic card access methods."
2419
- )
2420
- }).describe(`
2421
- ---
2422
- draft: Early access.
2423
- route_path: /access_methods
2424
- ---
2425
- Represents an access method for an access grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.
2426
- `);
2427
2407
  var acs_access_group_external_type = zod.z.enum([
2428
2408
  "pti_unit",
2429
2409
  "pti_access_level",
@@ -3649,8 +3629,8 @@ var deprecated_action_attempts = [
3649
3629
  ...delete_noise_threshold_action_attempt.options,
3650
3630
  ...update_noise_threshold_action_attempt.options
3651
3631
  ];
3652
- var action_type2 = zod.z.literal("ENCODE_ACCESS_METHOD").describe(
3653
- "Action attempt to track the status of encoding an access method from the physical encoder onto a card."
3632
+ var action_type2 = zod.z.literal("ENCODE_CREDENTIAL").describe(
3633
+ "Action attempt to track the status of encoding credential data from the physical encoder onto a card."
3654
3634
  );
3655
3635
  var no_credential_on_encoder_error = zod.z.object({
3656
3636
  type: zod.z.literal("no_credential_on_encoder").describe(
@@ -3682,149 +3662,94 @@ var error3 = zod.z.union([
3682
3662
  incompatible_card_format_error,
3683
3663
  credential_cannot_be_reissued
3684
3664
  ]);
3685
- var result3 = access_method.describe(
3686
- "Result of an encoding attempt. If the attempt was successful, includes the access method data that was encoded onto the card."
3687
- );
3688
- var encode_access_method_action_attempt = zod.z.discriminatedUnion(
3689
- "status",
3690
- [
3691
- common_pending_action_attempt.extend({
3692
- action_type: action_type2
3693
- }).describe(
3694
- "Encoding access method data from the physical encoder onto a card is pending."
3695
- ),
3696
- common_succeeded_action_attempt.extend({
3697
- action_type: action_type2,
3698
- result: result3
3699
- }).describe(
3700
- "Encoding access method data from the physical encoder onto a card succeeded."
3701
- ),
3702
- common_failed_action_attempt.extend({ action_type: action_type2, error: error3 }).describe(
3703
- "Encoding access method data from the physical encoder onto a card failed."
3704
- )
3705
- ]
3706
- );
3707
- var action_type3 = zod.z.literal("ENCODE_CREDENTIAL").describe(
3708
- "Action attempt to track the status of encoding credential data from the physical encoder onto a card."
3709
- );
3710
- var no_credential_on_encoder_error2 = zod.z.object({
3711
- type: zod.z.literal("no_credential_on_encoder").describe(
3712
- "Error type to indicate that there is no credential on the encoder."
3713
- ),
3714
- message: zod.z.string().describe(
3715
- "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
3716
- )
3717
- }).describe("Error to indicate that there is no credential on the encoder.");
3718
- var incompatible_card_format_error2 = zod.z.object({
3719
- type: zod.z.literal("incompatible_card_format").describe("Error type to indicate an incompatible card format."),
3720
- message: zod.z.string().describe(
3721
- "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
3722
- )
3723
- }).describe("Error to indicate an incompatible card format.");
3724
- var credential_cannot_be_reissued2 = zod.z.object({
3725
- type: zod.z.literal("credential_cannot_be_reissued").describe(
3726
- "Error type to indicate that the affected credential cannot be reissued."
3727
- ),
3728
- message: zod.z.string().describe(
3729
- "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
3730
- )
3731
- }).describe(
3732
- "Error to indicate that the affected credential cannot be reissued."
3733
- );
3734
- var error4 = zod.z.union([
3735
- ...common_action_attempt_errors,
3736
- no_credential_on_encoder_error2,
3737
- incompatible_card_format_error2,
3738
- credential_cannot_be_reissued2
3739
- ]);
3740
- var result4 = acs_credential.or(unmanaged_acs_credential).describe(
3665
+ var result3 = acs_credential.or(unmanaged_acs_credential).describe(
3741
3666
  "Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card."
3742
3667
  );
3743
3668
  var encode_credential_action_attempt = zod.z.discriminatedUnion("status", [
3744
3669
  common_pending_action_attempt.extend({
3745
- action_type: action_type3
3670
+ action_type: action_type2
3746
3671
  }).describe(
3747
3672
  "Encoding credential data from the physical encoder onto a card is pending."
3748
3673
  ),
3749
3674
  common_succeeded_action_attempt.extend({
3750
- action_type: action_type3,
3751
- result: result4
3675
+ action_type: action_type2,
3676
+ result: result3
3752
3677
  }).describe(
3753
3678
  "Encoding credential data from the physical encoder onto a card succeeded."
3754
3679
  ),
3755
- common_failed_action_attempt.extend({ action_type: action_type3, error: error4 }).describe(
3680
+ common_failed_action_attempt.extend({ action_type: action_type2, error: error3 }).describe(
3756
3681
  "Encoding credential data from the physical encoder onto a card failed."
3757
3682
  )
3758
3683
  ]);
3759
- var action_type4 = zod.z.literal("LOCK_DOOR").describe("Action attempt to track the status of locking a door.");
3760
- var error5 = zod.z.object({
3684
+ var action_type3 = zod.z.literal("LOCK_DOOR").describe("Action attempt to track the status of locking a door.");
3685
+ var error4 = zod.z.object({
3761
3686
  type: zod.z.string().describe("Type of the error."),
3762
3687
  message: zod.z.string().describe(
3763
3688
  "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
3764
3689
  )
3765
3690
  }).describe("Error associated with the action.");
3766
- var result5 = zod.z.object({}).describe("Result of the action.");
3691
+ var result4 = zod.z.object({}).describe("Result of the action.");
3767
3692
  var lock_door_action_attempt = zod.z.discriminatedUnion("status", [
3768
3693
  common_pending_action_attempt.extend({
3769
- action_type: action_type4
3694
+ action_type: action_type3
3770
3695
  }).describe("Locking a door is pending."),
3771
3696
  common_succeeded_action_attempt.extend({
3772
- action_type: action_type4,
3773
- result: result5
3697
+ action_type: action_type3,
3698
+ result: result4
3774
3699
  }).describe("Locking a door succeeded."),
3775
- common_failed_action_attempt.extend({ action_type: action_type4, error: error5 }).describe("Locking a door failed.")
3700
+ common_failed_action_attempt.extend({ action_type: action_type3, error: error4 }).describe("Locking a door failed.")
3776
3701
  ]);
3777
- var action_type5 = zod.z.literal("PUSH_THERMOSTAT_PROGRAMS").describe(
3702
+ var action_type4 = zod.z.literal("PUSH_THERMOSTAT_PROGRAMS").describe(
3778
3703
  "Action attempt to track the status of pushing thermostat programs."
3779
3704
  );
3780
- var error6 = zod.z.object({
3705
+ var error5 = zod.z.object({
3781
3706
  type: zod.z.string().describe("Type of the error."),
3782
3707
  message: zod.z.string().describe(
3783
3708
  "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
3784
3709
  )
3785
3710
  }).describe("Error associated with the action.");
3786
- var result6 = zod.z.object({}).describe("Result of the action.");
3711
+ var result5 = zod.z.object({}).describe("Result of the action.");
3787
3712
  var push_thermostat_programs_action_attempt = zod.z.discriminatedUnion(
3788
3713
  "status",
3789
3714
  [
3790
3715
  common_pending_action_attempt.extend({
3791
- action_type: action_type5
3716
+ action_type: action_type4
3792
3717
  }).describe("Pushing thermostat weekly programs is pending."),
3793
3718
  common_succeeded_action_attempt.extend({
3794
- action_type: action_type5,
3795
- result: result6
3719
+ action_type: action_type4,
3720
+ result: result5
3796
3721
  }).describe("Pushing thermostat weekly programs succeeded."),
3797
- common_failed_action_attempt.extend({ action_type: action_type5, error: error6 }).describe("Pushing thermostat weekly programs failed.")
3722
+ common_failed_action_attempt.extend({ action_type: action_type4, error: error5 }).describe("Pushing thermostat weekly programs failed.")
3798
3723
  ]
3799
3724
  );
3800
- var action_type6 = zod.z.literal("RESET_SANDBOX_WORKSPACE").describe(
3725
+ var action_type5 = zod.z.literal("RESET_SANDBOX_WORKSPACE").describe(
3801
3726
  "Action attempt to track the status of resetting a sandbox workspace."
3802
3727
  );
3803
- var error7 = zod.z.object({
3728
+ var error6 = zod.z.object({
3804
3729
  type: zod.z.string().describe("Type of the error."),
3805
3730
  message: zod.z.string().describe(
3806
3731
  "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
3807
3732
  )
3808
3733
  }).describe("Error associated with the action.");
3809
- var result7 = zod.z.object({}).describe("Result of the action.");
3734
+ var result6 = zod.z.object({}).describe("Result of the action.");
3810
3735
  var reset_sandbox_workspace_action_attempt = zod.z.discriminatedUnion(
3811
3736
  "status",
3812
3737
  [
3813
3738
  common_pending_action_attempt.extend({
3814
- action_type: action_type6
3739
+ action_type: action_type5
3815
3740
  }).describe("Resetting a sandbox workspace is pending."),
3816
3741
  common_succeeded_action_attempt.extend({
3817
- action_type: action_type6,
3818
- result: result7
3742
+ action_type: action_type5,
3743
+ result: result6
3819
3744
  }).describe("Resetting a sandbox workspace succeeded."),
3820
3745
  common_failed_action_attempt.extend({
3821
- action_type: action_type6,
3822
- error: error7
3746
+ action_type: action_type5,
3747
+ error: error6
3823
3748
  }).describe("Resetting a sandbox workspace failed.")
3824
3749
  ]
3825
3750
  );
3826
- var action_type7 = zod.z.literal("SCAN_CREDENTIAL").describe("Action attempt to track the status of scanning a credential.");
3827
- var no_credential_on_encoder_error3 = zod.z.object({
3751
+ var action_type6 = zod.z.literal("SCAN_CREDENTIAL").describe("Action attempt to track the status of scanning a credential.");
3752
+ var no_credential_on_encoder_error2 = zod.z.object({
3828
3753
  type: zod.z.literal("no_credential_on_encoder").describe(
3829
3754
  "Error type to indicate that there is no credential on the encoder."
3830
3755
  ),
@@ -3832,9 +3757,9 @@ var no_credential_on_encoder_error3 = zod.z.object({
3832
3757
  "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
3833
3758
  )
3834
3759
  }).describe("Error to indicate that there is no credential on the encoder.");
3835
- var error8 = zod.z.union([
3760
+ var error7 = zod.z.union([
3836
3761
  ...common_action_attempt_errors,
3837
- no_credential_on_encoder_error3
3762
+ no_credential_on_encoder_error2
3838
3763
  ]);
3839
3764
  var warning = zod.z.object({
3840
3765
  warning_code: zod.z.union([
@@ -3846,7 +3771,7 @@ var warning = zod.z.object({
3846
3771
  )
3847
3772
  }).describe("Warning related to scanning a credential.");
3848
3773
  var acs_credential_on_seam = acs_credential.or(unmanaged_acs_credential);
3849
- var result8 = zod.z.object({
3774
+ var result7 = zod.z.object({
3850
3775
  acs_credential_on_encoder: acs_credential_on_encoder.nullable().describe("Snapshot of credential data read from the physical encoder."),
3851
3776
  acs_credential_on_seam: acs_credential_on_seam.nullable().describe(
3852
3777
  "Corresponding credential data as stored on Seam and the access system."
@@ -3859,120 +3784,120 @@ var result8 = zod.z.object({
3859
3784
  );
3860
3785
  var scan_credential_action_attempt = zod.z.discriminatedUnion("status", [
3861
3786
  common_pending_action_attempt.extend({
3862
- action_type: action_type7
3787
+ action_type: action_type6
3863
3788
  }).describe("Reading credential data from the physical encoder is pending."),
3864
3789
  common_succeeded_action_attempt.extend({
3865
- action_type: action_type7,
3866
- result: result8
3790
+ action_type: action_type6,
3791
+ result: result7
3867
3792
  }).describe("Reading credential data from physical encoder succeeded."),
3868
- common_failed_action_attempt.extend({ action_type: action_type7, error: error8 }).describe("Reading credential data from physical encoder failed.")
3793
+ common_failed_action_attempt.extend({ action_type: action_type6, error: error7 }).describe("Reading credential data from physical encoder failed.")
3869
3794
  ]);
3870
- var action_type8 = zod.z.literal("SET_FAN_MODE").describe(
3795
+ var action_type7 = zod.z.literal("SET_FAN_MODE").describe(
3871
3796
  "Action attempt to track the status of setting the fan mode on a thermostat."
3872
3797
  );
3873
- var error9 = zod.z.object({
3798
+ var error8 = zod.z.object({
3874
3799
  type: zod.z.string().describe("Type of the error."),
3875
3800
  message: zod.z.string().describe(
3876
3801
  "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
3877
3802
  )
3878
3803
  }).describe("Error associated with the action.");
3879
- var result9 = zod.z.object({}).describe("Result of the action.");
3804
+ var result8 = zod.z.object({}).describe("Result of the action.");
3880
3805
  var set_fan_mode_action_attempt = zod.z.discriminatedUnion("status", [
3881
3806
  common_pending_action_attempt.extend({
3882
- action_type: action_type8
3807
+ action_type: action_type7
3883
3808
  }).describe("Setting the fan mode is pending."),
3884
3809
  common_succeeded_action_attempt.extend({
3885
- action_type: action_type8,
3886
- result: result9
3810
+ action_type: action_type7,
3811
+ result: result8
3887
3812
  }).describe("Setting the fan mode succeeded."),
3888
- common_failed_action_attempt.extend({ action_type: action_type8, error: error9 }).describe("Setting the fan mode failed.")
3813
+ common_failed_action_attempt.extend({ action_type: action_type7, error: error8 }).describe("Setting the fan mode failed.")
3889
3814
  ]);
3890
- var action_type9 = zod.z.literal("SET_HVAC_MODE").describe(
3815
+ var action_type8 = zod.z.literal("SET_HVAC_MODE").describe(
3891
3816
  "Action attempt to track the status of setting the HVAC mode on a thermostat."
3892
3817
  );
3893
- var error10 = zod.z.object({
3818
+ var error9 = zod.z.object({
3894
3819
  type: zod.z.string().describe("Type of the error."),
3895
3820
  message: zod.z.string().describe(
3896
3821
  "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
3897
3822
  )
3898
3823
  }).describe("Error associated with the action.");
3899
- var result10 = zod.z.object({}).describe("Result of the action.");
3824
+ var result9 = zod.z.object({}).describe("Result of the action.");
3900
3825
  var set_hvac_mode_action_attempt = zod.z.discriminatedUnion("status", [
3901
3826
  common_pending_action_attempt.extend({
3902
- action_type: action_type9
3827
+ action_type: action_type8
3903
3828
  }).describe("Setting the HVAC mode is pending."),
3904
3829
  common_succeeded_action_attempt.extend({
3905
- action_type: action_type9,
3906
- result: result10
3830
+ action_type: action_type8,
3831
+ result: result9
3907
3832
  }).describe("Setting the HVAC mode succeeded."),
3908
- common_failed_action_attempt.extend({ action_type: action_type9, error: error10 }).describe("Setting the HVAC mode failed.")
3833
+ common_failed_action_attempt.extend({ action_type: action_type8, error: error9 }).describe("Setting the HVAC mode failed.")
3909
3834
  ]);
3910
- var action_type10 = zod.z.literal("SIMULATE_KEYPAD_CODE_ENTRY").describe(
3835
+ var action_type9 = zod.z.literal("SIMULATE_KEYPAD_CODE_ENTRY").describe(
3911
3836
  "Action attempt to track the status of simulating a keypad code entry."
3912
3837
  );
3913
- var error11 = zod.z.object({
3838
+ var error10 = zod.z.object({
3914
3839
  type: zod.z.string().describe("Type of the error."),
3915
3840
  message: zod.z.string().describe(
3916
3841
  "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
3917
3842
  )
3918
3843
  }).describe("Error associated with the action.");
3919
- var result11 = zod.z.object({}).describe("Result of the action.");
3844
+ var result10 = zod.z.object({}).describe("Result of the action.");
3920
3845
  var simulate_keypad_code_entry_action_attempt = zod.z.discriminatedUnion(
3921
3846
  "status",
3922
3847
  [
3923
3848
  common_pending_action_attempt.extend({
3924
- action_type: action_type10
3849
+ action_type: action_type9
3925
3850
  }).describe("Simulating a keypad code entry is pending."),
3926
3851
  common_succeeded_action_attempt.extend({
3927
- action_type: action_type10,
3928
- result: result11
3852
+ action_type: action_type9,
3853
+ result: result10
3929
3854
  }).describe("Simulating a keypad code entry succeeded."),
3930
3855
  common_failed_action_attempt.extend({
3931
- action_type: action_type10,
3932
- error: error11
3856
+ action_type: action_type9,
3857
+ error: error10
3933
3858
  }).describe("Simulating a keypad code entry failed.")
3934
3859
  ]
3935
3860
  );
3936
- var action_type11 = zod.z.literal("SIMULATE_MANUAL_LOCK_VIA_KEYPAD").describe(
3861
+ var action_type10 = zod.z.literal("SIMULATE_MANUAL_LOCK_VIA_KEYPAD").describe(
3937
3862
  "Action attempt to track the status of simulating a manual lock action using a keypad."
3938
3863
  );
3939
- var error12 = zod.z.object({
3864
+ var error11 = zod.z.object({
3940
3865
  type: zod.z.string().describe("Type of the error."),
3941
3866
  message: zod.z.string().describe(
3942
3867
  "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
3943
3868
  )
3944
3869
  }).describe("Error associated with the action.");
3945
- var result12 = zod.z.object({}).describe("Result of the action.");
3870
+ var result11 = zod.z.object({}).describe("Result of the action.");
3946
3871
  var simulate_manual_lock_via_keypad_action_attempt = zod.z.discriminatedUnion("status", [
3947
3872
  common_pending_action_attempt.extend({
3948
- action_type: action_type11
3873
+ action_type: action_type10
3949
3874
  }).describe("Simulating a manual lock action using a keypad is pending."),
3950
3875
  common_succeeded_action_attempt.extend({
3951
- action_type: action_type11,
3952
- result: result12
3876
+ action_type: action_type10,
3877
+ result: result11
3953
3878
  }).describe("Simulating a manual lock action using a keypad succeeded."),
3954
3879
  common_failed_action_attempt.extend({
3955
- action_type: action_type11,
3956
- error: error12
3880
+ action_type: action_type10,
3881
+ error: error11
3957
3882
  }).describe("Simulating a manual lock action using a keypad failed.")
3958
3883
  ]);
3959
- var action_type12 = zod.z.literal("UNLOCK_DOOR").describe("Action attempt to track the status of unlocking a door.");
3960
- var error13 = zod.z.object({
3884
+ var action_type11 = zod.z.literal("UNLOCK_DOOR").describe("Action attempt to track the status of unlocking a door.");
3885
+ var error12 = zod.z.object({
3961
3886
  type: zod.z.string().describe("Type of the error."),
3962
3887
  message: zod.z.string().describe(
3963
3888
  "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
3964
3889
  )
3965
3890
  }).describe("Error associated with the action.");
3966
- var result13 = zod.z.object({}).describe("Result of the action.");
3891
+ var result12 = zod.z.object({}).describe("Result of the action.");
3967
3892
  var unlock_door_action_attempt = zod.z.discriminatedUnion("status", [
3968
3893
  common_pending_action_attempt.extend({
3969
- action_type: action_type12
3894
+ action_type: action_type11
3970
3895
  }).describe("Unlocking a door is pending."),
3971
3896
  common_succeeded_action_attempt.extend({
3972
- action_type: action_type12,
3973
- result: result13
3897
+ action_type: action_type11,
3898
+ result: result12
3974
3899
  }).describe("Unlocking a door succeeded."),
3975
- common_failed_action_attempt.extend({ action_type: action_type12, error: error13 }).describe("Unlocking a door failed.")
3900
+ common_failed_action_attempt.extend({ action_type: action_type11, error: error12 }).describe("Unlocking a door failed.")
3976
3901
  ]);
3977
3902
 
3978
3903
  // src/lib/seam/connect/models/action-attempts/action-attempt.ts
@@ -3980,7 +3905,6 @@ var action_attempt = zod.z.union([
3980
3905
  ...lock_door_action_attempt.options,
3981
3906
  ...unlock_door_action_attempt.options,
3982
3907
  ...scan_credential_action_attempt.options,
3983
- ...encode_access_method_action_attempt.options,
3984
3908
  ...encode_credential_action_attempt.options,
3985
3909
  ...reset_sandbox_workspace_action_attempt.options,
3986
3910
  ...set_fan_mode_action_attempt.options,
@@ -3995,7 +3919,7 @@ var action_attempt = zod.z.union([
3995
3919
  route_path: /action_attempts
3996
3920
  ---
3997
3921
  Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
3998
-
3922
+
3999
3923
  When you request for a device to perform an action, the Seam API immediately returns an action attempt object. In the background, the Seam API performs the action.
4000
3924
 
4001
3925
  See also [Action Attempts](https://docs.seam.co/latest/core-concepts/action-attempts).
@@ -7176,8 +7100,8 @@ var openapi_default = {
7176
7100
  format: "uri",
7177
7101
  type: "string"
7178
7102
  },
7179
- is_card_encoding_required: {
7180
- description: "Indicates whether card encoding is required for plastic card access methods.",
7103
+ is_encoding_required: {
7104
+ description: "Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.",
7181
7105
  type: "boolean"
7182
7106
  },
7183
7107
  issued_at: {
@@ -10295,229 +10219,6 @@ var openapi_default = {
10295
10219
  ],
10296
10220
  type: "object"
10297
10221
  },
10298
- {
10299
- description: "Encoding access method data from the physical encoder onto a card is pending.",
10300
- properties: {
10301
- action_attempt_id: {
10302
- description: "ID of the action attempt.",
10303
- format: "uuid",
10304
- type: "string"
10305
- },
10306
- action_type: {
10307
- description: "Action attempt to track the status of encoding an access method from the physical encoder onto a card.",
10308
- enum: ["ENCODE_ACCESS_METHOD"],
10309
- type: "string"
10310
- },
10311
- error: {
10312
- description: "Errors associated with the action attempt. Null for pending action attempts.",
10313
- nullable: true
10314
- },
10315
- result: {
10316
- description: "Result of the action attempt. Null for pending action attempts.",
10317
- nullable: true
10318
- },
10319
- status: { enum: ["pending"], type: "string" }
10320
- },
10321
- required: [
10322
- "action_attempt_id",
10323
- "status",
10324
- "result",
10325
- "error",
10326
- "action_type"
10327
- ],
10328
- type: "object"
10329
- },
10330
- {
10331
- description: "Encoding access method data from the physical encoder onto a card succeeded.",
10332
- properties: {
10333
- action_attempt_id: {
10334
- description: "ID of the action attempt.",
10335
- format: "uuid",
10336
- type: "string"
10337
- },
10338
- action_type: {
10339
- description: "Action attempt to track the status of encoding an access method from the physical encoder onto a card.",
10340
- enum: ["ENCODE_ACCESS_METHOD"],
10341
- type: "string"
10342
- },
10343
- error: {
10344
- description: "Errors associated with the action attempt. Null for successful action attempts.",
10345
- nullable: true
10346
- },
10347
- result: {
10348
- description: "Result of an encoding attempt. If the attempt was successful, includes the access method data that was encoded onto the card.",
10349
- properties: {
10350
- access_method_id: {
10351
- description: "ID of the access method.",
10352
- format: "uuid",
10353
- type: "string"
10354
- },
10355
- created_at: {
10356
- description: "Date and time at which the access method was created.",
10357
- format: "date-time",
10358
- type: "string"
10359
- },
10360
- display_name: {
10361
- description: "Display name of the access method.",
10362
- type: "string"
10363
- },
10364
- instant_key_url: {
10365
- description: "URL of the Instant Key for mobile key access methods.",
10366
- format: "uri",
10367
- type: "string"
10368
- },
10369
- is_card_encoding_required: {
10370
- description: "Indicates whether card encoding is required for plastic card access methods.",
10371
- type: "boolean"
10372
- },
10373
- issued_at: {
10374
- description: "Date and time at which the access method was issued.",
10375
- format: "date-time",
10376
- type: "string"
10377
- },
10378
- mode: {
10379
- description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
10380
- enum: ["code", "card", "mobile_key"],
10381
- type: "string"
10382
- },
10383
- workspace_id: {
10384
- description: "ID of the Seam workspace associated with the access method.",
10385
- format: "uuid",
10386
- type: "string"
10387
- }
10388
- },
10389
- required: [
10390
- "workspace_id",
10391
- "access_method_id",
10392
- "display_name",
10393
- "mode",
10394
- "created_at"
10395
- ],
10396
- type: "object"
10397
- },
10398
- status: { enum: ["success"], type: "string" }
10399
- },
10400
- required: [
10401
- "action_attempt_id",
10402
- "status",
10403
- "error",
10404
- "action_type",
10405
- "result"
10406
- ],
10407
- type: "object"
10408
- },
10409
- {
10410
- description: "Encoding access method data from the physical encoder onto a card failed.",
10411
- properties: {
10412
- action_attempt_id: {
10413
- description: "ID of the action attempt.",
10414
- format: "uuid",
10415
- type: "string"
10416
- },
10417
- action_type: {
10418
- description: "Action attempt to track the status of encoding an access method from the physical encoder onto a card.",
10419
- enum: ["ENCODE_ACCESS_METHOD"],
10420
- type: "string"
10421
- },
10422
- error: {
10423
- oneOf: [
10424
- {
10425
- description: "Error that doesn't fit into other specific error categories.",
10426
- properties: {
10427
- message: {
10428
- description: "Message for the error associated with the action attempt.",
10429
- type: "string"
10430
- },
10431
- type: {
10432
- description: "Type of the error associated with the action attempt.",
10433
- enum: ["uncategorized_error"],
10434
- type: "string"
10435
- }
10436
- },
10437
- required: ["type", "message"],
10438
- type: "object"
10439
- },
10440
- {
10441
- description: "Error to indicate an expired action attempt.",
10442
- properties: {
10443
- message: {
10444
- description: "Message for the error associated with the action attempt.",
10445
- type: "string"
10446
- },
10447
- type: {
10448
- description: "Type of the error associated with the action attempt.",
10449
- enum: ["action_attempt_expired"],
10450
- type: "string"
10451
- }
10452
- },
10453
- required: ["type", "message"],
10454
- type: "object"
10455
- },
10456
- {
10457
- description: "Error to indicate that there is no credential on the encoder.",
10458
- properties: {
10459
- message: {
10460
- description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
10461
- type: "string"
10462
- },
10463
- type: {
10464
- description: "Error type to indicate that there is no credential on the encoder.",
10465
- enum: ["no_credential_on_encoder"],
10466
- type: "string"
10467
- }
10468
- },
10469
- required: ["type", "message"],
10470
- type: "object"
10471
- },
10472
- {
10473
- description: "Error to indicate an incompatible card format.",
10474
- properties: {
10475
- message: {
10476
- description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
10477
- type: "string"
10478
- },
10479
- type: {
10480
- description: "Error type to indicate an incompatible card format.",
10481
- enum: ["incompatible_card_format"],
10482
- type: "string"
10483
- }
10484
- },
10485
- required: ["type", "message"],
10486
- type: "object"
10487
- },
10488
- {
10489
- description: "Error to indicate that the affected credential cannot be reissued.",
10490
- properties: {
10491
- message: {
10492
- description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
10493
- type: "string"
10494
- },
10495
- type: {
10496
- description: "Error type to indicate that the affected credential cannot be reissued.",
10497
- enum: ["credential_cannot_be_reissued"],
10498
- type: "string"
10499
- }
10500
- },
10501
- required: ["type", "message"],
10502
- type: "object"
10503
- }
10504
- ]
10505
- },
10506
- result: {
10507
- description: "Result of the action attempt. Null for failed action attempts.",
10508
- nullable: true
10509
- },
10510
- status: { enum: ["error"], type: "string" }
10511
- },
10512
- required: [
10513
- "action_attempt_id",
10514
- "status",
10515
- "result",
10516
- "action_type",
10517
- "error"
10518
- ],
10519
- type: "object"
10520
- },
10521
10222
  {
10522
10223
  description: "Encoding credential data from the physical encoder onto a card is pending.",
10523
10224
  properties: {
@@ -30152,6 +29853,68 @@ var openapi_default = {
30152
29853
  "x-title": "Delete an Access Method"
30153
29854
  }
30154
29855
  },
29856
+ "/access_methods/encode": {
29857
+ post: {
29858
+ 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).",
29859
+ operationId: "accessMethodsEncodePost",
29860
+ requestBody: {
29861
+ content: {
29862
+ "application/json": {
29863
+ schema: {
29864
+ properties: {
29865
+ access_method_id: {
29866
+ description: "ID of the `access_method` to encode onto a card.",
29867
+ format: "uuid",
29868
+ type: "string"
29869
+ },
29870
+ acs_encoder_id: {
29871
+ description: "ID of the `acs_encoder` to use to encode the `acs_credential`.",
29872
+ format: "uuid",
29873
+ type: "string"
29874
+ }
29875
+ },
29876
+ required: ["acs_encoder_id", "access_method_id"],
29877
+ type: "object"
29878
+ }
29879
+ }
29880
+ }
29881
+ },
29882
+ responses: {
29883
+ 200: {
29884
+ content: {
29885
+ "application/json": {
29886
+ schema: {
29887
+ properties: {
29888
+ action_attempt: {
29889
+ $ref: "#/components/schemas/action_attempt"
29890
+ },
29891
+ ok: { type: "boolean" }
29892
+ },
29893
+ required: ["action_attempt", "ok"],
29894
+ type: "object"
29895
+ }
29896
+ }
29897
+ },
29898
+ description: "OK"
29899
+ },
29900
+ 400: { description: "Bad Request" },
29901
+ 401: { description: "Unauthorized" }
29902
+ },
29903
+ security: [
29904
+ { pat_with_workspace: [] },
29905
+ { console_session_with_workspace: [] },
29906
+ { api_key: [] }
29907
+ ],
29908
+ summary: "/access_methods/encode",
29909
+ tags: [],
29910
+ "x-action-attempt-type": "ENCODE_CREDENTIAL",
29911
+ "x-fern-sdk-group-name": ["access_methods"],
29912
+ "x-fern-sdk-method-name": "encode",
29913
+ "x-fern-sdk-return-value": "action_attempt",
29914
+ "x-response-key": "action_attempt",
29915
+ "x-title": "Encode an Access Method"
29916
+ }
29917
+ },
30155
29918
  "/access_methods/get": {
30156
29919
  get: {
30157
29920
  description: "Get an access method.",
@@ -32834,10 +32597,10 @@ var openapi_default = {
32834
32597
  "x-title": "Update a Credential"
32835
32598
  }
32836
32599
  },
32837
- "/acs/encoders/encode_access_method": {
32600
+ "/acs/encoders/encode_credential": {
32838
32601
  post: {
32839
- 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).",
32840
- operationId: "acsEncodersEncodeAccessMethodPost",
32602
+ 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`",
32603
+ operationId: "acsEncodersEncodeCredentialPost",
32841
32604
  requestBody: {
32842
32605
  content: {
32843
32606
  "application/json": {
@@ -32848,63 +32611,6 @@ var openapi_default = {
32848
32611
  format: "uuid",
32849
32612
  type: "string"
32850
32613
  },
32851
- acs_encoder_id: {
32852
- description: "ID of the `acs_encoder` to use to encode the `access_method`.",
32853
- format: "uuid",
32854
- type: "string"
32855
- }
32856
- },
32857
- required: ["acs_encoder_id", "access_method_id"],
32858
- type: "object"
32859
- }
32860
- }
32861
- }
32862
- },
32863
- responses: {
32864
- 200: {
32865
- content: {
32866
- "application/json": {
32867
- schema: {
32868
- properties: {
32869
- action_attempt: {
32870
- $ref: "#/components/schemas/action_attempt"
32871
- },
32872
- ok: { type: "boolean" }
32873
- },
32874
- required: ["action_attempt", "ok"],
32875
- type: "object"
32876
- }
32877
- }
32878
- },
32879
- description: "OK"
32880
- },
32881
- 400: { description: "Bad Request" },
32882
- 401: { description: "Unauthorized" }
32883
- },
32884
- security: [
32885
- { pat_with_workspace: [] },
32886
- { console_session_with_workspace: [] },
32887
- { api_key: [] }
32888
- ],
32889
- summary: "/acs/encoders/encode_access_method",
32890
- tags: ["/acs"],
32891
- "x-action-attempt-type": "ENCODE_ACCESS_METHOD",
32892
- "x-fern-sdk-group-name": ["acs", "encoders"],
32893
- "x-fern-sdk-method-name": "encode_access_method",
32894
- "x-fern-sdk-return-value": "action_attempt",
32895
- "x-response-key": "action_attempt",
32896
- "x-title": "Encode an Access Method"
32897
- }
32898
- },
32899
- "/acs/encoders/encode_credential": {
32900
- post: {
32901
- 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).",
32902
- operationId: "acsEncodersEncodeCredentialPost",
32903
- requestBody: {
32904
- content: {
32905
- "application/json": {
32906
- schema: {
32907
- properties: {
32908
32614
  acs_credential_id: {
32909
32615
  description: "ID of the `acs_credential` to encode onto a card.",
32910
32616
  format: "uuid",
@@ -32916,7 +32622,7 @@ var openapi_default = {
32916
32622
  type: "string"
32917
32623
  }
32918
32624
  },
32919
- required: ["acs_encoder_id", "acs_credential_id"],
32625
+ required: ["acs_encoder_id"],
32920
32626
  type: "object"
32921
32627
  }
32922
32628
  }