@seamapi/types 1.879.0 → 1.880.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 +618 -108
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +7361 -251
- package/dist/index.cjs +618 -108
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +544 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/assign-credential.d.ts +547 -0
- package/lib/seam/connect/models/action-attempts/assign-credential.js +38 -0
- package/lib/seam/connect/models/action-attempts/assign-credential.js.map +1 -0
- package/lib/seam/connect/openapi.js +490 -9
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +7013 -447
- package/package.json +1 -1
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -0
- package/src/lib/seam/connect/models/action-attempts/assign-credential.ts +60 -0
- package/src/lib/seam/connect/openapi.ts +554 -10
- package/src/lib/seam/connect/route-types.ts +7435 -163
package/dist/connect.cjs
CHANGED
|
@@ -4675,47 +4675,75 @@ var activate_climate_preset_action_attempt = zod.z.discriminatedUnion(
|
|
|
4675
4675
|
common_failed_action_attempt.extend({ action_type, error }).describe("Activating a climate preset failed.")
|
|
4676
4676
|
]
|
|
4677
4677
|
);
|
|
4678
|
-
var action_type2 = zod.z.literal("
|
|
4678
|
+
var action_type2 = zod.z.literal("ASSIGN_CREDENTIAL").describe(
|
|
4679
|
+
"Action attempt to track the status of assigning an existing credential to an access method."
|
|
4680
|
+
);
|
|
4681
|
+
var credential_not_found_error = zod.z.object({
|
|
4682
|
+
type: zod.z.literal("credential_not_found").describe(
|
|
4683
|
+
"Error type to indicate that no matching credential was found."
|
|
4684
|
+
),
|
|
4685
|
+
message: zod.z.string().describe(
|
|
4686
|
+
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
4687
|
+
)
|
|
4688
|
+
}).describe("Error to indicate that no matching credential was found.");
|
|
4689
|
+
var error2 = zod.z.union([
|
|
4690
|
+
...common_action_attempt_errors,
|
|
4691
|
+
credential_not_found_error
|
|
4692
|
+
]);
|
|
4693
|
+
var result2 = access_method.describe(
|
|
4694
|
+
"Result of an assignment attempt. If the attempt was successful, includes the updated access method with the assigned credential."
|
|
4695
|
+
);
|
|
4696
|
+
var assign_credential_action_attempt = zod.z.discriminatedUnion("status", [
|
|
4697
|
+
common_pending_action_attempt.extend({
|
|
4698
|
+
action_type: action_type2
|
|
4699
|
+
}).describe("Assigning a credential to an access method is pending."),
|
|
4700
|
+
common_succeeded_action_attempt.extend({
|
|
4701
|
+
action_type: action_type2,
|
|
4702
|
+
result: result2
|
|
4703
|
+
}).describe("Assigning a credential to an access method succeeded."),
|
|
4704
|
+
common_failed_action_attempt.extend({ action_type: action_type2, error: error2 }).describe("Assigning a credential to an access method failed.")
|
|
4705
|
+
]);
|
|
4706
|
+
var action_type3 = zod.z.literal("CONFIGURE_AUTO_LOCK").describe(
|
|
4679
4707
|
"Action attempt to track the status of configuring the auto-lock on a lock."
|
|
4680
4708
|
);
|
|
4681
|
-
var
|
|
4709
|
+
var error3 = zod.z.object({
|
|
4682
4710
|
type: zod.z.string().describe("Type of the error."),
|
|
4683
4711
|
message: zod.z.string().describe(
|
|
4684
4712
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
4685
4713
|
)
|
|
4686
4714
|
}).describe("Error associated with the action.");
|
|
4687
|
-
var
|
|
4715
|
+
var result3 = zod.z.object({}).describe("Result of the action.");
|
|
4688
4716
|
var configure_auto_lock_action_attempt = zod.z.discriminatedUnion(
|
|
4689
4717
|
"status",
|
|
4690
4718
|
[
|
|
4691
4719
|
common_pending_action_attempt.extend({
|
|
4692
|
-
action_type:
|
|
4720
|
+
action_type: action_type3
|
|
4693
4721
|
}).describe("Configuring the auto-lock is pending."),
|
|
4694
4722
|
common_succeeded_action_attempt.extend({
|
|
4695
|
-
action_type:
|
|
4696
|
-
result:
|
|
4723
|
+
action_type: action_type3,
|
|
4724
|
+
result: result3
|
|
4697
4725
|
}).describe("Configuring the auto-lock succeeded."),
|
|
4698
|
-
common_failed_action_attempt.extend({ action_type:
|
|
4726
|
+
common_failed_action_attempt.extend({ action_type: action_type3, error: error3 }).describe("Configuring the auto-lock failed.")
|
|
4699
4727
|
]
|
|
4700
4728
|
);
|
|
4701
|
-
var
|
|
4729
|
+
var error4 = zod.z.object({
|
|
4702
4730
|
type: zod.z.string().describe("Type of the error."),
|
|
4703
4731
|
message: zod.z.string().describe(
|
|
4704
4732
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
4705
4733
|
)
|
|
4706
4734
|
}).describe("Error associated with the action.");
|
|
4707
|
-
var
|
|
4735
|
+
var result4 = zod.z.object({}).describe("Result of the action.");
|
|
4708
4736
|
var sync_access_codes_action_attempt = zod.z.discriminatedUnion("status", [
|
|
4709
4737
|
common_pending_action_attempt.extend({
|
|
4710
4738
|
action_type: zod.z.literal("SYNC_ACCESS_CODES").describe("Syncing access codes is pending.")
|
|
4711
4739
|
}),
|
|
4712
4740
|
common_succeeded_action_attempt.extend({
|
|
4713
4741
|
action_type: zod.z.literal("SYNC_ACCESS_CODES").describe("Syncing access codes succeeded."),
|
|
4714
|
-
result:
|
|
4742
|
+
result: result4
|
|
4715
4743
|
}),
|
|
4716
4744
|
common_failed_action_attempt.extend({
|
|
4717
4745
|
action_type: zod.z.literal("SYNC_ACCESS_CODES").describe("Syncing access codes failed."),
|
|
4718
|
-
error:
|
|
4746
|
+
error: error4
|
|
4719
4747
|
})
|
|
4720
4748
|
]).describe("Action attempt to track the status of syncing access codes.");
|
|
4721
4749
|
var create_access_code_action_attempt = zod.z.discriminatedUnion("status", [
|
|
@@ -4730,7 +4758,7 @@ var create_access_code_action_attempt = zod.z.discriminatedUnion("status", [
|
|
|
4730
4758
|
}),
|
|
4731
4759
|
common_failed_action_attempt.extend({
|
|
4732
4760
|
action_type: zod.z.literal("CREATE_ACCESS_CODE").describe("Creating an access code failed."),
|
|
4733
|
-
error:
|
|
4761
|
+
error: error4
|
|
4734
4762
|
})
|
|
4735
4763
|
]).describe("Action attempt to track the status of creating an access code.");
|
|
4736
4764
|
var delete_access_code_action_attempt = zod.z.discriminatedUnion("status", [
|
|
@@ -4739,11 +4767,11 @@ var delete_access_code_action_attempt = zod.z.discriminatedUnion("status", [
|
|
|
4739
4767
|
}),
|
|
4740
4768
|
common_succeeded_action_attempt.extend({
|
|
4741
4769
|
action_type: zod.z.literal("DELETE_ACCESS_CODE").describe("Deleting an access code succeeded."),
|
|
4742
|
-
result:
|
|
4770
|
+
result: result4
|
|
4743
4771
|
}),
|
|
4744
4772
|
common_failed_action_attempt.extend({
|
|
4745
4773
|
action_type: zod.z.literal("DELETE_ACCESS_CODE").describe("Deleting an access code failed."),
|
|
4746
|
-
error:
|
|
4774
|
+
error: error4
|
|
4747
4775
|
})
|
|
4748
4776
|
]).describe("Action attempt to track the status of deleting an access code.");
|
|
4749
4777
|
var update_access_code_action_attempt = zod.z.discriminatedUnion("status", [
|
|
@@ -4758,7 +4786,7 @@ var update_access_code_action_attempt = zod.z.discriminatedUnion("status", [
|
|
|
4758
4786
|
}),
|
|
4759
4787
|
common_failed_action_attempt.extend({
|
|
4760
4788
|
action_type: zod.z.literal("UPDATE_ACCESS_CODE").describe("Updating an access code failed."),
|
|
4761
|
-
error:
|
|
4789
|
+
error: error4
|
|
4762
4790
|
})
|
|
4763
4791
|
]).describe("Action attempt to track the status of updating an access code.");
|
|
4764
4792
|
var create_noise_threshold_action_attempt = zod.z.discriminatedUnion("status", [
|
|
@@ -4773,7 +4801,7 @@ var create_noise_threshold_action_attempt = zod.z.discriminatedUnion("status", [
|
|
|
4773
4801
|
}),
|
|
4774
4802
|
common_failed_action_attempt.extend({
|
|
4775
4803
|
action_type: zod.z.literal("CREATE_NOISE_THRESHOLD").describe("Creating a noise threshold failed."),
|
|
4776
|
-
error:
|
|
4804
|
+
error: error4
|
|
4777
4805
|
})
|
|
4778
4806
|
]).describe("Action attempt to track the status of creating a noise threshold.");
|
|
4779
4807
|
var delete_noise_threshold_action_attempt = zod.z.discriminatedUnion("status", [
|
|
@@ -4782,11 +4810,11 @@ var delete_noise_threshold_action_attempt = zod.z.discriminatedUnion("status", [
|
|
|
4782
4810
|
}),
|
|
4783
4811
|
common_succeeded_action_attempt.extend({
|
|
4784
4812
|
action_type: zod.z.literal("DELETE_NOISE_THRESHOLD").describe("Deleting a noise threshold succeeded."),
|
|
4785
|
-
result:
|
|
4813
|
+
result: result4
|
|
4786
4814
|
}),
|
|
4787
4815
|
common_failed_action_attempt.extend({
|
|
4788
4816
|
action_type: zod.z.literal("DELETE_NOISE_THRESHOLD").describe("Deleting a noise threshold failed."),
|
|
4789
|
-
error:
|
|
4817
|
+
error: error4
|
|
4790
4818
|
})
|
|
4791
4819
|
]).describe("Action attempt to track the status of deleting a noise threshold.");
|
|
4792
4820
|
var update_noise_threshold_action_attempt = zod.z.discriminatedUnion("status", [
|
|
@@ -4801,7 +4829,7 @@ var update_noise_threshold_action_attempt = zod.z.discriminatedUnion("status", [
|
|
|
4801
4829
|
}),
|
|
4802
4830
|
common_failed_action_attempt.extend({
|
|
4803
4831
|
action_type: zod.z.literal("UPDATE_NOISE_THRESHOLD").describe("Updating a noise threshold failed."),
|
|
4804
|
-
error:
|
|
4832
|
+
error: error4
|
|
4805
4833
|
})
|
|
4806
4834
|
]).describe("Action attempt to track the status of updating a noise threshold.");
|
|
4807
4835
|
var deprecated_action_attempts = [
|
|
@@ -4813,7 +4841,7 @@ var deprecated_action_attempts = [
|
|
|
4813
4841
|
...delete_noise_threshold_action_attempt.options,
|
|
4814
4842
|
...update_noise_threshold_action_attempt.options
|
|
4815
4843
|
];
|
|
4816
|
-
var
|
|
4844
|
+
var action_type4 = zod.z.literal("ENCODE_CREDENTIAL").describe(
|
|
4817
4845
|
"Action attempt to track the status of encoding credential data from the physical encoder onto a card."
|
|
4818
4846
|
);
|
|
4819
4847
|
var no_credential_on_encoder_error = zod.z.object({
|
|
@@ -4884,7 +4912,7 @@ var credential_deleted_error = zod.z.object({
|
|
|
4884
4912
|
}).describe(
|
|
4885
4913
|
"Error to indicate that the credential was deleted and can no longer be encoded."
|
|
4886
4914
|
);
|
|
4887
|
-
var
|
|
4915
|
+
var error5 = zod.z.union([
|
|
4888
4916
|
...common_action_attempt_errors,
|
|
4889
4917
|
no_credential_on_encoder_error,
|
|
4890
4918
|
incompatible_card_format_error,
|
|
@@ -4895,97 +4923,97 @@ var error4 = zod.z.union([
|
|
|
4895
4923
|
encoding_interrupted_error,
|
|
4896
4924
|
credential_deleted_error
|
|
4897
4925
|
]);
|
|
4898
|
-
var
|
|
4926
|
+
var result5 = acs_credential.or(unmanaged_acs_credential).describe(
|
|
4899
4927
|
"Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card."
|
|
4900
4928
|
);
|
|
4901
4929
|
var encode_credential_action_attempt = zod.z.discriminatedUnion("status", [
|
|
4902
4930
|
common_pending_action_attempt.extend({
|
|
4903
|
-
action_type:
|
|
4931
|
+
action_type: action_type4
|
|
4904
4932
|
}).describe(
|
|
4905
4933
|
"Encoding credential data from the physical encoder onto a card is pending."
|
|
4906
4934
|
),
|
|
4907
4935
|
common_succeeded_action_attempt.extend({
|
|
4908
|
-
action_type:
|
|
4909
|
-
result:
|
|
4936
|
+
action_type: action_type4,
|
|
4937
|
+
result: result5
|
|
4910
4938
|
}).describe(
|
|
4911
4939
|
"Encoding credential data from the physical encoder onto a card succeeded."
|
|
4912
4940
|
),
|
|
4913
|
-
common_failed_action_attempt.extend({ action_type:
|
|
4941
|
+
common_failed_action_attempt.extend({ action_type: action_type4, error: error5 }).describe(
|
|
4914
4942
|
"Encoding credential data from the physical encoder onto a card failed."
|
|
4915
4943
|
)
|
|
4916
4944
|
]);
|
|
4917
|
-
var
|
|
4918
|
-
var
|
|
4945
|
+
var action_type5 = zod.z.literal("LOCK_DOOR").describe("Action attempt to track the status of locking a door.");
|
|
4946
|
+
var error6 = zod.z.object({
|
|
4919
4947
|
type: zod.z.string().describe("Type of the error."),
|
|
4920
4948
|
message: zod.z.string().describe(
|
|
4921
4949
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
4922
4950
|
)
|
|
4923
4951
|
}).describe("Error associated with the action.");
|
|
4924
|
-
var
|
|
4952
|
+
var result6 = zod.z.object({
|
|
4925
4953
|
was_confirmed_by_device: zod.z.boolean().optional().describe(
|
|
4926
4954
|
"Indicates whether the device confirmed that the lock action occurred."
|
|
4927
4955
|
)
|
|
4928
4956
|
}).describe("Result of the action.");
|
|
4929
4957
|
var lock_door_action_attempt = zod.z.discriminatedUnion("status", [
|
|
4930
4958
|
common_pending_action_attempt.extend({
|
|
4931
|
-
action_type:
|
|
4959
|
+
action_type: action_type5
|
|
4932
4960
|
}).describe("Locking a door is pending."),
|
|
4933
4961
|
common_succeeded_action_attempt.extend({
|
|
4934
|
-
action_type:
|
|
4935
|
-
result:
|
|
4962
|
+
action_type: action_type5,
|
|
4963
|
+
result: result6
|
|
4936
4964
|
}).describe("Locking a door succeeded."),
|
|
4937
|
-
common_failed_action_attempt.extend({ action_type:
|
|
4965
|
+
common_failed_action_attempt.extend({ action_type: action_type5, error: error6 }).describe("Locking a door failed.")
|
|
4938
4966
|
]);
|
|
4939
|
-
var
|
|
4967
|
+
var action_type6 = zod.z.literal("PUSH_THERMOSTAT_PROGRAMS").describe(
|
|
4940
4968
|
"Action attempt to track the status of pushing thermostat programs."
|
|
4941
4969
|
);
|
|
4942
|
-
var
|
|
4970
|
+
var error7 = zod.z.object({
|
|
4943
4971
|
type: zod.z.string().describe("Type of the error."),
|
|
4944
4972
|
message: zod.z.string().describe(
|
|
4945
4973
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
4946
4974
|
)
|
|
4947
4975
|
}).describe("Error associated with the action.");
|
|
4948
|
-
var
|
|
4976
|
+
var result7 = zod.z.object({}).describe("Result of the action.");
|
|
4949
4977
|
var push_thermostat_programs_action_attempt = zod.z.discriminatedUnion(
|
|
4950
4978
|
"status",
|
|
4951
4979
|
[
|
|
4952
4980
|
common_pending_action_attempt.extend({
|
|
4953
|
-
action_type:
|
|
4981
|
+
action_type: action_type6
|
|
4954
4982
|
}).describe("Pushing thermostat weekly programs is pending."),
|
|
4955
4983
|
common_succeeded_action_attempt.extend({
|
|
4956
|
-
action_type:
|
|
4957
|
-
result:
|
|
4984
|
+
action_type: action_type6,
|
|
4985
|
+
result: result7
|
|
4958
4986
|
}).describe("Pushing thermostat weekly programs succeeded."),
|
|
4959
|
-
common_failed_action_attempt.extend({ action_type:
|
|
4987
|
+
common_failed_action_attempt.extend({ action_type: action_type6, error: error7 }).describe("Pushing thermostat weekly programs failed.")
|
|
4960
4988
|
]
|
|
4961
4989
|
);
|
|
4962
|
-
var
|
|
4990
|
+
var action_type7 = zod.z.literal("RESET_SANDBOX_WORKSPACE").describe(
|
|
4963
4991
|
"Action attempt to track the status of resetting a sandbox workspace."
|
|
4964
4992
|
);
|
|
4965
|
-
var
|
|
4993
|
+
var error8 = zod.z.object({
|
|
4966
4994
|
type: zod.z.string().describe("Type of the error."),
|
|
4967
4995
|
message: zod.z.string().describe(
|
|
4968
4996
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
4969
4997
|
)
|
|
4970
4998
|
}).describe("Error associated with the action.");
|
|
4971
|
-
var
|
|
4999
|
+
var result8 = zod.z.object({}).describe("Result of the action.");
|
|
4972
5000
|
var reset_sandbox_workspace_action_attempt = zod.z.discriminatedUnion(
|
|
4973
5001
|
"status",
|
|
4974
5002
|
[
|
|
4975
5003
|
common_pending_action_attempt.extend({
|
|
4976
|
-
action_type:
|
|
5004
|
+
action_type: action_type7
|
|
4977
5005
|
}).describe("Resetting a sandbox workspace is pending."),
|
|
4978
5006
|
common_succeeded_action_attempt.extend({
|
|
4979
|
-
action_type:
|
|
4980
|
-
result:
|
|
5007
|
+
action_type: action_type7,
|
|
5008
|
+
result: result8
|
|
4981
5009
|
}).describe("Resetting a sandbox workspace succeeded."),
|
|
4982
5010
|
common_failed_action_attempt.extend({
|
|
4983
|
-
action_type:
|
|
4984
|
-
error:
|
|
5011
|
+
action_type: action_type7,
|
|
5012
|
+
error: error8
|
|
4985
5013
|
}).describe("Resetting a sandbox workspace failed.")
|
|
4986
5014
|
]
|
|
4987
5015
|
);
|
|
4988
|
-
var
|
|
5016
|
+
var action_type8 = zod.z.literal("SCAN_CREDENTIAL").describe("Action attempt to track the status of scanning a credential.");
|
|
4989
5017
|
var no_credential_on_encoder_error2 = zod.z.object({
|
|
4990
5018
|
type: zod.z.literal("no_credential_on_encoder").describe(
|
|
4991
5019
|
"Error type to indicate that there is no credential on the encoder."
|
|
@@ -5018,7 +5046,7 @@ var bridge_disconnected_error2 = zod.z.object({
|
|
|
5018
5046
|
}).describe(
|
|
5019
5047
|
"Error to indicate that the Seam Bridge is disconnected or cannot reach the access control system."
|
|
5020
5048
|
);
|
|
5021
|
-
var
|
|
5049
|
+
var error9 = zod.z.union([
|
|
5022
5050
|
...common_action_attempt_errors,
|
|
5023
5051
|
no_credential_on_encoder_error2,
|
|
5024
5052
|
encoder_not_online_error2,
|
|
@@ -5035,7 +5063,7 @@ var warning = zod.z.object({
|
|
|
5035
5063
|
)
|
|
5036
5064
|
}).describe("Warning related to scanning a credential.");
|
|
5037
5065
|
var acs_credential_on_seam = acs_credential.or(unmanaged_acs_credential);
|
|
5038
|
-
var
|
|
5066
|
+
var result9 = zod.z.object({
|
|
5039
5067
|
acs_credential_on_encoder: acs_credential_on_encoder.nullable().describe("Snapshot of credential data read from the physical encoder."),
|
|
5040
5068
|
acs_credential_on_seam: acs_credential_on_seam.nullable().describe(
|
|
5041
5069
|
"Corresponding credential data as stored on Seam and the access system."
|
|
@@ -5048,15 +5076,15 @@ var result8 = zod.z.object({
|
|
|
5048
5076
|
);
|
|
5049
5077
|
var scan_credential_action_attempt = zod.z.discriminatedUnion("status", [
|
|
5050
5078
|
common_pending_action_attempt.extend({
|
|
5051
|
-
action_type:
|
|
5079
|
+
action_type: action_type8
|
|
5052
5080
|
}).describe("Reading credential data from the physical encoder is pending."),
|
|
5053
5081
|
common_succeeded_action_attempt.extend({
|
|
5054
|
-
action_type:
|
|
5055
|
-
result:
|
|
5082
|
+
action_type: action_type8,
|
|
5083
|
+
result: result9
|
|
5056
5084
|
}).describe("Reading credential data from physical encoder succeeded."),
|
|
5057
|
-
common_failed_action_attempt.extend({ action_type:
|
|
5085
|
+
common_failed_action_attempt.extend({ action_type: action_type8, error: error9 }).describe("Reading credential data from physical encoder failed.")
|
|
5058
5086
|
]);
|
|
5059
|
-
var
|
|
5087
|
+
var action_type9 = zod.z.literal("SCAN_TO_ASSIGN_CREDENTIAL").describe(
|
|
5060
5088
|
"Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user."
|
|
5061
5089
|
);
|
|
5062
5090
|
var no_credential_on_encoder_error3 = zod.z.object({
|
|
@@ -5067,142 +5095,142 @@ var no_credential_on_encoder_error3 = zod.z.object({
|
|
|
5067
5095
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
5068
5096
|
)
|
|
5069
5097
|
}).describe("Error to indicate that there is no credential on the encoder.");
|
|
5070
|
-
var
|
|
5098
|
+
var error10 = zod.z.union([
|
|
5071
5099
|
...common_action_attempt_errors,
|
|
5072
5100
|
no_credential_on_encoder_error3
|
|
5073
5101
|
]);
|
|
5074
|
-
var
|
|
5102
|
+
var result10 = acs_credential.describe(
|
|
5075
5103
|
"Result of a scan to assign attempt. If the attempt was successful, includes the credential data that was scanned and assigned."
|
|
5076
5104
|
);
|
|
5077
5105
|
var scan_to_assign_credential_action_attempt = zod.z.discriminatedUnion(
|
|
5078
5106
|
"status",
|
|
5079
5107
|
[
|
|
5080
5108
|
common_pending_action_attempt.extend({
|
|
5081
|
-
action_type:
|
|
5109
|
+
action_type: action_type9
|
|
5082
5110
|
}).describe(
|
|
5083
5111
|
"Scanning a physical card and assigning the credential is pending."
|
|
5084
5112
|
),
|
|
5085
5113
|
common_succeeded_action_attempt.extend({
|
|
5086
|
-
action_type:
|
|
5087
|
-
result:
|
|
5114
|
+
action_type: action_type9,
|
|
5115
|
+
result: result10
|
|
5088
5116
|
}).describe(
|
|
5089
5117
|
"Scanning a physical card and assigning the credential succeeded."
|
|
5090
5118
|
),
|
|
5091
|
-
common_failed_action_attempt.extend({ action_type:
|
|
5119
|
+
common_failed_action_attempt.extend({ action_type: action_type9, error: error10 }).describe(
|
|
5092
5120
|
"Scanning a physical card and assigning the credential failed."
|
|
5093
5121
|
)
|
|
5094
5122
|
]
|
|
5095
5123
|
);
|
|
5096
|
-
var
|
|
5124
|
+
var action_type10 = zod.z.literal("SET_FAN_MODE").describe(
|
|
5097
5125
|
"Action attempt to track the status of setting the fan mode on a thermostat."
|
|
5098
5126
|
);
|
|
5099
|
-
var
|
|
5127
|
+
var error11 = zod.z.object({
|
|
5100
5128
|
type: zod.z.string().describe("Type of the error."),
|
|
5101
5129
|
message: zod.z.string().describe(
|
|
5102
5130
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
5103
5131
|
)
|
|
5104
5132
|
}).describe("Error associated with the action.");
|
|
5105
|
-
var
|
|
5133
|
+
var result11 = zod.z.object({}).describe("Result of the action.");
|
|
5106
5134
|
var set_fan_mode_action_attempt = zod.z.discriminatedUnion("status", [
|
|
5107
5135
|
common_pending_action_attempt.extend({
|
|
5108
|
-
action_type:
|
|
5136
|
+
action_type: action_type10
|
|
5109
5137
|
}).describe("Setting the fan mode is pending."),
|
|
5110
5138
|
common_succeeded_action_attempt.extend({
|
|
5111
|
-
action_type:
|
|
5112
|
-
result:
|
|
5139
|
+
action_type: action_type10,
|
|
5140
|
+
result: result11
|
|
5113
5141
|
}).describe("Setting the fan mode succeeded."),
|
|
5114
|
-
common_failed_action_attempt.extend({ action_type:
|
|
5142
|
+
common_failed_action_attempt.extend({ action_type: action_type10, error: error11 }).describe("Setting the fan mode failed.")
|
|
5115
5143
|
]);
|
|
5116
|
-
var
|
|
5144
|
+
var action_type11 = zod.z.literal("SET_HVAC_MODE").describe(
|
|
5117
5145
|
"Action attempt to track the status of setting the HVAC mode on a thermostat."
|
|
5118
5146
|
);
|
|
5119
|
-
var
|
|
5147
|
+
var error12 = zod.z.object({
|
|
5120
5148
|
type: zod.z.string().describe("Type of the error."),
|
|
5121
5149
|
message: zod.z.string().describe(
|
|
5122
5150
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
5123
5151
|
)
|
|
5124
5152
|
}).describe("Error associated with the action.");
|
|
5125
|
-
var
|
|
5153
|
+
var result12 = zod.z.object({}).describe("Result of the action.");
|
|
5126
5154
|
var set_hvac_mode_action_attempt = zod.z.discriminatedUnion("status", [
|
|
5127
5155
|
common_pending_action_attempt.extend({
|
|
5128
|
-
action_type:
|
|
5156
|
+
action_type: action_type11
|
|
5129
5157
|
}).describe("Setting the HVAC mode is pending."),
|
|
5130
5158
|
common_succeeded_action_attempt.extend({
|
|
5131
|
-
action_type:
|
|
5132
|
-
result:
|
|
5159
|
+
action_type: action_type11,
|
|
5160
|
+
result: result12
|
|
5133
5161
|
}).describe("Setting the HVAC mode succeeded."),
|
|
5134
|
-
common_failed_action_attempt.extend({ action_type:
|
|
5162
|
+
common_failed_action_attempt.extend({ action_type: action_type11, error: error12 }).describe("Setting the HVAC mode failed.")
|
|
5135
5163
|
]);
|
|
5136
|
-
var
|
|
5164
|
+
var action_type12 = zod.z.literal("SIMULATE_KEYPAD_CODE_ENTRY").describe(
|
|
5137
5165
|
"Action attempt to track the status of simulating a keypad code entry."
|
|
5138
5166
|
);
|
|
5139
|
-
var
|
|
5167
|
+
var error13 = zod.z.object({
|
|
5140
5168
|
type: zod.z.string().describe("Type of the error."),
|
|
5141
5169
|
message: zod.z.string().describe(
|
|
5142
5170
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
5143
5171
|
)
|
|
5144
5172
|
}).describe("Error associated with the action.");
|
|
5145
|
-
var
|
|
5173
|
+
var result13 = zod.z.object({}).describe("Result of the action.");
|
|
5146
5174
|
var simulate_keypad_code_entry_action_attempt = zod.z.discriminatedUnion(
|
|
5147
5175
|
"status",
|
|
5148
5176
|
[
|
|
5149
5177
|
common_pending_action_attempt.extend({
|
|
5150
|
-
action_type:
|
|
5178
|
+
action_type: action_type12
|
|
5151
5179
|
}).describe("Simulating a keypad code entry is pending."),
|
|
5152
5180
|
common_succeeded_action_attempt.extend({
|
|
5153
|
-
action_type:
|
|
5154
|
-
result:
|
|
5181
|
+
action_type: action_type12,
|
|
5182
|
+
result: result13
|
|
5155
5183
|
}).describe("Simulating a keypad code entry succeeded."),
|
|
5156
5184
|
common_failed_action_attempt.extend({
|
|
5157
|
-
action_type:
|
|
5158
|
-
error:
|
|
5185
|
+
action_type: action_type12,
|
|
5186
|
+
error: error13
|
|
5159
5187
|
}).describe("Simulating a keypad code entry failed.")
|
|
5160
5188
|
]
|
|
5161
5189
|
);
|
|
5162
|
-
var
|
|
5190
|
+
var action_type13 = zod.z.literal("SIMULATE_MANUAL_LOCK_VIA_KEYPAD").describe(
|
|
5163
5191
|
"Action attempt to track the status of simulating a manual lock action using a keypad."
|
|
5164
5192
|
);
|
|
5165
|
-
var
|
|
5193
|
+
var error14 = zod.z.object({
|
|
5166
5194
|
type: zod.z.string().describe("Type of the error."),
|
|
5167
5195
|
message: zod.z.string().describe(
|
|
5168
5196
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
5169
5197
|
)
|
|
5170
5198
|
}).describe("Error associated with the action.");
|
|
5171
|
-
var
|
|
5199
|
+
var result14 = zod.z.object({}).describe("Result of the action.");
|
|
5172
5200
|
var simulate_manual_lock_via_keypad_action_attempt = zod.z.discriminatedUnion("status", [
|
|
5173
5201
|
common_pending_action_attempt.extend({
|
|
5174
|
-
action_type:
|
|
5202
|
+
action_type: action_type13
|
|
5175
5203
|
}).describe("Simulating a manual lock action using a keypad is pending."),
|
|
5176
5204
|
common_succeeded_action_attempt.extend({
|
|
5177
|
-
action_type:
|
|
5178
|
-
result:
|
|
5205
|
+
action_type: action_type13,
|
|
5206
|
+
result: result14
|
|
5179
5207
|
}).describe("Simulating a manual lock action using a keypad succeeded."),
|
|
5180
5208
|
common_failed_action_attempt.extend({
|
|
5181
|
-
action_type:
|
|
5182
|
-
error:
|
|
5209
|
+
action_type: action_type13,
|
|
5210
|
+
error: error14
|
|
5183
5211
|
}).describe("Simulating a manual lock action using a keypad failed.")
|
|
5184
5212
|
]);
|
|
5185
|
-
var
|
|
5186
|
-
var
|
|
5213
|
+
var action_type14 = zod.z.literal("UNLOCK_DOOR").describe("Action attempt to track the status of unlocking a door.");
|
|
5214
|
+
var error15 = zod.z.object({
|
|
5187
5215
|
type: zod.z.string().describe("Type of the error."),
|
|
5188
5216
|
message: zod.z.string().describe(
|
|
5189
5217
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
5190
5218
|
)
|
|
5191
5219
|
}).describe("Error associated with the action.");
|
|
5192
|
-
var
|
|
5220
|
+
var result15 = zod.z.object({
|
|
5193
5221
|
was_confirmed_by_device: zod.z.boolean().optional().describe(
|
|
5194
5222
|
"Indicates whether the device confirmed that the unlock action occurred."
|
|
5195
5223
|
)
|
|
5196
5224
|
}).describe("Result of the action.");
|
|
5197
5225
|
var unlock_door_action_attempt = zod.z.discriminatedUnion("status", [
|
|
5198
5226
|
common_pending_action_attempt.extend({
|
|
5199
|
-
action_type:
|
|
5227
|
+
action_type: action_type14
|
|
5200
5228
|
}).describe("Unlocking a door is pending."),
|
|
5201
5229
|
common_succeeded_action_attempt.extend({
|
|
5202
|
-
action_type:
|
|
5203
|
-
result:
|
|
5230
|
+
action_type: action_type14,
|
|
5231
|
+
result: result15
|
|
5204
5232
|
}).describe("Unlocking a door succeeded."),
|
|
5205
|
-
common_failed_action_attempt.extend({ action_type:
|
|
5233
|
+
common_failed_action_attempt.extend({ action_type: action_type14, error: error15 }).describe("Unlocking a door failed.")
|
|
5206
5234
|
]);
|
|
5207
5235
|
|
|
5208
5236
|
// src/lib/seam/connect/models/action-attempts/action-attempt.ts
|
|
@@ -5212,6 +5240,7 @@ var action_attempt = zod.z.union([
|
|
|
5212
5240
|
...scan_credential_action_attempt.options,
|
|
5213
5241
|
...encode_credential_action_attempt.options,
|
|
5214
5242
|
...scan_to_assign_credential_action_attempt.options,
|
|
5243
|
+
...assign_credential_action_attempt.options,
|
|
5215
5244
|
...reset_sandbox_workspace_action_attempt.options,
|
|
5216
5245
|
...set_fan_mode_action_attempt.options,
|
|
5217
5246
|
...set_hvac_mode_action_attempt.options,
|
|
@@ -15655,6 +15684,486 @@ var openapi = {
|
|
|
15655
15684
|
],
|
|
15656
15685
|
type: "object"
|
|
15657
15686
|
},
|
|
15687
|
+
{
|
|
15688
|
+
description: "Assigning a credential to an access method is pending.",
|
|
15689
|
+
properties: {
|
|
15690
|
+
action_attempt_id: {
|
|
15691
|
+
description: "ID of the action attempt.",
|
|
15692
|
+
format: "uuid",
|
|
15693
|
+
type: "string"
|
|
15694
|
+
},
|
|
15695
|
+
action_type: {
|
|
15696
|
+
description: "Action attempt to track the status of assigning an existing credential to an access method.",
|
|
15697
|
+
enum: ["ASSIGN_CREDENTIAL"],
|
|
15698
|
+
type: "string"
|
|
15699
|
+
},
|
|
15700
|
+
error: {
|
|
15701
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
15702
|
+
nullable: true
|
|
15703
|
+
},
|
|
15704
|
+
result: {
|
|
15705
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
15706
|
+
nullable: true
|
|
15707
|
+
},
|
|
15708
|
+
status: { enum: ["pending"], type: "string" }
|
|
15709
|
+
},
|
|
15710
|
+
required: [
|
|
15711
|
+
"action_attempt_id",
|
|
15712
|
+
"status",
|
|
15713
|
+
"result",
|
|
15714
|
+
"error",
|
|
15715
|
+
"action_type"
|
|
15716
|
+
],
|
|
15717
|
+
type: "object"
|
|
15718
|
+
},
|
|
15719
|
+
{
|
|
15720
|
+
description: "Assigning a credential to an access method succeeded.",
|
|
15721
|
+
properties: {
|
|
15722
|
+
action_attempt_id: {
|
|
15723
|
+
description: "ID of the action attempt.",
|
|
15724
|
+
format: "uuid",
|
|
15725
|
+
type: "string"
|
|
15726
|
+
},
|
|
15727
|
+
action_type: {
|
|
15728
|
+
description: "Action attempt to track the status of assigning an existing credential to an access method.",
|
|
15729
|
+
enum: ["ASSIGN_CREDENTIAL"],
|
|
15730
|
+
type: "string"
|
|
15731
|
+
},
|
|
15732
|
+
error: {
|
|
15733
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
15734
|
+
nullable: true
|
|
15735
|
+
},
|
|
15736
|
+
result: {
|
|
15737
|
+
description: "Result of an assignment attempt. If the attempt was successful, includes the updated access method with the assigned credential.",
|
|
15738
|
+
properties: {
|
|
15739
|
+
access_method_id: {
|
|
15740
|
+
description: "ID of the access method.",
|
|
15741
|
+
format: "uuid",
|
|
15742
|
+
type: "string"
|
|
15743
|
+
},
|
|
15744
|
+
client_session_token: {
|
|
15745
|
+
description: "Token of the client session associated with the access method.",
|
|
15746
|
+
type: "string"
|
|
15747
|
+
},
|
|
15748
|
+
code: {
|
|
15749
|
+
description: "The actual PIN code for code access methods.",
|
|
15750
|
+
nullable: true,
|
|
15751
|
+
type: "string"
|
|
15752
|
+
},
|
|
15753
|
+
created_at: {
|
|
15754
|
+
description: "Date and time at which the access method was created.",
|
|
15755
|
+
format: "date-time",
|
|
15756
|
+
type: "string"
|
|
15757
|
+
},
|
|
15758
|
+
customization_profile_id: {
|
|
15759
|
+
description: "ID of the customization profile associated with the access method.",
|
|
15760
|
+
format: "uuid",
|
|
15761
|
+
type: "string"
|
|
15762
|
+
},
|
|
15763
|
+
display_name: {
|
|
15764
|
+
description: "Display name of the access method.",
|
|
15765
|
+
type: "string"
|
|
15766
|
+
},
|
|
15767
|
+
instant_key_url: {
|
|
15768
|
+
description: "URL of the Instant Key for mobile key access methods.",
|
|
15769
|
+
format: "uri",
|
|
15770
|
+
type: "string"
|
|
15771
|
+
},
|
|
15772
|
+
is_assignment_required: {
|
|
15773
|
+
description: "Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.",
|
|
15774
|
+
type: "boolean"
|
|
15775
|
+
},
|
|
15776
|
+
is_encoding_required: {
|
|
15777
|
+
description: "Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.",
|
|
15778
|
+
type: "boolean"
|
|
15779
|
+
},
|
|
15780
|
+
is_issued: {
|
|
15781
|
+
description: "Indicates whether the access method has been issued.",
|
|
15782
|
+
type: "boolean"
|
|
15783
|
+
},
|
|
15784
|
+
is_ready_for_assignment: {
|
|
15785
|
+
description: "Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment.",
|
|
15786
|
+
type: "boolean"
|
|
15787
|
+
},
|
|
15788
|
+
is_ready_for_encoding: {
|
|
15789
|
+
description: "Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.",
|
|
15790
|
+
type: "boolean"
|
|
15791
|
+
},
|
|
15792
|
+
issued_at: {
|
|
15793
|
+
description: "Date and time at which the access method was issued.",
|
|
15794
|
+
format: "date-time",
|
|
15795
|
+
nullable: true,
|
|
15796
|
+
type: "string"
|
|
15797
|
+
},
|
|
15798
|
+
mode: {
|
|
15799
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.",
|
|
15800
|
+
enum: ["code", "card", "mobile_key", "cloud_key"],
|
|
15801
|
+
type: "string"
|
|
15802
|
+
},
|
|
15803
|
+
pending_mutations: {
|
|
15804
|
+
description: "Pending mutations for the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). Indicates operations that are in progress.",
|
|
15805
|
+
items: {
|
|
15806
|
+
discriminator: { propertyName: "mutation_code" },
|
|
15807
|
+
oneOf: [
|
|
15808
|
+
{
|
|
15809
|
+
description: "Seam is in the process of provisioning access for this access method on new devices.",
|
|
15810
|
+
properties: {
|
|
15811
|
+
created_at: {
|
|
15812
|
+
description: "Date and time at which the mutation was created.",
|
|
15813
|
+
format: "date-time",
|
|
15814
|
+
type: "string"
|
|
15815
|
+
},
|
|
15816
|
+
from: {
|
|
15817
|
+
description: "Previous device configuration.",
|
|
15818
|
+
properties: {
|
|
15819
|
+
device_ids: {
|
|
15820
|
+
description: "Previous device IDs where access was provisioned.",
|
|
15821
|
+
items: { format: "uuid", type: "string" },
|
|
15822
|
+
type: "array"
|
|
15823
|
+
}
|
|
15824
|
+
},
|
|
15825
|
+
required: ["device_ids"],
|
|
15826
|
+
type: "object"
|
|
15827
|
+
},
|
|
15828
|
+
message: {
|
|
15829
|
+
description: "Detailed description of the mutation.",
|
|
15830
|
+
type: "string"
|
|
15831
|
+
},
|
|
15832
|
+
mutation_code: {
|
|
15833
|
+
description: "Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices.",
|
|
15834
|
+
enum: ["provisioning_access"],
|
|
15835
|
+
type: "string"
|
|
15836
|
+
},
|
|
15837
|
+
to: {
|
|
15838
|
+
description: "New device configuration.",
|
|
15839
|
+
properties: {
|
|
15840
|
+
device_ids: {
|
|
15841
|
+
description: "New device IDs where access is being provisioned.",
|
|
15842
|
+
items: { format: "uuid", type: "string" },
|
|
15843
|
+
type: "array"
|
|
15844
|
+
}
|
|
15845
|
+
},
|
|
15846
|
+
required: ["device_ids"],
|
|
15847
|
+
type: "object"
|
|
15848
|
+
}
|
|
15849
|
+
},
|
|
15850
|
+
required: [
|
|
15851
|
+
"created_at",
|
|
15852
|
+
"message",
|
|
15853
|
+
"mutation_code",
|
|
15854
|
+
"from",
|
|
15855
|
+
"to"
|
|
15856
|
+
],
|
|
15857
|
+
type: "object"
|
|
15858
|
+
},
|
|
15859
|
+
{
|
|
15860
|
+
description: "Seam is in the process of revoking access for this access method from devices.",
|
|
15861
|
+
properties: {
|
|
15862
|
+
created_at: {
|
|
15863
|
+
description: "Date and time at which the mutation was created.",
|
|
15864
|
+
format: "date-time",
|
|
15865
|
+
type: "string"
|
|
15866
|
+
},
|
|
15867
|
+
from: {
|
|
15868
|
+
description: "Previous device configuration.",
|
|
15869
|
+
properties: {
|
|
15870
|
+
device_ids: {
|
|
15871
|
+
description: "Previous device IDs where access existed.",
|
|
15872
|
+
items: { format: "uuid", type: "string" },
|
|
15873
|
+
type: "array"
|
|
15874
|
+
}
|
|
15875
|
+
},
|
|
15876
|
+
required: ["device_ids"],
|
|
15877
|
+
type: "object"
|
|
15878
|
+
},
|
|
15879
|
+
message: {
|
|
15880
|
+
description: "Detailed description of the mutation.",
|
|
15881
|
+
type: "string"
|
|
15882
|
+
},
|
|
15883
|
+
mutation_code: {
|
|
15884
|
+
description: "Mutation code to indicate that Seam is in the process of revoking access for this access method from devices.",
|
|
15885
|
+
enum: ["revoking_access"],
|
|
15886
|
+
type: "string"
|
|
15887
|
+
},
|
|
15888
|
+
to: {
|
|
15889
|
+
description: "New device configuration.",
|
|
15890
|
+
properties: {
|
|
15891
|
+
device_ids: {
|
|
15892
|
+
description: "New device IDs where access should remain.",
|
|
15893
|
+
items: { format: "uuid", type: "string" },
|
|
15894
|
+
type: "array"
|
|
15895
|
+
}
|
|
15896
|
+
},
|
|
15897
|
+
required: ["device_ids"],
|
|
15898
|
+
type: "object"
|
|
15899
|
+
}
|
|
15900
|
+
},
|
|
15901
|
+
required: [
|
|
15902
|
+
"created_at",
|
|
15903
|
+
"message",
|
|
15904
|
+
"mutation_code",
|
|
15905
|
+
"from",
|
|
15906
|
+
"to"
|
|
15907
|
+
],
|
|
15908
|
+
type: "object"
|
|
15909
|
+
},
|
|
15910
|
+
{
|
|
15911
|
+
description: "Seam is in the process of updating the access times for this access method.",
|
|
15912
|
+
properties: {
|
|
15913
|
+
created_at: {
|
|
15914
|
+
description: "Date and time at which the mutation was created.",
|
|
15915
|
+
format: "date-time",
|
|
15916
|
+
type: "string"
|
|
15917
|
+
},
|
|
15918
|
+
from: {
|
|
15919
|
+
description: "Previous access time configuration.",
|
|
15920
|
+
properties: {
|
|
15921
|
+
ends_at: {
|
|
15922
|
+
description: "Previous end time for access.",
|
|
15923
|
+
format: "date-time",
|
|
15924
|
+
nullable: true,
|
|
15925
|
+
type: "string"
|
|
15926
|
+
},
|
|
15927
|
+
starts_at: {
|
|
15928
|
+
description: "Previous start time for access.",
|
|
15929
|
+
format: "date-time",
|
|
15930
|
+
nullable: true,
|
|
15931
|
+
type: "string"
|
|
15932
|
+
}
|
|
15933
|
+
},
|
|
15934
|
+
required: ["starts_at", "ends_at"],
|
|
15935
|
+
type: "object"
|
|
15936
|
+
},
|
|
15937
|
+
message: {
|
|
15938
|
+
description: "Detailed description of the mutation.",
|
|
15939
|
+
type: "string"
|
|
15940
|
+
},
|
|
15941
|
+
mutation_code: {
|
|
15942
|
+
description: "Mutation code to indicate that Seam is in the process of updating the access times for this access method.",
|
|
15943
|
+
enum: ["updating_access_times"],
|
|
15944
|
+
type: "string"
|
|
15945
|
+
},
|
|
15946
|
+
to: {
|
|
15947
|
+
description: "New access time configuration.",
|
|
15948
|
+
properties: {
|
|
15949
|
+
ends_at: {
|
|
15950
|
+
description: "New end time for access.",
|
|
15951
|
+
format: "date-time",
|
|
15952
|
+
nullable: true,
|
|
15953
|
+
type: "string"
|
|
15954
|
+
},
|
|
15955
|
+
starts_at: {
|
|
15956
|
+
description: "New start time for access.",
|
|
15957
|
+
format: "date-time",
|
|
15958
|
+
nullable: true,
|
|
15959
|
+
type: "string"
|
|
15960
|
+
}
|
|
15961
|
+
},
|
|
15962
|
+
required: ["starts_at", "ends_at"],
|
|
15963
|
+
type: "object"
|
|
15964
|
+
}
|
|
15965
|
+
},
|
|
15966
|
+
required: [
|
|
15967
|
+
"created_at",
|
|
15968
|
+
"message",
|
|
15969
|
+
"mutation_code",
|
|
15970
|
+
"from",
|
|
15971
|
+
"to"
|
|
15972
|
+
],
|
|
15973
|
+
type: "object"
|
|
15974
|
+
}
|
|
15975
|
+
]
|
|
15976
|
+
},
|
|
15977
|
+
type: "array"
|
|
15978
|
+
},
|
|
15979
|
+
warnings: {
|
|
15980
|
+
description: "Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).",
|
|
15981
|
+
items: {
|
|
15982
|
+
description: "Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).",
|
|
15983
|
+
discriminator: { propertyName: "warning_code" },
|
|
15984
|
+
oneOf: [
|
|
15985
|
+
{
|
|
15986
|
+
description: "Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted.",
|
|
15987
|
+
properties: {
|
|
15988
|
+
created_at: {
|
|
15989
|
+
description: "Date and time at which Seam created the warning.",
|
|
15990
|
+
format: "date-time",
|
|
15991
|
+
type: "string"
|
|
15992
|
+
},
|
|
15993
|
+
message: {
|
|
15994
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
15995
|
+
type: "string"
|
|
15996
|
+
},
|
|
15997
|
+
warning_code: {
|
|
15998
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15999
|
+
enum: ["being_deleted"],
|
|
16000
|
+
type: "string"
|
|
16001
|
+
}
|
|
16002
|
+
},
|
|
16003
|
+
required: ["created_at", "message", "warning_code"],
|
|
16004
|
+
type: "object"
|
|
16005
|
+
},
|
|
16006
|
+
{
|
|
16007
|
+
description: "Indicates that the access times for this [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) are being updated.",
|
|
16008
|
+
properties: {
|
|
16009
|
+
created_at: {
|
|
16010
|
+
description: "Date and time at which Seam created the warning.",
|
|
16011
|
+
format: "date-time",
|
|
16012
|
+
type: "string"
|
|
16013
|
+
},
|
|
16014
|
+
message: {
|
|
16015
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
16016
|
+
type: "string"
|
|
16017
|
+
},
|
|
16018
|
+
warning_code: {
|
|
16019
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
16020
|
+
enum: ["updating_access_times"],
|
|
16021
|
+
type: "string"
|
|
16022
|
+
}
|
|
16023
|
+
},
|
|
16024
|
+
required: ["created_at", "message", "warning_code"],
|
|
16025
|
+
type: "object"
|
|
16026
|
+
},
|
|
16027
|
+
{
|
|
16028
|
+
description: "Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.",
|
|
16029
|
+
properties: {
|
|
16030
|
+
created_at: {
|
|
16031
|
+
description: "Date and time at which Seam created the warning.",
|
|
16032
|
+
format: "date-time",
|
|
16033
|
+
type: "string"
|
|
16034
|
+
},
|
|
16035
|
+
message: {
|
|
16036
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
16037
|
+
type: "string"
|
|
16038
|
+
},
|
|
16039
|
+
original_access_method_id: {
|
|
16040
|
+
description: "ID of the original access method from which this backup access method was split, if applicable.",
|
|
16041
|
+
format: "uuid",
|
|
16042
|
+
type: "string"
|
|
16043
|
+
},
|
|
16044
|
+
warning_code: {
|
|
16045
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
16046
|
+
enum: ["pulled_backup_access_code"],
|
|
16047
|
+
type: "string"
|
|
16048
|
+
}
|
|
16049
|
+
},
|
|
16050
|
+
required: ["created_at", "message", "warning_code"],
|
|
16051
|
+
type: "object"
|
|
16052
|
+
}
|
|
16053
|
+
]
|
|
16054
|
+
},
|
|
16055
|
+
type: "array"
|
|
16056
|
+
},
|
|
16057
|
+
workspace_id: {
|
|
16058
|
+
description: "ID of the Seam workspace associated with the access method.",
|
|
16059
|
+
format: "uuid",
|
|
16060
|
+
type: "string"
|
|
16061
|
+
}
|
|
16062
|
+
},
|
|
16063
|
+
required: [
|
|
16064
|
+
"workspace_id",
|
|
16065
|
+
"access_method_id",
|
|
16066
|
+
"display_name",
|
|
16067
|
+
"mode",
|
|
16068
|
+
"created_at",
|
|
16069
|
+
"issued_at",
|
|
16070
|
+
"is_issued",
|
|
16071
|
+
"warnings",
|
|
16072
|
+
"pending_mutations"
|
|
16073
|
+
],
|
|
16074
|
+
type: "object"
|
|
16075
|
+
},
|
|
16076
|
+
status: { enum: ["success"], type: "string" }
|
|
16077
|
+
},
|
|
16078
|
+
required: [
|
|
16079
|
+
"action_attempt_id",
|
|
16080
|
+
"status",
|
|
16081
|
+
"error",
|
|
16082
|
+
"action_type",
|
|
16083
|
+
"result"
|
|
16084
|
+
],
|
|
16085
|
+
type: "object"
|
|
16086
|
+
},
|
|
16087
|
+
{
|
|
16088
|
+
description: "Assigning a credential to an access method failed.",
|
|
16089
|
+
properties: {
|
|
16090
|
+
action_attempt_id: {
|
|
16091
|
+
description: "ID of the action attempt.",
|
|
16092
|
+
format: "uuid",
|
|
16093
|
+
type: "string"
|
|
16094
|
+
},
|
|
16095
|
+
action_type: {
|
|
16096
|
+
description: "Action attempt to track the status of assigning an existing credential to an access method.",
|
|
16097
|
+
enum: ["ASSIGN_CREDENTIAL"],
|
|
16098
|
+
type: "string"
|
|
16099
|
+
},
|
|
16100
|
+
error: {
|
|
16101
|
+
oneOf: [
|
|
16102
|
+
{
|
|
16103
|
+
description: "Error that doesn't fit into other specific error categories.",
|
|
16104
|
+
properties: {
|
|
16105
|
+
message: {
|
|
16106
|
+
description: "Message for the error associated with the action attempt.",
|
|
16107
|
+
type: "string"
|
|
16108
|
+
},
|
|
16109
|
+
type: {
|
|
16110
|
+
description: "Type of the error associated with the action attempt.",
|
|
16111
|
+
enum: ["uncategorized_error"],
|
|
16112
|
+
type: "string"
|
|
16113
|
+
}
|
|
16114
|
+
},
|
|
16115
|
+
required: ["type", "message"],
|
|
16116
|
+
type: "object"
|
|
16117
|
+
},
|
|
16118
|
+
{
|
|
16119
|
+
description: "Error to indicate an expired action attempt.",
|
|
16120
|
+
properties: {
|
|
16121
|
+
message: {
|
|
16122
|
+
description: "Message for the error associated with the action attempt.",
|
|
16123
|
+
type: "string"
|
|
16124
|
+
},
|
|
16125
|
+
type: {
|
|
16126
|
+
description: "Type of the error associated with the action attempt.",
|
|
16127
|
+
enum: ["action_attempt_expired"],
|
|
16128
|
+
type: "string"
|
|
16129
|
+
}
|
|
16130
|
+
},
|
|
16131
|
+
required: ["type", "message"],
|
|
16132
|
+
type: "object"
|
|
16133
|
+
},
|
|
16134
|
+
{
|
|
16135
|
+
description: "Error to indicate that no matching credential was found.",
|
|
16136
|
+
properties: {
|
|
16137
|
+
message: {
|
|
16138
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
16139
|
+
type: "string"
|
|
16140
|
+
},
|
|
16141
|
+
type: {
|
|
16142
|
+
description: "Error type to indicate that no matching credential was found.",
|
|
16143
|
+
enum: ["credential_not_found"],
|
|
16144
|
+
type: "string"
|
|
16145
|
+
}
|
|
16146
|
+
},
|
|
16147
|
+
required: ["type", "message"],
|
|
16148
|
+
type: "object"
|
|
16149
|
+
}
|
|
16150
|
+
]
|
|
16151
|
+
},
|
|
16152
|
+
result: {
|
|
16153
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
16154
|
+
nullable: true
|
|
16155
|
+
},
|
|
16156
|
+
status: { enum: ["error"], type: "string" }
|
|
16157
|
+
},
|
|
16158
|
+
required: [
|
|
16159
|
+
"action_attempt_id",
|
|
16160
|
+
"status",
|
|
16161
|
+
"result",
|
|
16162
|
+
"action_type",
|
|
16163
|
+
"error"
|
|
16164
|
+
],
|
|
16165
|
+
type: "object"
|
|
16166
|
+
},
|
|
15658
16167
|
{
|
|
15659
16168
|
description: "Resetting a sandbox workspace is pending.",
|
|
15660
16169
|
properties: {
|
|
@@ -43790,7 +44299,7 @@ var openapi = {
|
|
|
43790
44299
|
},
|
|
43791
44300
|
"/access_methods/assign_card": {
|
|
43792
44301
|
post: {
|
|
43793
|
-
description: "Assigns
|
|
44302
|
+
description: "Assigns a pre-registered card credential to a card-mode access method, identified by `card_number`. Use this endpoint for access systems that use pre-registered cards, where a physical card must be associated with an access method before it can be issued.",
|
|
43794
44303
|
operationId: "accessMethodsAssignCardPost",
|
|
43795
44304
|
requestBody: {
|
|
43796
44305
|
content: {
|
|
@@ -43798,12 +44307,12 @@ var openapi = {
|
|
|
43798
44307
|
schema: {
|
|
43799
44308
|
properties: {
|
|
43800
44309
|
access_method_id: {
|
|
43801
|
-
description: "ID of the
|
|
44310
|
+
description: "ID of the `access_method` to assign the credential to.",
|
|
43802
44311
|
format: "uuid",
|
|
43803
44312
|
type: "string"
|
|
43804
44313
|
},
|
|
43805
44314
|
card_number: {
|
|
43806
|
-
description: "Card number of the
|
|
44315
|
+
description: "Card number of the credential to assign.",
|
|
43807
44316
|
type: "string"
|
|
43808
44317
|
}
|
|
43809
44318
|
},
|
|
@@ -43819,12 +44328,12 @@ var openapi = {
|
|
|
43819
44328
|
"application/json": {
|
|
43820
44329
|
schema: {
|
|
43821
44330
|
properties: {
|
|
43822
|
-
|
|
43823
|
-
$ref: "#/components/schemas/
|
|
44331
|
+
action_attempt: {
|
|
44332
|
+
$ref: "#/components/schemas/action_attempt"
|
|
43824
44333
|
},
|
|
43825
44334
|
ok: { type: "boolean" }
|
|
43826
44335
|
},
|
|
43827
|
-
required: ["
|
|
44336
|
+
required: ["action_attempt", "ok"],
|
|
43828
44337
|
type: "object"
|
|
43829
44338
|
}
|
|
43830
44339
|
}
|
|
@@ -43841,11 +44350,12 @@ var openapi = {
|
|
|
43841
44350
|
],
|
|
43842
44351
|
summary: "/access_methods/assign_card",
|
|
43843
44352
|
tags: [],
|
|
44353
|
+
"x-action-attempt-type": "ASSIGN_CREDENTIAL",
|
|
43844
44354
|
"x-fern-sdk-group-name": ["access_methods"],
|
|
43845
44355
|
"x-fern-sdk-method-name": "assign_card",
|
|
43846
|
-
"x-fern-sdk-return-value": "
|
|
43847
|
-
"x-response-key": "
|
|
43848
|
-
"x-title": "Assign a Card to an Access Method"
|
|
44356
|
+
"x-fern-sdk-return-value": "action_attempt",
|
|
44357
|
+
"x-response-key": "action_attempt",
|
|
44358
|
+
"x-title": "Assign a Card Credential to an Access Method"
|
|
43849
44359
|
}
|
|
43850
44360
|
},
|
|
43851
44361
|
"/access_methods/delete": {
|