@seamapi/types 1.801.0 → 1.803.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 +107 -58
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +209 -19
- package/dist/index.cjs +107 -58
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +58 -0
- package/lib/seam/connect/models/access-codes/managed-access-code.js +9 -0
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +21 -0
- 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/batch.d.ts +58 -0
- 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/openapi.js +89 -47
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +96 -19
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +14 -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/openapi.ts +97 -47
- package/src/lib/seam/connect/route-types.ts +107 -19
package/dist/index.cjs
CHANGED
|
@@ -2382,6 +2382,11 @@ var schlage_detected_duplicate = common_access_code_warning.extend({
|
|
|
2382
2382
|
var schlage_creation_outage = common_access_code_warning.extend({
|
|
2383
2383
|
warning_code: zod.z.literal("schlage_creation_outage").describe(warning_code_description3)
|
|
2384
2384
|
}).describe("Received an error when attempting to create this code.");
|
|
2385
|
+
var schlage_access_code_ambiguous_timezone_dst_risk = common_access_code_warning.extend({
|
|
2386
|
+
warning_code: zod.z.literal("schlage_access_code_ambiguous_timezone_dst_risk").describe(warning_code_description3)
|
|
2387
|
+
}).describe(
|
|
2388
|
+
"The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift \u2014 the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling."
|
|
2389
|
+
);
|
|
2385
2390
|
var delay_in_setting_on_device = common_access_code_warning.extend({
|
|
2386
2391
|
warning_code: zod.z.literal("delay_in_setting_on_device").describe(warning_code_description3)
|
|
2387
2392
|
}).describe("Delay in setting code on device.");
|
|
@@ -2419,6 +2424,7 @@ var access_code_warning = zod.z.discriminatedUnion("warning_code", [
|
|
|
2419
2424
|
smartthings_failed_to_set_access_code_warning,
|
|
2420
2425
|
schlage_detected_duplicate,
|
|
2421
2426
|
schlage_creation_outage,
|
|
2427
|
+
schlage_access_code_ambiguous_timezone_dst_risk,
|
|
2422
2428
|
code_modified_external_to_seam_warning,
|
|
2423
2429
|
delay_in_setting_on_device,
|
|
2424
2430
|
delay_in_removing_from_device,
|
|
@@ -2438,6 +2444,7 @@ zod.z.object({
|
|
|
2438
2444
|
smartthings_failed_to_set_access_code: smartthings_failed_to_set_access_code_warning.optional().nullable(),
|
|
2439
2445
|
schlage_detected_duplicate: schlage_detected_duplicate.optional().nullable(),
|
|
2440
2446
|
schlage_creation_outage: schlage_creation_outage.optional().nullable(),
|
|
2447
|
+
schlage_access_code_ambiguous_timezone_dst_risk: schlage_access_code_ambiguous_timezone_dst_risk.optional().nullable(),
|
|
2441
2448
|
code_modified_external_to_seam_warning: code_modified_external_to_seam_warning.optional().nullable(),
|
|
2442
2449
|
delay_in_setting_on_device: delay_in_setting_on_device.optional().nullable(),
|
|
2443
2450
|
delay_in_removing_from_device: delay_in_removing_from_device.optional().nullable(),
|
|
@@ -3129,7 +3136,7 @@ var error_code_description5 = "Unique identifier of the type of error. Enables q
|
|
|
3129
3136
|
var acs_access_groups_failed_to_create_on_acs_system = common_acs_access_group_error.extend({
|
|
3130
3137
|
error_code: zod.z.literal("failed_to_create_on_acs_system").describe(error_code_description5)
|
|
3131
3138
|
}).describe(
|
|
3132
|
-
`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).`
|
|
3139
|
+
`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).`
|
|
3133
3140
|
);
|
|
3134
3141
|
var acs_access_group_errors = zod.z.discriminatedUnion("error_code", [
|
|
3135
3142
|
acs_access_groups_failed_to_create_on_acs_system
|
|
@@ -3206,7 +3213,7 @@ var acs_access_group = common_acs_access_group.extend({
|
|
|
3206
3213
|
---
|
|
3207
3214
|
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.
|
|
3208
3215
|
|
|
3209
|
-
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.
|
|
3216
|
+
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.
|
|
3210
3217
|
|
|
3211
3218
|
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).
|
|
3212
3219
|
`);
|
|
@@ -3756,7 +3763,7 @@ var visionline_instance_unreachable = common_acs_system_error.extend({
|
|
|
3756
3763
|
error_code: zod.z.literal("visionline_instance_unreachable").describe(error_code_description7)
|
|
3757
3764
|
}).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).
|
|
3758
3765
|
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).
|
|
3759
|
-
See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/
|
|
3766
|
+
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).`);
|
|
3760
3767
|
var salto_ks_subscription_limit_exceeded3 = common_acs_system_error.extend({
|
|
3761
3768
|
error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description7)
|
|
3762
3769
|
}).describe(
|
|
@@ -3770,7 +3777,7 @@ var acs_system_disconnected = common_acs_system_error.extend({
|
|
|
3770
3777
|
var account_disconnected3 = common_acs_system_error.extend({
|
|
3771
3778
|
error_code: zod.z.literal("account_disconnected").describe(error_code_description7)
|
|
3772
3779
|
}).describe(
|
|
3773
|
-
"Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/
|
|
3780
|
+
"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."
|
|
3774
3781
|
);
|
|
3775
3782
|
var salto_ks_certification_expired = common_acs_system_error.extend({
|
|
3776
3783
|
error_code: zod.z.literal("salto_ks_certification_expired").describe(error_code_description7)
|
|
@@ -5242,7 +5249,7 @@ var access_grant_access_granted_to_all_doors_event = access_grant_event.extend({
|
|
|
5242
5249
|
All access requested for an Access Grant was successfully granted.
|
|
5243
5250
|
`);
|
|
5244
5251
|
var acs_entrance_id = zod.z.string().uuid().describe(
|
|
5245
|
-
"ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details)."
|
|
5252
|
+
"ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
|
|
5246
5253
|
);
|
|
5247
5254
|
var access_grant_access_granted_to_door_event = access_grant_event.extend({
|
|
5248
5255
|
event_type: zod.z.literal("access_grant.access_granted_to_door"),
|
|
@@ -5456,7 +5463,7 @@ var acs_entrance_added_event = acs_entrance_event.extend({
|
|
|
5456
5463
|
---
|
|
5457
5464
|
route_path: /acs/entrances
|
|
5458
5465
|
---
|
|
5459
|
-
An [access system entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was added.
|
|
5466
|
+
An [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was added.
|
|
5460
5467
|
`);
|
|
5461
5468
|
var acs_entrance_removed_event = acs_entrance_event.extend({
|
|
5462
5469
|
event_type: zod.z.literal("acs_entrance.removed")
|
|
@@ -5464,7 +5471,7 @@ var acs_entrance_removed_event = acs_entrance_event.extend({
|
|
|
5464
5471
|
---
|
|
5465
5472
|
route_path: /acs/entrances
|
|
5466
5473
|
---
|
|
5467
|
-
An [access system entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was removed.
|
|
5474
|
+
An [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was removed.
|
|
5468
5475
|
`);
|
|
5469
5476
|
var acs_entrance_events = [
|
|
5470
5477
|
acs_entrance_added_event,
|
|
@@ -5644,7 +5651,7 @@ var client_session_deleted_event = client_session_event.extend({
|
|
|
5644
5651
|
var client_session_events = [client_session_deleted_event];
|
|
5645
5652
|
var connect_webview_event = common_event.extend({
|
|
5646
5653
|
connect_webview_id: zod.z.string().uuid().describe(
|
|
5647
|
-
"ID of the affected [Connect Webview](https://docs.seam.co/latest/
|
|
5654
|
+
"ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews)."
|
|
5648
5655
|
)
|
|
5649
5656
|
});
|
|
5650
5657
|
var connected_account_id = zod.z.string().uuid().describe(
|
|
@@ -5664,7 +5671,7 @@ var connect_webview_login_succeeded_event = connect_webview_event.extend({
|
|
|
5664
5671
|
---
|
|
5665
5672
|
route_path: /connect_webviews
|
|
5666
5673
|
---
|
|
5667
|
-
A [Connect Webview](https://docs.seam.co/latest/
|
|
5674
|
+
A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login succeeded.
|
|
5668
5675
|
`);
|
|
5669
5676
|
var connect_webview_login_failed_event = connect_webview_event.extend({
|
|
5670
5677
|
event_type: zod.z.literal("connect_webview.login_failed")
|
|
@@ -5672,7 +5679,7 @@ var connect_webview_login_failed_event = connect_webview_event.extend({
|
|
|
5672
5679
|
---
|
|
5673
5680
|
route_path: /connect_webviews
|
|
5674
5681
|
---
|
|
5675
|
-
A [Connect Webview](https://docs.seam.co/latest/
|
|
5682
|
+
A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login failed.
|
|
5676
5683
|
`);
|
|
5677
5684
|
var connect_webview_events = [
|
|
5678
5685
|
connect_webview_login_succeeded_event,
|
|
@@ -5724,7 +5731,7 @@ var connected_account_successful_login_event = connected_account_event.extend({
|
|
|
5724
5731
|
deprecated: Use \`connect_webview.login_succeeded\`.
|
|
5725
5732
|
route_path: /connected_accounts
|
|
5726
5733
|
---
|
|
5727
|
-
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/
|
|
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/core-concepts/connect-webviews).
|
|
5728
5735
|
`);
|
|
5729
5736
|
var connected_account_disconnected_event = connected_account_event.extend({
|
|
5730
5737
|
event_type: zod.z.literal("connected_account.disconnected")
|
|
@@ -8343,6 +8350,27 @@ var openapi_default = {
|
|
|
8343
8350
|
required: ["message", "warning_code"],
|
|
8344
8351
|
type: "object"
|
|
8345
8352
|
},
|
|
8353
|
+
{
|
|
8354
|
+
description: "The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift \u2014 the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling.",
|
|
8355
|
+
properties: {
|
|
8356
|
+
created_at: {
|
|
8357
|
+
description: "Date and time at which Seam created the warning.",
|
|
8358
|
+
format: "date-time",
|
|
8359
|
+
type: "string"
|
|
8360
|
+
},
|
|
8361
|
+
message: {
|
|
8362
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
8363
|
+
type: "string"
|
|
8364
|
+
},
|
|
8365
|
+
warning_code: {
|
|
8366
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
8367
|
+
enum: ["schlage_access_code_ambiguous_timezone_dst_risk"],
|
|
8368
|
+
type: "string"
|
|
8369
|
+
}
|
|
8370
|
+
},
|
|
8371
|
+
required: ["message", "warning_code"],
|
|
8372
|
+
type: "object"
|
|
8373
|
+
},
|
|
8346
8374
|
{
|
|
8347
8375
|
description: "Code was modified or removed externally after Seam successfully set it on the device.",
|
|
8348
8376
|
properties: {
|
|
@@ -9484,7 +9512,7 @@ var openapi_default = {
|
|
|
9484
9512
|
"x-route-path": "/access_methods"
|
|
9485
9513
|
},
|
|
9486
9514
|
acs_access_group: {
|
|
9487
|
-
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).",
|
|
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/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).",
|
|
9488
9516
|
properties: {
|
|
9489
9517
|
access_group_type: {
|
|
9490
9518
|
deprecated: true,
|
|
@@ -9551,7 +9579,7 @@ var openapi_default = {
|
|
|
9551
9579
|
discriminator: { propertyName: "error_code" },
|
|
9552
9580
|
oneOf: [
|
|
9553
9581
|
{
|
|
9554
|
-
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).",
|
|
9582
|
+
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).",
|
|
9555
9583
|
properties: {
|
|
9556
9584
|
created_at: {
|
|
9557
9585
|
description: "Date and time at which Seam created the error.",
|
|
@@ -10882,7 +10910,7 @@ var openapi_default = {
|
|
|
10882
10910
|
type: "object"
|
|
10883
10911
|
},
|
|
10884
10912
|
{
|
|
10885
|
-
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/
|
|
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/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).",
|
|
10886
10914
|
properties: {
|
|
10887
10915
|
created_at: {
|
|
10888
10916
|
description: "Date and time at which Seam created the error.",
|
|
@@ -10945,7 +10973,7 @@ var openapi_default = {
|
|
|
10945
10973
|
type: "object"
|
|
10946
10974
|
},
|
|
10947
10975
|
{
|
|
10948
|
-
description: "Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/
|
|
10976
|
+
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.",
|
|
10949
10977
|
properties: {
|
|
10950
10978
|
created_at: {
|
|
10951
10979
|
description: "Date and time at which Seam created the error.",
|
|
@@ -22712,7 +22740,7 @@ var openapi_default = {
|
|
|
22712
22740
|
type: "string"
|
|
22713
22741
|
},
|
|
22714
22742
|
acs_entrance_id: {
|
|
22715
|
-
description: "ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).",
|
|
22743
|
+
description: "ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
22716
22744
|
format: "uuid",
|
|
22717
22745
|
type: "string"
|
|
22718
22746
|
},
|
|
@@ -22762,7 +22790,7 @@ var openapi_default = {
|
|
|
22762
22790
|
type: "string"
|
|
22763
22791
|
},
|
|
22764
22792
|
acs_entrance_id: {
|
|
22765
|
-
description: "ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).",
|
|
22793
|
+
description: "ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
22766
22794
|
format: "uuid",
|
|
22767
22795
|
type: "string"
|
|
22768
22796
|
},
|
|
@@ -23942,7 +23970,7 @@ var openapi_default = {
|
|
|
23942
23970
|
"x-route-path": "/acs/access_groups"
|
|
23943
23971
|
},
|
|
23944
23972
|
{
|
|
23945
|
-
description: "An [access system entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was added.",
|
|
23973
|
+
description: "An [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was added.",
|
|
23946
23974
|
properties: {
|
|
23947
23975
|
acs_entrance_id: { format: "uuid", type: "string" },
|
|
23948
23976
|
acs_system_id: {
|
|
@@ -23990,7 +24018,7 @@ var openapi_default = {
|
|
|
23990
24018
|
"x-route-path": "/acs/entrances"
|
|
23991
24019
|
},
|
|
23992
24020
|
{
|
|
23993
|
-
description: "An [access system entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was removed.",
|
|
24021
|
+
description: "An [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was removed.",
|
|
23994
24022
|
properties: {
|
|
23995
24023
|
acs_entrance_id: { format: "uuid", type: "string" },
|
|
23996
24024
|
acs_system_id: {
|
|
@@ -24197,7 +24225,7 @@ var openapi_default = {
|
|
|
24197
24225
|
},
|
|
24198
24226
|
{
|
|
24199
24227
|
deprecated: true,
|
|
24200
|
-
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/
|
|
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/core-concepts/connect-webviews).",
|
|
24201
24229
|
properties: {
|
|
24202
24230
|
connect_webview_id: {
|
|
24203
24231
|
description: "ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event.",
|
|
@@ -25106,10 +25134,10 @@ var openapi_default = {
|
|
|
25106
25134
|
"x-route-path": "/action_attempts"
|
|
25107
25135
|
},
|
|
25108
25136
|
{
|
|
25109
|
-
description: "A [Connect Webview](https://docs.seam.co/latest/
|
|
25137
|
+
description: "A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login succeeded.",
|
|
25110
25138
|
properties: {
|
|
25111
25139
|
connect_webview_id: {
|
|
25112
|
-
description: "ID of the affected [Connect Webview](https://docs.seam.co/latest/
|
|
25140
|
+
description: "ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).",
|
|
25113
25141
|
format: "uuid",
|
|
25114
25142
|
type: "string"
|
|
25115
25143
|
},
|
|
@@ -25167,10 +25195,10 @@ var openapi_default = {
|
|
|
25167
25195
|
"x-route-path": "/connect_webviews"
|
|
25168
25196
|
},
|
|
25169
25197
|
{
|
|
25170
|
-
description: "A [Connect Webview](https://docs.seam.co/latest/
|
|
25198
|
+
description: "A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login failed.",
|
|
25171
25199
|
properties: {
|
|
25172
25200
|
connect_webview_id: {
|
|
25173
|
-
description: "ID of the affected [Connect Webview](https://docs.seam.co/latest/
|
|
25201
|
+
description: "ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).",
|
|
25174
25202
|
format: "uuid",
|
|
25175
25203
|
type: "string"
|
|
25176
25204
|
},
|
|
@@ -31439,6 +31467,27 @@ var openapi_default = {
|
|
|
31439
31467
|
required: ["message", "warning_code"],
|
|
31440
31468
|
type: "object"
|
|
31441
31469
|
},
|
|
31470
|
+
{
|
|
31471
|
+
description: "The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift \u2014 the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling.",
|
|
31472
|
+
properties: {
|
|
31473
|
+
created_at: {
|
|
31474
|
+
description: "Date and time at which Seam created the warning.",
|
|
31475
|
+
format: "date-time",
|
|
31476
|
+
type: "string"
|
|
31477
|
+
},
|
|
31478
|
+
message: {
|
|
31479
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
31480
|
+
type: "string"
|
|
31481
|
+
},
|
|
31482
|
+
warning_code: {
|
|
31483
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
31484
|
+
enum: ["schlage_access_code_ambiguous_timezone_dst_risk"],
|
|
31485
|
+
type: "string"
|
|
31486
|
+
}
|
|
31487
|
+
},
|
|
31488
|
+
required: ["message", "warning_code"],
|
|
31489
|
+
type: "object"
|
|
31490
|
+
},
|
|
31442
31491
|
{
|
|
31443
31492
|
description: "Code was modified or removed externally after Seam successfully set it on the device.",
|
|
31444
31493
|
properties: {
|
|
@@ -31793,7 +31842,7 @@ var openapi_default = {
|
|
|
31793
31842
|
discriminator: { propertyName: "error_code" },
|
|
31794
31843
|
oneOf: [
|
|
31795
31844
|
{
|
|
31796
|
-
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).",
|
|
31845
|
+
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).",
|
|
31797
31846
|
properties: {
|
|
31798
31847
|
created_at: {
|
|
31799
31848
|
description: "Date and time at which Seam created the error.",
|
|
@@ -35084,7 +35133,7 @@ var openapi_default = {
|
|
|
35084
35133
|
"x-undocumented": "Only used internally."
|
|
35085
35134
|
},
|
|
35086
35135
|
use_backup_access_code_pool: {
|
|
35087
|
-
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/
|
|
35136
|
+
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).",
|
|
35088
35137
|
type: "boolean"
|
|
35089
35138
|
},
|
|
35090
35139
|
use_offline_access_code: {
|
|
@@ -37355,7 +37404,7 @@ var openapi_default = {
|
|
|
37355
37404
|
type: "string"
|
|
37356
37405
|
},
|
|
37357
37406
|
use_backup_access_code_pool: {
|
|
37358
|
-
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/
|
|
37407
|
+
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).",
|
|
37359
37408
|
type: "boolean"
|
|
37360
37409
|
},
|
|
37361
37410
|
use_offline_access_code: {
|
|
@@ -37493,7 +37542,7 @@ var openapi_default = {
|
|
|
37493
37542
|
type: "string"
|
|
37494
37543
|
},
|
|
37495
37544
|
use_backup_access_code_pool: {
|
|
37496
|
-
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/
|
|
37545
|
+
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).",
|
|
37497
37546
|
type: "boolean"
|
|
37498
37547
|
},
|
|
37499
37548
|
use_offline_access_code: {
|
|
@@ -37631,7 +37680,7 @@ var openapi_default = {
|
|
|
37631
37680
|
type: "string"
|
|
37632
37681
|
},
|
|
37633
37682
|
use_backup_access_code_pool: {
|
|
37634
|
-
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/
|
|
37683
|
+
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).",
|
|
37635
37684
|
type: "boolean"
|
|
37636
37685
|
},
|
|
37637
37686
|
use_offline_access_code: {
|
|
@@ -43888,7 +43937,7 @@ var openapi_default = {
|
|
|
43888
43937
|
},
|
|
43889
43938
|
"/acs/access_groups/add_user": {
|
|
43890
43939
|
post: {
|
|
43891
|
-
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).",
|
|
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/user-management/assigning-users-to-access-groups).",
|
|
43892
43941
|
operationId: "acsAccessGroupsAddUserPost",
|
|
43893
43942
|
requestBody: {
|
|
43894
43943
|
content: {
|
|
@@ -43946,7 +43995,7 @@ var openapi_default = {
|
|
|
43946
43995
|
"x-title": "Add an ACS User to an Access Group"
|
|
43947
43996
|
},
|
|
43948
43997
|
put: {
|
|
43949
|
-
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).",
|
|
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/user-management/assigning-users-to-access-groups).",
|
|
43950
43999
|
operationId: "acsAccessGroupsAddUserPut",
|
|
43951
44000
|
requestBody: {
|
|
43952
44001
|
content: {
|
|
@@ -44006,7 +44055,7 @@ var openapi_default = {
|
|
|
44006
44055
|
},
|
|
44007
44056
|
"/acs/access_groups/delete": {
|
|
44008
44057
|
delete: {
|
|
44009
|
-
description: "Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44058
|
+
description: "Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44010
44059
|
operationId: "acsAccessGroupsDeleteDelete",
|
|
44011
44060
|
parameters: [
|
|
44012
44061
|
{
|
|
@@ -44050,7 +44099,7 @@ var openapi_default = {
|
|
|
44050
44099
|
"x-title": "Delete an Access Group"
|
|
44051
44100
|
},
|
|
44052
44101
|
post: {
|
|
44053
|
-
description: "Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44102
|
+
description: "Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44054
44103
|
operationId: "acsAccessGroupsDeletePost",
|
|
44055
44104
|
requestBody: {
|
|
44056
44105
|
content: {
|
|
@@ -44101,7 +44150,7 @@ var openapi_default = {
|
|
|
44101
44150
|
},
|
|
44102
44151
|
"/acs/access_groups/get": {
|
|
44103
44152
|
get: {
|
|
44104
|
-
description: "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44153
|
+
description: "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44105
44154
|
operationId: "acsAccessGroupsGetGet",
|
|
44106
44155
|
parameters: [
|
|
44107
44156
|
{
|
|
@@ -44150,7 +44199,7 @@ var openapi_default = {
|
|
|
44150
44199
|
"x-title": "Get an Access Group"
|
|
44151
44200
|
},
|
|
44152
44201
|
post: {
|
|
44153
|
-
description: "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44202
|
+
description: "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44154
44203
|
operationId: "acsAccessGroupsGetPost",
|
|
44155
44204
|
requestBody: {
|
|
44156
44205
|
content: {
|
|
@@ -44206,7 +44255,7 @@ var openapi_default = {
|
|
|
44206
44255
|
},
|
|
44207
44256
|
"/acs/access_groups/list": {
|
|
44208
44257
|
get: {
|
|
44209
|
-
description: "Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44258
|
+
description: "Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44210
44259
|
operationId: "acsAccessGroupsListGet",
|
|
44211
44260
|
parameters: [
|
|
44212
44261
|
{
|
|
@@ -44282,7 +44331,7 @@ var openapi_default = {
|
|
|
44282
44331
|
"x-title": "List Access Groups"
|
|
44283
44332
|
},
|
|
44284
44333
|
post: {
|
|
44285
|
-
description: "Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44334
|
+
description: "Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44286
44335
|
operationId: "acsAccessGroupsListPost",
|
|
44287
44336
|
requestBody: {
|
|
44288
44337
|
content: {
|
|
@@ -44353,7 +44402,7 @@ var openapi_default = {
|
|
|
44353
44402
|
},
|
|
44354
44403
|
"/acs/access_groups/list_accessible_entrances": {
|
|
44355
44404
|
get: {
|
|
44356
|
-
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).",
|
|
44405
|
+
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).",
|
|
44357
44406
|
operationId: "acsAccessGroupsListAccessibleEntrancesGet",
|
|
44358
44407
|
parameters: [
|
|
44359
44408
|
{
|
|
@@ -44403,7 +44452,7 @@ var openapi_default = {
|
|
|
44403
44452
|
"x-title": "List Entrances Accessible to an Access Group"
|
|
44404
44453
|
},
|
|
44405
44454
|
post: {
|
|
44406
|
-
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).",
|
|
44455
|
+
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).",
|
|
44407
44456
|
operationId: "acsAccessGroupsListAccessibleEntrancesPost",
|
|
44408
44457
|
requestBody: {
|
|
44409
44458
|
content: {
|
|
@@ -44460,7 +44509,7 @@ var openapi_default = {
|
|
|
44460
44509
|
},
|
|
44461
44510
|
"/acs/access_groups/list_users": {
|
|
44462
44511
|
get: {
|
|
44463
|
-
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).",
|
|
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/user-management/assigning-users-to-access-groups).",
|
|
44464
44513
|
operationId: "acsAccessGroupsListUsersGet",
|
|
44465
44514
|
parameters: [
|
|
44466
44515
|
{
|
|
@@ -44510,7 +44559,7 @@ var openapi_default = {
|
|
|
44510
44559
|
"x-title": "List ACS Users in an Access Group"
|
|
44511
44560
|
},
|
|
44512
44561
|
post: {
|
|
44513
|
-
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).",
|
|
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/user-management/assigning-users-to-access-groups).",
|
|
44514
44563
|
operationId: "acsAccessGroupsListUsersPost",
|
|
44515
44564
|
requestBody: {
|
|
44516
44565
|
content: {
|
|
@@ -44567,7 +44616,7 @@ var openapi_default = {
|
|
|
44567
44616
|
},
|
|
44568
44617
|
"/acs/access_groups/remove_user": {
|
|
44569
44618
|
delete: {
|
|
44570
|
-
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).",
|
|
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/user-management/assigning-users-to-access-groups).",
|
|
44571
44620
|
operationId: "acsAccessGroupsRemoveUserDelete",
|
|
44572
44621
|
parameters: [
|
|
44573
44622
|
{
|
|
@@ -44630,7 +44679,7 @@ var openapi_default = {
|
|
|
44630
44679
|
"x-title": "Remove an ACS User from an Access Group"
|
|
44631
44680
|
},
|
|
44632
44681
|
post: {
|
|
44633
|
-
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).",
|
|
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/user-management/assigning-users-to-access-groups).",
|
|
44634
44683
|
operationId: "acsAccessGroupsRemoveUserPost",
|
|
44635
44684
|
requestBody: {
|
|
44636
44685
|
content: {
|
|
@@ -44690,7 +44739,7 @@ var openapi_default = {
|
|
|
44690
44739
|
},
|
|
44691
44740
|
"/acs/access_groups/unmanaged/get": {
|
|
44692
44741
|
get: {
|
|
44693
|
-
description: "Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44742
|
+
description: "Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44694
44743
|
operationId: "acsAccessGroupsUnmanagedGetGet",
|
|
44695
44744
|
parameters: [
|
|
44696
44745
|
{
|
|
@@ -44740,7 +44789,7 @@ var openapi_default = {
|
|
|
44740
44789
|
"x-undocumented": "No unmanaged access groups are currently implemented."
|
|
44741
44790
|
},
|
|
44742
44791
|
post: {
|
|
44743
|
-
description: "Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44792
|
+
description: "Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).",
|
|
44744
44793
|
operationId: "acsAccessGroupsUnmanagedGetPost",
|
|
44745
44794
|
requestBody: {
|
|
44746
44795
|
content: {
|
|
@@ -44797,7 +44846,7 @@ var openapi_default = {
|
|
|
44797
44846
|
},
|
|
44798
44847
|
"/acs/access_groups/unmanaged/list": {
|
|
44799
44848
|
get: {
|
|
44800
|
-
description: "Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44849
|
+
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).",
|
|
44801
44850
|
operationId: "acsAccessGroupsUnmanagedListGet",
|
|
44802
44851
|
parameters: [
|
|
44803
44852
|
{
|
|
@@ -44867,7 +44916,7 @@ var openapi_default = {
|
|
|
44867
44916
|
"x-undocumented": "No unmanaged access groups are currently implemented."
|
|
44868
44917
|
},
|
|
44869
44918
|
post: {
|
|
44870
|
-
description: "Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
44919
|
+
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).",
|
|
44871
44920
|
operationId: "acsAccessGroupsUnmanagedListPost",
|
|
44872
44921
|
requestBody: {
|
|
44873
44922
|
content: {
|
|
@@ -48260,7 +48309,7 @@ var openapi_default = {
|
|
|
48260
48309
|
},
|
|
48261
48310
|
"/acs/users/add_to_access_group": {
|
|
48262
48311
|
post: {
|
|
48263
|
-
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).",
|
|
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/user-management/assigning-users-to-access-groups).",
|
|
48264
48313
|
operationId: "acsUsersAddToAccessGroupPost",
|
|
48265
48314
|
requestBody: {
|
|
48266
48315
|
content: {
|
|
@@ -48313,7 +48362,7 @@ var openapi_default = {
|
|
|
48313
48362
|
"x-title": "Add an ACS User to an Access Group"
|
|
48314
48363
|
},
|
|
48315
48364
|
put: {
|
|
48316
|
-
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).",
|
|
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/user-management/assigning-users-to-access-groups).",
|
|
48317
48366
|
operationId: "acsUsersAddToAccessGroupPut",
|
|
48318
48367
|
requestBody: {
|
|
48319
48368
|
content: {
|
|
@@ -49057,7 +49106,7 @@ var openapi_default = {
|
|
|
49057
49106
|
},
|
|
49058
49107
|
"/acs/users/remove_from_access_group": {
|
|
49059
49108
|
delete: {
|
|
49060
|
-
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).",
|
|
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/user-management/assigning-users-to-access-groups).",
|
|
49061
49110
|
operationId: "acsUsersRemoveFromAccessGroupDelete",
|
|
49062
49111
|
parameters: [
|
|
49063
49112
|
{
|
|
@@ -49120,7 +49169,7 @@ var openapi_default = {
|
|
|
49120
49169
|
"x-title": "Remove an ACS User from an Access Group"
|
|
49121
49170
|
},
|
|
49122
49171
|
post: {
|
|
49123
|
-
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).",
|
|
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/user-management/assigning-users-to-access-groups).",
|
|
49124
49173
|
operationId: "acsUsersRemoveFromAccessGroupPost",
|
|
49125
49174
|
requestBody: {
|
|
49126
49175
|
content: {
|
|
@@ -59543,7 +59592,7 @@ var openapi_default = {
|
|
|
59543
59592
|
},
|
|
59544
59593
|
"/instant_keys/get": {
|
|
59545
59594
|
get: {
|
|
59546
|
-
description: "Gets an [instant key](https://docs.seam.co/latest/capability-guides/
|
|
59595
|
+
description: "Gets an [instant key](https://docs.seam.co/latest/capability-guides/instant-keys).",
|
|
59547
59596
|
operationId: "instantKeysGetGet",
|
|
59548
59597
|
parameters: [
|
|
59549
59598
|
{
|
|
@@ -59598,7 +59647,7 @@ var openapi_default = {
|
|
|
59598
59647
|
"x-title": "Get an Instant Key"
|
|
59599
59648
|
},
|
|
59600
59649
|
post: {
|
|
59601
|
-
description: "Gets an [instant key](https://docs.seam.co/latest/capability-guides/
|
|
59650
|
+
description: "Gets an [instant key](https://docs.seam.co/latest/capability-guides/instant-keys).",
|
|
59602
59651
|
operationId: "instantKeysGetPost",
|
|
59603
59652
|
requestBody: {
|
|
59604
59653
|
content: {
|
|
@@ -59656,7 +59705,7 @@ var openapi_default = {
|
|
|
59656
59705
|
},
|
|
59657
59706
|
"/instant_keys/list": {
|
|
59658
59707
|
get: {
|
|
59659
|
-
description: "Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/
|
|
59708
|
+
description: "Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/instant-keys).",
|
|
59660
59709
|
operationId: "instantKeysListGet",
|
|
59661
59710
|
parameters: [
|
|
59662
59711
|
{
|
|
@@ -59705,7 +59754,7 @@ var openapi_default = {
|
|
|
59705
59754
|
"x-title": "List Instant Keys"
|
|
59706
59755
|
},
|
|
59707
59756
|
post: {
|
|
59708
|
-
description: "Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/
|
|
59757
|
+
description: "Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/instant-keys).",
|
|
59709
59758
|
operationId: "instantKeysListPost",
|
|
59710
59759
|
requestBody: {
|
|
59711
59760
|
content: {
|
|
@@ -79516,7 +79565,7 @@ var openapi_default = {
|
|
|
79516
79565
|
},
|
|
79517
79566
|
"/user_identities/delete": {
|
|
79518
79567
|
delete: {
|
|
79519
|
-
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/
|
|
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/acs/credentials), [acs users](https://docs.seam.co/latest/api/acs/users) and [client sessions](https://docs.seam.co/latest/api/client_sessions).",
|
|
79520
79569
|
operationId: "userIdentitiesDeleteDelete",
|
|
79521
79570
|
parameters: [
|
|
79522
79571
|
{
|
|
@@ -79559,7 +79608,7 @@ var openapi_default = {
|
|
|
79559
79608
|
"x-title": "Delete a User Identity"
|
|
79560
79609
|
},
|
|
79561
79610
|
post: {
|
|
79562
|
-
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/
|
|
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/acs/credentials), [acs users](https://docs.seam.co/latest/api/acs/users) and [client sessions](https://docs.seam.co/latest/api/client_sessions).",
|
|
79563
79612
|
operationId: "userIdentitiesDeletePost",
|
|
79564
79613
|
requestBody: {
|
|
79565
79614
|
content: {
|
|
@@ -80007,7 +80056,7 @@ var openapi_default = {
|
|
|
80007
80056
|
},
|
|
80008
80057
|
"/user_identities/generate_instant_key": {
|
|
80009
80058
|
post: {
|
|
80010
|
-
description: "Generates a new [instant key](https://docs.seam.co/latest/capability-guides/
|
|
80059
|
+
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).",
|
|
80011
80060
|
operationId: "userIdentitiesGenerateInstantKeyPost",
|
|
80012
80061
|
requestBody: {
|
|
80013
80062
|
content: {
|