@seamapi/types 1.871.0 → 1.873.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 +367 -30
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +825 -0
- package/dist/index.cjs +367 -30
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +210 -10
- package/lib/seam/connect/models/access-codes/managed-access-code.js +85 -10
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +73 -0
- package/lib/seam/connect/models/acs/acs-entrance.d.ts +48 -0
- package/lib/seam/connect/models/acs/acs-entrance.js +13 -0
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +236 -0
- package/lib/seam/connect/models/phones/phone-session.d.ts +98 -0
- package/lib/seam/connect/openapi.js +240 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +374 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +110 -10
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +18 -0
- package/src/lib/seam/connect/openapi.ts +282 -0
- package/src/lib/seam/connect/route-types.ts +418 -0
package/dist/index.cjs
CHANGED
|
@@ -2306,12 +2306,31 @@ var common_access_code_error = zod.z.object({
|
|
|
2306
2306
|
created_at: zod.z.string().datetime().optional().describe("Date and time at which Seam created the error.")
|
|
2307
2307
|
});
|
|
2308
2308
|
var error_code_description3 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
|
|
2309
|
+
var provider_issue = common_access_code_error.extend({
|
|
2310
|
+
error_code: zod.z.literal("provider_issue").describe(error_code_description3)
|
|
2311
|
+
}).describe(
|
|
2312
|
+
"Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details."
|
|
2313
|
+
);
|
|
2309
2314
|
var smartthings_failed_to_set_access_code_error = common_access_code_error.extend({
|
|
2310
2315
|
error_code: zod.z.literal("smartthings_failed_to_set_access_code").describe(error_code_description3)
|
|
2311
|
-
}).describe(
|
|
2316
|
+
}).describe(
|
|
2317
|
+
`
|
|
2318
|
+
---
|
|
2319
|
+
deprecated: Handled by the generic \`failed_to_set_on_device\` system.
|
|
2320
|
+
---
|
|
2321
|
+
Failed to set code on SmartThings device.
|
|
2322
|
+
`
|
|
2323
|
+
);
|
|
2312
2324
|
var smartthings_failed_to_set_after_multiple_retries = common_access_code_error.extend({
|
|
2313
2325
|
error_code: zod.z.literal("smartthings_failed_to_set_after_multiple_retries").describe(error_code_description3)
|
|
2314
|
-
}).describe(
|
|
2326
|
+
}).describe(
|
|
2327
|
+
`
|
|
2328
|
+
---
|
|
2329
|
+
deprecated: Handled by the generic \`failed_to_set_on_device\` system.
|
|
2330
|
+
---
|
|
2331
|
+
Failed to set code after multiple retries.
|
|
2332
|
+
`
|
|
2333
|
+
);
|
|
2315
2334
|
var modified_field = zod.z.object({
|
|
2316
2335
|
field: zod.z.string().describe(
|
|
2317
2336
|
"The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`)."
|
|
@@ -2379,20 +2398,58 @@ var kwikset_unable_to_confirm_deletion = common_access_code_error.extend({
|
|
|
2379
2398
|
var kwikset_insufficient_permissions = common_access_code_error.extend({
|
|
2380
2399
|
error_code: zod.z.literal("kwikset_insufficient_permissions").describe(error_code_description3)
|
|
2381
2400
|
}).describe(
|
|
2382
|
-
|
|
2401
|
+
`
|
|
2402
|
+
---
|
|
2403
|
+
deprecated: Use \`provider_issue\` instead.
|
|
2404
|
+
---
|
|
2405
|
+
Admin role required\u2014insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.
|
|
2406
|
+
`
|
|
2383
2407
|
);
|
|
2384
2408
|
var august_lock_invalid_code_length = common_access_code_error.extend({
|
|
2385
2409
|
error_code: zod.z.literal("august_lock_invalid_code_length").describe(error_code_description3)
|
|
2386
|
-
}).describe(
|
|
2410
|
+
}).describe(
|
|
2411
|
+
`
|
|
2412
|
+
---
|
|
2413
|
+
deprecated: Use \`provider_issue\` instead.
|
|
2414
|
+
---
|
|
2415
|
+
Invalid code length for August lock.
|
|
2416
|
+
`
|
|
2417
|
+
);
|
|
2387
2418
|
var august_lock_temporarily_offline_error = common_access_code_error.extend({
|
|
2388
2419
|
error_code: zod.z.literal("august_lock_temporarily_offline").describe(error_code_description3)
|
|
2389
|
-
}).describe(
|
|
2420
|
+
}).describe(
|
|
2421
|
+
`
|
|
2422
|
+
---
|
|
2423
|
+
deprecated: Use \`provider_issue\` instead.
|
|
2424
|
+
---
|
|
2425
|
+
August lock is temporarily offline.
|
|
2426
|
+
`
|
|
2427
|
+
);
|
|
2390
2428
|
var august_lock_missing_keypad = common_access_code_error.extend({
|
|
2391
2429
|
error_code: zod.z.literal("august_lock_missing_keypad").describe(error_code_description3)
|
|
2392
|
-
}).describe(
|
|
2430
|
+
}).describe(
|
|
2431
|
+
`
|
|
2432
|
+
---
|
|
2433
|
+
deprecated: Use \`provider_issue\` instead.
|
|
2434
|
+
---
|
|
2435
|
+
August lock is missing a keypad.
|
|
2436
|
+
`
|
|
2437
|
+
);
|
|
2438
|
+
var access_code_inactive_error = common_access_code_error.extend({
|
|
2439
|
+
error_code: zod.z.literal("access_code_inactive").describe(error_code_description3)
|
|
2440
|
+
}).describe(
|
|
2441
|
+
"Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled."
|
|
2442
|
+
);
|
|
2393
2443
|
var salto_ks_user_not_subscribed = common_access_code_error.extend({
|
|
2394
2444
|
error_code: zod.z.literal("salto_ks_user_not_subscribed").describe(error_code_description3)
|
|
2395
|
-
}).describe(
|
|
2445
|
+
}).describe(
|
|
2446
|
+
`
|
|
2447
|
+
---
|
|
2448
|
+
deprecated: Use \`access_code_inactive\` instead.
|
|
2449
|
+
---
|
|
2450
|
+
Salto site user is not subscribed.
|
|
2451
|
+
`
|
|
2452
|
+
);
|
|
2396
2453
|
var wyze_duplicate_code_name = common_access_code_error.extend({
|
|
2397
2454
|
error_code: zod.z.literal("wyze_duplicate_code_name").describe(error_code_description3)
|
|
2398
2455
|
}).describe(
|
|
@@ -2416,17 +2473,30 @@ var wyze_potential_duplicate_code = common_access_code_error.extend({
|
|
|
2416
2473
|
var dormakaba_oracode_invalid_time_range = common_access_code_error.extend({
|
|
2417
2474
|
error_code: zod.z.literal("dormakaba_oracode_invalid_time_range").describe(error_code_description3)
|
|
2418
2475
|
}).describe(
|
|
2419
|
-
|
|
2476
|
+
`
|
|
2477
|
+
---
|
|
2478
|
+
deprecated: Use \`provider_issue\` instead.
|
|
2479
|
+
---
|
|
2480
|
+
No Dormakaba Oracode user levels configured for the requested time range.
|
|
2481
|
+
`
|
|
2420
2482
|
);
|
|
2421
2483
|
var keynest_unsupported_third_party_locker = common_access_code_error.extend({
|
|
2422
2484
|
error_code: zod.z.literal("keynest_unsupported_third_party_locker").describe(error_code_description3)
|
|
2423
|
-
}).describe(
|
|
2485
|
+
}).describe(
|
|
2486
|
+
`
|
|
2487
|
+
---
|
|
2488
|
+
deprecated: Use \`provider_issue\` instead.
|
|
2489
|
+
---
|
|
2490
|
+
KeyNest locker is not supported.
|
|
2491
|
+
`
|
|
2492
|
+
);
|
|
2424
2493
|
var replaced_by_newer_access_code = common_access_code_error.extend({
|
|
2425
2494
|
error_code: zod.z.literal("replaced_by_newer_access_code").describe(error_code_description3)
|
|
2426
2495
|
}).describe(
|
|
2427
2496
|
"This access code was overridden on the device by a newer access code programmed to the same slot."
|
|
2428
2497
|
);
|
|
2429
2498
|
var access_code_error = zod.z.discriminatedUnion("error_code", [
|
|
2499
|
+
provider_issue,
|
|
2430
2500
|
smartthings_failed_to_set_access_code_error,
|
|
2431
2501
|
smartthings_failed_to_set_after_multiple_retries,
|
|
2432
2502
|
failed_to_set_on_device,
|
|
@@ -2441,6 +2511,7 @@ var access_code_error = zod.z.discriminatedUnion("error_code", [
|
|
|
2441
2511
|
august_lock_invalid_code_length,
|
|
2442
2512
|
august_lock_missing_keypad,
|
|
2443
2513
|
august_lock_temporarily_offline_error,
|
|
2514
|
+
access_code_inactive_error,
|
|
2444
2515
|
salto_ks_user_not_subscribed,
|
|
2445
2516
|
wyze_duplicate_code_name,
|
|
2446
2517
|
wyze_potential_duplicate_code,
|
|
@@ -2452,6 +2523,7 @@ var access_code_error = zod.z.discriminatedUnion("error_code", [
|
|
|
2452
2523
|
"Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
|
|
2453
2524
|
);
|
|
2454
2525
|
zod.z.object({
|
|
2526
|
+
provider_issue: provider_issue.optional().nullable(),
|
|
2455
2527
|
smartthings_failed_to_set_access_code: smartthings_failed_to_set_access_code_error.optional().nullable(),
|
|
2456
2528
|
smartthings_failed_to_set_after_multiple_retries: smartthings_failed_to_set_after_multiple_retries.optional().nullable(),
|
|
2457
2529
|
failed_to_set_on_device: failed_to_set_on_device.optional().nullable(),
|
|
@@ -2467,6 +2539,7 @@ zod.z.object({
|
|
|
2467
2539
|
august_lock_invalid_code_length: august_lock_invalid_code_length.optional().nullable(),
|
|
2468
2540
|
august_lock_temporarily_offline: august_lock_temporarily_offline_error.optional().nullable(),
|
|
2469
2541
|
august_lock_missing_keypad: august_lock_missing_keypad.optional().nullable(),
|
|
2542
|
+
access_code_inactive: access_code_inactive_error.optional().nullable(),
|
|
2470
2543
|
salto_ks_user_not_subscribed: salto_ks_user_not_subscribed.optional().nullable(),
|
|
2471
2544
|
wyze_duplicate_code_name: wyze_duplicate_code_name.optional().nullable(),
|
|
2472
2545
|
wyze_potential_duplicate_code: wyze_potential_duplicate_code.optional().nullable(),
|
|
@@ -2508,9 +2581,21 @@ var schlage_detected_duplicate = common_access_code_warning.extend({
|
|
|
2508
2581
|
Duplicate access code detected.
|
|
2509
2582
|
`
|
|
2510
2583
|
);
|
|
2584
|
+
var provider_issue_warning = common_access_code_warning.extend({
|
|
2585
|
+
warning_code: zod.z.literal("provider_issue").describe(warning_code_description3)
|
|
2586
|
+
}).describe(
|
|
2587
|
+
"Indicates a provider-specific issue that may affect the access code. Check the warning message for details."
|
|
2588
|
+
);
|
|
2511
2589
|
var schlage_creation_outage = common_access_code_warning.extend({
|
|
2512
2590
|
warning_code: zod.z.literal("schlage_creation_outage").describe(warning_code_description3)
|
|
2513
|
-
}).describe(
|
|
2591
|
+
}).describe(
|
|
2592
|
+
`
|
|
2593
|
+
---
|
|
2594
|
+
deprecated: Use \`provider_issue\` instead.
|
|
2595
|
+
---
|
|
2596
|
+
Received an error when attempting to create this code.
|
|
2597
|
+
`
|
|
2598
|
+
);
|
|
2514
2599
|
var schlage_access_code_ambiguous_timezone_dst_risk = common_access_code_warning.extend({
|
|
2515
2600
|
warning_code: zod.z.literal("schlage_access_code_ambiguous_timezone_dst_risk").describe(warning_code_description3)
|
|
2516
2601
|
}).describe(
|
|
@@ -2560,6 +2645,7 @@ var being_deleted2 = common_access_code_warning.extend({
|
|
|
2560
2645
|
warning_code: zod.z.literal("being_deleted").describe(warning_code_description3)
|
|
2561
2646
|
}).describe("Access code is being deleted.");
|
|
2562
2647
|
var access_code_warning = zod.z.discriminatedUnion("warning_code", [
|
|
2648
|
+
provider_issue_warning,
|
|
2563
2649
|
smartthings_failed_to_set_access_code_warning,
|
|
2564
2650
|
schlage_detected_duplicate,
|
|
2565
2651
|
schlage_creation_outage,
|
|
@@ -2580,6 +2666,7 @@ var access_code_warning = zod.z.discriminatedUnion("warning_code", [
|
|
|
2580
2666
|
"Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
|
|
2581
2667
|
);
|
|
2582
2668
|
zod.z.object({
|
|
2669
|
+
provider_issue: provider_issue_warning.optional().nullable(),
|
|
2583
2670
|
smartthings_failed_to_set_access_code: smartthings_failed_to_set_access_code_warning.optional().nullable(),
|
|
2584
2671
|
schlage_detected_duplicate: schlage_detected_duplicate.optional().nullable(),
|
|
2585
2672
|
schlage_creation_outage: schlage_creation_outage.optional().nullable(),
|
|
@@ -3835,17 +3922,24 @@ var entrance_setup_required = common_acs_entrance_warning.extend({
|
|
|
3835
3922
|
}).describe(
|
|
3836
3923
|
"Indicates that this entrance requires additional configuration in the access control system before Seam can fully manage it."
|
|
3837
3924
|
);
|
|
3925
|
+
var salto_ks_privacy_mode2 = common_acs_entrance_warning.extend({
|
|
3926
|
+
warning_code: zod.z.literal("salto_ks_privacy_mode").describe(warning_code_description8)
|
|
3927
|
+
}).describe(
|
|
3928
|
+
"Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access."
|
|
3929
|
+
);
|
|
3838
3930
|
var acs_entrance_warning = zod.z.discriminatedUnion("warning_code", [
|
|
3839
3931
|
salto_ks_entrance_access_code_support_removed,
|
|
3840
3932
|
entrance_shares_zone,
|
|
3841
|
-
entrance_setup_required
|
|
3933
|
+
entrance_setup_required,
|
|
3934
|
+
salto_ks_privacy_mode2
|
|
3842
3935
|
]).describe(
|
|
3843
3936
|
"Warning associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
|
|
3844
3937
|
);
|
|
3845
3938
|
zod.z.object({
|
|
3846
3939
|
salto_ks_entrance_access_code_support_removed: salto_ks_entrance_access_code_support_removed.optional().nullable(),
|
|
3847
3940
|
entrance_shares_zone: entrance_shares_zone.optional().nullable(),
|
|
3848
|
-
entrance_setup_required: entrance_setup_required.optional().nullable()
|
|
3941
|
+
entrance_setup_required: entrance_setup_required.optional().nullable(),
|
|
3942
|
+
salto_ks_privacy_mode: salto_ks_privacy_mode2.optional().nullable()
|
|
3849
3943
|
});
|
|
3850
3944
|
var acs_entrance_capability_flags = zod.z.object({
|
|
3851
3945
|
can_unlock_with_mobile_key: zod.z.boolean().optional().describe(
|
|
@@ -3925,6 +4019,9 @@ var acs_entrance = zod.z.object({
|
|
|
3925
4019
|
),
|
|
3926
4020
|
avigilon_alta_metadata: acs_entrance_avigilon_alta_metadata.optional().describe(
|
|
3927
4021
|
"Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
|
|
4022
|
+
),
|
|
4023
|
+
is_locked: zod.z.boolean().optional().describe(
|
|
4024
|
+
"Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked."
|
|
3928
4025
|
)
|
|
3929
4026
|
}).merge(acs_entrance_capability_flags).describe(`
|
|
3930
4027
|
---
|
|
@@ -7236,6 +7333,33 @@ var openapi = {
|
|
|
7236
7333
|
discriminator: { propertyName: "error_code" },
|
|
7237
7334
|
oneOf: [
|
|
7238
7335
|
{
|
|
7336
|
+
description: "Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.",
|
|
7337
|
+
properties: {
|
|
7338
|
+
created_at: {
|
|
7339
|
+
description: "Date and time at which Seam created the error.",
|
|
7340
|
+
format: "date-time",
|
|
7341
|
+
type: "string"
|
|
7342
|
+
},
|
|
7343
|
+
error_code: {
|
|
7344
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7345
|
+
enum: ["provider_issue"],
|
|
7346
|
+
type: "string"
|
|
7347
|
+
},
|
|
7348
|
+
is_access_code_error: {
|
|
7349
|
+
description: "Indicates that this is an access code error.",
|
|
7350
|
+
enum: [true],
|
|
7351
|
+
type: "boolean"
|
|
7352
|
+
},
|
|
7353
|
+
message: {
|
|
7354
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
7355
|
+
type: "string"
|
|
7356
|
+
}
|
|
7357
|
+
},
|
|
7358
|
+
required: ["message", "is_access_code_error", "error_code"],
|
|
7359
|
+
type: "object"
|
|
7360
|
+
},
|
|
7361
|
+
{
|
|
7362
|
+
deprecated: true,
|
|
7239
7363
|
description: "Failed to set code on SmartThings device.",
|
|
7240
7364
|
properties: {
|
|
7241
7365
|
created_at: {
|
|
@@ -7259,9 +7383,11 @@ var openapi = {
|
|
|
7259
7383
|
}
|
|
7260
7384
|
},
|
|
7261
7385
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7262
|
-
type: "object"
|
|
7386
|
+
type: "object",
|
|
7387
|
+
"x-deprecated": "Handled by the generic `failed_to_set_on_device` system."
|
|
7263
7388
|
},
|
|
7264
7389
|
{
|
|
7390
|
+
deprecated: true,
|
|
7265
7391
|
description: "Failed to set code after multiple retries.",
|
|
7266
7392
|
properties: {
|
|
7267
7393
|
created_at: {
|
|
@@ -7287,7 +7413,8 @@ var openapi = {
|
|
|
7287
7413
|
}
|
|
7288
7414
|
},
|
|
7289
7415
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7290
|
-
type: "object"
|
|
7416
|
+
type: "object",
|
|
7417
|
+
"x-deprecated": "Handled by the generic `failed_to_set_on_device` system."
|
|
7291
7418
|
},
|
|
7292
7419
|
{
|
|
7293
7420
|
description: "Failed to set code on device.",
|
|
@@ -7567,6 +7694,7 @@ var openapi = {
|
|
|
7567
7694
|
type: "object"
|
|
7568
7695
|
},
|
|
7569
7696
|
{
|
|
7697
|
+
deprecated: true,
|
|
7570
7698
|
description: "Invalid code length for August lock.",
|
|
7571
7699
|
properties: {
|
|
7572
7700
|
created_at: {
|
|
@@ -7590,9 +7718,11 @@ var openapi = {
|
|
|
7590
7718
|
}
|
|
7591
7719
|
},
|
|
7592
7720
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7593
|
-
type: "object"
|
|
7721
|
+
type: "object",
|
|
7722
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
7594
7723
|
},
|
|
7595
7724
|
{
|
|
7725
|
+
deprecated: true,
|
|
7596
7726
|
description: "August lock is missing a keypad.",
|
|
7597
7727
|
properties: {
|
|
7598
7728
|
created_at: {
|
|
@@ -7616,9 +7746,11 @@ var openapi = {
|
|
|
7616
7746
|
}
|
|
7617
7747
|
},
|
|
7618
7748
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7619
|
-
type: "object"
|
|
7749
|
+
type: "object",
|
|
7750
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
7620
7751
|
},
|
|
7621
7752
|
{
|
|
7753
|
+
deprecated: true,
|
|
7622
7754
|
description: "August lock is temporarily offline.",
|
|
7623
7755
|
properties: {
|
|
7624
7756
|
created_at: {
|
|
@@ -7642,9 +7774,37 @@ var openapi = {
|
|
|
7642
7774
|
}
|
|
7643
7775
|
},
|
|
7644
7776
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7777
|
+
type: "object",
|
|
7778
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
7779
|
+
},
|
|
7780
|
+
{
|
|
7781
|
+
description: "Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.",
|
|
7782
|
+
properties: {
|
|
7783
|
+
created_at: {
|
|
7784
|
+
description: "Date and time at which Seam created the error.",
|
|
7785
|
+
format: "date-time",
|
|
7786
|
+
type: "string"
|
|
7787
|
+
},
|
|
7788
|
+
error_code: {
|
|
7789
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7790
|
+
enum: ["access_code_inactive"],
|
|
7791
|
+
type: "string"
|
|
7792
|
+
},
|
|
7793
|
+
is_access_code_error: {
|
|
7794
|
+
description: "Indicates that this is an access code error.",
|
|
7795
|
+
enum: [true],
|
|
7796
|
+
type: "boolean"
|
|
7797
|
+
},
|
|
7798
|
+
message: {
|
|
7799
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
7800
|
+
type: "string"
|
|
7801
|
+
}
|
|
7802
|
+
},
|
|
7803
|
+
required: ["message", "is_access_code_error", "error_code"],
|
|
7645
7804
|
type: "object"
|
|
7646
7805
|
},
|
|
7647
7806
|
{
|
|
7807
|
+
deprecated: true,
|
|
7648
7808
|
description: "Salto site user is not subscribed.",
|
|
7649
7809
|
properties: {
|
|
7650
7810
|
created_at: {
|
|
@@ -7668,7 +7828,8 @@ var openapi = {
|
|
|
7668
7828
|
}
|
|
7669
7829
|
},
|
|
7670
7830
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7671
|
-
type: "object"
|
|
7831
|
+
type: "object",
|
|
7832
|
+
"x-deprecated": "Use `access_code_inactive` instead."
|
|
7672
7833
|
},
|
|
7673
7834
|
{
|
|
7674
7835
|
deprecated: true,
|
|
@@ -7727,6 +7888,7 @@ var openapi = {
|
|
|
7727
7888
|
"x-deprecated": "Use `duplicate_code_on_device` instead."
|
|
7728
7889
|
},
|
|
7729
7890
|
{
|
|
7891
|
+
deprecated: true,
|
|
7730
7892
|
description: "No Dormakaba Oracode user levels configured for the requested time range.",
|
|
7731
7893
|
properties: {
|
|
7732
7894
|
created_at: {
|
|
@@ -7750,9 +7912,11 @@ var openapi = {
|
|
|
7750
7912
|
}
|
|
7751
7913
|
},
|
|
7752
7914
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7753
|
-
type: "object"
|
|
7915
|
+
type: "object",
|
|
7916
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
7754
7917
|
},
|
|
7755
7918
|
{
|
|
7919
|
+
deprecated: true,
|
|
7756
7920
|
description: "Admin role required\u2014insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.",
|
|
7757
7921
|
properties: {
|
|
7758
7922
|
created_at: {
|
|
@@ -7776,9 +7940,11 @@ var openapi = {
|
|
|
7776
7940
|
}
|
|
7777
7941
|
},
|
|
7778
7942
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7779
|
-
type: "object"
|
|
7943
|
+
type: "object",
|
|
7944
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
7780
7945
|
},
|
|
7781
7946
|
{
|
|
7947
|
+
deprecated: true,
|
|
7782
7948
|
description: "KeyNest locker is not supported.",
|
|
7783
7949
|
properties: {
|
|
7784
7950
|
created_at: {
|
|
@@ -7802,7 +7968,8 @@ var openapi = {
|
|
|
7802
7968
|
}
|
|
7803
7969
|
},
|
|
7804
7970
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7805
|
-
type: "object"
|
|
7971
|
+
type: "object",
|
|
7972
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
7806
7973
|
},
|
|
7807
7974
|
{
|
|
7808
7975
|
description: "This access code was overridden on the device by a newer access code programmed to the same slot.",
|
|
@@ -8646,6 +8813,27 @@ var openapi = {
|
|
|
8646
8813
|
description: "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
8647
8814
|
discriminator: { propertyName: "warning_code" },
|
|
8648
8815
|
oneOf: [
|
|
8816
|
+
{
|
|
8817
|
+
description: "Indicates a provider-specific issue that may affect the access code. Check the warning message for details.",
|
|
8818
|
+
properties: {
|
|
8819
|
+
created_at: {
|
|
8820
|
+
description: "Date and time at which Seam created the warning.",
|
|
8821
|
+
format: "date-time",
|
|
8822
|
+
type: "string"
|
|
8823
|
+
},
|
|
8824
|
+
message: {
|
|
8825
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
8826
|
+
type: "string"
|
|
8827
|
+
},
|
|
8828
|
+
warning_code: {
|
|
8829
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
8830
|
+
enum: ["provider_issue"],
|
|
8831
|
+
type: "string"
|
|
8832
|
+
}
|
|
8833
|
+
},
|
|
8834
|
+
required: ["message", "warning_code"],
|
|
8835
|
+
type: "object"
|
|
8836
|
+
},
|
|
8649
8837
|
{
|
|
8650
8838
|
description: "Failed to set code on SmartThings device.",
|
|
8651
8839
|
properties: {
|
|
@@ -8691,6 +8879,7 @@ var openapi = {
|
|
|
8691
8879
|
"x-deprecated": "Use `duplicate_code_on_device` error instead."
|
|
8692
8880
|
},
|
|
8693
8881
|
{
|
|
8882
|
+
deprecated: true,
|
|
8694
8883
|
description: "Received an error when attempting to create this code.",
|
|
8695
8884
|
properties: {
|
|
8696
8885
|
created_at: {
|
|
@@ -8709,7 +8898,8 @@ var openapi = {
|
|
|
8709
8898
|
}
|
|
8710
8899
|
},
|
|
8711
8900
|
required: ["message", "warning_code"],
|
|
8712
|
-
type: "object"
|
|
8901
|
+
type: "object",
|
|
8902
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
8713
8903
|
},
|
|
8714
8904
|
{
|
|
8715
8905
|
description: "The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift \u2014 the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling.",
|
|
@@ -11150,6 +11340,10 @@ var openapi = {
|
|
|
11150
11340
|
},
|
|
11151
11341
|
type: "object"
|
|
11152
11342
|
},
|
|
11343
|
+
is_locked: {
|
|
11344
|
+
description: "Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked.",
|
|
11345
|
+
type: "boolean"
|
|
11346
|
+
},
|
|
11153
11347
|
latch_metadata: {
|
|
11154
11348
|
description: "Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
11155
11349
|
properties: {
|
|
@@ -11369,6 +11563,27 @@ var openapi = {
|
|
|
11369
11563
|
},
|
|
11370
11564
|
required: ["created_at", "message", "warning_code"],
|
|
11371
11565
|
type: "object"
|
|
11566
|
+
},
|
|
11567
|
+
{
|
|
11568
|
+
description: "Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.",
|
|
11569
|
+
properties: {
|
|
11570
|
+
created_at: {
|
|
11571
|
+
description: "Date and time at which Seam created the warning.",
|
|
11572
|
+
format: "date-time",
|
|
11573
|
+
type: "string"
|
|
11574
|
+
},
|
|
11575
|
+
message: {
|
|
11576
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
11577
|
+
type: "string"
|
|
11578
|
+
},
|
|
11579
|
+
warning_code: {
|
|
11580
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
11581
|
+
enum: ["salto_ks_privacy_mode"],
|
|
11582
|
+
type: "string"
|
|
11583
|
+
}
|
|
11584
|
+
},
|
|
11585
|
+
required: ["created_at", "message", "warning_code"],
|
|
11586
|
+
type: "object"
|
|
11372
11587
|
}
|
|
11373
11588
|
]
|
|
11374
11589
|
},
|
|
@@ -30565,6 +30780,10 @@ var openapi = {
|
|
|
30565
30780
|
},
|
|
30566
30781
|
type: "object"
|
|
30567
30782
|
},
|
|
30783
|
+
is_locked: {
|
|
30784
|
+
description: "Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked.",
|
|
30785
|
+
type: "boolean"
|
|
30786
|
+
},
|
|
30568
30787
|
latch_metadata: {
|
|
30569
30788
|
description: "Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
30570
30789
|
properties: {
|
|
@@ -30798,6 +31017,31 @@ var openapi = {
|
|
|
30798
31017
|
"warning_code"
|
|
30799
31018
|
],
|
|
30800
31019
|
type: "object"
|
|
31020
|
+
},
|
|
31021
|
+
{
|
|
31022
|
+
description: "Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.",
|
|
31023
|
+
properties: {
|
|
31024
|
+
created_at: {
|
|
31025
|
+
description: "Date and time at which Seam created the warning.",
|
|
31026
|
+
format: "date-time",
|
|
31027
|
+
type: "string"
|
|
31028
|
+
},
|
|
31029
|
+
message: {
|
|
31030
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
31031
|
+
type: "string"
|
|
31032
|
+
},
|
|
31033
|
+
warning_code: {
|
|
31034
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
31035
|
+
enum: ["salto_ks_privacy_mode"],
|
|
31036
|
+
type: "string"
|
|
31037
|
+
}
|
|
31038
|
+
},
|
|
31039
|
+
required: [
|
|
31040
|
+
"created_at",
|
|
31041
|
+
"message",
|
|
31042
|
+
"warning_code"
|
|
31043
|
+
],
|
|
31044
|
+
type: "object"
|
|
30801
31045
|
}
|
|
30802
31046
|
]
|
|
30803
31047
|
},
|
|
@@ -31796,6 +32040,33 @@ var openapi = {
|
|
|
31796
32040
|
discriminator: { propertyName: "error_code" },
|
|
31797
32041
|
oneOf: [
|
|
31798
32042
|
{
|
|
32043
|
+
description: "Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.",
|
|
32044
|
+
properties: {
|
|
32045
|
+
created_at: {
|
|
32046
|
+
description: "Date and time at which Seam created the error.",
|
|
32047
|
+
format: "date-time",
|
|
32048
|
+
type: "string"
|
|
32049
|
+
},
|
|
32050
|
+
error_code: {
|
|
32051
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
32052
|
+
enum: ["provider_issue"],
|
|
32053
|
+
type: "string"
|
|
32054
|
+
},
|
|
32055
|
+
is_access_code_error: {
|
|
32056
|
+
description: "Indicates that this is an access code error.",
|
|
32057
|
+
enum: [true],
|
|
32058
|
+
type: "boolean"
|
|
32059
|
+
},
|
|
32060
|
+
message: {
|
|
32061
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
32062
|
+
type: "string"
|
|
32063
|
+
}
|
|
32064
|
+
},
|
|
32065
|
+
required: ["message", "is_access_code_error", "error_code"],
|
|
32066
|
+
type: "object"
|
|
32067
|
+
},
|
|
32068
|
+
{
|
|
32069
|
+
deprecated: true,
|
|
31799
32070
|
description: "Failed to set code on SmartThings device.",
|
|
31800
32071
|
properties: {
|
|
31801
32072
|
created_at: {
|
|
@@ -31819,9 +32090,11 @@ var openapi = {
|
|
|
31819
32090
|
}
|
|
31820
32091
|
},
|
|
31821
32092
|
required: ["message", "is_access_code_error", "error_code"],
|
|
31822
|
-
type: "object"
|
|
32093
|
+
type: "object",
|
|
32094
|
+
"x-deprecated": "Handled by the generic `failed_to_set_on_device` system."
|
|
31823
32095
|
},
|
|
31824
32096
|
{
|
|
32097
|
+
deprecated: true,
|
|
31825
32098
|
description: "Failed to set code after multiple retries.",
|
|
31826
32099
|
properties: {
|
|
31827
32100
|
created_at: {
|
|
@@ -31847,7 +32120,8 @@ var openapi = {
|
|
|
31847
32120
|
}
|
|
31848
32121
|
},
|
|
31849
32122
|
required: ["message", "is_access_code_error", "error_code"],
|
|
31850
|
-
type: "object"
|
|
32123
|
+
type: "object",
|
|
32124
|
+
"x-deprecated": "Handled by the generic `failed_to_set_on_device` system."
|
|
31851
32125
|
},
|
|
31852
32126
|
{
|
|
31853
32127
|
description: "Failed to set code on device.",
|
|
@@ -32127,6 +32401,7 @@ var openapi = {
|
|
|
32127
32401
|
type: "object"
|
|
32128
32402
|
},
|
|
32129
32403
|
{
|
|
32404
|
+
deprecated: true,
|
|
32130
32405
|
description: "Invalid code length for August lock.",
|
|
32131
32406
|
properties: {
|
|
32132
32407
|
created_at: {
|
|
@@ -32150,9 +32425,11 @@ var openapi = {
|
|
|
32150
32425
|
}
|
|
32151
32426
|
},
|
|
32152
32427
|
required: ["message", "is_access_code_error", "error_code"],
|
|
32153
|
-
type: "object"
|
|
32428
|
+
type: "object",
|
|
32429
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
32154
32430
|
},
|
|
32155
32431
|
{
|
|
32432
|
+
deprecated: true,
|
|
32156
32433
|
description: "August lock is missing a keypad.",
|
|
32157
32434
|
properties: {
|
|
32158
32435
|
created_at: {
|
|
@@ -32176,9 +32453,11 @@ var openapi = {
|
|
|
32176
32453
|
}
|
|
32177
32454
|
},
|
|
32178
32455
|
required: ["message", "is_access_code_error", "error_code"],
|
|
32179
|
-
type: "object"
|
|
32456
|
+
type: "object",
|
|
32457
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
32180
32458
|
},
|
|
32181
32459
|
{
|
|
32460
|
+
deprecated: true,
|
|
32182
32461
|
description: "August lock is temporarily offline.",
|
|
32183
32462
|
properties: {
|
|
32184
32463
|
created_at: {
|
|
@@ -32202,9 +32481,37 @@ var openapi = {
|
|
|
32202
32481
|
}
|
|
32203
32482
|
},
|
|
32204
32483
|
required: ["message", "is_access_code_error", "error_code"],
|
|
32484
|
+
type: "object",
|
|
32485
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
32486
|
+
},
|
|
32487
|
+
{
|
|
32488
|
+
description: "Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.",
|
|
32489
|
+
properties: {
|
|
32490
|
+
created_at: {
|
|
32491
|
+
description: "Date and time at which Seam created the error.",
|
|
32492
|
+
format: "date-time",
|
|
32493
|
+
type: "string"
|
|
32494
|
+
},
|
|
32495
|
+
error_code: {
|
|
32496
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
32497
|
+
enum: ["access_code_inactive"],
|
|
32498
|
+
type: "string"
|
|
32499
|
+
},
|
|
32500
|
+
is_access_code_error: {
|
|
32501
|
+
description: "Indicates that this is an access code error.",
|
|
32502
|
+
enum: [true],
|
|
32503
|
+
type: "boolean"
|
|
32504
|
+
},
|
|
32505
|
+
message: {
|
|
32506
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
32507
|
+
type: "string"
|
|
32508
|
+
}
|
|
32509
|
+
},
|
|
32510
|
+
required: ["message", "is_access_code_error", "error_code"],
|
|
32205
32511
|
type: "object"
|
|
32206
32512
|
},
|
|
32207
32513
|
{
|
|
32514
|
+
deprecated: true,
|
|
32208
32515
|
description: "Salto site user is not subscribed.",
|
|
32209
32516
|
properties: {
|
|
32210
32517
|
created_at: {
|
|
@@ -32228,7 +32535,8 @@ var openapi = {
|
|
|
32228
32535
|
}
|
|
32229
32536
|
},
|
|
32230
32537
|
required: ["message", "is_access_code_error", "error_code"],
|
|
32231
|
-
type: "object"
|
|
32538
|
+
type: "object",
|
|
32539
|
+
"x-deprecated": "Use `access_code_inactive` instead."
|
|
32232
32540
|
},
|
|
32233
32541
|
{
|
|
32234
32542
|
deprecated: true,
|
|
@@ -32287,6 +32595,7 @@ var openapi = {
|
|
|
32287
32595
|
"x-deprecated": "Use `duplicate_code_on_device` instead."
|
|
32288
32596
|
},
|
|
32289
32597
|
{
|
|
32598
|
+
deprecated: true,
|
|
32290
32599
|
description: "No Dormakaba Oracode user levels configured for the requested time range.",
|
|
32291
32600
|
properties: {
|
|
32292
32601
|
created_at: {
|
|
@@ -32310,9 +32619,11 @@ var openapi = {
|
|
|
32310
32619
|
}
|
|
32311
32620
|
},
|
|
32312
32621
|
required: ["message", "is_access_code_error", "error_code"],
|
|
32313
|
-
type: "object"
|
|
32622
|
+
type: "object",
|
|
32623
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
32314
32624
|
},
|
|
32315
32625
|
{
|
|
32626
|
+
deprecated: true,
|
|
32316
32627
|
description: "Admin role required\u2014insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.",
|
|
32317
32628
|
properties: {
|
|
32318
32629
|
created_at: {
|
|
@@ -32336,9 +32647,11 @@ var openapi = {
|
|
|
32336
32647
|
}
|
|
32337
32648
|
},
|
|
32338
32649
|
required: ["message", "is_access_code_error", "error_code"],
|
|
32339
|
-
type: "object"
|
|
32650
|
+
type: "object",
|
|
32651
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
32340
32652
|
},
|
|
32341
32653
|
{
|
|
32654
|
+
deprecated: true,
|
|
32342
32655
|
description: "KeyNest locker is not supported.",
|
|
32343
32656
|
properties: {
|
|
32344
32657
|
created_at: {
|
|
@@ -32362,7 +32675,8 @@ var openapi = {
|
|
|
32362
32675
|
}
|
|
32363
32676
|
},
|
|
32364
32677
|
required: ["message", "is_access_code_error", "error_code"],
|
|
32365
|
-
type: "object"
|
|
32678
|
+
type: "object",
|
|
32679
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
32366
32680
|
},
|
|
32367
32681
|
{
|
|
32368
32682
|
description: "This access code was overridden on the device by a newer access code programmed to the same slot.",
|
|
@@ -32923,6 +33237,27 @@ var openapi = {
|
|
|
32923
33237
|
description: "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
32924
33238
|
discriminator: { propertyName: "warning_code" },
|
|
32925
33239
|
oneOf: [
|
|
33240
|
+
{
|
|
33241
|
+
description: "Indicates a provider-specific issue that may affect the access code. Check the warning message for details.",
|
|
33242
|
+
properties: {
|
|
33243
|
+
created_at: {
|
|
33244
|
+
description: "Date and time at which Seam created the warning.",
|
|
33245
|
+
format: "date-time",
|
|
33246
|
+
type: "string"
|
|
33247
|
+
},
|
|
33248
|
+
message: {
|
|
33249
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
33250
|
+
type: "string"
|
|
33251
|
+
},
|
|
33252
|
+
warning_code: {
|
|
33253
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
33254
|
+
enum: ["provider_issue"],
|
|
33255
|
+
type: "string"
|
|
33256
|
+
}
|
|
33257
|
+
},
|
|
33258
|
+
required: ["message", "warning_code"],
|
|
33259
|
+
type: "object"
|
|
33260
|
+
},
|
|
32926
33261
|
{
|
|
32927
33262
|
description: "Failed to set code on SmartThings device.",
|
|
32928
33263
|
properties: {
|
|
@@ -32968,6 +33303,7 @@ var openapi = {
|
|
|
32968
33303
|
"x-deprecated": "Use `duplicate_code_on_device` error instead."
|
|
32969
33304
|
},
|
|
32970
33305
|
{
|
|
33306
|
+
deprecated: true,
|
|
32971
33307
|
description: "Received an error when attempting to create this code.",
|
|
32972
33308
|
properties: {
|
|
32973
33309
|
created_at: {
|
|
@@ -32986,7 +33322,8 @@ var openapi = {
|
|
|
32986
33322
|
}
|
|
32987
33323
|
},
|
|
32988
33324
|
required: ["message", "warning_code"],
|
|
32989
|
-
type: "object"
|
|
33325
|
+
type: "object",
|
|
33326
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
32990
33327
|
},
|
|
32991
33328
|
{
|
|
32992
33329
|
description: "The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift \u2014 the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling.",
|