@seamapi/types 1.851.0 → 1.853.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 +729 -60
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +8858 -470
- package/dist/index.cjs +729 -60
- 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 +953 -117
- package/lib/seam/connect/models/devices/device-metadata.d.ts +28 -0
- package/lib/seam/connect/models/devices/device-metadata.js +12 -0
- package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +1 -0
- package/lib/seam/connect/models/devices/device-provider.js +1 -0
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/devices/device-type.d.ts +1 -0
- package/lib/seam/connect/models/devices/device-type.js +1 -0
- package/lib/seam/connect/models/devices/device-type.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +43 -3
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +31 -3
- package/lib/seam/connect/openapi.js +621 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +7379 -454
- 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/models/devices/device-metadata.ts +15 -0
- package/src/lib/seam/connect/models/devices/device-provider.ts +1 -0
- package/src/lib/seam/connect/models/devices/device-type.ts +1 -0
- package/src/lib/seam/connect/openapi.ts +709 -0
- package/src/lib/seam/connect/route-types.ts +8322 -0
package/dist/index.cjs
CHANGED
|
@@ -1089,6 +1089,14 @@ var device_metadata = zod.z.object({
|
|
|
1089
1089
|
assa_abloy_vostio_metadata: zod.z.object({
|
|
1090
1090
|
encoder_name: zod.z.string().describe(`Encoder name for an ASSA ABLOY Vostio system.`)
|
|
1091
1091
|
}).describe(`Metadata for an ASSA ABLOY Vostio system.`),
|
|
1092
|
+
omnitec_metadata: zod.z.object({
|
|
1093
|
+
lock_id: zod.z.number().describe(`Lock ID for an Omnitec device.`),
|
|
1094
|
+
lock_name: zod.z.string().describe(`Lock name for an Omnitec device.`),
|
|
1095
|
+
lock_mac: zod.z.string().describe(`Bluetooth MAC address for an Omnitec device.`),
|
|
1096
|
+
has_gateway: zod.z.boolean().describe(
|
|
1097
|
+
`Whether the Omnitec lock has a connected gateway for remote operations.`
|
|
1098
|
+
)
|
|
1099
|
+
}).describe(`Metadata for an Omnitec device.`),
|
|
1092
1100
|
tado_metadata: zod.z.object({
|
|
1093
1101
|
serial_no: zod.z.string().describe(`Serial number for a tado\xB0 device.`),
|
|
1094
1102
|
device_type: zod.z.string().describe(`Device type for a tado\xB0 device.`)
|
|
@@ -1183,7 +1191,8 @@ var LOCK_DEVICE_TYPE = {
|
|
|
1183
1191
|
TEDEE_LOCK: "tedee_lock",
|
|
1184
1192
|
AKILES_LOCK: "akiles_lock",
|
|
1185
1193
|
ULTRALOQ_LOCK: "ultraloq_lock",
|
|
1186
|
-
KORELOCK_LOCK: "korelock_lock"
|
|
1194
|
+
KORELOCK_LOCK: "korelock_lock",
|
|
1195
|
+
OMNITEC_LOCK: "omnitec_lock"
|
|
1187
1196
|
};
|
|
1188
1197
|
var lock_device_type = zod.z.enum(
|
|
1189
1198
|
Object.values(LOCK_DEVICE_TYPE)
|
|
@@ -2011,7 +2020,8 @@ var DEVICE_PROVIDERS = {
|
|
|
2011
2020
|
ICAL: "ical",
|
|
2012
2021
|
LODGIFY: "lodgify",
|
|
2013
2022
|
HOSTAWAY: "hostaway",
|
|
2014
|
-
ACUITY_SCHEDULING: "acuity_scheduling"
|
|
2023
|
+
ACUITY_SCHEDULING: "acuity_scheduling",
|
|
2024
|
+
OMNITEC: "omnitec"
|
|
2015
2025
|
};
|
|
2016
2026
|
var ALL_DEVICE_PROVIDERS = Object.values(DEVICE_PROVIDERS);
|
|
2017
2027
|
var PROVIDER_CATEGORY_MAP = {
|
|
@@ -4845,116 +4855,153 @@ var scan_credential_action_attempt = zod.z.discriminatedUnion("status", [
|
|
|
4845
4855
|
}).describe("Reading credential data from physical encoder succeeded."),
|
|
4846
4856
|
common_failed_action_attempt.extend({ action_type: action_type7, error: error8 }).describe("Reading credential data from physical encoder failed.")
|
|
4847
4857
|
]);
|
|
4848
|
-
var action_type8 = zod.z.literal("
|
|
4858
|
+
var action_type8 = zod.z.literal("SCAN_TO_ASSIGN_CREDENTIAL").describe(
|
|
4859
|
+
"Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user."
|
|
4860
|
+
);
|
|
4861
|
+
var no_credential_on_encoder_error3 = zod.z.object({
|
|
4862
|
+
type: zod.z.literal("no_credential_on_encoder").describe(
|
|
4863
|
+
"Error type to indicate that there is no credential on the encoder."
|
|
4864
|
+
),
|
|
4865
|
+
message: zod.z.string().describe(
|
|
4866
|
+
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
4867
|
+
)
|
|
4868
|
+
}).describe("Error to indicate that there is no credential on the encoder.");
|
|
4869
|
+
var error9 = zod.z.union([
|
|
4870
|
+
...common_action_attempt_errors,
|
|
4871
|
+
no_credential_on_encoder_error3
|
|
4872
|
+
]);
|
|
4873
|
+
var result9 = acs_credential.describe(
|
|
4874
|
+
"Result of a scan to assign attempt. If the attempt was successful, includes the credential data that was scanned and assigned."
|
|
4875
|
+
);
|
|
4876
|
+
var scan_to_assign_credential_action_attempt = zod.z.discriminatedUnion(
|
|
4877
|
+
"status",
|
|
4878
|
+
[
|
|
4879
|
+
common_pending_action_attempt.extend({
|
|
4880
|
+
action_type: action_type8
|
|
4881
|
+
}).describe(
|
|
4882
|
+
"Scanning a physical card and assigning the credential is pending."
|
|
4883
|
+
),
|
|
4884
|
+
common_succeeded_action_attempt.extend({
|
|
4885
|
+
action_type: action_type8,
|
|
4886
|
+
result: result9
|
|
4887
|
+
}).describe(
|
|
4888
|
+
"Scanning a physical card and assigning the credential succeeded."
|
|
4889
|
+
),
|
|
4890
|
+
common_failed_action_attempt.extend({ action_type: action_type8, error: error9 }).describe(
|
|
4891
|
+
"Scanning a physical card and assigning the credential failed."
|
|
4892
|
+
)
|
|
4893
|
+
]
|
|
4894
|
+
);
|
|
4895
|
+
var action_type9 = zod.z.literal("SET_FAN_MODE").describe(
|
|
4849
4896
|
"Action attempt to track the status of setting the fan mode on a thermostat."
|
|
4850
4897
|
);
|
|
4851
|
-
var
|
|
4898
|
+
var error10 = zod.z.object({
|
|
4852
4899
|
type: zod.z.string().describe("Type of the error."),
|
|
4853
4900
|
message: zod.z.string().describe(
|
|
4854
4901
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
4855
4902
|
)
|
|
4856
4903
|
}).describe("Error associated with the action.");
|
|
4857
|
-
var
|
|
4904
|
+
var result10 = zod.z.object({}).describe("Result of the action.");
|
|
4858
4905
|
var set_fan_mode_action_attempt = zod.z.discriminatedUnion("status", [
|
|
4859
4906
|
common_pending_action_attempt.extend({
|
|
4860
|
-
action_type:
|
|
4907
|
+
action_type: action_type9
|
|
4861
4908
|
}).describe("Setting the fan mode is pending."),
|
|
4862
4909
|
common_succeeded_action_attempt.extend({
|
|
4863
|
-
action_type:
|
|
4864
|
-
result:
|
|
4910
|
+
action_type: action_type9,
|
|
4911
|
+
result: result10
|
|
4865
4912
|
}).describe("Setting the fan mode succeeded."),
|
|
4866
|
-
common_failed_action_attempt.extend({ action_type:
|
|
4913
|
+
common_failed_action_attempt.extend({ action_type: action_type9, error: error10 }).describe("Setting the fan mode failed.")
|
|
4867
4914
|
]);
|
|
4868
|
-
var
|
|
4915
|
+
var action_type10 = zod.z.literal("SET_HVAC_MODE").describe(
|
|
4869
4916
|
"Action attempt to track the status of setting the HVAC mode on a thermostat."
|
|
4870
4917
|
);
|
|
4871
|
-
var
|
|
4918
|
+
var error11 = zod.z.object({
|
|
4872
4919
|
type: zod.z.string().describe("Type of the error."),
|
|
4873
4920
|
message: zod.z.string().describe(
|
|
4874
4921
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
4875
4922
|
)
|
|
4876
4923
|
}).describe("Error associated with the action.");
|
|
4877
|
-
var
|
|
4924
|
+
var result11 = zod.z.object({}).describe("Result of the action.");
|
|
4878
4925
|
var set_hvac_mode_action_attempt = zod.z.discriminatedUnion("status", [
|
|
4879
4926
|
common_pending_action_attempt.extend({
|
|
4880
|
-
action_type:
|
|
4927
|
+
action_type: action_type10
|
|
4881
4928
|
}).describe("Setting the HVAC mode is pending."),
|
|
4882
4929
|
common_succeeded_action_attempt.extend({
|
|
4883
|
-
action_type:
|
|
4884
|
-
result:
|
|
4930
|
+
action_type: action_type10,
|
|
4931
|
+
result: result11
|
|
4885
4932
|
}).describe("Setting the HVAC mode succeeded."),
|
|
4886
|
-
common_failed_action_attempt.extend({ action_type:
|
|
4933
|
+
common_failed_action_attempt.extend({ action_type: action_type10, error: error11 }).describe("Setting the HVAC mode failed.")
|
|
4887
4934
|
]);
|
|
4888
|
-
var
|
|
4935
|
+
var action_type11 = zod.z.literal("SIMULATE_KEYPAD_CODE_ENTRY").describe(
|
|
4889
4936
|
"Action attempt to track the status of simulating a keypad code entry."
|
|
4890
4937
|
);
|
|
4891
|
-
var
|
|
4938
|
+
var error12 = zod.z.object({
|
|
4892
4939
|
type: zod.z.string().describe("Type of the error."),
|
|
4893
4940
|
message: zod.z.string().describe(
|
|
4894
4941
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
4895
4942
|
)
|
|
4896
4943
|
}).describe("Error associated with the action.");
|
|
4897
|
-
var
|
|
4944
|
+
var result12 = zod.z.object({}).describe("Result of the action.");
|
|
4898
4945
|
var simulate_keypad_code_entry_action_attempt = zod.z.discriminatedUnion(
|
|
4899
4946
|
"status",
|
|
4900
4947
|
[
|
|
4901
4948
|
common_pending_action_attempt.extend({
|
|
4902
|
-
action_type:
|
|
4949
|
+
action_type: action_type11
|
|
4903
4950
|
}).describe("Simulating a keypad code entry is pending."),
|
|
4904
4951
|
common_succeeded_action_attempt.extend({
|
|
4905
|
-
action_type:
|
|
4906
|
-
result:
|
|
4952
|
+
action_type: action_type11,
|
|
4953
|
+
result: result12
|
|
4907
4954
|
}).describe("Simulating a keypad code entry succeeded."),
|
|
4908
4955
|
common_failed_action_attempt.extend({
|
|
4909
|
-
action_type:
|
|
4910
|
-
error:
|
|
4956
|
+
action_type: action_type11,
|
|
4957
|
+
error: error12
|
|
4911
4958
|
}).describe("Simulating a keypad code entry failed.")
|
|
4912
4959
|
]
|
|
4913
4960
|
);
|
|
4914
|
-
var
|
|
4961
|
+
var action_type12 = zod.z.literal("SIMULATE_MANUAL_LOCK_VIA_KEYPAD").describe(
|
|
4915
4962
|
"Action attempt to track the status of simulating a manual lock action using a keypad."
|
|
4916
4963
|
);
|
|
4917
|
-
var
|
|
4964
|
+
var error13 = zod.z.object({
|
|
4918
4965
|
type: zod.z.string().describe("Type of the error."),
|
|
4919
4966
|
message: zod.z.string().describe(
|
|
4920
4967
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
4921
4968
|
)
|
|
4922
4969
|
}).describe("Error associated with the action.");
|
|
4923
|
-
var
|
|
4970
|
+
var result13 = zod.z.object({}).describe("Result of the action.");
|
|
4924
4971
|
var simulate_manual_lock_via_keypad_action_attempt = zod.z.discriminatedUnion("status", [
|
|
4925
4972
|
common_pending_action_attempt.extend({
|
|
4926
|
-
action_type:
|
|
4973
|
+
action_type: action_type12
|
|
4927
4974
|
}).describe("Simulating a manual lock action using a keypad is pending."),
|
|
4928
4975
|
common_succeeded_action_attempt.extend({
|
|
4929
|
-
action_type:
|
|
4930
|
-
result:
|
|
4976
|
+
action_type: action_type12,
|
|
4977
|
+
result: result13
|
|
4931
4978
|
}).describe("Simulating a manual lock action using a keypad succeeded."),
|
|
4932
4979
|
common_failed_action_attempt.extend({
|
|
4933
|
-
action_type:
|
|
4934
|
-
error:
|
|
4980
|
+
action_type: action_type12,
|
|
4981
|
+
error: error13
|
|
4935
4982
|
}).describe("Simulating a manual lock action using a keypad failed.")
|
|
4936
4983
|
]);
|
|
4937
|
-
var
|
|
4938
|
-
var
|
|
4984
|
+
var action_type13 = zod.z.literal("UNLOCK_DOOR").describe("Action attempt to track the status of unlocking a door.");
|
|
4985
|
+
var error14 = zod.z.object({
|
|
4939
4986
|
type: zod.z.string().describe("Type of the error."),
|
|
4940
4987
|
message: zod.z.string().describe(
|
|
4941
4988
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
4942
4989
|
)
|
|
4943
4990
|
}).describe("Error associated with the action.");
|
|
4944
|
-
var
|
|
4991
|
+
var result14 = zod.z.object({
|
|
4945
4992
|
was_confirmed_by_device: zod.z.boolean().optional().describe(
|
|
4946
4993
|
"Indicates whether the device confirmed that the unlock action occurred."
|
|
4947
4994
|
)
|
|
4948
4995
|
}).describe("Result of the action.");
|
|
4949
4996
|
var unlock_door_action_attempt = zod.z.discriminatedUnion("status", [
|
|
4950
4997
|
common_pending_action_attempt.extend({
|
|
4951
|
-
action_type:
|
|
4998
|
+
action_type: action_type13
|
|
4952
4999
|
}).describe("Unlocking a door is pending."),
|
|
4953
5000
|
common_succeeded_action_attempt.extend({
|
|
4954
|
-
action_type:
|
|
4955
|
-
result:
|
|
5001
|
+
action_type: action_type13,
|
|
5002
|
+
result: result14
|
|
4956
5003
|
}).describe("Unlocking a door succeeded."),
|
|
4957
|
-
common_failed_action_attempt.extend({ action_type:
|
|
5004
|
+
common_failed_action_attempt.extend({ action_type: action_type13, error: error14 }).describe("Unlocking a door failed.")
|
|
4958
5005
|
]);
|
|
4959
5006
|
|
|
4960
5007
|
// src/lib/seam/connect/models/action-attempts/action-attempt.ts
|
|
@@ -4963,6 +5010,7 @@ var action_attempt = zod.z.union([
|
|
|
4963
5010
|
...unlock_door_action_attempt.options,
|
|
4964
5011
|
...scan_credential_action_attempt.options,
|
|
4965
5012
|
...encode_credential_action_attempt.options,
|
|
5013
|
+
...scan_to_assign_credential_action_attempt.options,
|
|
4966
5014
|
...reset_sandbox_workspace_action_attempt.options,
|
|
4967
5015
|
...set_fan_mode_action_attempt.options,
|
|
4968
5016
|
...set_hvac_mode_action_attempt.options,
|
|
@@ -14707,6 +14755,508 @@ var openapi = {
|
|
|
14707
14755
|
],
|
|
14708
14756
|
type: "object"
|
|
14709
14757
|
},
|
|
14758
|
+
{
|
|
14759
|
+
description: "Scanning a physical card and assigning the credential is pending.",
|
|
14760
|
+
properties: {
|
|
14761
|
+
action_attempt_id: {
|
|
14762
|
+
description: "ID of the action attempt.",
|
|
14763
|
+
format: "uuid",
|
|
14764
|
+
type: "string"
|
|
14765
|
+
},
|
|
14766
|
+
action_type: {
|
|
14767
|
+
description: "Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user.",
|
|
14768
|
+
enum: ["SCAN_TO_ASSIGN_CREDENTIAL"],
|
|
14769
|
+
type: "string"
|
|
14770
|
+
},
|
|
14771
|
+
error: {
|
|
14772
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
14773
|
+
nullable: true
|
|
14774
|
+
},
|
|
14775
|
+
result: {
|
|
14776
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
14777
|
+
nullable: true
|
|
14778
|
+
},
|
|
14779
|
+
status: { enum: ["pending"], type: "string" }
|
|
14780
|
+
},
|
|
14781
|
+
required: [
|
|
14782
|
+
"action_attempt_id",
|
|
14783
|
+
"status",
|
|
14784
|
+
"result",
|
|
14785
|
+
"error",
|
|
14786
|
+
"action_type"
|
|
14787
|
+
],
|
|
14788
|
+
type: "object"
|
|
14789
|
+
},
|
|
14790
|
+
{
|
|
14791
|
+
description: "Scanning a physical card and assigning the credential succeeded.",
|
|
14792
|
+
properties: {
|
|
14793
|
+
action_attempt_id: {
|
|
14794
|
+
description: "ID of the action attempt.",
|
|
14795
|
+
format: "uuid",
|
|
14796
|
+
type: "string"
|
|
14797
|
+
},
|
|
14798
|
+
action_type: {
|
|
14799
|
+
description: "Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user.",
|
|
14800
|
+
enum: ["SCAN_TO_ASSIGN_CREDENTIAL"],
|
|
14801
|
+
type: "string"
|
|
14802
|
+
},
|
|
14803
|
+
error: {
|
|
14804
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
14805
|
+
nullable: true
|
|
14806
|
+
},
|
|
14807
|
+
result: {
|
|
14808
|
+
description: "Result of a scan to assign attempt. If the attempt was successful, includes the credential data that was scanned and assigned.",
|
|
14809
|
+
properties: {
|
|
14810
|
+
access_method: {
|
|
14811
|
+
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`.",
|
|
14812
|
+
enum: ["code", "card", "mobile_key", "cloud_key"],
|
|
14813
|
+
type: "string"
|
|
14814
|
+
},
|
|
14815
|
+
acs_credential_id: {
|
|
14816
|
+
description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
14817
|
+
format: "uuid",
|
|
14818
|
+
type: "string"
|
|
14819
|
+
},
|
|
14820
|
+
acs_credential_pool_id: { format: "uuid", type: "string" },
|
|
14821
|
+
acs_system_id: {
|
|
14822
|
+
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).",
|
|
14823
|
+
format: "uuid",
|
|
14824
|
+
type: "string"
|
|
14825
|
+
},
|
|
14826
|
+
acs_user_id: {
|
|
14827
|
+
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.",
|
|
14828
|
+
format: "uuid",
|
|
14829
|
+
type: "string"
|
|
14830
|
+
},
|
|
14831
|
+
assa_abloy_vostio_metadata: {
|
|
14832
|
+
description: "Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
14833
|
+
properties: {
|
|
14834
|
+
auto_join: {
|
|
14835
|
+
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.",
|
|
14836
|
+
type: "boolean"
|
|
14837
|
+
},
|
|
14838
|
+
door_names: {
|
|
14839
|
+
description: "Names of the doors to which to grant access in the Vostio access system.",
|
|
14840
|
+
items: { type: "string" },
|
|
14841
|
+
type: "array"
|
|
14842
|
+
},
|
|
14843
|
+
endpoint_id: {
|
|
14844
|
+
description: "Endpoint ID in the Vostio access system.",
|
|
14845
|
+
type: "string"
|
|
14846
|
+
},
|
|
14847
|
+
key_id: {
|
|
14848
|
+
description: "Key ID in the Vostio access system.",
|
|
14849
|
+
type: "string"
|
|
14850
|
+
},
|
|
14851
|
+
key_issuing_request_id: {
|
|
14852
|
+
description: "Key issuing request ID in the Vostio access system.",
|
|
14853
|
+
type: "string"
|
|
14854
|
+
},
|
|
14855
|
+
override_guest_acs_entrance_ids: {
|
|
14856
|
+
description: "IDs of the guest entrances to override in the Vostio access system.",
|
|
14857
|
+
items: { type: "string" },
|
|
14858
|
+
type: "array"
|
|
14859
|
+
}
|
|
14860
|
+
},
|
|
14861
|
+
type: "object"
|
|
14862
|
+
},
|
|
14863
|
+
card_number: {
|
|
14864
|
+
description: "Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
14865
|
+
nullable: true,
|
|
14866
|
+
type: "string"
|
|
14867
|
+
},
|
|
14868
|
+
code: {
|
|
14869
|
+
description: "Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
14870
|
+
nullable: true,
|
|
14871
|
+
type: "string"
|
|
14872
|
+
},
|
|
14873
|
+
connected_account_id: {
|
|
14874
|
+
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.",
|
|
14875
|
+
format: "uuid",
|
|
14876
|
+
type: "string"
|
|
14877
|
+
},
|
|
14878
|
+
created_at: {
|
|
14879
|
+
description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.",
|
|
14880
|
+
format: "date-time",
|
|
14881
|
+
type: "string"
|
|
14882
|
+
},
|
|
14883
|
+
display_name: {
|
|
14884
|
+
description: "Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.",
|
|
14885
|
+
minLength: 1,
|
|
14886
|
+
type: "string"
|
|
14887
|
+
},
|
|
14888
|
+
ends_at: {
|
|
14889
|
+
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`.",
|
|
14890
|
+
type: "string"
|
|
14891
|
+
},
|
|
14892
|
+
errors: {
|
|
14893
|
+
description: "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
14894
|
+
items: {
|
|
14895
|
+
properties: {
|
|
14896
|
+
error_code: { type: "string" },
|
|
14897
|
+
message: { type: "string" }
|
|
14898
|
+
},
|
|
14899
|
+
required: ["error_code", "message"],
|
|
14900
|
+
type: "object"
|
|
14901
|
+
},
|
|
14902
|
+
type: "array"
|
|
14903
|
+
},
|
|
14904
|
+
external_type: {
|
|
14905
|
+
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`.",
|
|
14906
|
+
enum: [
|
|
14907
|
+
"pti_card",
|
|
14908
|
+
"brivo_credential",
|
|
14909
|
+
"hid_credential",
|
|
14910
|
+
"visionline_card",
|
|
14911
|
+
"salto_ks_credential",
|
|
14912
|
+
"assa_abloy_vostio_key",
|
|
14913
|
+
"salto_space_key",
|
|
14914
|
+
"latch_access",
|
|
14915
|
+
"dormakaba_ambiance_credential",
|
|
14916
|
+
"hotek_card",
|
|
14917
|
+
"salto_ks_tag",
|
|
14918
|
+
"avigilon_alta_credential"
|
|
14919
|
+
],
|
|
14920
|
+
type: "string"
|
|
14921
|
+
},
|
|
14922
|
+
external_type_display_name: {
|
|
14923
|
+
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.",
|
|
14924
|
+
type: "string"
|
|
14925
|
+
},
|
|
14926
|
+
is_issued: {
|
|
14927
|
+
description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.",
|
|
14928
|
+
type: "boolean"
|
|
14929
|
+
},
|
|
14930
|
+
is_latest_desired_state_synced_with_provider: {
|
|
14931
|
+
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.",
|
|
14932
|
+
nullable: true,
|
|
14933
|
+
type: "boolean"
|
|
14934
|
+
},
|
|
14935
|
+
is_managed: { enum: [true], type: "boolean" },
|
|
14936
|
+
is_multi_phone_sync_credential: {
|
|
14937
|
+
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).",
|
|
14938
|
+
type: "boolean"
|
|
14939
|
+
},
|
|
14940
|
+
is_one_time_use: {
|
|
14941
|
+
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.",
|
|
14942
|
+
type: "boolean"
|
|
14943
|
+
},
|
|
14944
|
+
issued_at: {
|
|
14945
|
+
description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.",
|
|
14946
|
+
format: "date-time",
|
|
14947
|
+
nullable: true,
|
|
14948
|
+
type: "string"
|
|
14949
|
+
},
|
|
14950
|
+
latest_desired_state_synced_with_provider_at: {
|
|
14951
|
+
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.",
|
|
14952
|
+
format: "date-time",
|
|
14953
|
+
nullable: true,
|
|
14954
|
+
type: "string"
|
|
14955
|
+
},
|
|
14956
|
+
parent_acs_credential_id: {
|
|
14957
|
+
description: "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
14958
|
+
format: "uuid",
|
|
14959
|
+
type: "string"
|
|
14960
|
+
},
|
|
14961
|
+
starts_at: {
|
|
14962
|
+
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.",
|
|
14963
|
+
type: "string"
|
|
14964
|
+
},
|
|
14965
|
+
user_identity_id: {
|
|
14966
|
+
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.",
|
|
14967
|
+
format: "uuid",
|
|
14968
|
+
type: "string"
|
|
14969
|
+
},
|
|
14970
|
+
visionline_metadata: {
|
|
14971
|
+
description: "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
14972
|
+
properties: {
|
|
14973
|
+
auto_join: {
|
|
14974
|
+
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.",
|
|
14975
|
+
type: "boolean"
|
|
14976
|
+
},
|
|
14977
|
+
card_function_type: {
|
|
14978
|
+
description: "Card function type in the Visionline access system.",
|
|
14979
|
+
enum: ["guest", "staff"],
|
|
14980
|
+
type: "string"
|
|
14981
|
+
},
|
|
14982
|
+
card_id: {
|
|
14983
|
+
description: "ID of the card in the Visionline access system.",
|
|
14984
|
+
type: "string"
|
|
14985
|
+
},
|
|
14986
|
+
common_acs_entrance_ids: {
|
|
14987
|
+
description: "Common entrance IDs in the Visionline access system.",
|
|
14988
|
+
items: { format: "uuid", type: "string" },
|
|
14989
|
+
type: "array"
|
|
14990
|
+
},
|
|
14991
|
+
credential_id: {
|
|
14992
|
+
description: "ID of the credential in the Visionline access system.",
|
|
14993
|
+
type: "string"
|
|
14994
|
+
},
|
|
14995
|
+
guest_acs_entrance_ids: {
|
|
14996
|
+
description: "Guest entrance IDs in the Visionline access system.",
|
|
14997
|
+
items: { format: "uuid", type: "string" },
|
|
14998
|
+
type: "array"
|
|
14999
|
+
},
|
|
15000
|
+
is_valid: {
|
|
15001
|
+
description: "Indicates whether the credential is valid.",
|
|
15002
|
+
type: "boolean"
|
|
15003
|
+
},
|
|
15004
|
+
joiner_acs_credential_ids: {
|
|
15005
|
+
description: "IDs of the credentials to which you want to join.",
|
|
15006
|
+
items: { format: "uuid", type: "string" },
|
|
15007
|
+
type: "array"
|
|
15008
|
+
}
|
|
15009
|
+
},
|
|
15010
|
+
required: ["card_function_type"],
|
|
15011
|
+
type: "object"
|
|
15012
|
+
},
|
|
15013
|
+
warnings: {
|
|
15014
|
+
description: "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
15015
|
+
items: {
|
|
15016
|
+
description: "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
15017
|
+
discriminator: { propertyName: "warning_code" },
|
|
15018
|
+
oneOf: [
|
|
15019
|
+
{
|
|
15020
|
+
description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.",
|
|
15021
|
+
properties: {
|
|
15022
|
+
created_at: {
|
|
15023
|
+
description: "Date and time at which Seam created the warning.",
|
|
15024
|
+
format: "date-time",
|
|
15025
|
+
type: "string"
|
|
15026
|
+
},
|
|
15027
|
+
message: {
|
|
15028
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
15029
|
+
type: "string"
|
|
15030
|
+
},
|
|
15031
|
+
warning_code: {
|
|
15032
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15033
|
+
enum: ["waiting_to_be_issued"],
|
|
15034
|
+
type: "string"
|
|
15035
|
+
}
|
|
15036
|
+
},
|
|
15037
|
+
required: ["created_at", "message", "warning_code"],
|
|
15038
|
+
type: "object"
|
|
15039
|
+
},
|
|
15040
|
+
{
|
|
15041
|
+
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.",
|
|
15042
|
+
properties: {
|
|
15043
|
+
created_at: {
|
|
15044
|
+
description: "Date and time at which Seam created the warning.",
|
|
15045
|
+
format: "date-time",
|
|
15046
|
+
type: "string"
|
|
15047
|
+
},
|
|
15048
|
+
message: {
|
|
15049
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
15050
|
+
type: "string"
|
|
15051
|
+
},
|
|
15052
|
+
warning_code: {
|
|
15053
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15054
|
+
enum: ["schedule_externally_modified"],
|
|
15055
|
+
type: "string"
|
|
15056
|
+
}
|
|
15057
|
+
},
|
|
15058
|
+
required: ["created_at", "message", "warning_code"],
|
|
15059
|
+
type: "object"
|
|
15060
|
+
},
|
|
15061
|
+
{
|
|
15062
|
+
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.",
|
|
15063
|
+
properties: {
|
|
15064
|
+
created_at: {
|
|
15065
|
+
description: "Date and time at which Seam created the warning.",
|
|
15066
|
+
format: "date-time",
|
|
15067
|
+
type: "string"
|
|
15068
|
+
},
|
|
15069
|
+
message: {
|
|
15070
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
15071
|
+
type: "string"
|
|
15072
|
+
},
|
|
15073
|
+
warning_code: {
|
|
15074
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15075
|
+
enum: ["schedule_modified"],
|
|
15076
|
+
type: "string"
|
|
15077
|
+
}
|
|
15078
|
+
},
|
|
15079
|
+
required: ["created_at", "message", "warning_code"],
|
|
15080
|
+
type: "object"
|
|
15081
|
+
},
|
|
15082
|
+
{
|
|
15083
|
+
description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.",
|
|
15084
|
+
properties: {
|
|
15085
|
+
created_at: {
|
|
15086
|
+
description: "Date and time at which Seam created the warning.",
|
|
15087
|
+
format: "date-time",
|
|
15088
|
+
type: "string"
|
|
15089
|
+
},
|
|
15090
|
+
message: {
|
|
15091
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
15092
|
+
type: "string"
|
|
15093
|
+
},
|
|
15094
|
+
warning_code: {
|
|
15095
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15096
|
+
enum: ["being_deleted"],
|
|
15097
|
+
type: "string"
|
|
15098
|
+
}
|
|
15099
|
+
},
|
|
15100
|
+
required: ["created_at", "message", "warning_code"],
|
|
15101
|
+
type: "object"
|
|
15102
|
+
},
|
|
15103
|
+
{
|
|
15104
|
+
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.",
|
|
15105
|
+
properties: {
|
|
15106
|
+
created_at: {
|
|
15107
|
+
description: "Date and time at which Seam created the warning.",
|
|
15108
|
+
format: "date-time",
|
|
15109
|
+
type: "string"
|
|
15110
|
+
},
|
|
15111
|
+
message: {
|
|
15112
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
15113
|
+
type: "string"
|
|
15114
|
+
},
|
|
15115
|
+
warning_code: {
|
|
15116
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15117
|
+
enum: ["unknown_issue_with_acs_credential"],
|
|
15118
|
+
type: "string"
|
|
15119
|
+
}
|
|
15120
|
+
},
|
|
15121
|
+
required: ["created_at", "message", "warning_code"],
|
|
15122
|
+
type: "object"
|
|
15123
|
+
},
|
|
15124
|
+
{
|
|
15125
|
+
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.",
|
|
15126
|
+
properties: {
|
|
15127
|
+
created_at: {
|
|
15128
|
+
description: "Date and time at which Seam created the warning.",
|
|
15129
|
+
format: "date-time",
|
|
15130
|
+
type: "string"
|
|
15131
|
+
},
|
|
15132
|
+
message: {
|
|
15133
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
15134
|
+
type: "string"
|
|
15135
|
+
},
|
|
15136
|
+
warning_code: {
|
|
15137
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
15138
|
+
enum: ["needs_to_be_reissued"],
|
|
15139
|
+
type: "string"
|
|
15140
|
+
}
|
|
15141
|
+
},
|
|
15142
|
+
required: ["created_at", "message", "warning_code"],
|
|
15143
|
+
type: "object"
|
|
15144
|
+
}
|
|
15145
|
+
]
|
|
15146
|
+
},
|
|
15147
|
+
type: "array"
|
|
15148
|
+
},
|
|
15149
|
+
workspace_id: {
|
|
15150
|
+
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).",
|
|
15151
|
+
format: "uuid",
|
|
15152
|
+
type: "string"
|
|
15153
|
+
}
|
|
15154
|
+
},
|
|
15155
|
+
required: [
|
|
15156
|
+
"acs_credential_id",
|
|
15157
|
+
"connected_account_id",
|
|
15158
|
+
"acs_system_id",
|
|
15159
|
+
"display_name",
|
|
15160
|
+
"access_method",
|
|
15161
|
+
"created_at",
|
|
15162
|
+
"workspace_id",
|
|
15163
|
+
"errors",
|
|
15164
|
+
"warnings",
|
|
15165
|
+
"is_managed"
|
|
15166
|
+
],
|
|
15167
|
+
type: "object"
|
|
15168
|
+
},
|
|
15169
|
+
status: { enum: ["success"], type: "string" }
|
|
15170
|
+
},
|
|
15171
|
+
required: [
|
|
15172
|
+
"action_attempt_id",
|
|
15173
|
+
"status",
|
|
15174
|
+
"error",
|
|
15175
|
+
"action_type",
|
|
15176
|
+
"result"
|
|
15177
|
+
],
|
|
15178
|
+
type: "object"
|
|
15179
|
+
},
|
|
15180
|
+
{
|
|
15181
|
+
description: "Scanning a physical card and assigning the credential failed.",
|
|
15182
|
+
properties: {
|
|
15183
|
+
action_attempt_id: {
|
|
15184
|
+
description: "ID of the action attempt.",
|
|
15185
|
+
format: "uuid",
|
|
15186
|
+
type: "string"
|
|
15187
|
+
},
|
|
15188
|
+
action_type: {
|
|
15189
|
+
description: "Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user.",
|
|
15190
|
+
enum: ["SCAN_TO_ASSIGN_CREDENTIAL"],
|
|
15191
|
+
type: "string"
|
|
15192
|
+
},
|
|
15193
|
+
error: {
|
|
15194
|
+
oneOf: [
|
|
15195
|
+
{
|
|
15196
|
+
description: "Error that doesn't fit into other specific error categories.",
|
|
15197
|
+
properties: {
|
|
15198
|
+
message: {
|
|
15199
|
+
description: "Message for the error associated with the action attempt.",
|
|
15200
|
+
type: "string"
|
|
15201
|
+
},
|
|
15202
|
+
type: {
|
|
15203
|
+
description: "Type of the error associated with the action attempt.",
|
|
15204
|
+
enum: ["uncategorized_error"],
|
|
15205
|
+
type: "string"
|
|
15206
|
+
}
|
|
15207
|
+
},
|
|
15208
|
+
required: ["type", "message"],
|
|
15209
|
+
type: "object"
|
|
15210
|
+
},
|
|
15211
|
+
{
|
|
15212
|
+
description: "Error to indicate an expired action attempt.",
|
|
15213
|
+
properties: {
|
|
15214
|
+
message: {
|
|
15215
|
+
description: "Message for the error associated with the action attempt.",
|
|
15216
|
+
type: "string"
|
|
15217
|
+
},
|
|
15218
|
+
type: {
|
|
15219
|
+
description: "Type of the error associated with the action attempt.",
|
|
15220
|
+
enum: ["action_attempt_expired"],
|
|
15221
|
+
type: "string"
|
|
15222
|
+
}
|
|
15223
|
+
},
|
|
15224
|
+
required: ["type", "message"],
|
|
15225
|
+
type: "object"
|
|
15226
|
+
},
|
|
15227
|
+
{
|
|
15228
|
+
description: "Error to indicate that there is no credential on the encoder.",
|
|
15229
|
+
properties: {
|
|
15230
|
+
message: {
|
|
15231
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
15232
|
+
type: "string"
|
|
15233
|
+
},
|
|
15234
|
+
type: {
|
|
15235
|
+
description: "Error type to indicate that there is no credential on the encoder.",
|
|
15236
|
+
enum: ["no_credential_on_encoder"],
|
|
15237
|
+
type: "string"
|
|
15238
|
+
}
|
|
15239
|
+
},
|
|
15240
|
+
required: ["type", "message"],
|
|
15241
|
+
type: "object"
|
|
15242
|
+
}
|
|
15243
|
+
]
|
|
15244
|
+
},
|
|
15245
|
+
result: {
|
|
15246
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
15247
|
+
nullable: true
|
|
15248
|
+
},
|
|
15249
|
+
status: { enum: ["error"], type: "string" }
|
|
15250
|
+
},
|
|
15251
|
+
required: [
|
|
15252
|
+
"action_attempt_id",
|
|
15253
|
+
"status",
|
|
15254
|
+
"result",
|
|
15255
|
+
"action_type",
|
|
15256
|
+
"error"
|
|
15257
|
+
],
|
|
15258
|
+
type: "object"
|
|
15259
|
+
},
|
|
14710
15260
|
{
|
|
14711
15261
|
description: "Resetting a sandbox workspace is pending.",
|
|
14712
15262
|
properties: {
|
|
@@ -17522,7 +18072,8 @@ var openapi = {
|
|
|
17522
18072
|
"tedee_lock",
|
|
17523
18073
|
"akiles_lock",
|
|
17524
18074
|
"ultraloq_lock",
|
|
17525
|
-
"korelock_lock"
|
|
18075
|
+
"korelock_lock",
|
|
18076
|
+
"omnitec_lock"
|
|
17526
18077
|
],
|
|
17527
18078
|
type: "string"
|
|
17528
18079
|
},
|
|
@@ -19105,6 +19656,35 @@ var openapi = {
|
|
|
19105
19656
|
required: ["device_id", "device_name"],
|
|
19106
19657
|
type: "object"
|
|
19107
19658
|
},
|
|
19659
|
+
omnitec_metadata: {
|
|
19660
|
+
description: "Metadata for an Omnitec device.",
|
|
19661
|
+
properties: {
|
|
19662
|
+
has_gateway: {
|
|
19663
|
+
description: "Whether the Omnitec lock has a connected gateway for remote operations.",
|
|
19664
|
+
type: "boolean"
|
|
19665
|
+
},
|
|
19666
|
+
lock_id: {
|
|
19667
|
+
description: "Lock ID for an Omnitec device.",
|
|
19668
|
+
format: "float",
|
|
19669
|
+
type: "number"
|
|
19670
|
+
},
|
|
19671
|
+
lock_mac: {
|
|
19672
|
+
description: "Bluetooth MAC address for an Omnitec device.",
|
|
19673
|
+
type: "string"
|
|
19674
|
+
},
|
|
19675
|
+
lock_name: {
|
|
19676
|
+
description: "Lock name for an Omnitec device.",
|
|
19677
|
+
type: "string"
|
|
19678
|
+
}
|
|
19679
|
+
},
|
|
19680
|
+
required: [
|
|
19681
|
+
"lock_id",
|
|
19682
|
+
"lock_name",
|
|
19683
|
+
"lock_mac",
|
|
19684
|
+
"has_gateway"
|
|
19685
|
+
],
|
|
19686
|
+
type: "object"
|
|
19687
|
+
},
|
|
19108
19688
|
ring_metadata: {
|
|
19109
19689
|
description: "Metadata for a Ring device.",
|
|
19110
19690
|
properties: {
|
|
@@ -21139,7 +21719,8 @@ var openapi = {
|
|
|
21139
21719
|
"ical",
|
|
21140
21720
|
"lodgify",
|
|
21141
21721
|
"hostaway",
|
|
21142
|
-
"acuity_scheduling"
|
|
21722
|
+
"acuity_scheduling",
|
|
21723
|
+
"omnitec"
|
|
21143
21724
|
],
|
|
21144
21725
|
type: "string"
|
|
21145
21726
|
},
|
|
@@ -34221,7 +34802,8 @@ var openapi = {
|
|
|
34221
34802
|
"tedee_lock",
|
|
34222
34803
|
"akiles_lock",
|
|
34223
34804
|
"ultraloq_lock",
|
|
34224
|
-
"korelock_lock"
|
|
34805
|
+
"korelock_lock",
|
|
34806
|
+
"omnitec_lock"
|
|
34225
34807
|
],
|
|
34226
34808
|
type: "string"
|
|
34227
34809
|
},
|
|
@@ -47872,6 +48454,74 @@ var openapi = {
|
|
|
47872
48454
|
"x-title": "Scan a Credential"
|
|
47873
48455
|
}
|
|
47874
48456
|
},
|
|
48457
|
+
"/acs/encoders/scan_to_assign_credential": {
|
|
48458
|
+
post: {
|
|
48459
|
+
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`.",
|
|
48460
|
+
operationId: "acsEncodersScanToAssignCredentialPost",
|
|
48461
|
+
requestBody: {
|
|
48462
|
+
content: {
|
|
48463
|
+
"application/json": {
|
|
48464
|
+
schema: {
|
|
48465
|
+
properties: {
|
|
48466
|
+
acs_encoder_id: {
|
|
48467
|
+
description: "ID of the `acs_encoder` to use to scan the credential.",
|
|
48468
|
+
format: "uuid",
|
|
48469
|
+
type: "string"
|
|
48470
|
+
},
|
|
48471
|
+
acs_user_id: {
|
|
48472
|
+
description: "ID of the `acs_user` to assign the scanned credential to.",
|
|
48473
|
+
format: "uuid",
|
|
48474
|
+
type: "string"
|
|
48475
|
+
},
|
|
48476
|
+
user_identity_id: {
|
|
48477
|
+
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.",
|
|
48478
|
+
format: "uuid",
|
|
48479
|
+
type: "string"
|
|
48480
|
+
}
|
|
48481
|
+
},
|
|
48482
|
+
required: ["acs_encoder_id"],
|
|
48483
|
+
type: "object"
|
|
48484
|
+
}
|
|
48485
|
+
}
|
|
48486
|
+
}
|
|
48487
|
+
},
|
|
48488
|
+
responses: {
|
|
48489
|
+
200: {
|
|
48490
|
+
content: {
|
|
48491
|
+
"application/json": {
|
|
48492
|
+
schema: {
|
|
48493
|
+
properties: {
|
|
48494
|
+
action_attempt: {
|
|
48495
|
+
$ref: "#/components/schemas/action_attempt"
|
|
48496
|
+
},
|
|
48497
|
+
ok: { type: "boolean" }
|
|
48498
|
+
},
|
|
48499
|
+
required: ["action_attempt", "ok"],
|
|
48500
|
+
type: "object"
|
|
48501
|
+
}
|
|
48502
|
+
}
|
|
48503
|
+
},
|
|
48504
|
+
description: "OK"
|
|
48505
|
+
},
|
|
48506
|
+
400: { description: "Bad Request" },
|
|
48507
|
+
401: { description: "Unauthorized" }
|
|
48508
|
+
},
|
|
48509
|
+
security: [
|
|
48510
|
+
{ pat_with_workspace: [] },
|
|
48511
|
+
{ console_session_with_workspace: [] },
|
|
48512
|
+
{ api_key: [] },
|
|
48513
|
+
{ client_session_with_customer: [] }
|
|
48514
|
+
],
|
|
48515
|
+
summary: "/acs/encoders/scan_to_assign_credential",
|
|
48516
|
+
tags: ["/acs"],
|
|
48517
|
+
"x-action-attempt-type": "SCAN_TO_ASSIGN_CREDENTIAL",
|
|
48518
|
+
"x-fern-sdk-group-name": ["acs", "encoders"],
|
|
48519
|
+
"x-fern-sdk-method-name": "scan_to_assign_credential",
|
|
48520
|
+
"x-fern-sdk-return-value": "action_attempt",
|
|
48521
|
+
"x-response-key": "action_attempt",
|
|
48522
|
+
"x-title": "Scan to Assign a Credential"
|
|
48523
|
+
}
|
|
48524
|
+
},
|
|
47875
48525
|
"/acs/encoders/simulate/next_credential_encode_will_fail": {
|
|
47876
48526
|
post: {
|
|
47877
48527
|
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).",
|
|
@@ -52292,6 +52942,7 @@ var openapi = {
|
|
|
52292
52942
|
"lodgify",
|
|
52293
52943
|
"hostaway",
|
|
52294
52944
|
"acuity_scheduling",
|
|
52945
|
+
"omnitec",
|
|
52295
52946
|
"yale_access",
|
|
52296
52947
|
"hid_cm",
|
|
52297
52948
|
"google_nest"
|
|
@@ -56102,7 +56753,8 @@ var openapi = {
|
|
|
56102
56753
|
"tedee_lock",
|
|
56103
56754
|
"akiles_lock",
|
|
56104
56755
|
"ultraloq_lock",
|
|
56105
|
-
"korelock_lock"
|
|
56756
|
+
"korelock_lock",
|
|
56757
|
+
"omnitec_lock"
|
|
56106
56758
|
],
|
|
56107
56759
|
type: "string"
|
|
56108
56760
|
},
|
|
@@ -56177,7 +56829,8 @@ var openapi = {
|
|
|
56177
56829
|
"tedee_lock",
|
|
56178
56830
|
"akiles_lock",
|
|
56179
56831
|
"ultraloq_lock",
|
|
56180
|
-
"korelock_lock"
|
|
56832
|
+
"korelock_lock",
|
|
56833
|
+
"omnitec_lock"
|
|
56181
56834
|
],
|
|
56182
56835
|
type: "string"
|
|
56183
56836
|
},
|
|
@@ -56269,7 +56922,8 @@ var openapi = {
|
|
|
56269
56922
|
"ical",
|
|
56270
56923
|
"lodgify",
|
|
56271
56924
|
"hostaway",
|
|
56272
|
-
"acuity_scheduling"
|
|
56925
|
+
"acuity_scheduling",
|
|
56926
|
+
"omnitec"
|
|
56273
56927
|
],
|
|
56274
56928
|
type: "string"
|
|
56275
56929
|
}
|
|
@@ -56540,7 +57194,8 @@ var openapi = {
|
|
|
56540
57194
|
"tedee_lock",
|
|
56541
57195
|
"akiles_lock",
|
|
56542
57196
|
"ultraloq_lock",
|
|
56543
|
-
"korelock_lock"
|
|
57197
|
+
"korelock_lock",
|
|
57198
|
+
"omnitec_lock"
|
|
56544
57199
|
],
|
|
56545
57200
|
type: "string"
|
|
56546
57201
|
},
|
|
@@ -56611,7 +57266,8 @@ var openapi = {
|
|
|
56611
57266
|
"tedee_lock",
|
|
56612
57267
|
"akiles_lock",
|
|
56613
57268
|
"ultraloq_lock",
|
|
56614
|
-
"korelock_lock"
|
|
57269
|
+
"korelock_lock",
|
|
57270
|
+
"omnitec_lock"
|
|
56615
57271
|
],
|
|
56616
57272
|
type: "string"
|
|
56617
57273
|
},
|
|
@@ -56763,7 +57419,8 @@ var openapi = {
|
|
|
56763
57419
|
"ical",
|
|
56764
57420
|
"lodgify",
|
|
56765
57421
|
"hostaway",
|
|
56766
|
-
"acuity_scheduling"
|
|
57422
|
+
"acuity_scheduling",
|
|
57423
|
+
"omnitec"
|
|
56767
57424
|
],
|
|
56768
57425
|
type: "string"
|
|
56769
57426
|
},
|
|
@@ -58399,7 +59056,8 @@ var openapi = {
|
|
|
58399
59056
|
"tedee_lock",
|
|
58400
59057
|
"akiles_lock",
|
|
58401
59058
|
"ultraloq_lock",
|
|
58402
|
-
"korelock_lock"
|
|
59059
|
+
"korelock_lock",
|
|
59060
|
+
"omnitec_lock"
|
|
58403
59061
|
],
|
|
58404
59062
|
type: "string"
|
|
58405
59063
|
},
|
|
@@ -58474,7 +59132,8 @@ var openapi = {
|
|
|
58474
59132
|
"tedee_lock",
|
|
58475
59133
|
"akiles_lock",
|
|
58476
59134
|
"ultraloq_lock",
|
|
58477
|
-
"korelock_lock"
|
|
59135
|
+
"korelock_lock",
|
|
59136
|
+
"omnitec_lock"
|
|
58478
59137
|
],
|
|
58479
59138
|
type: "string"
|
|
58480
59139
|
},
|
|
@@ -58566,7 +59225,8 @@ var openapi = {
|
|
|
58566
59225
|
"ical",
|
|
58567
59226
|
"lodgify",
|
|
58568
59227
|
"hostaway",
|
|
58569
|
-
"acuity_scheduling"
|
|
59228
|
+
"acuity_scheduling",
|
|
59229
|
+
"omnitec"
|
|
58570
59230
|
],
|
|
58571
59231
|
type: "string"
|
|
58572
59232
|
}
|
|
@@ -58836,7 +59496,8 @@ var openapi = {
|
|
|
58836
59496
|
"tedee_lock",
|
|
58837
59497
|
"akiles_lock",
|
|
58838
59498
|
"ultraloq_lock",
|
|
58839
|
-
"korelock_lock"
|
|
59499
|
+
"korelock_lock",
|
|
59500
|
+
"omnitec_lock"
|
|
58840
59501
|
],
|
|
58841
59502
|
type: "string"
|
|
58842
59503
|
},
|
|
@@ -58907,7 +59568,8 @@ var openapi = {
|
|
|
58907
59568
|
"tedee_lock",
|
|
58908
59569
|
"akiles_lock",
|
|
58909
59570
|
"ultraloq_lock",
|
|
58910
|
-
"korelock_lock"
|
|
59571
|
+
"korelock_lock",
|
|
59572
|
+
"omnitec_lock"
|
|
58911
59573
|
],
|
|
58912
59574
|
type: "string"
|
|
58913
59575
|
},
|
|
@@ -59059,7 +59721,8 @@ var openapi = {
|
|
|
59059
59721
|
"ical",
|
|
59060
59722
|
"lodgify",
|
|
59061
59723
|
"hostaway",
|
|
59062
|
-
"acuity_scheduling"
|
|
59724
|
+
"acuity_scheduling",
|
|
59725
|
+
"omnitec"
|
|
59063
59726
|
],
|
|
59064
59727
|
type: "string"
|
|
59065
59728
|
},
|
|
@@ -61054,7 +61717,8 @@ var openapi = {
|
|
|
61054
61717
|
"tedee_lock",
|
|
61055
61718
|
"akiles_lock",
|
|
61056
61719
|
"ultraloq_lock",
|
|
61057
|
-
"korelock_lock"
|
|
61720
|
+
"korelock_lock",
|
|
61721
|
+
"omnitec_lock"
|
|
61058
61722
|
],
|
|
61059
61723
|
type: "string"
|
|
61060
61724
|
}
|
|
@@ -61093,7 +61757,8 @@ var openapi = {
|
|
|
61093
61757
|
"tedee_lock",
|
|
61094
61758
|
"akiles_lock",
|
|
61095
61759
|
"ultraloq_lock",
|
|
61096
|
-
"korelock_lock"
|
|
61760
|
+
"korelock_lock",
|
|
61761
|
+
"omnitec_lock"
|
|
61097
61762
|
],
|
|
61098
61763
|
type: "string"
|
|
61099
61764
|
},
|
|
@@ -61134,7 +61799,8 @@ var openapi = {
|
|
|
61134
61799
|
"akiles",
|
|
61135
61800
|
"korelock",
|
|
61136
61801
|
"smartthings",
|
|
61137
|
-
"ultraloq"
|
|
61802
|
+
"ultraloq",
|
|
61803
|
+
"omnitec"
|
|
61138
61804
|
],
|
|
61139
61805
|
type: "string"
|
|
61140
61806
|
}
|
|
@@ -61404,7 +62070,8 @@ var openapi = {
|
|
|
61404
62070
|
"tedee_lock",
|
|
61405
62071
|
"akiles_lock",
|
|
61406
62072
|
"ultraloq_lock",
|
|
61407
|
-
"korelock_lock"
|
|
62073
|
+
"korelock_lock",
|
|
62074
|
+
"omnitec_lock"
|
|
61408
62075
|
],
|
|
61409
62076
|
type: "string"
|
|
61410
62077
|
},
|
|
@@ -61439,7 +62106,8 @@ var openapi = {
|
|
|
61439
62106
|
"tedee_lock",
|
|
61440
62107
|
"akiles_lock",
|
|
61441
62108
|
"ultraloq_lock",
|
|
61442
|
-
"korelock_lock"
|
|
62109
|
+
"korelock_lock",
|
|
62110
|
+
"omnitec_lock"
|
|
61443
62111
|
],
|
|
61444
62112
|
type: "string"
|
|
61445
62113
|
},
|
|
@@ -61540,7 +62208,8 @@ var openapi = {
|
|
|
61540
62208
|
"akiles",
|
|
61541
62209
|
"korelock",
|
|
61542
62210
|
"smartthings",
|
|
61543
|
-
"ultraloq"
|
|
62211
|
+
"ultraloq",
|
|
62212
|
+
"omnitec"
|
|
61544
62213
|
],
|
|
61545
62214
|
type: "string"
|
|
61546
62215
|
},
|