@seamapi/types 1.802.0 → 1.804.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 +120 -61
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +90 -20
- package/dist/index.cjs +120 -61
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.js +2 -2
- package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-system.js +2 -2
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/events/access-grants.js +1 -1
- package/lib/seam/connect/models/events/access-grants.js.map +1 -1
- package/lib/seam/connect/models/events/acs/entrances.js +2 -2
- package/lib/seam/connect/models/events/connect-webviews.js +3 -3
- package/lib/seam/connect/models/events/connected-accounts.js +1 -1
- package/lib/seam/connect/models/partner/customer-portal.d.ts +21 -0
- package/lib/seam/connect/models/partner/customer-portal.js +29 -0
- package/lib/seam/connect/models/partner/customer-portal.js.map +1 -0
- package/lib/seam/connect/models/partner/index.d.ts +1 -0
- package/lib/seam/connect/models/partner/index.js +1 -0
- package/lib/seam/connect/models/partner/index.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +32 -0
- package/lib/seam/connect/openapi.js +88 -50
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +36 -19
- package/lib/seam/connect/schemas.d.ts +1 -1
- package/lib/seam/connect/schemas.js +1 -1
- package/lib/seam/connect/schemas.js.map +1 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +2 -2
- package/src/lib/seam/connect/models/acs/acs-system.ts +2 -2
- package/src/lib/seam/connect/models/events/access-grants.ts +1 -1
- package/src/lib/seam/connect/models/events/acs/entrances.ts +2 -2
- package/src/lib/seam/connect/models/events/connect-webviews.ts +3 -3
- package/src/lib/seam/connect/models/events/connected-accounts.ts +1 -1
- package/src/lib/seam/connect/models/partner/customer-portal.ts +35 -0
- package/src/lib/seam/connect/models/partner/index.ts +1 -0
- package/src/lib/seam/connect/openapi.ts +92 -50
- package/src/lib/seam/connect/route-types.ts +36 -19
- package/src/lib/seam/connect/schemas.ts +1 -0
package/dist/connect.cjs
CHANGED
|
@@ -29,6 +29,7 @@ __export(schemas_exports, {
|
|
|
29
29
|
connect_webview: () => connect_webview,
|
|
30
30
|
connected_account: () => connected_account,
|
|
31
31
|
custom_metadata: () => custom_metadata,
|
|
32
|
+
customer_portal: () => customer_portal,
|
|
32
33
|
customization_profile: () => customization_profile,
|
|
33
34
|
device: () => device,
|
|
34
35
|
device_provider: () => device_provider,
|
|
@@ -3136,7 +3137,7 @@ var error_code_description5 = "Unique identifier of the type of error. Enables q
|
|
|
3136
3137
|
var acs_access_groups_failed_to_create_on_acs_system = common_acs_access_group_error.extend({
|
|
3137
3138
|
error_code: zod.z.literal("failed_to_create_on_acs_system").describe(error_code_description5)
|
|
3138
3139
|
}).describe(
|
|
3139
|
-
`Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`
|
|
3140
|
+
`Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`
|
|
3140
3141
|
);
|
|
3141
3142
|
var acs_access_group_errors = zod.z.discriminatedUnion("error_code", [
|
|
3142
3143
|
acs_access_groups_failed_to_create_on_acs_system
|
|
@@ -3213,7 +3214,7 @@ var acs_access_group = common_acs_access_group.extend({
|
|
|
3213
3214
|
---
|
|
3214
3215
|
Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
|
|
3215
3216
|
|
|
3216
|
-
Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
|
|
3217
|
+
Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
|
|
3217
3218
|
|
|
3218
3219
|
To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).
|
|
3219
3220
|
`);
|
|
@@ -3763,7 +3764,7 @@ var visionline_instance_unreachable = common_acs_system_error.extend({
|
|
|
3763
3764
|
error_code: zod.z.literal("visionline_instance_unreachable").describe(error_code_description7)
|
|
3764
3765
|
}).describe(`Indicates that [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).
|
|
3765
3766
|
For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
|
|
3766
|
-
See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/
|
|
3767
|
+
See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).`);
|
|
3767
3768
|
var salto_ks_subscription_limit_exceeded3 = common_acs_system_error.extend({
|
|
3768
3769
|
error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description7)
|
|
3769
3770
|
}).describe(
|
|
@@ -3777,7 +3778,7 @@ var acs_system_disconnected = common_acs_system_error.extend({
|
|
|
3777
3778
|
var account_disconnected3 = common_acs_system_error.extend({
|
|
3778
3779
|
error_code: zod.z.literal("account_disconnected").describe(error_code_description7)
|
|
3779
3780
|
}).describe(
|
|
3780
|
-
"Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/
|
|
3781
|
+
"Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to restore access."
|
|
3781
3782
|
);
|
|
3782
3783
|
var salto_ks_certification_expired = common_acs_system_error.extend({
|
|
3783
3784
|
error_code: zod.z.literal("salto_ks_certification_expired").describe(error_code_description7)
|
|
@@ -5249,7 +5250,7 @@ var access_grant_access_granted_to_all_doors_event = access_grant_event.extend({
|
|
|
5249
5250
|
All access requested for an Access Grant was successfully granted.
|
|
5250
5251
|
`);
|
|
5251
5252
|
var acs_entrance_id = zod.z.string().uuid().describe(
|
|
5252
|
-
"ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details)."
|
|
5253
|
+
"ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
|
|
5253
5254
|
);
|
|
5254
5255
|
var access_grant_access_granted_to_door_event = access_grant_event.extend({
|
|
5255
5256
|
event_type: zod.z.literal("access_grant.access_granted_to_door"),
|
|
@@ -5463,7 +5464,7 @@ var acs_entrance_added_event = acs_entrance_event.extend({
|
|
|
5463
5464
|
---
|
|
5464
5465
|
route_path: /acs/entrances
|
|
5465
5466
|
---
|
|
5466
|
-
An [access system entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was added.
|
|
5467
|
+
An [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was added.
|
|
5467
5468
|
`);
|
|
5468
5469
|
var acs_entrance_removed_event = acs_entrance_event.extend({
|
|
5469
5470
|
event_type: zod.z.literal("acs_entrance.removed")
|
|
@@ -5471,7 +5472,7 @@ var acs_entrance_removed_event = acs_entrance_event.extend({
|
|
|
5471
5472
|
---
|
|
5472
5473
|
route_path: /acs/entrances
|
|
5473
5474
|
---
|
|
5474
|
-
An [access system entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was removed.
|
|
5475
|
+
An [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was removed.
|
|
5475
5476
|
`);
|
|
5476
5477
|
var acs_entrance_events = [
|
|
5477
5478
|
acs_entrance_added_event,
|
|
@@ -5651,7 +5652,7 @@ var client_session_deleted_event = client_session_event.extend({
|
|
|
5651
5652
|
var client_session_events = [client_session_deleted_event];
|
|
5652
5653
|
var connect_webview_event = common_event.extend({
|
|
5653
5654
|
connect_webview_id: zod.z.string().uuid().describe(
|
|
5654
|
-
"ID of the affected [Connect Webview](https://docs.seam.co/latest/
|
|
5655
|
+
"ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews)."
|
|
5655
5656
|
)
|
|
5656
5657
|
});
|
|
5657
5658
|
var connected_account_id = zod.z.string().uuid().describe(
|
|
@@ -5671,7 +5672,7 @@ var connect_webview_login_succeeded_event = connect_webview_event.extend({
|
|
|
5671
5672
|
---
|
|
5672
5673
|
route_path: /connect_webviews
|
|
5673
5674
|
---
|
|
5674
|
-
A [Connect Webview](https://docs.seam.co/latest/
|
|
5675
|
+
A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login succeeded.
|
|
5675
5676
|
`);
|
|
5676
5677
|
var connect_webview_login_failed_event = connect_webview_event.extend({
|
|
5677
5678
|
event_type: zod.z.literal("connect_webview.login_failed")
|
|
@@ -5679,7 +5680,7 @@ var connect_webview_login_failed_event = connect_webview_event.extend({
|
|
|
5679
5680
|
---
|
|
5680
5681
|
route_path: /connect_webviews
|
|
5681
5682
|
---
|
|
5682
|
-
A [Connect Webview](https://docs.seam.co/latest/
|
|
5683
|
+
A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login failed.
|
|
5683
5684
|
`);
|
|
5684
5685
|
var connect_webview_events = [
|
|
5685
5686
|
connect_webview_login_succeeded_event,
|
|
@@ -5731,7 +5732,7 @@ var connected_account_successful_login_event = connected_account_event.extend({
|
|
|
5731
5732
|
deprecated: Use \`connect_webview.login_succeeded\`.
|
|
5732
5733
|
route_path: /connected_accounts
|
|
5733
5734
|
---
|
|
5734
|
-
A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) had a successful login using a [Connect Webview](https://docs.seam.co/latest/
|
|
5735
|
+
A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) had a successful login using a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).
|
|
5735
5736
|
`);
|
|
5736
5737
|
var connected_account_disconnected_event = connected_account_event.extend({
|
|
5737
5738
|
event_type: zod.z.literal("connected_account.disconnected")
|
|
@@ -6781,6 +6782,26 @@ var pagination = zod.z.object({
|
|
|
6781
6782
|
),
|
|
6782
6783
|
next_page_url: zod.z.string().url().nullable().describe("URL to get the next page of results.")
|
|
6783
6784
|
}).describe("Information about the current page of results.");
|
|
6785
|
+
var customer_portal = zod.z.object({
|
|
6786
|
+
url: zod.z.string().url().describe("URL for the customer portal."),
|
|
6787
|
+
customer_key: zod.z.string().describe("Customer key for the customer portal."),
|
|
6788
|
+
expires_at: zod.z.string().datetime().describe("Date and time at which the customer portal link expires."),
|
|
6789
|
+
workspace_id: zod.z.string().uuid().describe(
|
|
6790
|
+
"ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer portal."
|
|
6791
|
+
),
|
|
6792
|
+
created_at: zod.z.string().datetime().describe("Date and time at which the customer portal link was created.")
|
|
6793
|
+
}).describe(
|
|
6794
|
+
`
|
|
6795
|
+
---
|
|
6796
|
+
route_path: /customers
|
|
6797
|
+
---
|
|
6798
|
+
Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product\u2014either by sharing a link with users or embedding a view in an iframe.
|
|
6799
|
+
|
|
6800
|
+
With Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.
|
|
6801
|
+
|
|
6802
|
+
Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control.
|
|
6803
|
+
`
|
|
6804
|
+
);
|
|
6784
6805
|
var magic_link = zod.z.object({
|
|
6785
6806
|
url: zod.z.string().url().describe("URL for the magic link."),
|
|
6786
6807
|
customer_key: zod.z.string().describe("Customer key for the magic link."),
|
|
@@ -9512,7 +9533,7 @@ var openapi_default = {
|
|
|
9512
9533
|
"x-route-path": "/access_methods"
|
|
9513
9534
|
},
|
|
9514
9535
|
acs_access_group: {
|
|
9515
|
-
description: "Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\n\nSome access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.\n\nTo learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).",
|
|
9536
|
+
description: "Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\n\nSome access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.\n\nTo learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).",
|
|
9516
9537
|
properties: {
|
|
9517
9538
|
access_group_type: {
|
|
9518
9539
|
deprecated: true,
|
|
@@ -9579,7 +9600,7 @@ var openapi_default = {
|
|
|
9579
9600
|
discriminator: { propertyName: "error_code" },
|
|
9580
9601
|
oneOf: [
|
|
9581
9602
|
{
|
|
9582
|
-
description: "Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).",
|
|
9603
|
+
description: "Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).",
|
|
9583
9604
|
properties: {
|
|
9584
9605
|
created_at: {
|
|
9585
9606
|
description: "Date and time at which Seam created the error.",
|
|
@@ -10910,7 +10931,7 @@ var openapi_default = {
|
|
|
10910
10931
|
type: "object"
|
|
10911
10932
|
},
|
|
10912
10933
|
{
|
|
10913
|
-
description: "Indicates that [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).\n For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/
|
|
10934
|
+
description: "Indicates that [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).\n For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).",
|
|
10914
10935
|
properties: {
|
|
10915
10936
|
created_at: {
|
|
10916
10937
|
description: "Date and time at which Seam created the error.",
|
|
@@ -10973,7 +10994,7 @@ var openapi_default = {
|
|
|
10973
10994
|
type: "object"
|
|
10974
10995
|
},
|
|
10975
10996
|
{
|
|
10976
|
-
description: "Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/
|
|
10997
|
+
description: "Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to restore access.",
|
|
10977
10998
|
properties: {
|
|
10978
10999
|
created_at: {
|
|
10979
11000
|
description: "Date and time at which Seam created the error.",
|
|
@@ -22740,7 +22761,7 @@ var openapi_default = {
|
|
|
22740
22761
|
type: "string"
|
|
22741
22762
|
},
|
|
22742
22763
|
acs_entrance_id: {
|
|
22743
|
-
description: "ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).",
|
|
22764
|
+
description: "ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
22744
22765
|
format: "uuid",
|
|
22745
22766
|
type: "string"
|
|
22746
22767
|
},
|
|
@@ -22790,7 +22811,7 @@ var openapi_default = {
|
|
|
22790
22811
|
type: "string"
|
|
22791
22812
|
},
|
|
22792
22813
|
acs_entrance_id: {
|
|
22793
|
-
description: "ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).",
|
|
22814
|
+
description: "ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
22794
22815
|
format: "uuid",
|
|
22795
22816
|
type: "string"
|
|
22796
22817
|
},
|
|
@@ -23970,7 +23991,7 @@ var openapi_default = {
|
|
|
23970
23991
|
"x-route-path": "/acs/access_groups"
|
|
23971
23992
|
},
|
|
23972
23993
|
{
|
|
23973
|
-
description: "An [access system entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was added.",
|
|
23994
|
+
description: "An [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was added.",
|
|
23974
23995
|
properties: {
|
|
23975
23996
|
acs_entrance_id: { format: "uuid", type: "string" },
|
|
23976
23997
|
acs_system_id: {
|
|
@@ -24018,7 +24039,7 @@ var openapi_default = {
|
|
|
24018
24039
|
"x-route-path": "/acs/entrances"
|
|
24019
24040
|
},
|
|
24020
24041
|
{
|
|
24021
|
-
description: "An [access system entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was removed.",
|
|
24042
|
+
description: "An [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was removed.",
|
|
24022
24043
|
properties: {
|
|
24023
24044
|
acs_entrance_id: { format: "uuid", type: "string" },
|
|
24024
24045
|
acs_system_id: {
|
|
@@ -24225,7 +24246,7 @@ var openapi_default = {
|
|
|
24225
24246
|
},
|
|
24226
24247
|
{
|
|
24227
24248
|
deprecated: true,
|
|
24228
|
-
description: "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) had a successful login using a [Connect Webview](https://docs.seam.co/latest/
|
|
24249
|
+
description: "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) had a successful login using a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).",
|
|
24229
24250
|
properties: {
|
|
24230
24251
|
connect_webview_id: {
|
|
24231
24252
|
description: "ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event.",
|
|
@@ -25134,10 +25155,10 @@ var openapi_default = {
|
|
|
25134
25155
|
"x-route-path": "/action_attempts"
|
|
25135
25156
|
},
|
|
25136
25157
|
{
|
|
25137
|
-
description: "A [Connect Webview](https://docs.seam.co/latest/
|
|
25158
|
+
description: "A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login succeeded.",
|
|
25138
25159
|
properties: {
|
|
25139
25160
|
connect_webview_id: {
|
|
25140
|
-
description: "ID of the affected [Connect Webview](https://docs.seam.co/latest/
|
|
25161
|
+
description: "ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).",
|
|
25141
25162
|
format: "uuid",
|
|
25142
25163
|
type: "string"
|
|
25143
25164
|
},
|
|
@@ -25195,10 +25216,10 @@ var openapi_default = {
|
|
|
25195
25216
|
"x-route-path": "/connect_webviews"
|
|
25196
25217
|
},
|
|
25197
25218
|
{
|
|
25198
|
-
description: "A [Connect Webview](https://docs.seam.co/latest/
|
|
25219
|
+
description: "A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login failed.",
|
|
25199
25220
|
properties: {
|
|
25200
25221
|
connect_webview_id: {
|
|
25201
|
-
description: "ID of the affected [Connect Webview](https://docs.seam.co/latest/
|
|
25222
|
+
description: "ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).",
|
|
25202
25223
|
format: "uuid",
|
|
25203
25224
|
type: "string"
|
|
25204
25225
|
},
|
|
@@ -31842,7 +31863,7 @@ var openapi_default = {
|
|
|
31842
31863
|
discriminator: { propertyName: "error_code" },
|
|
31843
31864
|
oneOf: [
|
|
31844
31865
|
{
|
|
31845
|
-
description: "Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).",
|
|
31866
|
+
description: "Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).",
|
|
31846
31867
|
properties: {
|
|
31847
31868
|
created_at: {
|
|
31848
31869
|
description: "Date and time at which Seam created the error.",
|
|
@@ -35133,7 +35154,7 @@ var openapi_default = {
|
|
|
35133
35154
|
"x-undocumented": "Only used internally."
|
|
35134
35155
|
},
|
|
35135
35156
|
use_backup_access_code_pool: {
|
|
35136
|
-
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/
|
|
35157
|
+
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).",
|
|
35137
35158
|
type: "boolean"
|
|
35138
35159
|
},
|
|
35139
35160
|
use_offline_access_code: {
|
|
@@ -37404,7 +37425,7 @@ var openapi_default = {
|
|
|
37404
37425
|
type: "string"
|
|
37405
37426
|
},
|
|
37406
37427
|
use_backup_access_code_pool: {
|
|
37407
|
-
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/
|
|
37428
|
+
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).",
|
|
37408
37429
|
type: "boolean"
|
|
37409
37430
|
},
|
|
37410
37431
|
use_offline_access_code: {
|
|
@@ -37542,7 +37563,7 @@ var openapi_default = {
|
|
|
37542
37563
|
type: "string"
|
|
37543
37564
|
},
|
|
37544
37565
|
use_backup_access_code_pool: {
|
|
37545
|
-
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/
|
|
37566
|
+
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).",
|
|
37546
37567
|
type: "boolean"
|
|
37547
37568
|
},
|
|
37548
37569
|
use_offline_access_code: {
|
|
@@ -37680,7 +37701,7 @@ var openapi_default = {
|
|
|
37680
37701
|
type: "string"
|
|
37681
37702
|
},
|
|
37682
37703
|
use_backup_access_code_pool: {
|
|
37683
|
-
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/
|
|
37704
|
+
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).",
|
|
37684
37705
|
type: "boolean"
|
|
37685
37706
|
},
|
|
37686
37707
|
use_offline_access_code: {
|
|
@@ -43937,7 +43958,7 @@ var openapi_default = {
|
|
|
43937
43958
|
},
|
|
43938
43959
|
"/acs/access_groups/add_user": {
|
|
43939
43960
|
post: {
|
|
43940
|
-
description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
43961
|
+
description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
43941
43962
|
operationId: "acsAccessGroupsAddUserPost",
|
|
43942
43963
|
requestBody: {
|
|
43943
43964
|
content: {
|
|
@@ -43995,7 +44016,7 @@ var openapi_default = {
|
|
|
43995
44016
|
"x-title": "Add an ACS User to an Access Group"
|
|
43996
44017
|
},
|
|
43997
44018
|
put: {
|
|
43998
|
-
description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44019
|
+
description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
43999
44020
|
operationId: "acsAccessGroupsAddUserPut",
|
|
44000
44021
|
requestBody: {
|
|
44001
44022
|
content: {
|
|
@@ -44055,7 +44076,7 @@ var openapi_default = {
|
|
|
44055
44076
|
},
|
|
44056
44077
|
"/acs/access_groups/delete": {
|
|
44057
44078
|
delete: {
|
|
44058
|
-
description: "Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44079
|
+
description: "Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44059
44080
|
operationId: "acsAccessGroupsDeleteDelete",
|
|
44060
44081
|
parameters: [
|
|
44061
44082
|
{
|
|
@@ -44099,7 +44120,7 @@ var openapi_default = {
|
|
|
44099
44120
|
"x-title": "Delete an Access Group"
|
|
44100
44121
|
},
|
|
44101
44122
|
post: {
|
|
44102
|
-
description: "Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44123
|
+
description: "Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44103
44124
|
operationId: "acsAccessGroupsDeletePost",
|
|
44104
44125
|
requestBody: {
|
|
44105
44126
|
content: {
|
|
@@ -44150,7 +44171,7 @@ var openapi_default = {
|
|
|
44150
44171
|
},
|
|
44151
44172
|
"/acs/access_groups/get": {
|
|
44152
44173
|
get: {
|
|
44153
|
-
description: "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44174
|
+
description: "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44154
44175
|
operationId: "acsAccessGroupsGetGet",
|
|
44155
44176
|
parameters: [
|
|
44156
44177
|
{
|
|
@@ -44199,7 +44220,7 @@ var openapi_default = {
|
|
|
44199
44220
|
"x-title": "Get an Access Group"
|
|
44200
44221
|
},
|
|
44201
44222
|
post: {
|
|
44202
|
-
description: "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44223
|
+
description: "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44203
44224
|
operationId: "acsAccessGroupsGetPost",
|
|
44204
44225
|
requestBody: {
|
|
44205
44226
|
content: {
|
|
@@ -44255,7 +44276,7 @@ var openapi_default = {
|
|
|
44255
44276
|
},
|
|
44256
44277
|
"/acs/access_groups/list": {
|
|
44257
44278
|
get: {
|
|
44258
|
-
description: "Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44279
|
+
description: "Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44259
44280
|
operationId: "acsAccessGroupsListGet",
|
|
44260
44281
|
parameters: [
|
|
44261
44282
|
{
|
|
@@ -44331,7 +44352,7 @@ var openapi_default = {
|
|
|
44331
44352
|
"x-title": "List Access Groups"
|
|
44332
44353
|
},
|
|
44333
44354
|
post: {
|
|
44334
|
-
description: "Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44355
|
+
description: "Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44335
44356
|
operationId: "acsAccessGroupsListPost",
|
|
44336
44357
|
requestBody: {
|
|
44337
44358
|
content: {
|
|
@@ -44402,7 +44423,7 @@ var openapi_default = {
|
|
|
44402
44423
|
},
|
|
44403
44424
|
"/acs/access_groups/list_accessible_entrances": {
|
|
44404
44425
|
get: {
|
|
44405
|
-
description: "Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44426
|
+
description: "Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44406
44427
|
operationId: "acsAccessGroupsListAccessibleEntrancesGet",
|
|
44407
44428
|
parameters: [
|
|
44408
44429
|
{
|
|
@@ -44452,7 +44473,7 @@ var openapi_default = {
|
|
|
44452
44473
|
"x-title": "List Entrances Accessible to an Access Group"
|
|
44453
44474
|
},
|
|
44454
44475
|
post: {
|
|
44455
|
-
description: "Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44476
|
+
description: "Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44456
44477
|
operationId: "acsAccessGroupsListAccessibleEntrancesPost",
|
|
44457
44478
|
requestBody: {
|
|
44458
44479
|
content: {
|
|
@@ -44509,7 +44530,7 @@ var openapi_default = {
|
|
|
44509
44530
|
},
|
|
44510
44531
|
"/acs/access_groups/list_users": {
|
|
44511
44532
|
get: {
|
|
44512
|
-
description: "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44533
|
+
description: "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44513
44534
|
operationId: "acsAccessGroupsListUsersGet",
|
|
44514
44535
|
parameters: [
|
|
44515
44536
|
{
|
|
@@ -44559,7 +44580,7 @@ var openapi_default = {
|
|
|
44559
44580
|
"x-title": "List ACS Users in an Access Group"
|
|
44560
44581
|
},
|
|
44561
44582
|
post: {
|
|
44562
|
-
description: "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44583
|
+
description: "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44563
44584
|
operationId: "acsAccessGroupsListUsersPost",
|
|
44564
44585
|
requestBody: {
|
|
44565
44586
|
content: {
|
|
@@ -44616,7 +44637,7 @@ var openapi_default = {
|
|
|
44616
44637
|
},
|
|
44617
44638
|
"/acs/access_groups/remove_user": {
|
|
44618
44639
|
delete: {
|
|
44619
|
-
description: "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44640
|
+
description: "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44620
44641
|
operationId: "acsAccessGroupsRemoveUserDelete",
|
|
44621
44642
|
parameters: [
|
|
44622
44643
|
{
|
|
@@ -44679,7 +44700,7 @@ var openapi_default = {
|
|
|
44679
44700
|
"x-title": "Remove an ACS User from an Access Group"
|
|
44680
44701
|
},
|
|
44681
44702
|
post: {
|
|
44682
|
-
description: "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44703
|
+
description: "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44683
44704
|
operationId: "acsAccessGroupsRemoveUserPost",
|
|
44684
44705
|
requestBody: {
|
|
44685
44706
|
content: {
|
|
@@ -44739,7 +44760,7 @@ var openapi_default = {
|
|
|
44739
44760
|
},
|
|
44740
44761
|
"/acs/access_groups/unmanaged/get": {
|
|
44741
44762
|
get: {
|
|
44742
|
-
description: "Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44763
|
+
description: "Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44743
44764
|
operationId: "acsAccessGroupsUnmanagedGetGet",
|
|
44744
44765
|
parameters: [
|
|
44745
44766
|
{
|
|
@@ -44789,7 +44810,7 @@ var openapi_default = {
|
|
|
44789
44810
|
"x-undocumented": "No unmanaged access groups are currently implemented."
|
|
44790
44811
|
},
|
|
44791
44812
|
post: {
|
|
44792
|
-
description: "Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44813
|
+
description: "Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44793
44814
|
operationId: "acsAccessGroupsUnmanagedGetPost",
|
|
44794
44815
|
requestBody: {
|
|
44795
44816
|
content: {
|
|
@@ -44846,7 +44867,7 @@ var openapi_default = {
|
|
|
44846
44867
|
},
|
|
44847
44868
|
"/acs/access_groups/unmanaged/list": {
|
|
44848
44869
|
get: {
|
|
44849
|
-
description: "Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44870
|
+
description: "Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44850
44871
|
operationId: "acsAccessGroupsUnmanagedListGet",
|
|
44851
44872
|
parameters: [
|
|
44852
44873
|
{
|
|
@@ -44916,7 +44937,7 @@ var openapi_default = {
|
|
|
44916
44937
|
"x-undocumented": "No unmanaged access groups are currently implemented."
|
|
44917
44938
|
},
|
|
44918
44939
|
post: {
|
|
44919
|
-
description: "Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44940
|
+
description: "Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44920
44941
|
operationId: "acsAccessGroupsUnmanagedListPost",
|
|
44921
44942
|
requestBody: {
|
|
44922
44943
|
content: {
|
|
@@ -48309,7 +48330,7 @@ var openapi_default = {
|
|
|
48309
48330
|
},
|
|
48310
48331
|
"/acs/users/add_to_access_group": {
|
|
48311
48332
|
post: {
|
|
48312
|
-
description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
48333
|
+
description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
48313
48334
|
operationId: "acsUsersAddToAccessGroupPost",
|
|
48314
48335
|
requestBody: {
|
|
48315
48336
|
content: {
|
|
@@ -48362,7 +48383,7 @@ var openapi_default = {
|
|
|
48362
48383
|
"x-title": "Add an ACS User to an Access Group"
|
|
48363
48384
|
},
|
|
48364
48385
|
put: {
|
|
48365
|
-
description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
48386
|
+
description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
48366
48387
|
operationId: "acsUsersAddToAccessGroupPut",
|
|
48367
48388
|
requestBody: {
|
|
48368
48389
|
content: {
|
|
@@ -49106,7 +49127,7 @@ var openapi_default = {
|
|
|
49106
49127
|
},
|
|
49107
49128
|
"/acs/users/remove_from_access_group": {
|
|
49108
49129
|
delete: {
|
|
49109
|
-
description: "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
49130
|
+
description: "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
49110
49131
|
operationId: "acsUsersRemoveFromAccessGroupDelete",
|
|
49111
49132
|
parameters: [
|
|
49112
49133
|
{
|
|
@@ -49169,7 +49190,7 @@ var openapi_default = {
|
|
|
49169
49190
|
"x-title": "Remove an ACS User from an Access Group"
|
|
49170
49191
|
},
|
|
49171
49192
|
post: {
|
|
49172
|
-
description: "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
49193
|
+
description: "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
49173
49194
|
operationId: "acsUsersRemoveFromAccessGroupPost",
|
|
49174
49195
|
requestBody: {
|
|
49175
49196
|
content: {
|
|
@@ -53616,10 +53637,48 @@ var openapi_default = {
|
|
|
53616
53637
|
"application/json": {
|
|
53617
53638
|
schema: {
|
|
53618
53639
|
properties: {
|
|
53640
|
+
customer_portal: {
|
|
53641
|
+
description: "Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product\u2014either by sharing a link with users or embedding a view in an iframe.\n\nWith Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.\n\nSeam hosts these flows, handling everything from account connection and device mapping to full-featured device control.",
|
|
53642
|
+
properties: {
|
|
53643
|
+
created_at: {
|
|
53644
|
+
description: "Date and time at which the customer portal link was created.",
|
|
53645
|
+
format: "date-time",
|
|
53646
|
+
type: "string"
|
|
53647
|
+
},
|
|
53648
|
+
customer_key: {
|
|
53649
|
+
description: "Customer key for the customer portal.",
|
|
53650
|
+
type: "string"
|
|
53651
|
+
},
|
|
53652
|
+
expires_at: {
|
|
53653
|
+
description: "Date and time at which the customer portal link expires.",
|
|
53654
|
+
format: "date-time",
|
|
53655
|
+
type: "string"
|
|
53656
|
+
},
|
|
53657
|
+
url: {
|
|
53658
|
+
description: "URL for the customer portal.",
|
|
53659
|
+
format: "uri",
|
|
53660
|
+
type: "string"
|
|
53661
|
+
},
|
|
53662
|
+
workspace_id: {
|
|
53663
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer portal.",
|
|
53664
|
+
format: "uuid",
|
|
53665
|
+
type: "string"
|
|
53666
|
+
}
|
|
53667
|
+
},
|
|
53668
|
+
required: [
|
|
53669
|
+
"url",
|
|
53670
|
+
"customer_key",
|
|
53671
|
+
"expires_at",
|
|
53672
|
+
"workspace_id",
|
|
53673
|
+
"created_at"
|
|
53674
|
+
],
|
|
53675
|
+
type: "object",
|
|
53676
|
+
"x-route-path": "/customers"
|
|
53677
|
+
},
|
|
53619
53678
|
magic_link: { $ref: "#/components/schemas/magic_link" },
|
|
53620
53679
|
ok: { type: "boolean" }
|
|
53621
53680
|
},
|
|
53622
|
-
required: ["magic_link", "ok"],
|
|
53681
|
+
required: ["customer_portal", "magic_link", "ok"],
|
|
53623
53682
|
type: "object"
|
|
53624
53683
|
}
|
|
53625
53684
|
}
|
|
@@ -53638,8 +53697,8 @@ var openapi_default = {
|
|
|
53638
53697
|
tags: [],
|
|
53639
53698
|
"x-fern-sdk-group-name": ["customers"],
|
|
53640
53699
|
"x-fern-sdk-method-name": "create_portal",
|
|
53641
|
-
"x-fern-sdk-return-value": "
|
|
53642
|
-
"x-response-key": "
|
|
53700
|
+
"x-fern-sdk-return-value": "customer_portal",
|
|
53701
|
+
"x-response-key": "customer_portal",
|
|
53643
53702
|
"x-title": "Create Customer Portal"
|
|
53644
53703
|
}
|
|
53645
53704
|
},
|
|
@@ -59592,7 +59651,7 @@ var openapi_default = {
|
|
|
59592
59651
|
},
|
|
59593
59652
|
"/instant_keys/get": {
|
|
59594
59653
|
get: {
|
|
59595
|
-
description: "Gets an [instant key](https://docs.seam.co/latest/capability-guides/
|
|
59654
|
+
description: "Gets an [instant key](https://docs.seam.co/latest/capability-guides/instant-keys).",
|
|
59596
59655
|
operationId: "instantKeysGetGet",
|
|
59597
59656
|
parameters: [
|
|
59598
59657
|
{
|
|
@@ -59647,7 +59706,7 @@ var openapi_default = {
|
|
|
59647
59706
|
"x-title": "Get an Instant Key"
|
|
59648
59707
|
},
|
|
59649
59708
|
post: {
|
|
59650
|
-
description: "Gets an [instant key](https://docs.seam.co/latest/capability-guides/
|
|
59709
|
+
description: "Gets an [instant key](https://docs.seam.co/latest/capability-guides/instant-keys).",
|
|
59651
59710
|
operationId: "instantKeysGetPost",
|
|
59652
59711
|
requestBody: {
|
|
59653
59712
|
content: {
|
|
@@ -59705,7 +59764,7 @@ var openapi_default = {
|
|
|
59705
59764
|
},
|
|
59706
59765
|
"/instant_keys/list": {
|
|
59707
59766
|
get: {
|
|
59708
|
-
description: "Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/
|
|
59767
|
+
description: "Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/instant-keys).",
|
|
59709
59768
|
operationId: "instantKeysListGet",
|
|
59710
59769
|
parameters: [
|
|
59711
59770
|
{
|
|
@@ -59754,7 +59813,7 @@ var openapi_default = {
|
|
|
59754
59813
|
"x-title": "List Instant Keys"
|
|
59755
59814
|
},
|
|
59756
59815
|
post: {
|
|
59757
|
-
description: "Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/
|
|
59816
|
+
description: "Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/instant-keys).",
|
|
59758
59817
|
operationId: "instantKeysListPost",
|
|
59759
59818
|
requestBody: {
|
|
59760
59819
|
content: {
|
|
@@ -79565,7 +79624,7 @@ var openapi_default = {
|
|
|
79565
79624
|
},
|
|
79566
79625
|
"/user_identities/delete": {
|
|
79567
79626
|
delete: {
|
|
79568
|
-
description: "Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/latest/api/
|
|
79627
|
+
description: "Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/latest/api/acs/credentials), [acs users](https://docs.seam.co/latest/api/acs/users) and [client sessions](https://docs.seam.co/latest/api/client_sessions).",
|
|
79569
79628
|
operationId: "userIdentitiesDeleteDelete",
|
|
79570
79629
|
parameters: [
|
|
79571
79630
|
{
|
|
@@ -79608,7 +79667,7 @@ var openapi_default = {
|
|
|
79608
79667
|
"x-title": "Delete a User Identity"
|
|
79609
79668
|
},
|
|
79610
79669
|
post: {
|
|
79611
|
-
description: "Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/latest/api/
|
|
79670
|
+
description: "Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/latest/api/acs/credentials), [acs users](https://docs.seam.co/latest/api/acs/users) and [client sessions](https://docs.seam.co/latest/api/client_sessions).",
|
|
79612
79671
|
operationId: "userIdentitiesDeletePost",
|
|
79613
79672
|
requestBody: {
|
|
79614
79673
|
content: {
|
|
@@ -80056,7 +80115,7 @@ var openapi_default = {
|
|
|
80056
80115
|
},
|
|
80057
80116
|
"/user_identities/generate_instant_key": {
|
|
80058
80117
|
post: {
|
|
80059
|
-
description: "Generates a new [instant key](https://docs.seam.co/latest/capability-guides/
|
|
80118
|
+
description: "Generates a new [instant key](https://docs.seam.co/latest/capability-guides/instant-keys) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
|
|
80060
80119
|
operationId: "userIdentitiesGenerateInstantKeyPost",
|
|
80061
80120
|
requestBody: {
|
|
80062
80121
|
content: {
|