@seamapi/types 1.851.0 → 1.852.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 +645 -37
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +8475 -423
- package/dist/index.cjs +645 -37
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +558 -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/scan-to-assign-credential.d.ts +561 -0
- package/lib/seam/connect/models/action-attempts/scan-to-assign-credential.js +38 -0
- package/lib/seam/connect/models/action-attempts/scan-to-assign-credential.js.map +1 -0
- package/lib/seam/connect/models/batch.d.ts +756 -0
- package/lib/seam/connect/openapi.js +570 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +7161 -423
- 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/scan-to-assign-credential.ts +69 -0
- package/src/lib/seam/connect/openapi.ts +656 -0
- package/src/lib/seam/connect/route-types.ts +8070 -0
package/dist/index.cjs
CHANGED
|
@@ -4845,116 +4845,153 @@ var scan_credential_action_attempt = zod.z.discriminatedUnion("status", [
|
|
|
4845
4845
|
}).describe("Reading credential data from physical encoder succeeded."),
|
|
4846
4846
|
common_failed_action_attempt.extend({ action_type: action_type7, error: error8 }).describe("Reading credential data from physical encoder failed.")
|
|
4847
4847
|
]);
|
|
4848
|
-
var action_type8 = zod.z.literal("
|
|
4848
|
+
var action_type8 = zod.z.literal("SCAN_TO_ASSIGN_CREDENTIAL").describe(
|
|
4849
|
+
"Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user."
|
|
4850
|
+
);
|
|
4851
|
+
var no_credential_on_encoder_error3 = zod.z.object({
|
|
4852
|
+
type: zod.z.literal("no_credential_on_encoder").describe(
|
|
4853
|
+
"Error type to indicate that there is no credential on the encoder."
|
|
4854
|
+
),
|
|
4855
|
+
message: zod.z.string().describe(
|
|
4856
|
+
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
4857
|
+
)
|
|
4858
|
+
}).describe("Error to indicate that there is no credential on the encoder.");
|
|
4859
|
+
var error9 = zod.z.union([
|
|
4860
|
+
...common_action_attempt_errors,
|
|
4861
|
+
no_credential_on_encoder_error3
|
|
4862
|
+
]);
|
|
4863
|
+
var result9 = acs_credential.describe(
|
|
4864
|
+
"Result of a scan to assign attempt. If the attempt was successful, includes the credential data that was scanned and assigned."
|
|
4865
|
+
);
|
|
4866
|
+
var scan_to_assign_credential_action_attempt = zod.z.discriminatedUnion(
|
|
4867
|
+
"status",
|
|
4868
|
+
[
|
|
4869
|
+
common_pending_action_attempt.extend({
|
|
4870
|
+
action_type: action_type8
|
|
4871
|
+
}).describe(
|
|
4872
|
+
"Scanning a physical card and assigning the credential is pending."
|
|
4873
|
+
),
|
|
4874
|
+
common_succeeded_action_attempt.extend({
|
|
4875
|
+
action_type: action_type8,
|
|
4876
|
+
result: result9
|
|
4877
|
+
}).describe(
|
|
4878
|
+
"Scanning a physical card and assigning the credential succeeded."
|
|
4879
|
+
),
|
|
4880
|
+
common_failed_action_attempt.extend({ action_type: action_type8, error: error9 }).describe(
|
|
4881
|
+
"Scanning a physical card and assigning the credential failed."
|
|
4882
|
+
)
|
|
4883
|
+
]
|
|
4884
|
+
);
|
|
4885
|
+
var action_type9 = zod.z.literal("SET_FAN_MODE").describe(
|
|
4849
4886
|
"Action attempt to track the status of setting the fan mode on a thermostat."
|
|
4850
4887
|
);
|
|
4851
|
-
var
|
|
4888
|
+
var error10 = zod.z.object({
|
|
4852
4889
|
type: zod.z.string().describe("Type of the error."),
|
|
4853
4890
|
message: zod.z.string().describe(
|
|
4854
4891
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
4855
4892
|
)
|
|
4856
4893
|
}).describe("Error associated with the action.");
|
|
4857
|
-
var
|
|
4894
|
+
var result10 = zod.z.object({}).describe("Result of the action.");
|
|
4858
4895
|
var set_fan_mode_action_attempt = zod.z.discriminatedUnion("status", [
|
|
4859
4896
|
common_pending_action_attempt.extend({
|
|
4860
|
-
action_type:
|
|
4897
|
+
action_type: action_type9
|
|
4861
4898
|
}).describe("Setting the fan mode is pending."),
|
|
4862
4899
|
common_succeeded_action_attempt.extend({
|
|
4863
|
-
action_type:
|
|
4864
|
-
result:
|
|
4900
|
+
action_type: action_type9,
|
|
4901
|
+
result: result10
|
|
4865
4902
|
}).describe("Setting the fan mode succeeded."),
|
|
4866
|
-
common_failed_action_attempt.extend({ action_type:
|
|
4903
|
+
common_failed_action_attempt.extend({ action_type: action_type9, error: error10 }).describe("Setting the fan mode failed.")
|
|
4867
4904
|
]);
|
|
4868
|
-
var
|
|
4905
|
+
var action_type10 = zod.z.literal("SET_HVAC_MODE").describe(
|
|
4869
4906
|
"Action attempt to track the status of setting the HVAC mode on a thermostat."
|
|
4870
4907
|
);
|
|
4871
|
-
var
|
|
4908
|
+
var error11 = zod.z.object({
|
|
4872
4909
|
type: zod.z.string().describe("Type of the error."),
|
|
4873
4910
|
message: zod.z.string().describe(
|
|
4874
4911
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
4875
4912
|
)
|
|
4876
4913
|
}).describe("Error associated with the action.");
|
|
4877
|
-
var
|
|
4914
|
+
var result11 = zod.z.object({}).describe("Result of the action.");
|
|
4878
4915
|
var set_hvac_mode_action_attempt = zod.z.discriminatedUnion("status", [
|
|
4879
4916
|
common_pending_action_attempt.extend({
|
|
4880
|
-
action_type:
|
|
4917
|
+
action_type: action_type10
|
|
4881
4918
|
}).describe("Setting the HVAC mode is pending."),
|
|
4882
4919
|
common_succeeded_action_attempt.extend({
|
|
4883
|
-
action_type:
|
|
4884
|
-
result:
|
|
4920
|
+
action_type: action_type10,
|
|
4921
|
+
result: result11
|
|
4885
4922
|
}).describe("Setting the HVAC mode succeeded."),
|
|
4886
|
-
common_failed_action_attempt.extend({ action_type:
|
|
4923
|
+
common_failed_action_attempt.extend({ action_type: action_type10, error: error11 }).describe("Setting the HVAC mode failed.")
|
|
4887
4924
|
]);
|
|
4888
|
-
var
|
|
4925
|
+
var action_type11 = zod.z.literal("SIMULATE_KEYPAD_CODE_ENTRY").describe(
|
|
4889
4926
|
"Action attempt to track the status of simulating a keypad code entry."
|
|
4890
4927
|
);
|
|
4891
|
-
var
|
|
4928
|
+
var error12 = zod.z.object({
|
|
4892
4929
|
type: zod.z.string().describe("Type of the error."),
|
|
4893
4930
|
message: zod.z.string().describe(
|
|
4894
4931
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
4895
4932
|
)
|
|
4896
4933
|
}).describe("Error associated with the action.");
|
|
4897
|
-
var
|
|
4934
|
+
var result12 = zod.z.object({}).describe("Result of the action.");
|
|
4898
4935
|
var simulate_keypad_code_entry_action_attempt = zod.z.discriminatedUnion(
|
|
4899
4936
|
"status",
|
|
4900
4937
|
[
|
|
4901
4938
|
common_pending_action_attempt.extend({
|
|
4902
|
-
action_type:
|
|
4939
|
+
action_type: action_type11
|
|
4903
4940
|
}).describe("Simulating a keypad code entry is pending."),
|
|
4904
4941
|
common_succeeded_action_attempt.extend({
|
|
4905
|
-
action_type:
|
|
4906
|
-
result:
|
|
4942
|
+
action_type: action_type11,
|
|
4943
|
+
result: result12
|
|
4907
4944
|
}).describe("Simulating a keypad code entry succeeded."),
|
|
4908
4945
|
common_failed_action_attempt.extend({
|
|
4909
|
-
action_type:
|
|
4910
|
-
error:
|
|
4946
|
+
action_type: action_type11,
|
|
4947
|
+
error: error12
|
|
4911
4948
|
}).describe("Simulating a keypad code entry failed.")
|
|
4912
4949
|
]
|
|
4913
4950
|
);
|
|
4914
|
-
var
|
|
4951
|
+
var action_type12 = zod.z.literal("SIMULATE_MANUAL_LOCK_VIA_KEYPAD").describe(
|
|
4915
4952
|
"Action attempt to track the status of simulating a manual lock action using a keypad."
|
|
4916
4953
|
);
|
|
4917
|
-
var
|
|
4954
|
+
var error13 = zod.z.object({
|
|
4918
4955
|
type: zod.z.string().describe("Type of the error."),
|
|
4919
4956
|
message: zod.z.string().describe(
|
|
4920
4957
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
4921
4958
|
)
|
|
4922
4959
|
}).describe("Error associated with the action.");
|
|
4923
|
-
var
|
|
4960
|
+
var result13 = zod.z.object({}).describe("Result of the action.");
|
|
4924
4961
|
var simulate_manual_lock_via_keypad_action_attempt = zod.z.discriminatedUnion("status", [
|
|
4925
4962
|
common_pending_action_attempt.extend({
|
|
4926
|
-
action_type:
|
|
4963
|
+
action_type: action_type12
|
|
4927
4964
|
}).describe("Simulating a manual lock action using a keypad is pending."),
|
|
4928
4965
|
common_succeeded_action_attempt.extend({
|
|
4929
|
-
action_type:
|
|
4930
|
-
result:
|
|
4966
|
+
action_type: action_type12,
|
|
4967
|
+
result: result13
|
|
4931
4968
|
}).describe("Simulating a manual lock action using a keypad succeeded."),
|
|
4932
4969
|
common_failed_action_attempt.extend({
|
|
4933
|
-
action_type:
|
|
4934
|
-
error:
|
|
4970
|
+
action_type: action_type12,
|
|
4971
|
+
error: error13
|
|
4935
4972
|
}).describe("Simulating a manual lock action using a keypad failed.")
|
|
4936
4973
|
]);
|
|
4937
|
-
var
|
|
4938
|
-
var
|
|
4974
|
+
var action_type13 = zod.z.literal("UNLOCK_DOOR").describe("Action attempt to track the status of unlocking a door.");
|
|
4975
|
+
var error14 = zod.z.object({
|
|
4939
4976
|
type: zod.z.string().describe("Type of the error."),
|
|
4940
4977
|
message: zod.z.string().describe(
|
|
4941
4978
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
4942
4979
|
)
|
|
4943
4980
|
}).describe("Error associated with the action.");
|
|
4944
|
-
var
|
|
4981
|
+
var result14 = zod.z.object({
|
|
4945
4982
|
was_confirmed_by_device: zod.z.boolean().optional().describe(
|
|
4946
4983
|
"Indicates whether the device confirmed that the unlock action occurred."
|
|
4947
4984
|
)
|
|
4948
4985
|
}).describe("Result of the action.");
|
|
4949
4986
|
var unlock_door_action_attempt = zod.z.discriminatedUnion("status", [
|
|
4950
4987
|
common_pending_action_attempt.extend({
|
|
4951
|
-
action_type:
|
|
4988
|
+
action_type: action_type13
|
|
4952
4989
|
}).describe("Unlocking a door is pending."),
|
|
4953
4990
|
common_succeeded_action_attempt.extend({
|
|
4954
|
-
action_type:
|
|
4955
|
-
result:
|
|
4991
|
+
action_type: action_type13,
|
|
4992
|
+
result: result14
|
|
4956
4993
|
}).describe("Unlocking a door succeeded."),
|
|
4957
|
-
common_failed_action_attempt.extend({ action_type:
|
|
4994
|
+
common_failed_action_attempt.extend({ action_type: action_type13, error: error14 }).describe("Unlocking a door failed.")
|
|
4958
4995
|
]);
|
|
4959
4996
|
|
|
4960
4997
|
// src/lib/seam/connect/models/action-attempts/action-attempt.ts
|
|
@@ -4963,6 +5000,7 @@ var action_attempt = zod.z.union([
|
|
|
4963
5000
|
...unlock_door_action_attempt.options,
|
|
4964
5001
|
...scan_credential_action_attempt.options,
|
|
4965
5002
|
...encode_credential_action_attempt.options,
|
|
5003
|
+
...scan_to_assign_credential_action_attempt.options,
|
|
4966
5004
|
...reset_sandbox_workspace_action_attempt.options,
|
|
4967
5005
|
...set_fan_mode_action_attempt.options,
|
|
4968
5006
|
...set_hvac_mode_action_attempt.options,
|
|
@@ -14707,6 +14745,508 @@ var openapi = {
|
|
|
14707
14745
|
],
|
|
14708
14746
|
type: "object"
|
|
14709
14747
|
},
|
|
14748
|
+
{
|
|
14749
|
+
description: "Scanning a physical card and assigning the credential is pending.",
|
|
14750
|
+
properties: {
|
|
14751
|
+
action_attempt_id: {
|
|
14752
|
+
description: "ID of the action attempt.",
|
|
14753
|
+
format: "uuid",
|
|
14754
|
+
type: "string"
|
|
14755
|
+
},
|
|
14756
|
+
action_type: {
|
|
14757
|
+
description: "Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user.",
|
|
14758
|
+
enum: ["SCAN_TO_ASSIGN_CREDENTIAL"],
|
|
14759
|
+
type: "string"
|
|
14760
|
+
},
|
|
14761
|
+
error: {
|
|
14762
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
14763
|
+
nullable: true
|
|
14764
|
+
},
|
|
14765
|
+
result: {
|
|
14766
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
14767
|
+
nullable: true
|
|
14768
|
+
},
|
|
14769
|
+
status: { enum: ["pending"], type: "string" }
|
|
14770
|
+
},
|
|
14771
|
+
required: [
|
|
14772
|
+
"action_attempt_id",
|
|
14773
|
+
"status",
|
|
14774
|
+
"result",
|
|
14775
|
+
"error",
|
|
14776
|
+
"action_type"
|
|
14777
|
+
],
|
|
14778
|
+
type: "object"
|
|
14779
|
+
},
|
|
14780
|
+
{
|
|
14781
|
+
description: "Scanning a physical card and assigning the credential succeeded.",
|
|
14782
|
+
properties: {
|
|
14783
|
+
action_attempt_id: {
|
|
14784
|
+
description: "ID of the action attempt.",
|
|
14785
|
+
format: "uuid",
|
|
14786
|
+
type: "string"
|
|
14787
|
+
},
|
|
14788
|
+
action_type: {
|
|
14789
|
+
description: "Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user.",
|
|
14790
|
+
enum: ["SCAN_TO_ASSIGN_CREDENTIAL"],
|
|
14791
|
+
type: "string"
|
|
14792
|
+
},
|
|
14793
|
+
error: {
|
|
14794
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
14795
|
+
nullable: true
|
|
14796
|
+
},
|
|
14797
|
+
result: {
|
|
14798
|
+
description: "Result of a scan to assign attempt. If the attempt was successful, includes the credential data that was scanned and assigned.",
|
|
14799
|
+
properties: {
|
|
14800
|
+
access_method: {
|
|
14801
|
+
description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.",
|
|
14802
|
+
enum: ["code", "card", "mobile_key", "cloud_key"],
|
|
14803
|
+
type: "string"
|
|
14804
|
+
},
|
|
14805
|
+
acs_credential_id: {
|
|
14806
|
+
description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
14807
|
+
format: "uuid",
|
|
14808
|
+
type: "string"
|
|
14809
|
+
},
|
|
14810
|
+
acs_credential_pool_id: { format: "uuid", type: "string" },
|
|
14811
|
+
acs_system_id: {
|
|
14812
|
+
description: "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
14813
|
+
format: "uuid",
|
|
14814
|
+
type: "string"
|
|
14815
|
+
},
|
|
14816
|
+
acs_user_id: {
|
|
14817
|
+
description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
|
|
14818
|
+
format: "uuid",
|
|
14819
|
+
type: "string"
|
|
14820
|
+
},
|
|
14821
|
+
assa_abloy_vostio_metadata: {
|
|
14822
|
+
description: "Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
14823
|
+
properties: {
|
|
14824
|
+
auto_join: {
|
|
14825
|
+
description: "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.",
|
|
14826
|
+
type: "boolean"
|
|
14827
|
+
},
|
|
14828
|
+
door_names: {
|
|
14829
|
+
description: "Names of the doors to which to grant access in the Vostio access system.",
|
|
14830
|
+
items: { type: "string" },
|
|
14831
|
+
type: "array"
|
|
14832
|
+
},
|
|
14833
|
+
endpoint_id: {
|
|
14834
|
+
description: "Endpoint ID in the Vostio access system.",
|
|
14835
|
+
type: "string"
|
|
14836
|
+
},
|
|
14837
|
+
key_id: {
|
|
14838
|
+
description: "Key ID in the Vostio access system.",
|
|
14839
|
+
type: "string"
|
|
14840
|
+
},
|
|
14841
|
+
key_issuing_request_id: {
|
|
14842
|
+
description: "Key issuing request ID in the Vostio access system.",
|
|
14843
|
+
type: "string"
|
|
14844
|
+
},
|
|
14845
|
+
override_guest_acs_entrance_ids: {
|
|
14846
|
+
description: "IDs of the guest entrances to override in the Vostio access system.",
|
|
14847
|
+
items: { type: "string" },
|
|
14848
|
+
type: "array"
|
|
14849
|
+
}
|
|
14850
|
+
},
|
|
14851
|
+
type: "object"
|
|
14852
|
+
},
|
|
14853
|
+
card_number: {
|
|
14854
|
+
description: "Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
14855
|
+
nullable: true,
|
|
14856
|
+
type: "string"
|
|
14857
|
+
},
|
|
14858
|
+
code: {
|
|
14859
|
+
description: "Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
14860
|
+
nullable: true,
|
|
14861
|
+
type: "string"
|
|
14862
|
+
},
|
|
14863
|
+
connected_account_id: {
|
|
14864
|
+
description: "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
|
|
14865
|
+
format: "uuid",
|
|
14866
|
+
type: "string"
|
|
14867
|
+
},
|
|
14868
|
+
created_at: {
|
|
14869
|
+
description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.",
|
|
14870
|
+
format: "date-time",
|
|
14871
|
+
type: "string"
|
|
14872
|
+
},
|
|
14873
|
+
display_name: {
|
|
14874
|
+
description: "Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.",
|
|
14875
|
+
minLength: 1,
|
|
14876
|
+
type: "string"
|
|
14877
|
+
},
|
|
14878
|
+
ends_at: {
|
|
14879
|
+
description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
|
|
14880
|
+
type: "string"
|
|
14881
|
+
},
|
|
14882
|
+
errors: {
|
|
14883
|
+
description: "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
14884
|
+
items: {
|
|
14885
|
+
properties: {
|
|
14886
|
+
error_code: { type: "string" },
|
|
14887
|
+
message: { type: "string" }
|
|
14888
|
+
},
|
|
14889
|
+
required: ["error_code", "message"],
|
|
14890
|
+
type: "object"
|
|
14891
|
+
},
|
|
14892
|
+
type: "array"
|
|
14893
|
+
},
|
|
14894
|
+
external_type: {
|
|
14895
|
+
description: "Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
|
|
14896
|
+
enum: [
|
|
14897
|
+
"pti_card",
|
|
14898
|
+
"brivo_credential",
|
|
14899
|
+
"hid_credential",
|
|
14900
|
+
"visionline_card",
|
|
14901
|
+
"salto_ks_credential",
|
|
14902
|
+
"assa_abloy_vostio_key",
|
|
14903
|
+
"salto_space_key",
|
|
14904
|
+
"latch_access",
|
|
14905
|
+
"dormakaba_ambiance_credential",
|
|
14906
|
+
"hotek_card",
|
|
14907
|
+
"salto_ks_tag",
|
|
14908
|
+
"avigilon_alta_credential"
|
|
14909
|
+
],
|
|
14910
|
+
type: "string"
|
|
14911
|
+
},
|
|
14912
|
+
external_type_display_name: {
|
|
14913
|
+
description: "Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.",
|
|
14914
|
+
type: "string"
|
|
14915
|
+
},
|
|
14916
|
+
is_issued: {
|
|
14917
|
+
description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.",
|
|
14918
|
+
type: "boolean"
|
|
14919
|
+
},
|
|
14920
|
+
is_latest_desired_state_synced_with_provider: {
|
|
14921
|
+
description: "Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.",
|
|
14922
|
+
nullable: true,
|
|
14923
|
+
type: "boolean"
|
|
14924
|
+
},
|
|
14925
|
+
is_managed: { enum: [true], type: "boolean" },
|
|
14926
|
+
is_multi_phone_sync_credential: {
|
|
14927
|
+
description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
14928
|
+
type: "boolean"
|
|
14929
|
+
},
|
|
14930
|
+
is_one_time_use: {
|
|
14931
|
+
description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.",
|
|
14932
|
+
type: "boolean"
|
|
14933
|
+
},
|
|
14934
|
+
issued_at: {
|
|
14935
|
+
description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.",
|
|
14936
|
+
format: "date-time",
|
|
14937
|
+
nullable: true,
|
|
14938
|
+
type: "string"
|
|
14939
|
+
},
|
|
14940
|
+
latest_desired_state_synced_with_provider_at: {
|
|
14941
|
+
description: "Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.",
|
|
14942
|
+
format: "date-time",
|
|
14943
|
+
nullable: true,
|
|
14944
|
+
type: "string"
|
|
14945
|
+
},
|
|
14946
|
+
parent_acs_credential_id: {
|
|
14947
|
+
description: "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
14948
|
+
format: "uuid",
|
|
14949
|
+
type: "string"
|
|
14950
|
+
},
|
|
14951
|
+
starts_at: {
|
|
14952
|
+
description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
14953
|
+
type: "string"
|
|
14954
|
+
},
|
|
14955
|
+
user_identity_id: {
|
|
14956
|
+
description: "ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
|
|
14957
|
+
format: "uuid",
|
|
14958
|
+
type: "string"
|
|
14959
|
+
},
|
|
14960
|
+
visionline_metadata: {
|
|
14961
|
+
description: "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
14962
|
+
properties: {
|
|
14963
|
+
auto_join: {
|
|
14964
|
+
description: "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.",
|
|
14965
|
+
type: "boolean"
|
|
14966
|
+
},
|
|
14967
|
+
card_function_type: {
|
|
14968
|
+
description: "Card function type in the Visionline access system.",
|
|
14969
|
+
enum: ["guest", "staff"],
|
|
14970
|
+
type: "string"
|
|
14971
|
+
},
|
|
14972
|
+
card_id: {
|
|
14973
|
+
description: "ID of the card in the Visionline access system.",
|
|
14974
|
+
type: "string"
|
|
14975
|
+
},
|
|
14976
|
+
common_acs_entrance_ids: {
|
|
14977
|
+
description: "Common entrance IDs in the Visionline access system.",
|
|
14978
|
+
items: { format: "uuid", type: "string" },
|
|
14979
|
+
type: "array"
|
|
14980
|
+
},
|
|
14981
|
+
credential_id: {
|
|
14982
|
+
description: "ID of the credential in the Visionline access system.",
|
|
14983
|
+
type: "string"
|
|
14984
|
+
},
|
|
14985
|
+
guest_acs_entrance_ids: {
|
|
14986
|
+
description: "Guest entrance IDs in the Visionline access system.",
|
|
14987
|
+
items: { format: "uuid", type: "string" },
|
|
14988
|
+
type: "array"
|
|
14989
|
+
},
|
|
14990
|
+
is_valid: {
|
|
14991
|
+
description: "Indicates whether the credential is valid.",
|
|
14992
|
+
type: "boolean"
|
|
14993
|
+
},
|
|
14994
|
+
joiner_acs_credential_ids: {
|
|
14995
|
+
description: "IDs of the credentials to which you want to join.",
|
|
14996
|
+
items: { format: "uuid", type: "string" },
|
|
14997
|
+
type: "array"
|
|
14998
|
+
}
|
|
14999
|
+
},
|
|
15000
|
+
required: ["card_function_type"],
|
|
15001
|
+
type: "object"
|
|
15002
|
+
},
|
|
15003
|
+
warnings: {
|
|
15004
|
+
description: "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
15005
|
+
items: {
|
|
15006
|
+
description: "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
15007
|
+
discriminator: { propertyName: "warning_code" },
|
|
15008
|
+
oneOf: [
|
|
15009
|
+
{
|
|
15010
|
+
description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.",
|
|
15011
|
+
properties: {
|
|
15012
|
+
created_at: {
|
|
15013
|
+
description: "Date and time at which Seam created the warning.",
|
|
15014
|
+
format: "date-time",
|
|
15015
|
+
type: "string"
|
|
15016
|
+
},
|
|
15017
|
+
message: {
|
|
15018
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
15019
|
+
type: "string"
|
|
15020
|
+
},
|
|
15021
|
+
warning_code: {
|
|
15022
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15023
|
+
enum: ["waiting_to_be_issued"],
|
|
15024
|
+
type: "string"
|
|
15025
|
+
}
|
|
15026
|
+
},
|
|
15027
|
+
required: ["created_at", "message", "warning_code"],
|
|
15028
|
+
type: "object"
|
|
15029
|
+
},
|
|
15030
|
+
{
|
|
15031
|
+
description: "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally.",
|
|
15032
|
+
properties: {
|
|
15033
|
+
created_at: {
|
|
15034
|
+
description: "Date and time at which Seam created the warning.",
|
|
15035
|
+
format: "date-time",
|
|
15036
|
+
type: "string"
|
|
15037
|
+
},
|
|
15038
|
+
message: {
|
|
15039
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
15040
|
+
type: "string"
|
|
15041
|
+
},
|
|
15042
|
+
warning_code: {
|
|
15043
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15044
|
+
enum: ["schedule_externally_modified"],
|
|
15045
|
+
type: "string"
|
|
15046
|
+
}
|
|
15047
|
+
},
|
|
15048
|
+
required: ["created_at", "message", "warning_code"],
|
|
15049
|
+
type: "object"
|
|
15050
|
+
},
|
|
15051
|
+
{
|
|
15052
|
+
description: "Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.",
|
|
15053
|
+
properties: {
|
|
15054
|
+
created_at: {
|
|
15055
|
+
description: "Date and time at which Seam created the warning.",
|
|
15056
|
+
format: "date-time",
|
|
15057
|
+
type: "string"
|
|
15058
|
+
},
|
|
15059
|
+
message: {
|
|
15060
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
15061
|
+
type: "string"
|
|
15062
|
+
},
|
|
15063
|
+
warning_code: {
|
|
15064
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15065
|
+
enum: ["schedule_modified"],
|
|
15066
|
+
type: "string"
|
|
15067
|
+
}
|
|
15068
|
+
},
|
|
15069
|
+
required: ["created_at", "message", "warning_code"],
|
|
15070
|
+
type: "object"
|
|
15071
|
+
},
|
|
15072
|
+
{
|
|
15073
|
+
description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.",
|
|
15074
|
+
properties: {
|
|
15075
|
+
created_at: {
|
|
15076
|
+
description: "Date and time at which Seam created the warning.",
|
|
15077
|
+
format: "date-time",
|
|
15078
|
+
type: "string"
|
|
15079
|
+
},
|
|
15080
|
+
message: {
|
|
15081
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
15082
|
+
type: "string"
|
|
15083
|
+
},
|
|
15084
|
+
warning_code: {
|
|
15085
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15086
|
+
enum: ["being_deleted"],
|
|
15087
|
+
type: "string"
|
|
15088
|
+
}
|
|
15089
|
+
},
|
|
15090
|
+
required: ["created_at", "message", "warning_code"],
|
|
15091
|
+
type: "object"
|
|
15092
|
+
},
|
|
15093
|
+
{
|
|
15094
|
+
description: "An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.",
|
|
15095
|
+
properties: {
|
|
15096
|
+
created_at: {
|
|
15097
|
+
description: "Date and time at which Seam created the warning.",
|
|
15098
|
+
format: "date-time",
|
|
15099
|
+
type: "string"
|
|
15100
|
+
},
|
|
15101
|
+
message: {
|
|
15102
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
15103
|
+
type: "string"
|
|
15104
|
+
},
|
|
15105
|
+
warning_code: {
|
|
15106
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15107
|
+
enum: ["unknown_issue_with_acs_credential"],
|
|
15108
|
+
type: "string"
|
|
15109
|
+
}
|
|
15110
|
+
},
|
|
15111
|
+
required: ["created_at", "message", "warning_code"],
|
|
15112
|
+
type: "object"
|
|
15113
|
+
},
|
|
15114
|
+
{
|
|
15115
|
+
description: "Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.",
|
|
15116
|
+
properties: {
|
|
15117
|
+
created_at: {
|
|
15118
|
+
description: "Date and time at which Seam created the warning.",
|
|
15119
|
+
format: "date-time",
|
|
15120
|
+
type: "string"
|
|
15121
|
+
},
|
|
15122
|
+
message: {
|
|
15123
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
15124
|
+
type: "string"
|
|
15125
|
+
},
|
|
15126
|
+
warning_code: {
|
|
15127
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15128
|
+
enum: ["needs_to_be_reissued"],
|
|
15129
|
+
type: "string"
|
|
15130
|
+
}
|
|
15131
|
+
},
|
|
15132
|
+
required: ["created_at", "message", "warning_code"],
|
|
15133
|
+
type: "object"
|
|
15134
|
+
}
|
|
15135
|
+
]
|
|
15136
|
+
},
|
|
15137
|
+
type: "array"
|
|
15138
|
+
},
|
|
15139
|
+
workspace_id: {
|
|
15140
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
15141
|
+
format: "uuid",
|
|
15142
|
+
type: "string"
|
|
15143
|
+
}
|
|
15144
|
+
},
|
|
15145
|
+
required: [
|
|
15146
|
+
"acs_credential_id",
|
|
15147
|
+
"connected_account_id",
|
|
15148
|
+
"acs_system_id",
|
|
15149
|
+
"display_name",
|
|
15150
|
+
"access_method",
|
|
15151
|
+
"created_at",
|
|
15152
|
+
"workspace_id",
|
|
15153
|
+
"errors",
|
|
15154
|
+
"warnings",
|
|
15155
|
+
"is_managed"
|
|
15156
|
+
],
|
|
15157
|
+
type: "object"
|
|
15158
|
+
},
|
|
15159
|
+
status: { enum: ["success"], type: "string" }
|
|
15160
|
+
},
|
|
15161
|
+
required: [
|
|
15162
|
+
"action_attempt_id",
|
|
15163
|
+
"status",
|
|
15164
|
+
"error",
|
|
15165
|
+
"action_type",
|
|
15166
|
+
"result"
|
|
15167
|
+
],
|
|
15168
|
+
type: "object"
|
|
15169
|
+
},
|
|
15170
|
+
{
|
|
15171
|
+
description: "Scanning a physical card and assigning the credential failed.",
|
|
15172
|
+
properties: {
|
|
15173
|
+
action_attempt_id: {
|
|
15174
|
+
description: "ID of the action attempt.",
|
|
15175
|
+
format: "uuid",
|
|
15176
|
+
type: "string"
|
|
15177
|
+
},
|
|
15178
|
+
action_type: {
|
|
15179
|
+
description: "Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user.",
|
|
15180
|
+
enum: ["SCAN_TO_ASSIGN_CREDENTIAL"],
|
|
15181
|
+
type: "string"
|
|
15182
|
+
},
|
|
15183
|
+
error: {
|
|
15184
|
+
oneOf: [
|
|
15185
|
+
{
|
|
15186
|
+
description: "Error that doesn't fit into other specific error categories.",
|
|
15187
|
+
properties: {
|
|
15188
|
+
message: {
|
|
15189
|
+
description: "Message for the error associated with the action attempt.",
|
|
15190
|
+
type: "string"
|
|
15191
|
+
},
|
|
15192
|
+
type: {
|
|
15193
|
+
description: "Type of the error associated with the action attempt.",
|
|
15194
|
+
enum: ["uncategorized_error"],
|
|
15195
|
+
type: "string"
|
|
15196
|
+
}
|
|
15197
|
+
},
|
|
15198
|
+
required: ["type", "message"],
|
|
15199
|
+
type: "object"
|
|
15200
|
+
},
|
|
15201
|
+
{
|
|
15202
|
+
description: "Error to indicate an expired action attempt.",
|
|
15203
|
+
properties: {
|
|
15204
|
+
message: {
|
|
15205
|
+
description: "Message for the error associated with the action attempt.",
|
|
15206
|
+
type: "string"
|
|
15207
|
+
},
|
|
15208
|
+
type: {
|
|
15209
|
+
description: "Type of the error associated with the action attempt.",
|
|
15210
|
+
enum: ["action_attempt_expired"],
|
|
15211
|
+
type: "string"
|
|
15212
|
+
}
|
|
15213
|
+
},
|
|
15214
|
+
required: ["type", "message"],
|
|
15215
|
+
type: "object"
|
|
15216
|
+
},
|
|
15217
|
+
{
|
|
15218
|
+
description: "Error to indicate that there is no credential on the encoder.",
|
|
15219
|
+
properties: {
|
|
15220
|
+
message: {
|
|
15221
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
15222
|
+
type: "string"
|
|
15223
|
+
},
|
|
15224
|
+
type: {
|
|
15225
|
+
description: "Error type to indicate that there is no credential on the encoder.",
|
|
15226
|
+
enum: ["no_credential_on_encoder"],
|
|
15227
|
+
type: "string"
|
|
15228
|
+
}
|
|
15229
|
+
},
|
|
15230
|
+
required: ["type", "message"],
|
|
15231
|
+
type: "object"
|
|
15232
|
+
}
|
|
15233
|
+
]
|
|
15234
|
+
},
|
|
15235
|
+
result: {
|
|
15236
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
15237
|
+
nullable: true
|
|
15238
|
+
},
|
|
15239
|
+
status: { enum: ["error"], type: "string" }
|
|
15240
|
+
},
|
|
15241
|
+
required: [
|
|
15242
|
+
"action_attempt_id",
|
|
15243
|
+
"status",
|
|
15244
|
+
"result",
|
|
15245
|
+
"action_type",
|
|
15246
|
+
"error"
|
|
15247
|
+
],
|
|
15248
|
+
type: "object"
|
|
15249
|
+
},
|
|
14710
15250
|
{
|
|
14711
15251
|
description: "Resetting a sandbox workspace is pending.",
|
|
14712
15252
|
properties: {
|
|
@@ -47872,6 +48412,74 @@ var openapi = {
|
|
|
47872
48412
|
"x-title": "Scan a Credential"
|
|
47873
48413
|
}
|
|
47874
48414
|
},
|
|
48415
|
+
"/acs/encoders/scan_to_assign_credential": {
|
|
48416
|
+
post: {
|
|
48417
|
+
description: "Scans a physical card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) and assigns the scanned credential to an ACS user. Provide either an `acs_user_id` or a `user_identity_id`.",
|
|
48418
|
+
operationId: "acsEncodersScanToAssignCredentialPost",
|
|
48419
|
+
requestBody: {
|
|
48420
|
+
content: {
|
|
48421
|
+
"application/json": {
|
|
48422
|
+
schema: {
|
|
48423
|
+
properties: {
|
|
48424
|
+
acs_encoder_id: {
|
|
48425
|
+
description: "ID of the `acs_encoder` to use to scan the credential.",
|
|
48426
|
+
format: "uuid",
|
|
48427
|
+
type: "string"
|
|
48428
|
+
},
|
|
48429
|
+
acs_user_id: {
|
|
48430
|
+
description: "ID of the `acs_user` to assign the scanned credential to.",
|
|
48431
|
+
format: "uuid",
|
|
48432
|
+
type: "string"
|
|
48433
|
+
},
|
|
48434
|
+
user_identity_id: {
|
|
48435
|
+
description: "ID of the `user_identity` to assign the scanned credential to. If the ACS system contains an ACS user linked to this user identity, it is used. Otherwise, one is created.",
|
|
48436
|
+
format: "uuid",
|
|
48437
|
+
type: "string"
|
|
48438
|
+
}
|
|
48439
|
+
},
|
|
48440
|
+
required: ["acs_encoder_id"],
|
|
48441
|
+
type: "object"
|
|
48442
|
+
}
|
|
48443
|
+
}
|
|
48444
|
+
}
|
|
48445
|
+
},
|
|
48446
|
+
responses: {
|
|
48447
|
+
200: {
|
|
48448
|
+
content: {
|
|
48449
|
+
"application/json": {
|
|
48450
|
+
schema: {
|
|
48451
|
+
properties: {
|
|
48452
|
+
action_attempt: {
|
|
48453
|
+
$ref: "#/components/schemas/action_attempt"
|
|
48454
|
+
},
|
|
48455
|
+
ok: { type: "boolean" }
|
|
48456
|
+
},
|
|
48457
|
+
required: ["action_attempt", "ok"],
|
|
48458
|
+
type: "object"
|
|
48459
|
+
}
|
|
48460
|
+
}
|
|
48461
|
+
},
|
|
48462
|
+
description: "OK"
|
|
48463
|
+
},
|
|
48464
|
+
400: { description: "Bad Request" },
|
|
48465
|
+
401: { description: "Unauthorized" }
|
|
48466
|
+
},
|
|
48467
|
+
security: [
|
|
48468
|
+
{ pat_with_workspace: [] },
|
|
48469
|
+
{ console_session_with_workspace: [] },
|
|
48470
|
+
{ api_key: [] },
|
|
48471
|
+
{ client_session_with_customer: [] }
|
|
48472
|
+
],
|
|
48473
|
+
summary: "/acs/encoders/scan_to_assign_credential",
|
|
48474
|
+
tags: ["/acs"],
|
|
48475
|
+
"x-action-attempt-type": "SCAN_TO_ASSIGN_CREDENTIAL",
|
|
48476
|
+
"x-fern-sdk-group-name": ["acs", "encoders"],
|
|
48477
|
+
"x-fern-sdk-method-name": "scan_to_assign_credential",
|
|
48478
|
+
"x-fern-sdk-return-value": "action_attempt",
|
|
48479
|
+
"x-response-key": "action_attempt",
|
|
48480
|
+
"x-title": "Scan to Assign a Credential"
|
|
48481
|
+
}
|
|
48482
|
+
},
|
|
47875
48483
|
"/acs/encoders/simulate/next_credential_encode_will_fail": {
|
|
47876
48484
|
post: {
|
|
47877
48485
|
description: "Simulates that the next attempt to encode a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).",
|