@seamapi/types 1.870.0 → 1.872.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 +438 -30
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1314 -0
- package/dist/index.cjs +438 -30
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +414 -10
- package/lib/seam/connect/models/access-codes/managed-access-code.js +108 -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 +149 -0
- package/lib/seam/connect/models/batch.d.ts +402 -0
- package/lib/seam/connect/openapi.js +302 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +517 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +144 -10
- package/src/lib/seam/connect/openapi.ts +346 -0
- package/src/lib/seam/connect/route-types.ts +594 -0
package/dist/connect.cjs
CHANGED
|
@@ -2306,14 +2306,46 @@ 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
|
+
);
|
|
2334
|
+
var modified_field = zod.z.object({
|
|
2335
|
+
field: zod.z.string().describe(
|
|
2336
|
+
"The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`)."
|
|
2337
|
+
),
|
|
2338
|
+
from: zod.z.string().nullable().describe("The previous value of the field."),
|
|
2339
|
+
to: zod.z.string().nullable().describe("The new value of the field.")
|
|
2340
|
+
});
|
|
2315
2341
|
var code_modified_external_to_seam_error = common_access_code_error.extend({
|
|
2316
|
-
error_code: zod.z.literal("code_modified_external_to_seam").describe(error_code_description3)
|
|
2342
|
+
error_code: zod.z.literal("code_modified_external_to_seam").describe(error_code_description3),
|
|
2343
|
+
change_type: zod.z.enum(["modified", "removed"]).optional().describe(
|
|
2344
|
+
"Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device."
|
|
2345
|
+
),
|
|
2346
|
+
modified_fields: zod.z.array(modified_field).optional().describe(
|
|
2347
|
+
"List of fields that were changed externally, with their previous and new values."
|
|
2348
|
+
)
|
|
2317
2349
|
}).describe(
|
|
2318
2350
|
"Code was modified or removed externally after Seam successfully set it on the device."
|
|
2319
2351
|
);
|
|
@@ -2366,20 +2398,58 @@ var kwikset_unable_to_confirm_deletion = common_access_code_error.extend({
|
|
|
2366
2398
|
var kwikset_insufficient_permissions = common_access_code_error.extend({
|
|
2367
2399
|
error_code: zod.z.literal("kwikset_insufficient_permissions").describe(error_code_description3)
|
|
2368
2400
|
}).describe(
|
|
2369
|
-
|
|
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
|
+
`
|
|
2370
2407
|
);
|
|
2371
2408
|
var august_lock_invalid_code_length = common_access_code_error.extend({
|
|
2372
2409
|
error_code: zod.z.literal("august_lock_invalid_code_length").describe(error_code_description3)
|
|
2373
|
-
}).describe(
|
|
2410
|
+
}).describe(
|
|
2411
|
+
`
|
|
2412
|
+
---
|
|
2413
|
+
deprecated: Use \`provider_issue\` instead.
|
|
2414
|
+
---
|
|
2415
|
+
Invalid code length for August lock.
|
|
2416
|
+
`
|
|
2417
|
+
);
|
|
2374
2418
|
var august_lock_temporarily_offline_error = common_access_code_error.extend({
|
|
2375
2419
|
error_code: zod.z.literal("august_lock_temporarily_offline").describe(error_code_description3)
|
|
2376
|
-
}).describe(
|
|
2420
|
+
}).describe(
|
|
2421
|
+
`
|
|
2422
|
+
---
|
|
2423
|
+
deprecated: Use \`provider_issue\` instead.
|
|
2424
|
+
---
|
|
2425
|
+
August lock is temporarily offline.
|
|
2426
|
+
`
|
|
2427
|
+
);
|
|
2377
2428
|
var august_lock_missing_keypad = common_access_code_error.extend({
|
|
2378
2429
|
error_code: zod.z.literal("august_lock_missing_keypad").describe(error_code_description3)
|
|
2379
|
-
}).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
|
+
);
|
|
2380
2443
|
var salto_ks_user_not_subscribed = common_access_code_error.extend({
|
|
2381
2444
|
error_code: zod.z.literal("salto_ks_user_not_subscribed").describe(error_code_description3)
|
|
2382
|
-
}).describe(
|
|
2445
|
+
}).describe(
|
|
2446
|
+
`
|
|
2447
|
+
---
|
|
2448
|
+
deprecated: Use \`access_code_inactive\` instead.
|
|
2449
|
+
---
|
|
2450
|
+
Salto site user is not subscribed.
|
|
2451
|
+
`
|
|
2452
|
+
);
|
|
2383
2453
|
var wyze_duplicate_code_name = common_access_code_error.extend({
|
|
2384
2454
|
error_code: zod.z.literal("wyze_duplicate_code_name").describe(error_code_description3)
|
|
2385
2455
|
}).describe(
|
|
@@ -2403,17 +2473,30 @@ var wyze_potential_duplicate_code = common_access_code_error.extend({
|
|
|
2403
2473
|
var dormakaba_oracode_invalid_time_range = common_access_code_error.extend({
|
|
2404
2474
|
error_code: zod.z.literal("dormakaba_oracode_invalid_time_range").describe(error_code_description3)
|
|
2405
2475
|
}).describe(
|
|
2406
|
-
|
|
2476
|
+
`
|
|
2477
|
+
---
|
|
2478
|
+
deprecated: Use \`provider_issue\` instead.
|
|
2479
|
+
---
|
|
2480
|
+
No Dormakaba Oracode user levels configured for the requested time range.
|
|
2481
|
+
`
|
|
2407
2482
|
);
|
|
2408
2483
|
var keynest_unsupported_third_party_locker = common_access_code_error.extend({
|
|
2409
2484
|
error_code: zod.z.literal("keynest_unsupported_third_party_locker").describe(error_code_description3)
|
|
2410
|
-
}).describe(
|
|
2485
|
+
}).describe(
|
|
2486
|
+
`
|
|
2487
|
+
---
|
|
2488
|
+
deprecated: Use \`provider_issue\` instead.
|
|
2489
|
+
---
|
|
2490
|
+
KeyNest locker is not supported.
|
|
2491
|
+
`
|
|
2492
|
+
);
|
|
2411
2493
|
var replaced_by_newer_access_code = common_access_code_error.extend({
|
|
2412
2494
|
error_code: zod.z.literal("replaced_by_newer_access_code").describe(error_code_description3)
|
|
2413
2495
|
}).describe(
|
|
2414
2496
|
"This access code was overridden on the device by a newer access code programmed to the same slot."
|
|
2415
2497
|
);
|
|
2416
2498
|
var access_code_error = zod.z.discriminatedUnion("error_code", [
|
|
2499
|
+
provider_issue,
|
|
2417
2500
|
smartthings_failed_to_set_access_code_error,
|
|
2418
2501
|
smartthings_failed_to_set_after_multiple_retries,
|
|
2419
2502
|
failed_to_set_on_device,
|
|
@@ -2428,6 +2511,7 @@ var access_code_error = zod.z.discriminatedUnion("error_code", [
|
|
|
2428
2511
|
august_lock_invalid_code_length,
|
|
2429
2512
|
august_lock_missing_keypad,
|
|
2430
2513
|
august_lock_temporarily_offline_error,
|
|
2514
|
+
access_code_inactive_error,
|
|
2431
2515
|
salto_ks_user_not_subscribed,
|
|
2432
2516
|
wyze_duplicate_code_name,
|
|
2433
2517
|
wyze_potential_duplicate_code,
|
|
@@ -2439,6 +2523,7 @@ var access_code_error = zod.z.discriminatedUnion("error_code", [
|
|
|
2439
2523
|
"Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
|
|
2440
2524
|
);
|
|
2441
2525
|
zod.z.object({
|
|
2526
|
+
provider_issue: provider_issue.optional().nullable(),
|
|
2442
2527
|
smartthings_failed_to_set_access_code: smartthings_failed_to_set_access_code_error.optional().nullable(),
|
|
2443
2528
|
smartthings_failed_to_set_after_multiple_retries: smartthings_failed_to_set_after_multiple_retries.optional().nullable(),
|
|
2444
2529
|
failed_to_set_on_device: failed_to_set_on_device.optional().nullable(),
|
|
@@ -2454,6 +2539,7 @@ zod.z.object({
|
|
|
2454
2539
|
august_lock_invalid_code_length: august_lock_invalid_code_length.optional().nullable(),
|
|
2455
2540
|
august_lock_temporarily_offline: august_lock_temporarily_offline_error.optional().nullable(),
|
|
2456
2541
|
august_lock_missing_keypad: august_lock_missing_keypad.optional().nullable(),
|
|
2542
|
+
access_code_inactive: access_code_inactive_error.optional().nullable(),
|
|
2457
2543
|
salto_ks_user_not_subscribed: salto_ks_user_not_subscribed.optional().nullable(),
|
|
2458
2544
|
wyze_duplicate_code_name: wyze_duplicate_code_name.optional().nullable(),
|
|
2459
2545
|
wyze_potential_duplicate_code: wyze_potential_duplicate_code.optional().nullable(),
|
|
@@ -2475,7 +2561,13 @@ var august_lock_temporarily_offline_warning = common_access_code_warning.extend(
|
|
|
2475
2561
|
warning_code: zod.z.literal("august_lock_temporarily_offline").describe(error_code_description3)
|
|
2476
2562
|
}).describe("August lock is temporarily offline.");
|
|
2477
2563
|
var code_modified_external_to_seam_warning = common_access_code_warning.extend({
|
|
2478
|
-
warning_code: zod.z.literal("code_modified_external_to_seam").describe(warning_code_description3)
|
|
2564
|
+
warning_code: zod.z.literal("code_modified_external_to_seam").describe(warning_code_description3),
|
|
2565
|
+
change_type: zod.z.enum(["modified", "removed"]).optional().describe(
|
|
2566
|
+
"Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device."
|
|
2567
|
+
),
|
|
2568
|
+
modified_fields: zod.z.array(modified_field).optional().describe(
|
|
2569
|
+
"List of fields that were changed externally, with their previous and new values."
|
|
2570
|
+
)
|
|
2479
2571
|
}).describe(
|
|
2480
2572
|
"Code was modified or removed externally after Seam successfully set it on the device."
|
|
2481
2573
|
);
|
|
@@ -2489,9 +2581,21 @@ var schlage_detected_duplicate = common_access_code_warning.extend({
|
|
|
2489
2581
|
Duplicate access code detected.
|
|
2490
2582
|
`
|
|
2491
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
|
+
);
|
|
2492
2589
|
var schlage_creation_outage = common_access_code_warning.extend({
|
|
2493
2590
|
warning_code: zod.z.literal("schlage_creation_outage").describe(warning_code_description3)
|
|
2494
|
-
}).describe(
|
|
2591
|
+
}).describe(
|
|
2592
|
+
`
|
|
2593
|
+
---
|
|
2594
|
+
deprecated: Use \`provider_issue\` instead.
|
|
2595
|
+
---
|
|
2596
|
+
Received an error when attempting to create this code.
|
|
2597
|
+
`
|
|
2598
|
+
);
|
|
2495
2599
|
var schlage_access_code_ambiguous_timezone_dst_risk = common_access_code_warning.extend({
|
|
2496
2600
|
warning_code: zod.z.literal("schlage_access_code_ambiguous_timezone_dst_risk").describe(warning_code_description3)
|
|
2497
2601
|
}).describe(
|
|
@@ -2541,6 +2645,7 @@ var being_deleted2 = common_access_code_warning.extend({
|
|
|
2541
2645
|
warning_code: zod.z.literal("being_deleted").describe(warning_code_description3)
|
|
2542
2646
|
}).describe("Access code is being deleted.");
|
|
2543
2647
|
var access_code_warning = zod.z.discriminatedUnion("warning_code", [
|
|
2648
|
+
provider_issue_warning,
|
|
2544
2649
|
smartthings_failed_to_set_access_code_warning,
|
|
2545
2650
|
schlage_detected_duplicate,
|
|
2546
2651
|
schlage_creation_outage,
|
|
@@ -2561,6 +2666,7 @@ var access_code_warning = zod.z.discriminatedUnion("warning_code", [
|
|
|
2561
2666
|
"Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
|
|
2562
2667
|
);
|
|
2563
2668
|
zod.z.object({
|
|
2669
|
+
provider_issue: provider_issue_warning.optional().nullable(),
|
|
2564
2670
|
smartthings_failed_to_set_access_code: smartthings_failed_to_set_access_code_warning.optional().nullable(),
|
|
2565
2671
|
schlage_detected_duplicate: schlage_detected_duplicate.optional().nullable(),
|
|
2566
2672
|
schlage_creation_outage: schlage_creation_outage.optional().nullable(),
|
|
@@ -7217,6 +7323,33 @@ var openapi = {
|
|
|
7217
7323
|
discriminator: { propertyName: "error_code" },
|
|
7218
7324
|
oneOf: [
|
|
7219
7325
|
{
|
|
7326
|
+
description: "Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.",
|
|
7327
|
+
properties: {
|
|
7328
|
+
created_at: {
|
|
7329
|
+
description: "Date and time at which Seam created the error.",
|
|
7330
|
+
format: "date-time",
|
|
7331
|
+
type: "string"
|
|
7332
|
+
},
|
|
7333
|
+
error_code: {
|
|
7334
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7335
|
+
enum: ["provider_issue"],
|
|
7336
|
+
type: "string"
|
|
7337
|
+
},
|
|
7338
|
+
is_access_code_error: {
|
|
7339
|
+
description: "Indicates that this is an access code error.",
|
|
7340
|
+
enum: [true],
|
|
7341
|
+
type: "boolean"
|
|
7342
|
+
},
|
|
7343
|
+
message: {
|
|
7344
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
7345
|
+
type: "string"
|
|
7346
|
+
}
|
|
7347
|
+
},
|
|
7348
|
+
required: ["message", "is_access_code_error", "error_code"],
|
|
7349
|
+
type: "object"
|
|
7350
|
+
},
|
|
7351
|
+
{
|
|
7352
|
+
deprecated: true,
|
|
7220
7353
|
description: "Failed to set code on SmartThings device.",
|
|
7221
7354
|
properties: {
|
|
7222
7355
|
created_at: {
|
|
@@ -7240,9 +7373,11 @@ var openapi = {
|
|
|
7240
7373
|
}
|
|
7241
7374
|
},
|
|
7242
7375
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7243
|
-
type: "object"
|
|
7376
|
+
type: "object",
|
|
7377
|
+
"x-deprecated": "Handled by the generic `failed_to_set_on_device` system."
|
|
7244
7378
|
},
|
|
7245
7379
|
{
|
|
7380
|
+
deprecated: true,
|
|
7246
7381
|
description: "Failed to set code after multiple retries.",
|
|
7247
7382
|
properties: {
|
|
7248
7383
|
created_at: {
|
|
@@ -7268,7 +7403,8 @@ var openapi = {
|
|
|
7268
7403
|
}
|
|
7269
7404
|
},
|
|
7270
7405
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7271
|
-
type: "object"
|
|
7406
|
+
type: "object",
|
|
7407
|
+
"x-deprecated": "Handled by the generic `failed_to_set_on_device` system."
|
|
7272
7408
|
},
|
|
7273
7409
|
{
|
|
7274
7410
|
description: "Failed to set code on device.",
|
|
@@ -7495,6 +7631,11 @@ var openapi = {
|
|
|
7495
7631
|
{
|
|
7496
7632
|
description: "Code was modified or removed externally after Seam successfully set it on the device.",
|
|
7497
7633
|
properties: {
|
|
7634
|
+
change_type: {
|
|
7635
|
+
description: "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
|
|
7636
|
+
enum: ["modified", "removed"],
|
|
7637
|
+
type: "string"
|
|
7638
|
+
},
|
|
7498
7639
|
created_at: {
|
|
7499
7640
|
description: "Date and time at which Seam created the error.",
|
|
7500
7641
|
format: "date-time",
|
|
@@ -7513,12 +7654,37 @@ var openapi = {
|
|
|
7513
7654
|
message: {
|
|
7514
7655
|
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
7515
7656
|
type: "string"
|
|
7657
|
+
},
|
|
7658
|
+
modified_fields: {
|
|
7659
|
+
description: "List of fields that were changed externally, with their previous and new values.",
|
|
7660
|
+
items: {
|
|
7661
|
+
properties: {
|
|
7662
|
+
field: {
|
|
7663
|
+
description: "The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).",
|
|
7664
|
+
type: "string"
|
|
7665
|
+
},
|
|
7666
|
+
from: {
|
|
7667
|
+
description: "The previous value of the field.",
|
|
7668
|
+
nullable: true,
|
|
7669
|
+
type: "string"
|
|
7670
|
+
},
|
|
7671
|
+
to: {
|
|
7672
|
+
description: "The new value of the field.",
|
|
7673
|
+
nullable: true,
|
|
7674
|
+
type: "string"
|
|
7675
|
+
}
|
|
7676
|
+
},
|
|
7677
|
+
required: ["field", "from", "to"],
|
|
7678
|
+
type: "object"
|
|
7679
|
+
},
|
|
7680
|
+
type: "array"
|
|
7516
7681
|
}
|
|
7517
7682
|
},
|
|
7518
7683
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7519
7684
|
type: "object"
|
|
7520
7685
|
},
|
|
7521
7686
|
{
|
|
7687
|
+
deprecated: true,
|
|
7522
7688
|
description: "Invalid code length for August lock.",
|
|
7523
7689
|
properties: {
|
|
7524
7690
|
created_at: {
|
|
@@ -7542,9 +7708,11 @@ var openapi = {
|
|
|
7542
7708
|
}
|
|
7543
7709
|
},
|
|
7544
7710
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7545
|
-
type: "object"
|
|
7711
|
+
type: "object",
|
|
7712
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
7546
7713
|
},
|
|
7547
7714
|
{
|
|
7715
|
+
deprecated: true,
|
|
7548
7716
|
description: "August lock is missing a keypad.",
|
|
7549
7717
|
properties: {
|
|
7550
7718
|
created_at: {
|
|
@@ -7568,9 +7736,11 @@ var openapi = {
|
|
|
7568
7736
|
}
|
|
7569
7737
|
},
|
|
7570
7738
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7571
|
-
type: "object"
|
|
7739
|
+
type: "object",
|
|
7740
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
7572
7741
|
},
|
|
7573
7742
|
{
|
|
7743
|
+
deprecated: true,
|
|
7574
7744
|
description: "August lock is temporarily offline.",
|
|
7575
7745
|
properties: {
|
|
7576
7746
|
created_at: {
|
|
@@ -7594,9 +7764,37 @@ var openapi = {
|
|
|
7594
7764
|
}
|
|
7595
7765
|
},
|
|
7596
7766
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7767
|
+
type: "object",
|
|
7768
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
7769
|
+
},
|
|
7770
|
+
{
|
|
7771
|
+
description: "Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.",
|
|
7772
|
+
properties: {
|
|
7773
|
+
created_at: {
|
|
7774
|
+
description: "Date and time at which Seam created the error.",
|
|
7775
|
+
format: "date-time",
|
|
7776
|
+
type: "string"
|
|
7777
|
+
},
|
|
7778
|
+
error_code: {
|
|
7779
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
7780
|
+
enum: ["access_code_inactive"],
|
|
7781
|
+
type: "string"
|
|
7782
|
+
},
|
|
7783
|
+
is_access_code_error: {
|
|
7784
|
+
description: "Indicates that this is an access code error.",
|
|
7785
|
+
enum: [true],
|
|
7786
|
+
type: "boolean"
|
|
7787
|
+
},
|
|
7788
|
+
message: {
|
|
7789
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
7790
|
+
type: "string"
|
|
7791
|
+
}
|
|
7792
|
+
},
|
|
7793
|
+
required: ["message", "is_access_code_error", "error_code"],
|
|
7597
7794
|
type: "object"
|
|
7598
7795
|
},
|
|
7599
7796
|
{
|
|
7797
|
+
deprecated: true,
|
|
7600
7798
|
description: "Salto site user is not subscribed.",
|
|
7601
7799
|
properties: {
|
|
7602
7800
|
created_at: {
|
|
@@ -7620,7 +7818,8 @@ var openapi = {
|
|
|
7620
7818
|
}
|
|
7621
7819
|
},
|
|
7622
7820
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7623
|
-
type: "object"
|
|
7821
|
+
type: "object",
|
|
7822
|
+
"x-deprecated": "Use `access_code_inactive` instead."
|
|
7624
7823
|
},
|
|
7625
7824
|
{
|
|
7626
7825
|
deprecated: true,
|
|
@@ -7679,6 +7878,7 @@ var openapi = {
|
|
|
7679
7878
|
"x-deprecated": "Use `duplicate_code_on_device` instead."
|
|
7680
7879
|
},
|
|
7681
7880
|
{
|
|
7881
|
+
deprecated: true,
|
|
7682
7882
|
description: "No Dormakaba Oracode user levels configured for the requested time range.",
|
|
7683
7883
|
properties: {
|
|
7684
7884
|
created_at: {
|
|
@@ -7702,9 +7902,11 @@ var openapi = {
|
|
|
7702
7902
|
}
|
|
7703
7903
|
},
|
|
7704
7904
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7705
|
-
type: "object"
|
|
7905
|
+
type: "object",
|
|
7906
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
7706
7907
|
},
|
|
7707
7908
|
{
|
|
7909
|
+
deprecated: true,
|
|
7708
7910
|
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.",
|
|
7709
7911
|
properties: {
|
|
7710
7912
|
created_at: {
|
|
@@ -7728,9 +7930,11 @@ var openapi = {
|
|
|
7728
7930
|
}
|
|
7729
7931
|
},
|
|
7730
7932
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7731
|
-
type: "object"
|
|
7933
|
+
type: "object",
|
|
7934
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
7732
7935
|
},
|
|
7733
7936
|
{
|
|
7937
|
+
deprecated: true,
|
|
7734
7938
|
description: "KeyNest locker is not supported.",
|
|
7735
7939
|
properties: {
|
|
7736
7940
|
created_at: {
|
|
@@ -7754,7 +7958,8 @@ var openapi = {
|
|
|
7754
7958
|
}
|
|
7755
7959
|
},
|
|
7756
7960
|
required: ["message", "is_access_code_error", "error_code"],
|
|
7757
|
-
type: "object"
|
|
7961
|
+
type: "object",
|
|
7962
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
7758
7963
|
},
|
|
7759
7964
|
{
|
|
7760
7965
|
description: "This access code was overridden on the device by a newer access code programmed to the same slot.",
|
|
@@ -8598,6 +8803,27 @@ var openapi = {
|
|
|
8598
8803
|
description: "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
8599
8804
|
discriminator: { propertyName: "warning_code" },
|
|
8600
8805
|
oneOf: [
|
|
8806
|
+
{
|
|
8807
|
+
description: "Indicates a provider-specific issue that may affect the access code. Check the warning message for details.",
|
|
8808
|
+
properties: {
|
|
8809
|
+
created_at: {
|
|
8810
|
+
description: "Date and time at which Seam created the warning.",
|
|
8811
|
+
format: "date-time",
|
|
8812
|
+
type: "string"
|
|
8813
|
+
},
|
|
8814
|
+
message: {
|
|
8815
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
8816
|
+
type: "string"
|
|
8817
|
+
},
|
|
8818
|
+
warning_code: {
|
|
8819
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
8820
|
+
enum: ["provider_issue"],
|
|
8821
|
+
type: "string"
|
|
8822
|
+
}
|
|
8823
|
+
},
|
|
8824
|
+
required: ["message", "warning_code"],
|
|
8825
|
+
type: "object"
|
|
8826
|
+
},
|
|
8601
8827
|
{
|
|
8602
8828
|
description: "Failed to set code on SmartThings device.",
|
|
8603
8829
|
properties: {
|
|
@@ -8643,6 +8869,7 @@ var openapi = {
|
|
|
8643
8869
|
"x-deprecated": "Use `duplicate_code_on_device` error instead."
|
|
8644
8870
|
},
|
|
8645
8871
|
{
|
|
8872
|
+
deprecated: true,
|
|
8646
8873
|
description: "Received an error when attempting to create this code.",
|
|
8647
8874
|
properties: {
|
|
8648
8875
|
created_at: {
|
|
@@ -8661,7 +8888,8 @@ var openapi = {
|
|
|
8661
8888
|
}
|
|
8662
8889
|
},
|
|
8663
8890
|
required: ["message", "warning_code"],
|
|
8664
|
-
type: "object"
|
|
8891
|
+
type: "object",
|
|
8892
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
8665
8893
|
},
|
|
8666
8894
|
{
|
|
8667
8895
|
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.",
|
|
@@ -8687,6 +8915,11 @@ var openapi = {
|
|
|
8687
8915
|
{
|
|
8688
8916
|
description: "Code was modified or removed externally after Seam successfully set it on the device.",
|
|
8689
8917
|
properties: {
|
|
8918
|
+
change_type: {
|
|
8919
|
+
description: "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
|
|
8920
|
+
enum: ["modified", "removed"],
|
|
8921
|
+
type: "string"
|
|
8922
|
+
},
|
|
8690
8923
|
created_at: {
|
|
8691
8924
|
description: "Date and time at which Seam created the warning.",
|
|
8692
8925
|
format: "date-time",
|
|
@@ -8696,6 +8929,30 @@ var openapi = {
|
|
|
8696
8929
|
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
8697
8930
|
type: "string"
|
|
8698
8931
|
},
|
|
8932
|
+
modified_fields: {
|
|
8933
|
+
description: "List of fields that were changed externally, with their previous and new values.",
|
|
8934
|
+
items: {
|
|
8935
|
+
properties: {
|
|
8936
|
+
field: {
|
|
8937
|
+
description: "The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).",
|
|
8938
|
+
type: "string"
|
|
8939
|
+
},
|
|
8940
|
+
from: {
|
|
8941
|
+
description: "The previous value of the field.",
|
|
8942
|
+
nullable: true,
|
|
8943
|
+
type: "string"
|
|
8944
|
+
},
|
|
8945
|
+
to: {
|
|
8946
|
+
description: "The new value of the field.",
|
|
8947
|
+
nullable: true,
|
|
8948
|
+
type: "string"
|
|
8949
|
+
}
|
|
8950
|
+
},
|
|
8951
|
+
required: ["field", "from", "to"],
|
|
8952
|
+
type: "object"
|
|
8953
|
+
},
|
|
8954
|
+
type: "array"
|
|
8955
|
+
},
|
|
8699
8956
|
warning_code: {
|
|
8700
8957
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
8701
8958
|
enum: ["code_modified_external_to_seam"],
|
|
@@ -31719,6 +31976,33 @@ var openapi = {
|
|
|
31719
31976
|
discriminator: { propertyName: "error_code" },
|
|
31720
31977
|
oneOf: [
|
|
31721
31978
|
{
|
|
31979
|
+
description: "Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.",
|
|
31980
|
+
properties: {
|
|
31981
|
+
created_at: {
|
|
31982
|
+
description: "Date and time at which Seam created the error.",
|
|
31983
|
+
format: "date-time",
|
|
31984
|
+
type: "string"
|
|
31985
|
+
},
|
|
31986
|
+
error_code: {
|
|
31987
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
31988
|
+
enum: ["provider_issue"],
|
|
31989
|
+
type: "string"
|
|
31990
|
+
},
|
|
31991
|
+
is_access_code_error: {
|
|
31992
|
+
description: "Indicates that this is an access code error.",
|
|
31993
|
+
enum: [true],
|
|
31994
|
+
type: "boolean"
|
|
31995
|
+
},
|
|
31996
|
+
message: {
|
|
31997
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
31998
|
+
type: "string"
|
|
31999
|
+
}
|
|
32000
|
+
},
|
|
32001
|
+
required: ["message", "is_access_code_error", "error_code"],
|
|
32002
|
+
type: "object"
|
|
32003
|
+
},
|
|
32004
|
+
{
|
|
32005
|
+
deprecated: true,
|
|
31722
32006
|
description: "Failed to set code on SmartThings device.",
|
|
31723
32007
|
properties: {
|
|
31724
32008
|
created_at: {
|
|
@@ -31742,9 +32026,11 @@ var openapi = {
|
|
|
31742
32026
|
}
|
|
31743
32027
|
},
|
|
31744
32028
|
required: ["message", "is_access_code_error", "error_code"],
|
|
31745
|
-
type: "object"
|
|
32029
|
+
type: "object",
|
|
32030
|
+
"x-deprecated": "Handled by the generic `failed_to_set_on_device` system."
|
|
31746
32031
|
},
|
|
31747
32032
|
{
|
|
32033
|
+
deprecated: true,
|
|
31748
32034
|
description: "Failed to set code after multiple retries.",
|
|
31749
32035
|
properties: {
|
|
31750
32036
|
created_at: {
|
|
@@ -31770,7 +32056,8 @@ var openapi = {
|
|
|
31770
32056
|
}
|
|
31771
32057
|
},
|
|
31772
32058
|
required: ["message", "is_access_code_error", "error_code"],
|
|
31773
|
-
type: "object"
|
|
32059
|
+
type: "object",
|
|
32060
|
+
"x-deprecated": "Handled by the generic `failed_to_set_on_device` system."
|
|
31774
32061
|
},
|
|
31775
32062
|
{
|
|
31776
32063
|
description: "Failed to set code on device.",
|
|
@@ -31997,6 +32284,11 @@ var openapi = {
|
|
|
31997
32284
|
{
|
|
31998
32285
|
description: "Code was modified or removed externally after Seam successfully set it on the device.",
|
|
31999
32286
|
properties: {
|
|
32287
|
+
change_type: {
|
|
32288
|
+
description: "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
|
|
32289
|
+
enum: ["modified", "removed"],
|
|
32290
|
+
type: "string"
|
|
32291
|
+
},
|
|
32000
32292
|
created_at: {
|
|
32001
32293
|
description: "Date and time at which Seam created the error.",
|
|
32002
32294
|
format: "date-time",
|
|
@@ -32015,12 +32307,37 @@ var openapi = {
|
|
|
32015
32307
|
message: {
|
|
32016
32308
|
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
32017
32309
|
type: "string"
|
|
32310
|
+
},
|
|
32311
|
+
modified_fields: {
|
|
32312
|
+
description: "List of fields that were changed externally, with their previous and new values.",
|
|
32313
|
+
items: {
|
|
32314
|
+
properties: {
|
|
32315
|
+
field: {
|
|
32316
|
+
description: "The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).",
|
|
32317
|
+
type: "string"
|
|
32318
|
+
},
|
|
32319
|
+
from: {
|
|
32320
|
+
description: "The previous value of the field.",
|
|
32321
|
+
nullable: true,
|
|
32322
|
+
type: "string"
|
|
32323
|
+
},
|
|
32324
|
+
to: {
|
|
32325
|
+
description: "The new value of the field.",
|
|
32326
|
+
nullable: true,
|
|
32327
|
+
type: "string"
|
|
32328
|
+
}
|
|
32329
|
+
},
|
|
32330
|
+
required: ["field", "from", "to"],
|
|
32331
|
+
type: "object"
|
|
32332
|
+
},
|
|
32333
|
+
type: "array"
|
|
32018
32334
|
}
|
|
32019
32335
|
},
|
|
32020
32336
|
required: ["message", "is_access_code_error", "error_code"],
|
|
32021
32337
|
type: "object"
|
|
32022
32338
|
},
|
|
32023
32339
|
{
|
|
32340
|
+
deprecated: true,
|
|
32024
32341
|
description: "Invalid code length for August lock.",
|
|
32025
32342
|
properties: {
|
|
32026
32343
|
created_at: {
|
|
@@ -32044,9 +32361,11 @@ var openapi = {
|
|
|
32044
32361
|
}
|
|
32045
32362
|
},
|
|
32046
32363
|
required: ["message", "is_access_code_error", "error_code"],
|
|
32047
|
-
type: "object"
|
|
32364
|
+
type: "object",
|
|
32365
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
32048
32366
|
},
|
|
32049
32367
|
{
|
|
32368
|
+
deprecated: true,
|
|
32050
32369
|
description: "August lock is missing a keypad.",
|
|
32051
32370
|
properties: {
|
|
32052
32371
|
created_at: {
|
|
@@ -32070,9 +32389,11 @@ var openapi = {
|
|
|
32070
32389
|
}
|
|
32071
32390
|
},
|
|
32072
32391
|
required: ["message", "is_access_code_error", "error_code"],
|
|
32073
|
-
type: "object"
|
|
32392
|
+
type: "object",
|
|
32393
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
32074
32394
|
},
|
|
32075
32395
|
{
|
|
32396
|
+
deprecated: true,
|
|
32076
32397
|
description: "August lock is temporarily offline.",
|
|
32077
32398
|
properties: {
|
|
32078
32399
|
created_at: {
|
|
@@ -32096,9 +32417,37 @@ var openapi = {
|
|
|
32096
32417
|
}
|
|
32097
32418
|
},
|
|
32098
32419
|
required: ["message", "is_access_code_error", "error_code"],
|
|
32420
|
+
type: "object",
|
|
32421
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
32422
|
+
},
|
|
32423
|
+
{
|
|
32424
|
+
description: "Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.",
|
|
32425
|
+
properties: {
|
|
32426
|
+
created_at: {
|
|
32427
|
+
description: "Date and time at which Seam created the error.",
|
|
32428
|
+
format: "date-time",
|
|
32429
|
+
type: "string"
|
|
32430
|
+
},
|
|
32431
|
+
error_code: {
|
|
32432
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
32433
|
+
enum: ["access_code_inactive"],
|
|
32434
|
+
type: "string"
|
|
32435
|
+
},
|
|
32436
|
+
is_access_code_error: {
|
|
32437
|
+
description: "Indicates that this is an access code error.",
|
|
32438
|
+
enum: [true],
|
|
32439
|
+
type: "boolean"
|
|
32440
|
+
},
|
|
32441
|
+
message: {
|
|
32442
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
32443
|
+
type: "string"
|
|
32444
|
+
}
|
|
32445
|
+
},
|
|
32446
|
+
required: ["message", "is_access_code_error", "error_code"],
|
|
32099
32447
|
type: "object"
|
|
32100
32448
|
},
|
|
32101
32449
|
{
|
|
32450
|
+
deprecated: true,
|
|
32102
32451
|
description: "Salto site user is not subscribed.",
|
|
32103
32452
|
properties: {
|
|
32104
32453
|
created_at: {
|
|
@@ -32122,7 +32471,8 @@ var openapi = {
|
|
|
32122
32471
|
}
|
|
32123
32472
|
},
|
|
32124
32473
|
required: ["message", "is_access_code_error", "error_code"],
|
|
32125
|
-
type: "object"
|
|
32474
|
+
type: "object",
|
|
32475
|
+
"x-deprecated": "Use `access_code_inactive` instead."
|
|
32126
32476
|
},
|
|
32127
32477
|
{
|
|
32128
32478
|
deprecated: true,
|
|
@@ -32181,6 +32531,7 @@ var openapi = {
|
|
|
32181
32531
|
"x-deprecated": "Use `duplicate_code_on_device` instead."
|
|
32182
32532
|
},
|
|
32183
32533
|
{
|
|
32534
|
+
deprecated: true,
|
|
32184
32535
|
description: "No Dormakaba Oracode user levels configured for the requested time range.",
|
|
32185
32536
|
properties: {
|
|
32186
32537
|
created_at: {
|
|
@@ -32204,9 +32555,11 @@ var openapi = {
|
|
|
32204
32555
|
}
|
|
32205
32556
|
},
|
|
32206
32557
|
required: ["message", "is_access_code_error", "error_code"],
|
|
32207
|
-
type: "object"
|
|
32558
|
+
type: "object",
|
|
32559
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
32208
32560
|
},
|
|
32209
32561
|
{
|
|
32562
|
+
deprecated: true,
|
|
32210
32563
|
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.",
|
|
32211
32564
|
properties: {
|
|
32212
32565
|
created_at: {
|
|
@@ -32230,9 +32583,11 @@ var openapi = {
|
|
|
32230
32583
|
}
|
|
32231
32584
|
},
|
|
32232
32585
|
required: ["message", "is_access_code_error", "error_code"],
|
|
32233
|
-
type: "object"
|
|
32586
|
+
type: "object",
|
|
32587
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
32234
32588
|
},
|
|
32235
32589
|
{
|
|
32590
|
+
deprecated: true,
|
|
32236
32591
|
description: "KeyNest locker is not supported.",
|
|
32237
32592
|
properties: {
|
|
32238
32593
|
created_at: {
|
|
@@ -32256,7 +32611,8 @@ var openapi = {
|
|
|
32256
32611
|
}
|
|
32257
32612
|
},
|
|
32258
32613
|
required: ["message", "is_access_code_error", "error_code"],
|
|
32259
|
-
type: "object"
|
|
32614
|
+
type: "object",
|
|
32615
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
32260
32616
|
},
|
|
32261
32617
|
{
|
|
32262
32618
|
description: "This access code was overridden on the device by a newer access code programmed to the same slot.",
|
|
@@ -32817,6 +33173,27 @@ var openapi = {
|
|
|
32817
33173
|
description: "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
|
|
32818
33174
|
discriminator: { propertyName: "warning_code" },
|
|
32819
33175
|
oneOf: [
|
|
33176
|
+
{
|
|
33177
|
+
description: "Indicates a provider-specific issue that may affect the access code. Check the warning message for details.",
|
|
33178
|
+
properties: {
|
|
33179
|
+
created_at: {
|
|
33180
|
+
description: "Date and time at which Seam created the warning.",
|
|
33181
|
+
format: "date-time",
|
|
33182
|
+
type: "string"
|
|
33183
|
+
},
|
|
33184
|
+
message: {
|
|
33185
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
33186
|
+
type: "string"
|
|
33187
|
+
},
|
|
33188
|
+
warning_code: {
|
|
33189
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
33190
|
+
enum: ["provider_issue"],
|
|
33191
|
+
type: "string"
|
|
33192
|
+
}
|
|
33193
|
+
},
|
|
33194
|
+
required: ["message", "warning_code"],
|
|
33195
|
+
type: "object"
|
|
33196
|
+
},
|
|
32820
33197
|
{
|
|
32821
33198
|
description: "Failed to set code on SmartThings device.",
|
|
32822
33199
|
properties: {
|
|
@@ -32862,6 +33239,7 @@ var openapi = {
|
|
|
32862
33239
|
"x-deprecated": "Use `duplicate_code_on_device` error instead."
|
|
32863
33240
|
},
|
|
32864
33241
|
{
|
|
33242
|
+
deprecated: true,
|
|
32865
33243
|
description: "Received an error when attempting to create this code.",
|
|
32866
33244
|
properties: {
|
|
32867
33245
|
created_at: {
|
|
@@ -32880,7 +33258,8 @@ var openapi = {
|
|
|
32880
33258
|
}
|
|
32881
33259
|
},
|
|
32882
33260
|
required: ["message", "warning_code"],
|
|
32883
|
-
type: "object"
|
|
33261
|
+
type: "object",
|
|
33262
|
+
"x-deprecated": "Use `provider_issue` instead."
|
|
32884
33263
|
},
|
|
32885
33264
|
{
|
|
32886
33265
|
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.",
|
|
@@ -32906,6 +33285,11 @@ var openapi = {
|
|
|
32906
33285
|
{
|
|
32907
33286
|
description: "Code was modified or removed externally after Seam successfully set it on the device.",
|
|
32908
33287
|
properties: {
|
|
33288
|
+
change_type: {
|
|
33289
|
+
description: "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
|
|
33290
|
+
enum: ["modified", "removed"],
|
|
33291
|
+
type: "string"
|
|
33292
|
+
},
|
|
32909
33293
|
created_at: {
|
|
32910
33294
|
description: "Date and time at which Seam created the warning.",
|
|
32911
33295
|
format: "date-time",
|
|
@@ -32915,6 +33299,30 @@ var openapi = {
|
|
|
32915
33299
|
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
32916
33300
|
type: "string"
|
|
32917
33301
|
},
|
|
33302
|
+
modified_fields: {
|
|
33303
|
+
description: "List of fields that were changed externally, with their previous and new values.",
|
|
33304
|
+
items: {
|
|
33305
|
+
properties: {
|
|
33306
|
+
field: {
|
|
33307
|
+
description: "The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).",
|
|
33308
|
+
type: "string"
|
|
33309
|
+
},
|
|
33310
|
+
from: {
|
|
33311
|
+
description: "The previous value of the field.",
|
|
33312
|
+
nullable: true,
|
|
33313
|
+
type: "string"
|
|
33314
|
+
},
|
|
33315
|
+
to: {
|
|
33316
|
+
description: "The new value of the field.",
|
|
33317
|
+
nullable: true,
|
|
33318
|
+
type: "string"
|
|
33319
|
+
}
|
|
33320
|
+
},
|
|
33321
|
+
required: ["field", "from", "to"],
|
|
33322
|
+
type: "object"
|
|
33323
|
+
},
|
|
33324
|
+
type: "array"
|
|
33325
|
+
},
|
|
32918
33326
|
warning_code: {
|
|
32919
33327
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
32920
33328
|
enum: ["code_modified_external_to_seam"],
|