@seamapi/types 1.404.1 → 1.404.3
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 +416 -138
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +448 -122
- package/lib/seam/connect/models/access-codes/managed-access-code.js +2 -8
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/connected-accounts/connected-account.js +121 -41
- package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +1 -1
- package/lib/seam/connect/models/devices/device-provider.js +0 -1
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +125 -9
- package/lib/seam/connect/openapi.js +328 -90
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +323 -113
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +2 -8
- package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +172 -44
- package/src/lib/seam/connect/models/devices/device-provider.ts +0 -1
- package/src/lib/seam/connect/openapi.ts +404 -90
- package/src/lib/seam/connect/route-types.ts +330 -113
package/dist/connect.cjs
CHANGED
|
@@ -532,15 +532,21 @@ var custom_metadata = zod.z.record(zod.z.string(), zod.z.union([zod.z.string(),
|
|
|
532
532
|
// src/lib/seam/connect/models/connected-accounts/connected-account.ts
|
|
533
533
|
var common_connected_account_error = zod.z.object({
|
|
534
534
|
created_at: zod.z.string().datetime().describe("Date and time at which Seam created the error."),
|
|
535
|
-
message: zod.z.string()
|
|
536
|
-
|
|
537
|
-
|
|
535
|
+
message: zod.z.string().describe(
|
|
536
|
+
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
537
|
+
),
|
|
538
|
+
is_connected_account_error: zod.z.boolean().optional().describe(
|
|
539
|
+
"Indicates whether the error is related specifically to the connected account."
|
|
540
|
+
),
|
|
541
|
+
is_bridge_error: zod.z.boolean().optional().describe("Indicates whether the error is related to Seam Bridge.")
|
|
538
542
|
});
|
|
539
543
|
var error_code_description = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
|
|
540
544
|
var warning_code_description = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
|
|
541
545
|
var common_connected_account_warning = zod.z.object({
|
|
542
546
|
created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
|
|
543
|
-
message: zod.z.string()
|
|
547
|
+
message: zod.z.string().describe(
|
|
548
|
+
"Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
|
|
549
|
+
)
|
|
544
550
|
});
|
|
545
551
|
var account_disconnected = common_connected_account_error.extend({
|
|
546
552
|
error_code: zod.z.literal("account_disconnected").describe(error_code_description)
|
|
@@ -550,20 +556,35 @@ var invalid_credentials = common_connected_account_error.extend({
|
|
|
550
556
|
}).describe("Credentials provided were invalid.");
|
|
551
557
|
var bridge_disconnected = common_connected_account_error.extend({
|
|
552
558
|
error_code: zod.z.literal("bridge_disconnected").describe(error_code_description)
|
|
553
|
-
}).describe(
|
|
554
|
-
See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected)
|
|
559
|
+
}).describe(
|
|
560
|
+
"Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected)."
|
|
561
|
+
);
|
|
555
562
|
var salto_ks_subscription_limit_exceeded = common_connected_account_error.extend({
|
|
556
563
|
error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description),
|
|
557
564
|
salto_ks_metadata: zod.z.object({
|
|
558
565
|
sites: zod.z.array(
|
|
559
566
|
zod.z.object({
|
|
560
|
-
site_id: zod.z.string()
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
567
|
+
site_id: zod.z.string().describe(
|
|
568
|
+
"ID of a Salto site associated with the connected account that has an error."
|
|
569
|
+
),
|
|
570
|
+
site_name: zod.z.string().describe(
|
|
571
|
+
"Name of a Salto site associated with the connected account that has an error."
|
|
572
|
+
),
|
|
573
|
+
subscribed_site_user_count: zod.z.number().int().min(0).describe(
|
|
574
|
+
"Count of subscribed site users for a Salto site associated with the connected account that has an error."
|
|
575
|
+
),
|
|
576
|
+
site_user_subscription_limit: zod.z.number().int().min(0).describe(
|
|
577
|
+
"Subscription limit of site users for a Salto site associated with the connected account that has an error."
|
|
578
|
+
)
|
|
579
|
+
}).describe(
|
|
580
|
+
"Salto site associated with the connected account that has an error."
|
|
581
|
+
)
|
|
582
|
+
).describe(
|
|
583
|
+
"Salto sites associated with the connected account that has an error."
|
|
565
584
|
)
|
|
566
|
-
})
|
|
585
|
+
}).describe(
|
|
586
|
+
"Salto KS metadata associated with the connected account that has an error."
|
|
587
|
+
)
|
|
567
588
|
}).describe(
|
|
568
589
|
"Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit."
|
|
569
590
|
);
|
|
@@ -582,52 +603,78 @@ zod.z.object({
|
|
|
582
603
|
var unknown_issue_with_connected_account = common_connected_account_warning.extend({
|
|
583
604
|
warning_code: zod.z.literal("unknown_issue_with_connected_account").describe(warning_code_description)
|
|
584
605
|
}).describe(
|
|
585
|
-
"An unknown issue occurred while syncing the state of
|
|
606
|
+
"An unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account."
|
|
586
607
|
);
|
|
587
608
|
var scheduled_maintenance_window = common_connected_account_warning.extend({
|
|
588
609
|
warning_code: zod.z.literal("scheduled_maintenance_window").describe(warning_code_description)
|
|
589
|
-
}).describe("Scheduled downtime for account
|
|
610
|
+
}).describe("Scheduled downtime planned for the connected account.");
|
|
590
611
|
var salto_ks_subscription_limit_almost_reached = common_connected_account_warning.extend({
|
|
591
612
|
warning_code: zod.z.literal("salto_ks_subscription_limit_almost_reached").describe(warning_code_description),
|
|
592
613
|
salto_ks_metadata: zod.z.object({
|
|
593
614
|
sites: zod.z.array(
|
|
594
615
|
zod.z.object({
|
|
595
|
-
site_id: zod.z.string()
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
616
|
+
site_id: zod.z.string().describe(
|
|
617
|
+
"ID of a Salto site associated with the connected account that has a warning."
|
|
618
|
+
),
|
|
619
|
+
site_name: zod.z.string().describe(
|
|
620
|
+
"Name of a Salto site associated with the connected account that has a warning."
|
|
621
|
+
),
|
|
622
|
+
site_user_subscription_limit: zod.z.number().int().min(0).describe(
|
|
623
|
+
"Subscription limit of site users for a Salto site associated with the connected account that has a warning."
|
|
624
|
+
),
|
|
625
|
+
subscribed_site_user_count: zod.z.number().int().min(0).describe(
|
|
626
|
+
"Count of subscribed site users for a Salto site associated with the connected account that has a warning."
|
|
627
|
+
)
|
|
628
|
+
}).describe(
|
|
629
|
+
"Salto site associated with the connected account that has a warning."
|
|
630
|
+
)
|
|
631
|
+
).describe(
|
|
632
|
+
"Salto sites associated with the connected account that has a warning."
|
|
600
633
|
)
|
|
601
|
-
})
|
|
634
|
+
}).describe(
|
|
635
|
+
"Salto KS metadata associated with the connected account that has a warning."
|
|
636
|
+
)
|
|
602
637
|
}).describe(
|
|
603
|
-
"Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users.
|
|
638
|
+
"Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site."
|
|
604
639
|
);
|
|
605
640
|
var connected_account_warning = zod.z.discriminatedUnion("warning_code", [
|
|
606
641
|
scheduled_maintenance_window,
|
|
607
642
|
unknown_issue_with_connected_account,
|
|
608
643
|
salto_ks_subscription_limit_almost_reached
|
|
609
|
-
]).describe("Warning associated with the
|
|
644
|
+
]).describe("Warning associated with the connected account.");
|
|
610
645
|
zod.z.object({
|
|
611
646
|
scheduled_maintenance_window: scheduled_maintenance_window.nullable().optional(),
|
|
612
647
|
unknown_issue_with_connected_account: unknown_issue_with_connected_account.nullable().optional(),
|
|
613
648
|
salto_ks_subscription_limit_almost_reached: salto_ks_subscription_limit_almost_reached.nullable().optional()
|
|
614
649
|
});
|
|
615
650
|
var connected_account = zod.z.object({
|
|
616
|
-
connected_account_id: zod.z.string().uuid().optional(),
|
|
617
|
-
created_at: zod.z.string().datetime().optional(),
|
|
651
|
+
connected_account_id: zod.z.string().uuid().optional().describe("Unique identifier for the connected account."),
|
|
652
|
+
created_at: zod.z.string().datetime().optional().describe("Date and time at which the connected account was created."),
|
|
618
653
|
user_identifier: zod.z.object({
|
|
619
|
-
username: zod.z.string().optional()
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
654
|
+
username: zod.z.string().optional().describe(
|
|
655
|
+
"Username of the user identifier associated with the connected account."
|
|
656
|
+
),
|
|
657
|
+
api_url: zod.z.string().optional().describe(
|
|
658
|
+
"API URL for the user identifier associated with the connected account."
|
|
659
|
+
),
|
|
660
|
+
email: zod.z.string().optional().describe(
|
|
661
|
+
"Email address of the user identifier associated with the connected account."
|
|
662
|
+
),
|
|
663
|
+
phone: zod.z.string().optional().describe(
|
|
664
|
+
"Phone number of the user identifier associated with the connected account."
|
|
665
|
+
),
|
|
666
|
+
exclusive: zod.z.boolean().optional().describe(
|
|
667
|
+
"Indicates whether the user identifier associated with the connected account is exclusive."
|
|
668
|
+
)
|
|
669
|
+
}).optional().describe("User identifier associated with the connected account."),
|
|
670
|
+
account_type: zod.z.string().optional().describe("Type of connected account."),
|
|
671
|
+
account_type_display_name: zod.z.string().describe("Display name for the connected account type."),
|
|
672
|
+
errors: zod.z.array(connected_account_error).describe("Errors associated with the connected account."),
|
|
673
|
+
warnings: zod.z.array(connected_account_warning).describe("Warnings associated with the connected account."),
|
|
629
674
|
custom_metadata,
|
|
630
|
-
automatically_manage_new_devices: zod.z.boolean()
|
|
675
|
+
automatically_manage_new_devices: zod.z.boolean().describe(
|
|
676
|
+
"Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API."
|
|
677
|
+
)
|
|
631
678
|
}).describe(`
|
|
632
679
|
---
|
|
633
680
|
route_path: /connected_accounts
|
|
@@ -1390,7 +1437,6 @@ var PROVIDER_CATEGORY_MAP = {
|
|
|
1390
1437
|
thermostats: ["ecobee", "nest", "sensi", "honeywell_resideo"],
|
|
1391
1438
|
noise_sensors: ["minut", "noiseaware"],
|
|
1392
1439
|
access_control_systems: [
|
|
1393
|
-
"pti",
|
|
1394
1440
|
"visionline",
|
|
1395
1441
|
"assa_abloy_credential_service",
|
|
1396
1442
|
"latch",
|
|
@@ -1683,13 +1729,7 @@ var access_code = zod.z.object({
|
|
|
1683
1729
|
"Unique identifier for the device associated with the access code."
|
|
1684
1730
|
),
|
|
1685
1731
|
name: zod.z.string().nullable().describe(
|
|
1686
|
-
|
|
1687
|
-
|
|
1688
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as \`first_name\` and \`last_name\`.
|
|
1689
|
-
|
|
1690
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
1691
|
-
|
|
1692
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called \`appearance\`. This is an object with a \`name\` property and, optionally, \`first_name\` and \`last_name\` properties (for providers that break down a name into components).`
|
|
1732
|
+
"Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components)."
|
|
1693
1733
|
),
|
|
1694
1734
|
code: zod.z.string().nullable().describe(
|
|
1695
1735
|
"Code used for access. Typically, a numeric or alphanumeric string."
|
|
@@ -1714,7 +1754,7 @@ var access_code = zod.z.object({
|
|
|
1714
1754
|
"Date and time after which the time-bound access code becomes inactive."
|
|
1715
1755
|
),
|
|
1716
1756
|
status: zod.z.enum(["setting", "set", "unset", "removing", "unknown"]).describe(
|
|
1717
|
-
"Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting."
|
|
1757
|
+
"Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes)."
|
|
1718
1758
|
),
|
|
1719
1759
|
is_backup_access_code_available: zod.z.boolean().describe(
|
|
1720
1760
|
"Indicates whether a backup access code is available for use if the primary access code is lost or compromised."
|
|
@@ -5608,15 +5648,24 @@ var openapi_default = {
|
|
|
5608
5648
|
enum: ["invalid_credentials"],
|
|
5609
5649
|
type: "string"
|
|
5610
5650
|
},
|
|
5611
|
-
is_bridge_error: {
|
|
5612
|
-
|
|
5613
|
-
|
|
5651
|
+
is_bridge_error: {
|
|
5652
|
+
description: "Indicates whether the error is related to Seam Bridge.",
|
|
5653
|
+
type: "boolean"
|
|
5654
|
+
},
|
|
5655
|
+
is_connected_account_error: {
|
|
5656
|
+
description: "Indicates whether the error is related specifically to the connected account.",
|
|
5657
|
+
type: "boolean"
|
|
5658
|
+
},
|
|
5659
|
+
message: {
|
|
5660
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
5661
|
+
type: "string"
|
|
5662
|
+
}
|
|
5614
5663
|
},
|
|
5615
5664
|
required: ["created_at", "message", "error_code"],
|
|
5616
5665
|
type: "object"
|
|
5617
5666
|
},
|
|
5618
5667
|
{
|
|
5619
|
-
description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline
|
|
5668
|
+
description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
|
|
5620
5669
|
properties: {
|
|
5621
5670
|
created_at: {
|
|
5622
5671
|
description: "Date and time at which Seam created the error.",
|
|
@@ -5628,9 +5677,18 @@ var openapi_default = {
|
|
|
5628
5677
|
enum: ["bridge_disconnected"],
|
|
5629
5678
|
type: "string"
|
|
5630
5679
|
},
|
|
5631
|
-
is_bridge_error: {
|
|
5632
|
-
|
|
5633
|
-
|
|
5680
|
+
is_bridge_error: {
|
|
5681
|
+
description: "Indicates whether the error is related to Seam Bridge.",
|
|
5682
|
+
type: "boolean"
|
|
5683
|
+
},
|
|
5684
|
+
is_connected_account_error: {
|
|
5685
|
+
description: "Indicates whether the error is related specifically to the connected account.",
|
|
5686
|
+
type: "boolean"
|
|
5687
|
+
},
|
|
5688
|
+
message: {
|
|
5689
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
5690
|
+
type: "string"
|
|
5691
|
+
}
|
|
5634
5692
|
},
|
|
5635
5693
|
required: ["created_at", "message", "error_code"],
|
|
5636
5694
|
type: "object"
|
|
@@ -5673,7 +5731,7 @@ var openapi_default = {
|
|
|
5673
5731
|
type: "boolean"
|
|
5674
5732
|
},
|
|
5675
5733
|
name: {
|
|
5676
|
-
description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
5734
|
+
description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
5677
5735
|
nullable: true,
|
|
5678
5736
|
type: "string"
|
|
5679
5737
|
},
|
|
@@ -5690,7 +5748,7 @@ var openapi_default = {
|
|
|
5690
5748
|
type: "string"
|
|
5691
5749
|
},
|
|
5692
5750
|
status: {
|
|
5693
|
-
description: "Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.",
|
|
5751
|
+
description: "Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes).",
|
|
5694
5752
|
enum: ["setting", "set", "unset", "removing", "unknown"],
|
|
5695
5753
|
type: "string"
|
|
5696
5754
|
},
|
|
@@ -11201,11 +11259,28 @@ var openapi_default = {
|
|
|
11201
11259
|
connected_account: {
|
|
11202
11260
|
description: "Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.",
|
|
11203
11261
|
properties: {
|
|
11204
|
-
account_type: {
|
|
11205
|
-
|
|
11206
|
-
|
|
11207
|
-
|
|
11208
|
-
|
|
11262
|
+
account_type: {
|
|
11263
|
+
description: "Type of connected account.",
|
|
11264
|
+
type: "string"
|
|
11265
|
+
},
|
|
11266
|
+
account_type_display_name: {
|
|
11267
|
+
description: "Display name for the connected account type.",
|
|
11268
|
+
type: "string"
|
|
11269
|
+
},
|
|
11270
|
+
automatically_manage_new_devices: {
|
|
11271
|
+
description: "Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.",
|
|
11272
|
+
type: "boolean"
|
|
11273
|
+
},
|
|
11274
|
+
connected_account_id: {
|
|
11275
|
+
description: "Unique identifier for the connected account.",
|
|
11276
|
+
format: "uuid",
|
|
11277
|
+
type: "string"
|
|
11278
|
+
},
|
|
11279
|
+
created_at: {
|
|
11280
|
+
description: "Date and time at which the connected account was created.",
|
|
11281
|
+
format: "date-time",
|
|
11282
|
+
type: "string"
|
|
11283
|
+
},
|
|
11209
11284
|
custom_metadata: {
|
|
11210
11285
|
additionalProperties: {
|
|
11211
11286
|
oneOf: [{ type: "string" }, { type: "boolean" }]
|
|
@@ -11214,6 +11289,7 @@ var openapi_default = {
|
|
|
11214
11289
|
type: "object"
|
|
11215
11290
|
},
|
|
11216
11291
|
errors: {
|
|
11292
|
+
description: "Errors associated with the connected account.",
|
|
11217
11293
|
items: {
|
|
11218
11294
|
discriminator: { propertyName: "error_code" },
|
|
11219
11295
|
oneOf: [
|
|
@@ -11230,9 +11306,18 @@ var openapi_default = {
|
|
|
11230
11306
|
enum: ["account_disconnected"],
|
|
11231
11307
|
type: "string"
|
|
11232
11308
|
},
|
|
11233
|
-
is_bridge_error: {
|
|
11234
|
-
|
|
11235
|
-
|
|
11309
|
+
is_bridge_error: {
|
|
11310
|
+
description: "Indicates whether the error is related to Seam Bridge.",
|
|
11311
|
+
type: "boolean"
|
|
11312
|
+
},
|
|
11313
|
+
is_connected_account_error: {
|
|
11314
|
+
description: "Indicates whether the error is related specifically to the connected account.",
|
|
11315
|
+
type: "boolean"
|
|
11316
|
+
},
|
|
11317
|
+
message: {
|
|
11318
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
11319
|
+
type: "string"
|
|
11320
|
+
}
|
|
11236
11321
|
},
|
|
11237
11322
|
required: ["created_at", "message", "error_code"],
|
|
11238
11323
|
type: "object"
|
|
@@ -11250,15 +11335,24 @@ var openapi_default = {
|
|
|
11250
11335
|
enum: ["invalid_credentials"],
|
|
11251
11336
|
type: "string"
|
|
11252
11337
|
},
|
|
11253
|
-
is_bridge_error: {
|
|
11254
|
-
|
|
11255
|
-
|
|
11338
|
+
is_bridge_error: {
|
|
11339
|
+
description: "Indicates whether the error is related to Seam Bridge.",
|
|
11340
|
+
type: "boolean"
|
|
11341
|
+
},
|
|
11342
|
+
is_connected_account_error: {
|
|
11343
|
+
description: "Indicates whether the error is related specifically to the connected account.",
|
|
11344
|
+
type: "boolean"
|
|
11345
|
+
},
|
|
11346
|
+
message: {
|
|
11347
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
11348
|
+
type: "string"
|
|
11349
|
+
}
|
|
11256
11350
|
},
|
|
11257
11351
|
required: ["created_at", "message", "error_code"],
|
|
11258
11352
|
type: "object"
|
|
11259
11353
|
},
|
|
11260
11354
|
{
|
|
11261
|
-
description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline
|
|
11355
|
+
description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
|
|
11262
11356
|
properties: {
|
|
11263
11357
|
created_at: {
|
|
11264
11358
|
description: "Date and time at which Seam created the error.",
|
|
@@ -11270,9 +11364,18 @@ var openapi_default = {
|
|
|
11270
11364
|
enum: ["bridge_disconnected"],
|
|
11271
11365
|
type: "string"
|
|
11272
11366
|
},
|
|
11273
|
-
is_bridge_error: {
|
|
11274
|
-
|
|
11275
|
-
|
|
11367
|
+
is_bridge_error: {
|
|
11368
|
+
description: "Indicates whether the error is related to Seam Bridge.",
|
|
11369
|
+
type: "boolean"
|
|
11370
|
+
},
|
|
11371
|
+
is_connected_account_error: {
|
|
11372
|
+
description: "Indicates whether the error is related specifically to the connected account.",
|
|
11373
|
+
type: "boolean"
|
|
11374
|
+
},
|
|
11375
|
+
message: {
|
|
11376
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
11377
|
+
type: "string"
|
|
11378
|
+
}
|
|
11276
11379
|
},
|
|
11277
11380
|
required: ["created_at", "message", "error_code"],
|
|
11278
11381
|
type: "object"
|
|
@@ -11290,21 +11393,41 @@ var openapi_default = {
|
|
|
11290
11393
|
enum: ["salto_ks_subscription_limit_exceeded"],
|
|
11291
11394
|
type: "string"
|
|
11292
11395
|
},
|
|
11293
|
-
is_bridge_error: {
|
|
11294
|
-
|
|
11295
|
-
|
|
11396
|
+
is_bridge_error: {
|
|
11397
|
+
description: "Indicates whether the error is related to Seam Bridge.",
|
|
11398
|
+
type: "boolean"
|
|
11399
|
+
},
|
|
11400
|
+
is_connected_account_error: {
|
|
11401
|
+
description: "Indicates whether the error is related specifically to the connected account.",
|
|
11402
|
+
type: "boolean"
|
|
11403
|
+
},
|
|
11404
|
+
message: {
|
|
11405
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
11406
|
+
type: "string"
|
|
11407
|
+
},
|
|
11296
11408
|
salto_ks_metadata: {
|
|
11409
|
+
description: "Salto KS metadata associated with the connected account that has an error.",
|
|
11297
11410
|
properties: {
|
|
11298
11411
|
sites: {
|
|
11412
|
+
description: "Salto sites associated with the connected account that has an error.",
|
|
11299
11413
|
items: {
|
|
11414
|
+
description: "Salto site associated with the connected account that has an error.",
|
|
11300
11415
|
properties: {
|
|
11301
|
-
site_id: {
|
|
11302
|
-
|
|
11416
|
+
site_id: {
|
|
11417
|
+
description: "ID of a Salto site associated with the connected account that has an error.",
|
|
11418
|
+
type: "string"
|
|
11419
|
+
},
|
|
11420
|
+
site_name: {
|
|
11421
|
+
description: "Name of a Salto site associated with the connected account that has an error.",
|
|
11422
|
+
type: "string"
|
|
11423
|
+
},
|
|
11303
11424
|
site_user_subscription_limit: {
|
|
11425
|
+
description: "Subscription limit of site users for a Salto site associated with the connected account that has an error.",
|
|
11304
11426
|
minimum: 0,
|
|
11305
11427
|
type: "integer"
|
|
11306
11428
|
},
|
|
11307
11429
|
subscribed_site_user_count: {
|
|
11430
|
+
description: "Count of subscribed site users for a Salto site associated with the connected account that has an error.",
|
|
11308
11431
|
minimum: 0,
|
|
11309
11432
|
type: "integer"
|
|
11310
11433
|
}
|
|
@@ -11337,29 +11460,49 @@ var openapi_default = {
|
|
|
11337
11460
|
type: "array"
|
|
11338
11461
|
},
|
|
11339
11462
|
user_identifier: {
|
|
11463
|
+
description: "User identifier associated with the connected account.",
|
|
11340
11464
|
properties: {
|
|
11341
|
-
api_url: {
|
|
11342
|
-
|
|
11343
|
-
|
|
11344
|
-
|
|
11345
|
-
|
|
11465
|
+
api_url: {
|
|
11466
|
+
description: "API URL for the user identifier associated with the connected account.",
|
|
11467
|
+
type: "string"
|
|
11468
|
+
},
|
|
11469
|
+
email: {
|
|
11470
|
+
description: "Email address of the user identifier associated with the connected account.",
|
|
11471
|
+
type: "string"
|
|
11472
|
+
},
|
|
11473
|
+
exclusive: {
|
|
11474
|
+
description: "Indicates whether the user identifier associated with the connected account is exclusive.",
|
|
11475
|
+
type: "boolean"
|
|
11476
|
+
},
|
|
11477
|
+
phone: {
|
|
11478
|
+
description: "Phone number of the user identifier associated with the connected account.",
|
|
11479
|
+
type: "string"
|
|
11480
|
+
},
|
|
11481
|
+
username: {
|
|
11482
|
+
description: "Username of the user identifier associated with the connected account.",
|
|
11483
|
+
type: "string"
|
|
11484
|
+
}
|
|
11346
11485
|
},
|
|
11347
11486
|
type: "object"
|
|
11348
11487
|
},
|
|
11349
11488
|
warnings: {
|
|
11489
|
+
description: "Warnings associated with the connected account.",
|
|
11350
11490
|
items: {
|
|
11351
|
-
description: "Warning associated with the
|
|
11491
|
+
description: "Warning associated with the connected account.",
|
|
11352
11492
|
discriminator: { propertyName: "warning_code" },
|
|
11353
11493
|
oneOf: [
|
|
11354
11494
|
{
|
|
11355
|
-
description: "Scheduled downtime for account
|
|
11495
|
+
description: "Scheduled downtime planned for the connected account.",
|
|
11356
11496
|
properties: {
|
|
11357
11497
|
created_at: {
|
|
11358
11498
|
description: "Date and time at which Seam created the warning.",
|
|
11359
11499
|
format: "date-time",
|
|
11360
11500
|
type: "string"
|
|
11361
11501
|
},
|
|
11362
|
-
message: {
|
|
11502
|
+
message: {
|
|
11503
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
11504
|
+
type: "string"
|
|
11505
|
+
},
|
|
11363
11506
|
warning_code: {
|
|
11364
11507
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
11365
11508
|
enum: ["scheduled_maintenance_window"],
|
|
@@ -11370,14 +11513,17 @@ var openapi_default = {
|
|
|
11370
11513
|
type: "object"
|
|
11371
11514
|
},
|
|
11372
11515
|
{
|
|
11373
|
-
description: "An unknown issue occurred while syncing the state of
|
|
11516
|
+
description: "An unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account.",
|
|
11374
11517
|
properties: {
|
|
11375
11518
|
created_at: {
|
|
11376
11519
|
description: "Date and time at which Seam created the warning.",
|
|
11377
11520
|
format: "date-time",
|
|
11378
11521
|
type: "string"
|
|
11379
11522
|
},
|
|
11380
|
-
message: {
|
|
11523
|
+
message: {
|
|
11524
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
11525
|
+
type: "string"
|
|
11526
|
+
},
|
|
11381
11527
|
warning_code: {
|
|
11382
11528
|
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
11383
11529
|
enum: ["unknown_issue_with_connected_account"],
|
|
@@ -11388,26 +11534,40 @@ var openapi_default = {
|
|
|
11388
11534
|
type: "object"
|
|
11389
11535
|
},
|
|
11390
11536
|
{
|
|
11391
|
-
description: "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users.
|
|
11537
|
+
description: "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.",
|
|
11392
11538
|
properties: {
|
|
11393
11539
|
created_at: {
|
|
11394
11540
|
description: "Date and time at which Seam created the warning.",
|
|
11395
11541
|
format: "date-time",
|
|
11396
11542
|
type: "string"
|
|
11397
11543
|
},
|
|
11398
|
-
message: {
|
|
11544
|
+
message: {
|
|
11545
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
11546
|
+
type: "string"
|
|
11547
|
+
},
|
|
11399
11548
|
salto_ks_metadata: {
|
|
11549
|
+
description: "Salto KS metadata associated with the connected account that has a warning.",
|
|
11400
11550
|
properties: {
|
|
11401
11551
|
sites: {
|
|
11552
|
+
description: "Salto sites associated with the connected account that has a warning.",
|
|
11402
11553
|
items: {
|
|
11554
|
+
description: "Salto site associated with the connected account that has a warning.",
|
|
11403
11555
|
properties: {
|
|
11404
|
-
site_id: {
|
|
11405
|
-
|
|
11556
|
+
site_id: {
|
|
11557
|
+
description: "ID of a Salto site associated with the connected account that has a warning.",
|
|
11558
|
+
type: "string"
|
|
11559
|
+
},
|
|
11560
|
+
site_name: {
|
|
11561
|
+
description: "Name of a Salto site associated with the connected account that has a warning.",
|
|
11562
|
+
type: "string"
|
|
11563
|
+
},
|
|
11406
11564
|
site_user_subscription_limit: {
|
|
11565
|
+
description: "Subscription limit of site users for a Salto site associated with the connected account that has a warning.",
|
|
11407
11566
|
minimum: 0,
|
|
11408
11567
|
type: "integer"
|
|
11409
11568
|
},
|
|
11410
11569
|
subscribed_site_user_count: {
|
|
11570
|
+
description: "Count of subscribed site users for a Salto site associated with the connected account that has a warning.",
|
|
11411
11571
|
minimum: 0,
|
|
11412
11572
|
type: "integer"
|
|
11413
11573
|
}
|
|
@@ -11855,15 +12015,24 @@ var openapi_default = {
|
|
|
11855
12015
|
enum: ["invalid_credentials"],
|
|
11856
12016
|
type: "string"
|
|
11857
12017
|
},
|
|
11858
|
-
is_bridge_error: {
|
|
11859
|
-
|
|
11860
|
-
|
|
12018
|
+
is_bridge_error: {
|
|
12019
|
+
description: "Indicates whether the error is related to Seam Bridge.",
|
|
12020
|
+
type: "boolean"
|
|
12021
|
+
},
|
|
12022
|
+
is_connected_account_error: {
|
|
12023
|
+
description: "Indicates whether the error is related specifically to the connected account.",
|
|
12024
|
+
type: "boolean"
|
|
12025
|
+
},
|
|
12026
|
+
message: {
|
|
12027
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
12028
|
+
type: "string"
|
|
12029
|
+
}
|
|
11861
12030
|
},
|
|
11862
12031
|
required: ["created_at", "message", "error_code"],
|
|
11863
12032
|
type: "object"
|
|
11864
12033
|
},
|
|
11865
12034
|
{
|
|
11866
|
-
description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline
|
|
12035
|
+
description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
|
|
11867
12036
|
properties: {
|
|
11868
12037
|
created_at: {
|
|
11869
12038
|
description: "Date and time at which Seam created the error.",
|
|
@@ -11875,9 +12044,18 @@ var openapi_default = {
|
|
|
11875
12044
|
enum: ["bridge_disconnected"],
|
|
11876
12045
|
type: "string"
|
|
11877
12046
|
},
|
|
11878
|
-
is_bridge_error: {
|
|
11879
|
-
|
|
11880
|
-
|
|
12047
|
+
is_bridge_error: {
|
|
12048
|
+
description: "Indicates whether the error is related to Seam Bridge.",
|
|
12049
|
+
type: "boolean"
|
|
12050
|
+
},
|
|
12051
|
+
is_connected_account_error: {
|
|
12052
|
+
description: "Indicates whether the error is related specifically to the connected account.",
|
|
12053
|
+
type: "boolean"
|
|
12054
|
+
},
|
|
12055
|
+
message: {
|
|
12056
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
12057
|
+
type: "string"
|
|
12058
|
+
}
|
|
11881
12059
|
},
|
|
11882
12060
|
required: ["created_at", "message", "error_code"],
|
|
11883
12061
|
type: "object"
|
|
@@ -20148,15 +20326,24 @@ var openapi_default = {
|
|
|
20148
20326
|
enum: ["invalid_credentials"],
|
|
20149
20327
|
type: "string"
|
|
20150
20328
|
},
|
|
20151
|
-
is_bridge_error: {
|
|
20152
|
-
|
|
20153
|
-
|
|
20329
|
+
is_bridge_error: {
|
|
20330
|
+
description: "Indicates whether the error is related to Seam Bridge.",
|
|
20331
|
+
type: "boolean"
|
|
20332
|
+
},
|
|
20333
|
+
is_connected_account_error: {
|
|
20334
|
+
description: "Indicates whether the error is related specifically to the connected account.",
|
|
20335
|
+
type: "boolean"
|
|
20336
|
+
},
|
|
20337
|
+
message: {
|
|
20338
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
20339
|
+
type: "string"
|
|
20340
|
+
}
|
|
20154
20341
|
},
|
|
20155
20342
|
required: ["created_at", "message", "error_code"],
|
|
20156
20343
|
type: "object"
|
|
20157
20344
|
},
|
|
20158
20345
|
{
|
|
20159
|
-
description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline
|
|
20346
|
+
description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
|
|
20160
20347
|
properties: {
|
|
20161
20348
|
created_at: {
|
|
20162
20349
|
description: "Date and time at which Seam created the error.",
|
|
@@ -20168,9 +20355,18 @@ var openapi_default = {
|
|
|
20168
20355
|
enum: ["bridge_disconnected"],
|
|
20169
20356
|
type: "string"
|
|
20170
20357
|
},
|
|
20171
|
-
is_bridge_error: {
|
|
20172
|
-
|
|
20173
|
-
|
|
20358
|
+
is_bridge_error: {
|
|
20359
|
+
description: "Indicates whether the error is related to Seam Bridge.",
|
|
20360
|
+
type: "boolean"
|
|
20361
|
+
},
|
|
20362
|
+
is_connected_account_error: {
|
|
20363
|
+
description: "Indicates whether the error is related specifically to the connected account.",
|
|
20364
|
+
type: "boolean"
|
|
20365
|
+
},
|
|
20366
|
+
message: {
|
|
20367
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
20368
|
+
type: "string"
|
|
20369
|
+
}
|
|
20174
20370
|
},
|
|
20175
20371
|
required: ["created_at", "message", "error_code"],
|
|
20176
20372
|
type: "object"
|
|
@@ -20185,7 +20381,7 @@ var openapi_default = {
|
|
|
20185
20381
|
type: "boolean"
|
|
20186
20382
|
},
|
|
20187
20383
|
name: {
|
|
20188
|
-
description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
20384
|
+
description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
20189
20385
|
nullable: true,
|
|
20190
20386
|
type: "string"
|
|
20191
20387
|
},
|
|
@@ -21870,15 +22066,24 @@ var openapi_default = {
|
|
|
21870
22066
|
enum: ["invalid_credentials"],
|
|
21871
22067
|
type: "string"
|
|
21872
22068
|
},
|
|
21873
|
-
is_bridge_error: {
|
|
21874
|
-
|
|
21875
|
-
|
|
22069
|
+
is_bridge_error: {
|
|
22070
|
+
description: "Indicates whether the error is related to Seam Bridge.",
|
|
22071
|
+
type: "boolean"
|
|
22072
|
+
},
|
|
22073
|
+
is_connected_account_error: {
|
|
22074
|
+
description: "Indicates whether the error is related specifically to the connected account.",
|
|
22075
|
+
type: "boolean"
|
|
22076
|
+
},
|
|
22077
|
+
message: {
|
|
22078
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
22079
|
+
type: "string"
|
|
22080
|
+
}
|
|
21876
22081
|
},
|
|
21877
22082
|
required: ["created_at", "message", "error_code"],
|
|
21878
22083
|
type: "object"
|
|
21879
22084
|
},
|
|
21880
22085
|
{
|
|
21881
|
-
description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline
|
|
22086
|
+
description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
|
|
21882
22087
|
properties: {
|
|
21883
22088
|
created_at: {
|
|
21884
22089
|
description: "Date and time at which Seam created the error.",
|
|
@@ -21890,9 +22095,18 @@ var openapi_default = {
|
|
|
21890
22095
|
enum: ["bridge_disconnected"],
|
|
21891
22096
|
type: "string"
|
|
21892
22097
|
},
|
|
21893
|
-
is_bridge_error: {
|
|
21894
|
-
|
|
21895
|
-
|
|
22098
|
+
is_bridge_error: {
|
|
22099
|
+
description: "Indicates whether the error is related to Seam Bridge.",
|
|
22100
|
+
type: "boolean"
|
|
22101
|
+
},
|
|
22102
|
+
is_connected_account_error: {
|
|
22103
|
+
description: "Indicates whether the error is related specifically to the connected account.",
|
|
22104
|
+
type: "boolean"
|
|
22105
|
+
},
|
|
22106
|
+
message: {
|
|
22107
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
22108
|
+
type: "string"
|
|
22109
|
+
}
|
|
21896
22110
|
},
|
|
21897
22111
|
required: ["created_at", "message", "error_code"],
|
|
21898
22112
|
type: "object"
|
|
@@ -22528,7 +22742,7 @@ var openapi_default = {
|
|
|
22528
22742
|
type: "string"
|
|
22529
22743
|
},
|
|
22530
22744
|
name: {
|
|
22531
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
22745
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
22532
22746
|
type: "string"
|
|
22533
22747
|
},
|
|
22534
22748
|
prefer_native_scheduling: {
|
|
@@ -22657,7 +22871,7 @@ var openapi_default = {
|
|
|
22657
22871
|
type: "string"
|
|
22658
22872
|
},
|
|
22659
22873
|
name: {
|
|
22660
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
22874
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
22661
22875
|
type: "string"
|
|
22662
22876
|
},
|
|
22663
22877
|
prefer_native_scheduling: {
|
|
@@ -22778,7 +22992,7 @@ var openapi_default = {
|
|
|
22778
22992
|
type: "string"
|
|
22779
22993
|
},
|
|
22780
22994
|
name: {
|
|
22781
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
22995
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
22782
22996
|
type: "string"
|
|
22783
22997
|
},
|
|
22784
22998
|
prefer_native_scheduling: {
|
|
@@ -23813,7 +24027,7 @@ var openapi_default = {
|
|
|
23813
24027
|
type: "string"
|
|
23814
24028
|
},
|
|
23815
24029
|
name: {
|
|
23816
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
24030
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
23817
24031
|
type: "string"
|
|
23818
24032
|
},
|
|
23819
24033
|
prefer_native_scheduling: {
|
|
@@ -23945,7 +24159,7 @@ var openapi_default = {
|
|
|
23945
24159
|
type: "string"
|
|
23946
24160
|
},
|
|
23947
24161
|
name: {
|
|
23948
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
24162
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
23949
24163
|
type: "string"
|
|
23950
24164
|
},
|
|
23951
24165
|
prefer_native_scheduling: {
|
|
@@ -24078,7 +24292,7 @@ var openapi_default = {
|
|
|
24078
24292
|
type: "string"
|
|
24079
24293
|
},
|
|
24080
24294
|
name: {
|
|
24081
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
24295
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
24082
24296
|
type: "string"
|
|
24083
24297
|
},
|
|
24084
24298
|
prefer_native_scheduling: {
|
|
@@ -24169,7 +24383,7 @@ var openapi_default = {
|
|
|
24169
24383
|
type: "string"
|
|
24170
24384
|
},
|
|
24171
24385
|
name: {
|
|
24172
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
24386
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
24173
24387
|
type: "string"
|
|
24174
24388
|
},
|
|
24175
24389
|
starts_at: {
|
|
@@ -24228,7 +24442,7 @@ var openapi_default = {
|
|
|
24228
24442
|
type: "string"
|
|
24229
24443
|
},
|
|
24230
24444
|
name: {
|
|
24231
|
-
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes
|
|
24445
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
24232
24446
|
type: "string"
|
|
24233
24447
|
},
|
|
24234
24448
|
starts_at: {
|
|
@@ -27311,13 +27525,22 @@ var openapi_default = {
|
|
|
27311
27525
|
"application/json": {
|
|
27312
27526
|
schema: {
|
|
27313
27527
|
properties: {
|
|
27528
|
+
acs_system_id: {
|
|
27529
|
+
description: "ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id.",
|
|
27530
|
+
format: "uuid",
|
|
27531
|
+
type: "string"
|
|
27532
|
+
},
|
|
27314
27533
|
acs_user_id: {
|
|
27315
|
-
description: "ID of the access system user that you want to delete.",
|
|
27534
|
+
description: "ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id",
|
|
27535
|
+
format: "uuid",
|
|
27536
|
+
type: "string"
|
|
27537
|
+
},
|
|
27538
|
+
user_identity_id: {
|
|
27539
|
+
description: "ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.",
|
|
27316
27540
|
format: "uuid",
|
|
27317
27541
|
type: "string"
|
|
27318
27542
|
}
|
|
27319
27543
|
},
|
|
27320
|
-
required: ["acs_user_id"],
|
|
27321
27544
|
type: "object"
|
|
27322
27545
|
}
|
|
27323
27546
|
}
|
|
@@ -27361,13 +27584,22 @@ var openapi_default = {
|
|
|
27361
27584
|
"application/json": {
|
|
27362
27585
|
schema: {
|
|
27363
27586
|
properties: {
|
|
27587
|
+
acs_system_id: {
|
|
27588
|
+
description: "ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id.",
|
|
27589
|
+
format: "uuid",
|
|
27590
|
+
type: "string"
|
|
27591
|
+
},
|
|
27364
27592
|
acs_user_id: {
|
|
27365
|
-
description: "ID of the access system user that you want to get.",
|
|
27593
|
+
description: "ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id.",
|
|
27594
|
+
format: "uuid",
|
|
27595
|
+
type: "string"
|
|
27596
|
+
},
|
|
27597
|
+
user_identity_id: {
|
|
27598
|
+
description: "ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id.",
|
|
27366
27599
|
format: "uuid",
|
|
27367
27600
|
type: "string"
|
|
27368
27601
|
}
|
|
27369
27602
|
},
|
|
27370
|
-
required: ["acs_user_id"],
|
|
27371
27603
|
type: "object"
|
|
27372
27604
|
}
|
|
27373
27605
|
}
|
|
@@ -27635,13 +27867,22 @@ var openapi_default = {
|
|
|
27635
27867
|
"application/json": {
|
|
27636
27868
|
schema: {
|
|
27637
27869
|
properties: {
|
|
27870
|
+
acs_system_id: {
|
|
27871
|
+
description: "ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id.",
|
|
27872
|
+
format: "uuid",
|
|
27873
|
+
type: "string"
|
|
27874
|
+
},
|
|
27638
27875
|
acs_user_id: {
|
|
27639
|
-
description: "ID of the access system user for whom you want to revoke access.",
|
|
27876
|
+
description: "ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.",
|
|
27877
|
+
format: "uuid",
|
|
27878
|
+
type: "string"
|
|
27879
|
+
},
|
|
27880
|
+
user_identity_id: {
|
|
27881
|
+
description: "ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.",
|
|
27640
27882
|
format: "uuid",
|
|
27641
27883
|
type: "string"
|
|
27642
27884
|
}
|
|
27643
27885
|
},
|
|
27644
|
-
required: ["acs_user_id"],
|
|
27645
27886
|
type: "object"
|
|
27646
27887
|
}
|
|
27647
27888
|
}
|
|
@@ -27685,13 +27926,22 @@ var openapi_default = {
|
|
|
27685
27926
|
"application/json": {
|
|
27686
27927
|
schema: {
|
|
27687
27928
|
properties: {
|
|
27929
|
+
acs_system_id: {
|
|
27930
|
+
description: "ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.",
|
|
27931
|
+
format: "uuid",
|
|
27932
|
+
type: "string"
|
|
27933
|
+
},
|
|
27688
27934
|
acs_user_id: {
|
|
27689
|
-
description: "ID of the access system user that you want to suspend.",
|
|
27935
|
+
description: "ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.",
|
|
27936
|
+
format: "uuid",
|
|
27937
|
+
type: "string"
|
|
27938
|
+
},
|
|
27939
|
+
user_identity_id: {
|
|
27940
|
+
description: "ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.",
|
|
27690
27941
|
format: "uuid",
|
|
27691
27942
|
type: "string"
|
|
27692
27943
|
}
|
|
27693
27944
|
},
|
|
27694
|
-
required: ["acs_user_id"],
|
|
27695
27945
|
type: "object"
|
|
27696
27946
|
}
|
|
27697
27947
|
}
|
|
@@ -27870,13 +28120,22 @@ var openapi_default = {
|
|
|
27870
28120
|
"application/json": {
|
|
27871
28121
|
schema: {
|
|
27872
28122
|
properties: {
|
|
28123
|
+
acs_system_id: {
|
|
28124
|
+
description: "ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id.",
|
|
28125
|
+
format: "uuid",
|
|
28126
|
+
type: "string"
|
|
28127
|
+
},
|
|
27873
28128
|
acs_user_id: {
|
|
27874
|
-
description: "ID of the access system user that you want to unsuspend.",
|
|
28129
|
+
description: "ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.",
|
|
28130
|
+
format: "uuid",
|
|
28131
|
+
type: "string"
|
|
28132
|
+
},
|
|
28133
|
+
user_identity_id: {
|
|
28134
|
+
description: "ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.",
|
|
27875
28135
|
format: "uuid",
|
|
27876
28136
|
type: "string"
|
|
27877
28137
|
}
|
|
27878
28138
|
},
|
|
27879
|
-
required: ["acs_user_id"],
|
|
27880
28139
|
type: "object"
|
|
27881
28140
|
}
|
|
27882
28141
|
}
|
|
@@ -27938,8 +28197,13 @@ var openapi_default = {
|
|
|
27938
28197
|
required: ["starts_at", "ends_at"],
|
|
27939
28198
|
type: "object"
|
|
27940
28199
|
},
|
|
28200
|
+
acs_system_id: {
|
|
28201
|
+
description: "ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.",
|
|
28202
|
+
format: "uuid",
|
|
28203
|
+
type: "string"
|
|
28204
|
+
},
|
|
27941
28205
|
acs_user_id: {
|
|
27942
|
-
description: "ID of the
|
|
28206
|
+
description: "ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.",
|
|
27943
28207
|
format: "uuid",
|
|
27944
28208
|
type: "string"
|
|
27945
28209
|
},
|
|
@@ -27963,9 +28227,13 @@ var openapi_default = {
|
|
|
27963
28227
|
phone_number: {
|
|
27964
28228
|
description: "Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
|
|
27965
28229
|
type: "string"
|
|
28230
|
+
},
|
|
28231
|
+
user_identity_id: {
|
|
28232
|
+
description: "ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.",
|
|
28233
|
+
format: "uuid",
|
|
28234
|
+
type: "string"
|
|
27966
28235
|
}
|
|
27967
28236
|
},
|
|
27968
|
-
required: ["acs_user_id"],
|
|
27969
28237
|
type: "object"
|
|
27970
28238
|
}
|
|
27971
28239
|
}
|
|
@@ -28024,8 +28292,13 @@ var openapi_default = {
|
|
|
28024
28292
|
required: ["starts_at", "ends_at"],
|
|
28025
28293
|
type: "object"
|
|
28026
28294
|
},
|
|
28295
|
+
acs_system_id: {
|
|
28296
|
+
description: "ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.",
|
|
28297
|
+
format: "uuid",
|
|
28298
|
+
type: "string"
|
|
28299
|
+
},
|
|
28027
28300
|
acs_user_id: {
|
|
28028
|
-
description: "ID of the
|
|
28301
|
+
description: "ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.",
|
|
28029
28302
|
format: "uuid",
|
|
28030
28303
|
type: "string"
|
|
28031
28304
|
},
|
|
@@ -28049,9 +28322,13 @@ var openapi_default = {
|
|
|
28049
28322
|
phone_number: {
|
|
28050
28323
|
description: "Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
|
|
28051
28324
|
type: "string"
|
|
28325
|
+
},
|
|
28326
|
+
user_identity_id: {
|
|
28327
|
+
description: "ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.",
|
|
28328
|
+
format: "uuid",
|
|
28329
|
+
type: "string"
|
|
28052
28330
|
}
|
|
28053
28331
|
},
|
|
28054
|
-
required: ["acs_user_id"],
|
|
28055
28332
|
type: "object"
|
|
28056
28333
|
}
|
|
28057
28334
|
}
|
|
@@ -29872,7 +30149,6 @@ var openapi_default = {
|
|
|
29872
30149
|
"igloohome",
|
|
29873
30150
|
"hubitat",
|
|
29874
30151
|
"controlbyweb",
|
|
29875
|
-
"smartthings",
|
|
29876
30152
|
"dormakaba_oracode",
|
|
29877
30153
|
"tedee",
|
|
29878
30154
|
"akiles",
|
|
@@ -29882,7 +30158,8 @@ var openapi_default = {
|
|
|
29882
30158
|
"nest",
|
|
29883
30159
|
"noiseaware",
|
|
29884
30160
|
"tado",
|
|
29885
|
-
"sensi"
|
|
30161
|
+
"sensi",
|
|
30162
|
+
"smartthings"
|
|
29886
30163
|
],
|
|
29887
30164
|
type: "string"
|
|
29888
30165
|
},
|
|
@@ -30455,7 +30732,6 @@ var openapi_default = {
|
|
|
30455
30732
|
"igloohome",
|
|
30456
30733
|
"hubitat",
|
|
30457
30734
|
"controlbyweb",
|
|
30458
|
-
"smartthings",
|
|
30459
30735
|
"dormakaba_oracode",
|
|
30460
30736
|
"tedee",
|
|
30461
30737
|
"akiles",
|
|
@@ -30465,7 +30741,8 @@ var openapi_default = {
|
|
|
30465
30741
|
"nest",
|
|
30466
30742
|
"noiseaware",
|
|
30467
30743
|
"tado",
|
|
30468
|
-
"sensi"
|
|
30744
|
+
"sensi",
|
|
30745
|
+
"smartthings"
|
|
30469
30746
|
],
|
|
30470
30747
|
type: "string"
|
|
30471
30748
|
},
|
|
@@ -31356,7 +31633,6 @@ var openapi_default = {
|
|
|
31356
31633
|
"salto",
|
|
31357
31634
|
"schlage",
|
|
31358
31635
|
"seam",
|
|
31359
|
-
"smartthings",
|
|
31360
31636
|
"wyze",
|
|
31361
31637
|
"yale",
|
|
31362
31638
|
"two_n",
|
|
@@ -31367,7 +31643,8 @@ var openapi_default = {
|
|
|
31367
31643
|
"four_suites",
|
|
31368
31644
|
"dormakaba_oracode",
|
|
31369
31645
|
"tedee",
|
|
31370
|
-
"akiles"
|
|
31646
|
+
"akiles",
|
|
31647
|
+
"smartthings"
|
|
31371
31648
|
],
|
|
31372
31649
|
type: "string"
|
|
31373
31650
|
},
|
|
@@ -34807,7 +35084,8 @@ var openapi_default = {
|
|
|
34807
35084
|
"honeywell_resideo",
|
|
34808
35085
|
"nest",
|
|
34809
35086
|
"tado",
|
|
34810
|
-
"sensi"
|
|
35087
|
+
"sensi",
|
|
35088
|
+
"smartthings"
|
|
34811
35089
|
],
|
|
34812
35090
|
type: "string"
|
|
34813
35091
|
},
|