@seamapi/types 1.368.0 → 1.369.1
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 +454 -243
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +2663 -1011
- package/lib/seam/connect/models/acs/acs-access-group.js +4 -1
- package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential.js +5 -1
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-encoder.js +14 -1
- package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.js +2 -0
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-system.js +4 -0
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +4 -0
- package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/common.js +36 -19
- package/lib/seam/connect/models/action-attempts/common.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/encode-credential.js +9 -5
- package/lib/seam/connect/models/action-attempts/encode-credential.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +154 -34
- package/lib/seam/connect/openapi.js +344 -172
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +2509 -977
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +4 -1
- package/src/lib/seam/connect/models/acs/acs-credential.ts +5 -1
- package/src/lib/seam/connect/models/acs/acs-encoder.ts +14 -1
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +2 -0
- package/src/lib/seam/connect/models/acs/acs-system.ts +4 -0
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +4 -0
- package/src/lib/seam/connect/models/action-attempts/common.ts +42 -19
- package/src/lib/seam/connect/models/action-attempts/encode-credential.ts +17 -5
- package/src/lib/seam/connect/openapi.ts +415 -172
- package/src/lib/seam/connect/route-types.ts +2509 -977
package/dist/connect.cjs
CHANGED
|
@@ -1719,7 +1719,10 @@ var acs_access_group = common_acs_access_group.extend({
|
|
|
1719
1719
|
route_path: /acs/access_groups
|
|
1720
1720
|
---
|
|
1721
1721
|
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.
|
|
1722
|
-
|
|
1722
|
+
|
|
1723
|
+
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.
|
|
1724
|
+
|
|
1725
|
+
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).
|
|
1723
1726
|
`);
|
|
1724
1727
|
var unmanaged_acs_access_group = common_acs_access_group.extend({
|
|
1725
1728
|
is_managed: zod.z.literal(false)
|
|
@@ -1946,7 +1949,11 @@ var acs_credential = common_acs_credential.merge(
|
|
|
1946
1949
|
---
|
|
1947
1950
|
route_path: /acs/credentials
|
|
1948
1951
|
---
|
|
1949
|
-
Means by which an [
|
|
1952
|
+
Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The \`acs_credential\` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
|
|
1953
|
+
|
|
1954
|
+
An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
|
|
1955
|
+
|
|
1956
|
+
For each \`acs_credential\`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
1950
1957
|
`);
|
|
1951
1958
|
var unmanaged_acs_credential = common_acs_credential.merge(
|
|
1952
1959
|
zod.z.object({
|
|
@@ -2056,7 +2063,20 @@ var acs_encoder = zod.z.object({
|
|
|
2056
2063
|
---
|
|
2057
2064
|
route_path: /acs/encoders
|
|
2058
2065
|
---
|
|
2059
|
-
Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
|
|
2066
|
+
Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
|
|
2067
|
+
|
|
2068
|
+
Some access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:
|
|
2069
|
+
|
|
2070
|
+
1. Credential creation
|
|
2071
|
+
Configure the access parameters for the credential.
|
|
2072
|
+
2. Card encoding
|
|
2073
|
+
Write the credential data onto the card using a compatible card encoder.
|
|
2074
|
+
|
|
2075
|
+
Separately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.
|
|
2076
|
+
|
|
2077
|
+
See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).
|
|
2078
|
+
|
|
2079
|
+
To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).
|
|
2060
2080
|
`);
|
|
2061
2081
|
var acs_entrance_salto_space_metadata = zod.z.object({
|
|
2062
2082
|
door_name: zod.z.string(),
|
|
@@ -2113,6 +2133,8 @@ var acs_entrance = zod.z.object({
|
|
|
2113
2133
|
route_path: /acs/entrances
|
|
2114
2134
|
---
|
|
2115
2135
|
Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
|
|
2136
|
+
|
|
2137
|
+
In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the \`acs_entrance\` resources in your workspace or get these details for a specific \`acs_entrance\`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.
|
|
2116
2138
|
`);
|
|
2117
2139
|
var acs_system_capability_flags = zod.z.object({
|
|
2118
2140
|
can_automate_enrollment: zod.z.boolean().optional().describe(
|
|
@@ -2310,6 +2332,10 @@ var acs_system = zod.z.object({
|
|
|
2310
2332
|
route_path: /acs/systems
|
|
2311
2333
|
---
|
|
2312
2334
|
Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
|
|
2335
|
+
|
|
2336
|
+
Within an \`acs_system\`, create [\`acs_user\`s](https://docs.seam.co/latest/api/acs/users#acs_user) and [\`acs_credential\`s](https://docs.seam.co/latest/api/acs/credentials#acs_credential) to grant access to the \`acs_user\`s.
|
|
2337
|
+
|
|
2338
|
+
For details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/latest/api/acs).
|
|
2313
2339
|
`);
|
|
2314
2340
|
var phone_number = zod.z.coerce.string().trim().refine(
|
|
2315
2341
|
(val) => {
|
|
@@ -2597,6 +2623,10 @@ var acs_user = common_acs_user.merge(
|
|
|
2597
2623
|
route_path: /acs/users
|
|
2598
2624
|
---
|
|
2599
2625
|
Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
|
|
2626
|
+
|
|
2627
|
+
An \`acs_user\` typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.
|
|
2628
|
+
|
|
2629
|
+
For details about how to configure \`acs_user\`s in your access control system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).
|
|
2600
2630
|
`);
|
|
2601
2631
|
var unmanaged_acs_user = common_acs_user.merge(
|
|
2602
2632
|
zod.z.object({
|
|
@@ -2609,36 +2639,37 @@ var unmanaged_acs_user = common_acs_user.merge(
|
|
|
2609
2639
|
Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
|
|
2610
2640
|
`);
|
|
2611
2641
|
var common_action_attempt = zod.z.object({
|
|
2612
|
-
action_attempt_id: zod.z.string().uuid().describe(
|
|
2613
|
-
|
|
2614
|
-
title: Action Attempt ID
|
|
2615
|
-
---
|
|
2616
|
-
The ID of the action attempt.
|
|
2617
|
-
`),
|
|
2618
|
-
status: zod.z.enum(["pending", "success", "error"])
|
|
2642
|
+
action_attempt_id: zod.z.string().uuid().describe("ID of the action attempt."),
|
|
2643
|
+
status: zod.z.enum(["pending", "success", "error"]).describe("Status of the action attempt.")
|
|
2619
2644
|
});
|
|
2620
2645
|
var common_pending_action_attempt = common_action_attempt.extend({
|
|
2621
2646
|
status: zod.z.literal("pending"),
|
|
2622
|
-
result: zod.z.null()
|
|
2623
|
-
|
|
2647
|
+
result: zod.z.null().describe(
|
|
2648
|
+
"Result of the action attempt. Null for pending action attempts."
|
|
2649
|
+
),
|
|
2650
|
+
error: zod.z.null().describe(
|
|
2651
|
+
"Errors associated with the action attempt. Null for pending action attempts."
|
|
2652
|
+
)
|
|
2624
2653
|
});
|
|
2625
2654
|
var common_succeeded_action_attempt = common_action_attempt.extend({
|
|
2626
2655
|
status: zod.z.literal("success"),
|
|
2627
|
-
error: zod.z.null()
|
|
2656
|
+
error: zod.z.null().describe(
|
|
2657
|
+
"Errors associated with the action attempt. Null for successful action attempts."
|
|
2658
|
+
)
|
|
2628
2659
|
});
|
|
2629
2660
|
var common_failed_action_attempt = common_action_attempt.extend({
|
|
2630
2661
|
status: zod.z.literal("error"),
|
|
2631
|
-
result: zod.z.null()
|
|
2662
|
+
result: zod.z.null().describe("Result of the action attempt. Null for failed action attempts.")
|
|
2632
2663
|
});
|
|
2633
2664
|
var common_action_attempt_errors = [
|
|
2634
2665
|
zod.z.object({
|
|
2635
|
-
type: zod.z.literal("uncategorized_error"),
|
|
2636
|
-
message: zod.z.string()
|
|
2637
|
-
}),
|
|
2666
|
+
type: zod.z.literal("uncategorized_error").describe("Type of the error associated with the action attempt."),
|
|
2667
|
+
message: zod.z.string().describe("Message for the error associated with the action attempt.")
|
|
2668
|
+
}).describe("Error that doesn't fit into other specific error categories."),
|
|
2638
2669
|
zod.z.object({
|
|
2639
|
-
type: zod.z.literal("action_attempt_expired"),
|
|
2640
|
-
message: zod.z.string()
|
|
2641
|
-
})
|
|
2670
|
+
type: zod.z.literal("action_attempt_expired").describe("Type of the error associated with the action attempt."),
|
|
2671
|
+
message: zod.z.string().describe("Message for the error associated with the action attempt.")
|
|
2672
|
+
}).describe("Error to indicate an expired action attempt.")
|
|
2642
2673
|
];
|
|
2643
2674
|
|
|
2644
2675
|
// src/lib/seam/connect/models/action-attempts/activate-climate-preset.ts
|
|
@@ -2774,7 +2805,7 @@ var deprecated_action_attempts = [
|
|
|
2774
2805
|
...delete_noise_threshold_action_attempt.options,
|
|
2775
2806
|
...update_noise_threshold_action_attempt.options
|
|
2776
2807
|
];
|
|
2777
|
-
var action_type2 = zod.z.literal("ENCODE_CREDENTIAL");
|
|
2808
|
+
var action_type2 = zod.z.literal("ENCODE_CREDENTIAL").describe("Type of action that the action attempt tracks.");
|
|
2778
2809
|
var no_credential_on_encoder_error = zod.z.object({
|
|
2779
2810
|
type: zod.z.literal("no_credential_on_encoder"),
|
|
2780
2811
|
message: zod.z.string()
|
|
@@ -2793,16 +2824,24 @@ var error3 = zod.z.union([
|
|
|
2793
2824
|
incompatible_card_format_error,
|
|
2794
2825
|
credential_cannot_be_reissued
|
|
2795
2826
|
]);
|
|
2796
|
-
var result3 = acs_credential.or(unmanaged_acs_credential)
|
|
2827
|
+
var result3 = acs_credential.or(unmanaged_acs_credential).describe(
|
|
2828
|
+
"If an encoding attempt was successful, includes the `acs_credential` data that was encoded onto the card."
|
|
2829
|
+
);
|
|
2797
2830
|
var encode_credential_action_attempt = zod.z.discriminatedUnion("status", [
|
|
2798
2831
|
common_pending_action_attempt.extend({
|
|
2799
2832
|
action_type: action_type2
|
|
2800
|
-
}).describe(
|
|
2833
|
+
}).describe(
|
|
2834
|
+
"Action attempt to track encoding credential data from the physical encoder onto a card."
|
|
2835
|
+
),
|
|
2801
2836
|
common_succeeded_action_attempt.extend({
|
|
2802
2837
|
action_type: action_type2,
|
|
2803
2838
|
result: result3
|
|
2804
|
-
}).describe(
|
|
2805
|
-
|
|
2839
|
+
}).describe(
|
|
2840
|
+
"Action attempt to indicate that encoding credential data from the physical encoder onto a card succeeded."
|
|
2841
|
+
),
|
|
2842
|
+
common_failed_action_attempt.extend({ action_type: action_type2, error: error3 }).describe(
|
|
2843
|
+
"Action attempt to indicate that encoding credential data from the physical encoder onto a card failed."
|
|
2844
|
+
)
|
|
2806
2845
|
]);
|
|
2807
2846
|
var action_type3 = zod.z.literal("LOCK_DOOR");
|
|
2808
2847
|
var error4 = zod.z.object({
|
|
@@ -5082,7 +5121,7 @@ var openapi_default = {
|
|
|
5082
5121
|
"x-route-path": "/access_codes"
|
|
5083
5122
|
},
|
|
5084
5123
|
acs_access_group: {
|
|
5085
|
-
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.\
|
|
5124
|
+
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).",
|
|
5086
5125
|
properties: {
|
|
5087
5126
|
access_group_type: {
|
|
5088
5127
|
deprecated: true,
|
|
@@ -5185,7 +5224,7 @@ var openapi_default = {
|
|
|
5185
5224
|
"x-route-path": "/acs/access_groups"
|
|
5186
5225
|
},
|
|
5187
5226
|
acs_credential: {
|
|
5188
|
-
description: "Means by which an [
|
|
5227
|
+
description: "Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.",
|
|
5189
5228
|
properties: {
|
|
5190
5229
|
access_method: {
|
|
5191
5230
|
description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
|
|
@@ -5538,7 +5577,7 @@ var openapi_default = {
|
|
|
5538
5577
|
"x-route-path": "/acs/credential_provisioning_automations"
|
|
5539
5578
|
},
|
|
5540
5579
|
acs_encoder: {
|
|
5541
|
-
description: "Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
|
|
5580
|
+
description: "Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSome access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:\n\n1. Credential creation\n Configure the access parameters for the credential.\n2. Card encoding\n Write the credential data onto the card using a compatible card encoder.\n\nSeparately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.\n\n See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).\n\nTo verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).",
|
|
5542
5581
|
properties: {
|
|
5543
5582
|
acs_encoder_id: {
|
|
5544
5583
|
description: "ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners.",
|
|
@@ -5602,7 +5641,7 @@ var openapi_default = {
|
|
|
5602
5641
|
"x-route-path": "/acs/encoders"
|
|
5603
5642
|
},
|
|
5604
5643
|
acs_entrance: {
|
|
5605
|
-
description: "Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
|
|
5644
|
+
description: "Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nIn an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.",
|
|
5606
5645
|
properties: {
|
|
5607
5646
|
acs_entrance_id: {
|
|
5608
5647
|
description: "ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
@@ -5755,7 +5794,7 @@ var openapi_default = {
|
|
|
5755
5794
|
"x-route-path": "/acs/entrances"
|
|
5756
5795
|
},
|
|
5757
5796
|
acs_system: {
|
|
5758
|
-
description: "Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
|
|
5797
|
+
description: "Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nWithin an `acs_system`, create [`acs_user`s](https://docs.seam.co/latest/api/acs/users#acs_user) and [`acs_credential`s](https://docs.seam.co/latest/api/acs/credentials#acs_credential) to grant access to the `acs_user`s.\n\nFor details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/latest/api/acs).",
|
|
5759
5798
|
properties: {
|
|
5760
5799
|
acs_system_id: {
|
|
5761
5800
|
description: "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
|
|
@@ -6112,7 +6151,7 @@ var openapi_default = {
|
|
|
6112
6151
|
"x-route-path": "/acs/systems"
|
|
6113
6152
|
},
|
|
6114
6153
|
acs_user: {
|
|
6115
|
-
description: "Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
|
|
6154
|
+
description: "Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn `acs_user` typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.\n\nFor details about how to configure `acs_user`s in your access control system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).",
|
|
6116
6155
|
properties: {
|
|
6117
6156
|
access_schedule: {
|
|
6118
6157
|
description: "`starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.",
|
|
@@ -6585,14 +6624,19 @@ var openapi_default = {
|
|
|
6585
6624
|
description: "Locking door.",
|
|
6586
6625
|
properties: {
|
|
6587
6626
|
action_attempt_id: {
|
|
6588
|
-
description: "
|
|
6627
|
+
description: "ID of the action attempt.",
|
|
6589
6628
|
format: "uuid",
|
|
6590
|
-
type: "string"
|
|
6591
|
-
"x-title": "Action Attempt ID"
|
|
6629
|
+
type: "string"
|
|
6592
6630
|
},
|
|
6593
6631
|
action_type: { enum: ["LOCK_DOOR"], type: "string" },
|
|
6594
|
-
error: {
|
|
6595
|
-
|
|
6632
|
+
error: {
|
|
6633
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
6634
|
+
nullable: true
|
|
6635
|
+
},
|
|
6636
|
+
result: {
|
|
6637
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
6638
|
+
nullable: true
|
|
6639
|
+
},
|
|
6596
6640
|
status: { enum: ["pending"], type: "string" }
|
|
6597
6641
|
},
|
|
6598
6642
|
required: [
|
|
@@ -6608,13 +6652,15 @@ var openapi_default = {
|
|
|
6608
6652
|
description: "Locking door succeeded.",
|
|
6609
6653
|
properties: {
|
|
6610
6654
|
action_attempt_id: {
|
|
6611
|
-
description: "
|
|
6655
|
+
description: "ID of the action attempt.",
|
|
6612
6656
|
format: "uuid",
|
|
6613
|
-
type: "string"
|
|
6614
|
-
"x-title": "Action Attempt ID"
|
|
6657
|
+
type: "string"
|
|
6615
6658
|
},
|
|
6616
6659
|
action_type: { enum: ["LOCK_DOOR"], type: "string" },
|
|
6617
|
-
error: {
|
|
6660
|
+
error: {
|
|
6661
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
6662
|
+
nullable: true
|
|
6663
|
+
},
|
|
6618
6664
|
result: { properties: {}, type: "object" },
|
|
6619
6665
|
status: { enum: ["success"], type: "string" }
|
|
6620
6666
|
},
|
|
@@ -6631,10 +6677,9 @@ var openapi_default = {
|
|
|
6631
6677
|
description: "Locking door failed.",
|
|
6632
6678
|
properties: {
|
|
6633
6679
|
action_attempt_id: {
|
|
6634
|
-
description: "
|
|
6680
|
+
description: "ID of the action attempt.",
|
|
6635
6681
|
format: "uuid",
|
|
6636
|
-
type: "string"
|
|
6637
|
-
"x-title": "Action Attempt ID"
|
|
6682
|
+
type: "string"
|
|
6638
6683
|
},
|
|
6639
6684
|
action_type: { enum: ["LOCK_DOOR"], type: "string" },
|
|
6640
6685
|
error: {
|
|
@@ -6645,7 +6690,10 @@ var openapi_default = {
|
|
|
6645
6690
|
required: ["type", "message"],
|
|
6646
6691
|
type: "object"
|
|
6647
6692
|
},
|
|
6648
|
-
result: {
|
|
6693
|
+
result: {
|
|
6694
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
6695
|
+
nullable: true
|
|
6696
|
+
},
|
|
6649
6697
|
status: { enum: ["error"], type: "string" }
|
|
6650
6698
|
},
|
|
6651
6699
|
required: [
|
|
@@ -6661,14 +6709,19 @@ var openapi_default = {
|
|
|
6661
6709
|
description: "Unlocking door.",
|
|
6662
6710
|
properties: {
|
|
6663
6711
|
action_attempt_id: {
|
|
6664
|
-
description: "
|
|
6712
|
+
description: "ID of the action attempt.",
|
|
6665
6713
|
format: "uuid",
|
|
6666
|
-
type: "string"
|
|
6667
|
-
"x-title": "Action Attempt ID"
|
|
6714
|
+
type: "string"
|
|
6668
6715
|
},
|
|
6669
6716
|
action_type: { enum: ["UNLOCK_DOOR"], type: "string" },
|
|
6670
|
-
error: {
|
|
6671
|
-
|
|
6717
|
+
error: {
|
|
6718
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
6719
|
+
nullable: true
|
|
6720
|
+
},
|
|
6721
|
+
result: {
|
|
6722
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
6723
|
+
nullable: true
|
|
6724
|
+
},
|
|
6672
6725
|
status: { enum: ["pending"], type: "string" }
|
|
6673
6726
|
},
|
|
6674
6727
|
required: [
|
|
@@ -6684,13 +6737,15 @@ var openapi_default = {
|
|
|
6684
6737
|
description: "Unlocking door succeeded.",
|
|
6685
6738
|
properties: {
|
|
6686
6739
|
action_attempt_id: {
|
|
6687
|
-
description: "
|
|
6740
|
+
description: "ID of the action attempt.",
|
|
6688
6741
|
format: "uuid",
|
|
6689
|
-
type: "string"
|
|
6690
|
-
"x-title": "Action Attempt ID"
|
|
6742
|
+
type: "string"
|
|
6691
6743
|
},
|
|
6692
6744
|
action_type: { enum: ["UNLOCK_DOOR"], type: "string" },
|
|
6693
|
-
error: {
|
|
6745
|
+
error: {
|
|
6746
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
6747
|
+
nullable: true
|
|
6748
|
+
},
|
|
6694
6749
|
result: { properties: {}, type: "object" },
|
|
6695
6750
|
status: { enum: ["success"], type: "string" }
|
|
6696
6751
|
},
|
|
@@ -6707,10 +6762,9 @@ var openapi_default = {
|
|
|
6707
6762
|
description: "Unlocking door failed.",
|
|
6708
6763
|
properties: {
|
|
6709
6764
|
action_attempt_id: {
|
|
6710
|
-
description: "
|
|
6765
|
+
description: "ID of the action attempt.",
|
|
6711
6766
|
format: "uuid",
|
|
6712
|
-
type: "string"
|
|
6713
|
-
"x-title": "Action Attempt ID"
|
|
6767
|
+
type: "string"
|
|
6714
6768
|
},
|
|
6715
6769
|
action_type: { enum: ["UNLOCK_DOOR"], type: "string" },
|
|
6716
6770
|
error: {
|
|
@@ -6721,7 +6775,10 @@ var openapi_default = {
|
|
|
6721
6775
|
required: ["type", "message"],
|
|
6722
6776
|
type: "object"
|
|
6723
6777
|
},
|
|
6724
|
-
result: {
|
|
6778
|
+
result: {
|
|
6779
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
6780
|
+
nullable: true
|
|
6781
|
+
},
|
|
6725
6782
|
status: { enum: ["error"], type: "string" }
|
|
6726
6783
|
},
|
|
6727
6784
|
required: [
|
|
@@ -6737,14 +6794,19 @@ var openapi_default = {
|
|
|
6737
6794
|
description: "Reading credential data from physical encoder.",
|
|
6738
6795
|
properties: {
|
|
6739
6796
|
action_attempt_id: {
|
|
6740
|
-
description: "
|
|
6797
|
+
description: "ID of the action attempt.",
|
|
6741
6798
|
format: "uuid",
|
|
6742
|
-
type: "string"
|
|
6743
|
-
"x-title": "Action Attempt ID"
|
|
6799
|
+
type: "string"
|
|
6744
6800
|
},
|
|
6745
6801
|
action_type: { enum: ["SCAN_CREDENTIAL"], type: "string" },
|
|
6746
|
-
error: {
|
|
6747
|
-
|
|
6802
|
+
error: {
|
|
6803
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
6804
|
+
nullable: true
|
|
6805
|
+
},
|
|
6806
|
+
result: {
|
|
6807
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
6808
|
+
nullable: true
|
|
6809
|
+
},
|
|
6748
6810
|
status: { enum: ["pending"], type: "string" }
|
|
6749
6811
|
},
|
|
6750
6812
|
required: [
|
|
@@ -6760,13 +6822,15 @@ var openapi_default = {
|
|
|
6760
6822
|
description: "Reading credential data from physical encoder succeeded.",
|
|
6761
6823
|
properties: {
|
|
6762
6824
|
action_attempt_id: {
|
|
6763
|
-
description: "
|
|
6825
|
+
description: "ID of the action attempt.",
|
|
6764
6826
|
format: "uuid",
|
|
6765
|
-
type: "string"
|
|
6766
|
-
"x-title": "Action Attempt ID"
|
|
6827
|
+
type: "string"
|
|
6767
6828
|
},
|
|
6768
6829
|
action_type: { enum: ["SCAN_CREDENTIAL"], type: "string" },
|
|
6769
|
-
error: {
|
|
6830
|
+
error: {
|
|
6831
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
6832
|
+
nullable: true
|
|
6833
|
+
},
|
|
6770
6834
|
result: {
|
|
6771
6835
|
properties: {
|
|
6772
6836
|
acs_credential_on_encoder: {
|
|
@@ -6880,7 +6944,7 @@ var openapi_default = {
|
|
|
6880
6944
|
nullable: true,
|
|
6881
6945
|
oneOf: [
|
|
6882
6946
|
{
|
|
6883
|
-
description: "Means by which an [
|
|
6947
|
+
description: "Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.",
|
|
6884
6948
|
properties: {
|
|
6885
6949
|
access_method: {
|
|
6886
6950
|
description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
|
|
@@ -7612,26 +7676,38 @@ var openapi_default = {
|
|
|
7612
7676
|
description: "Reading credential data from physical encoder failed.",
|
|
7613
7677
|
properties: {
|
|
7614
7678
|
action_attempt_id: {
|
|
7615
|
-
description: "
|
|
7679
|
+
description: "ID of the action attempt.",
|
|
7616
7680
|
format: "uuid",
|
|
7617
|
-
type: "string"
|
|
7618
|
-
"x-title": "Action Attempt ID"
|
|
7681
|
+
type: "string"
|
|
7619
7682
|
},
|
|
7620
7683
|
action_type: { enum: ["SCAN_CREDENTIAL"], type: "string" },
|
|
7621
7684
|
error: {
|
|
7622
7685
|
oneOf: [
|
|
7623
7686
|
{
|
|
7687
|
+
description: "Error that doesn't fit into other specific error categories.",
|
|
7624
7688
|
properties: {
|
|
7625
|
-
message: {
|
|
7626
|
-
|
|
7689
|
+
message: {
|
|
7690
|
+
description: "Message for the error associated with the action attempt.",
|
|
7691
|
+
type: "string"
|
|
7692
|
+
},
|
|
7693
|
+
type: {
|
|
7694
|
+
description: "Type of the error associated with the action attempt.",
|
|
7695
|
+
enum: ["uncategorized_error"],
|
|
7696
|
+
type: "string"
|
|
7697
|
+
}
|
|
7627
7698
|
},
|
|
7628
7699
|
required: ["type", "message"],
|
|
7629
7700
|
type: "object"
|
|
7630
7701
|
},
|
|
7631
7702
|
{
|
|
7703
|
+
description: "Error to indicate an expired action attempt.",
|
|
7632
7704
|
properties: {
|
|
7633
|
-
message: {
|
|
7705
|
+
message: {
|
|
7706
|
+
description: "Message for the error associated with the action attempt.",
|
|
7707
|
+
type: "string"
|
|
7708
|
+
},
|
|
7634
7709
|
type: {
|
|
7710
|
+
description: "Type of the error associated with the action attempt.",
|
|
7635
7711
|
enum: ["action_attempt_expired"],
|
|
7636
7712
|
type: "string"
|
|
7637
7713
|
}
|
|
@@ -7652,7 +7728,10 @@ var openapi_default = {
|
|
|
7652
7728
|
}
|
|
7653
7729
|
]
|
|
7654
7730
|
},
|
|
7655
|
-
result: {
|
|
7731
|
+
result: {
|
|
7732
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
7733
|
+
nullable: true
|
|
7734
|
+
},
|
|
7656
7735
|
status: { enum: ["error"], type: "string" }
|
|
7657
7736
|
},
|
|
7658
7737
|
required: [
|
|
@@ -7665,17 +7744,26 @@ var openapi_default = {
|
|
|
7665
7744
|
type: "object"
|
|
7666
7745
|
},
|
|
7667
7746
|
{
|
|
7668
|
-
description: "
|
|
7747
|
+
description: "Action attempt to track encoding credential data from the physical encoder onto a card.",
|
|
7669
7748
|
properties: {
|
|
7670
7749
|
action_attempt_id: {
|
|
7671
|
-
description: "
|
|
7750
|
+
description: "ID of the action attempt.",
|
|
7672
7751
|
format: "uuid",
|
|
7673
|
-
type: "string"
|
|
7674
|
-
|
|
7752
|
+
type: "string"
|
|
7753
|
+
},
|
|
7754
|
+
action_type: {
|
|
7755
|
+
description: "Type of action that the action attempt tracks.",
|
|
7756
|
+
enum: ["ENCODE_CREDENTIAL"],
|
|
7757
|
+
type: "string"
|
|
7758
|
+
},
|
|
7759
|
+
error: {
|
|
7760
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
7761
|
+
nullable: true
|
|
7762
|
+
},
|
|
7763
|
+
result: {
|
|
7764
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
7765
|
+
nullable: true
|
|
7675
7766
|
},
|
|
7676
|
-
action_type: { enum: ["ENCODE_CREDENTIAL"], type: "string" },
|
|
7677
|
-
error: { nullable: true },
|
|
7678
|
-
result: { nullable: true },
|
|
7679
7767
|
status: { enum: ["pending"], type: "string" }
|
|
7680
7768
|
},
|
|
7681
7769
|
required: [
|
|
@@ -7688,21 +7776,27 @@ var openapi_default = {
|
|
|
7688
7776
|
type: "object"
|
|
7689
7777
|
},
|
|
7690
7778
|
{
|
|
7691
|
-
description: "
|
|
7779
|
+
description: "Action attempt to indicate that encoding credential data from the physical encoder onto a card succeeded.",
|
|
7692
7780
|
properties: {
|
|
7693
7781
|
action_attempt_id: {
|
|
7694
|
-
description: "
|
|
7782
|
+
description: "ID of the action attempt.",
|
|
7695
7783
|
format: "uuid",
|
|
7696
|
-
type: "string"
|
|
7697
|
-
|
|
7784
|
+
type: "string"
|
|
7785
|
+
},
|
|
7786
|
+
action_type: {
|
|
7787
|
+
description: "Type of action that the action attempt tracks.",
|
|
7788
|
+
enum: ["ENCODE_CREDENTIAL"],
|
|
7789
|
+
type: "string"
|
|
7790
|
+
},
|
|
7791
|
+
error: {
|
|
7792
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
7793
|
+
nullable: true
|
|
7698
7794
|
},
|
|
7699
|
-
action_type: { enum: ["ENCODE_CREDENTIAL"], type: "string" },
|
|
7700
|
-
error: { nullable: true },
|
|
7701
7795
|
result: {
|
|
7702
|
-
description: "
|
|
7796
|
+
description: "If an encoding attempt was successful, includes the `acs_credential` data that was encoded onto the card.",
|
|
7703
7797
|
oneOf: [
|
|
7704
7798
|
{
|
|
7705
|
-
description: "Means by which an [
|
|
7799
|
+
description: "Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.",
|
|
7706
7800
|
properties: {
|
|
7707
7801
|
access_method: {
|
|
7708
7802
|
description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
|
|
@@ -8387,8 +8481,7 @@ var openapi_default = {
|
|
|
8387
8481
|
type: "object",
|
|
8388
8482
|
"x-route-path": "/acs/credentials/unmanaged"
|
|
8389
8483
|
}
|
|
8390
|
-
]
|
|
8391
|
-
"x-route-path": "/acs/credentials"
|
|
8484
|
+
]
|
|
8392
8485
|
},
|
|
8393
8486
|
status: { enum: ["success"], type: "string" }
|
|
8394
8487
|
},
|
|
@@ -8402,29 +8495,45 @@ var openapi_default = {
|
|
|
8402
8495
|
type: "object"
|
|
8403
8496
|
},
|
|
8404
8497
|
{
|
|
8405
|
-
description: "
|
|
8498
|
+
description: "Action attempt to indicate that encoding credential data from the physical encoder onto a card failed.",
|
|
8406
8499
|
properties: {
|
|
8407
8500
|
action_attempt_id: {
|
|
8408
|
-
description: "
|
|
8501
|
+
description: "ID of the action attempt.",
|
|
8409
8502
|
format: "uuid",
|
|
8410
|
-
type: "string"
|
|
8411
|
-
|
|
8503
|
+
type: "string"
|
|
8504
|
+
},
|
|
8505
|
+
action_type: {
|
|
8506
|
+
description: "Type of action that the action attempt tracks.",
|
|
8507
|
+
enum: ["ENCODE_CREDENTIAL"],
|
|
8508
|
+
type: "string"
|
|
8412
8509
|
},
|
|
8413
|
-
action_type: { enum: ["ENCODE_CREDENTIAL"], type: "string" },
|
|
8414
8510
|
error: {
|
|
8415
8511
|
oneOf: [
|
|
8416
8512
|
{
|
|
8513
|
+
description: "Error that doesn't fit into other specific error categories.",
|
|
8417
8514
|
properties: {
|
|
8418
|
-
message: {
|
|
8419
|
-
|
|
8515
|
+
message: {
|
|
8516
|
+
description: "Message for the error associated with the action attempt.",
|
|
8517
|
+
type: "string"
|
|
8518
|
+
},
|
|
8519
|
+
type: {
|
|
8520
|
+
description: "Type of the error associated with the action attempt.",
|
|
8521
|
+
enum: ["uncategorized_error"],
|
|
8522
|
+
type: "string"
|
|
8523
|
+
}
|
|
8420
8524
|
},
|
|
8421
8525
|
required: ["type", "message"],
|
|
8422
8526
|
type: "object"
|
|
8423
8527
|
},
|
|
8424
8528
|
{
|
|
8529
|
+
description: "Error to indicate an expired action attempt.",
|
|
8425
8530
|
properties: {
|
|
8426
|
-
message: {
|
|
8531
|
+
message: {
|
|
8532
|
+
description: "Message for the error associated with the action attempt.",
|
|
8533
|
+
type: "string"
|
|
8534
|
+
},
|
|
8427
8535
|
type: {
|
|
8536
|
+
description: "Type of the error associated with the action attempt.",
|
|
8428
8537
|
enum: ["action_attempt_expired"],
|
|
8429
8538
|
type: "string"
|
|
8430
8539
|
}
|
|
@@ -8467,7 +8576,10 @@ var openapi_default = {
|
|
|
8467
8576
|
}
|
|
8468
8577
|
]
|
|
8469
8578
|
},
|
|
8470
|
-
result: {
|
|
8579
|
+
result: {
|
|
8580
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
8581
|
+
nullable: true
|
|
8582
|
+
},
|
|
8471
8583
|
status: { enum: ["error"], type: "string" }
|
|
8472
8584
|
},
|
|
8473
8585
|
required: [
|
|
@@ -8483,17 +8595,22 @@ var openapi_default = {
|
|
|
8483
8595
|
description: "Resetting sandbox workspace.",
|
|
8484
8596
|
properties: {
|
|
8485
8597
|
action_attempt_id: {
|
|
8486
|
-
description: "
|
|
8598
|
+
description: "ID of the action attempt.",
|
|
8487
8599
|
format: "uuid",
|
|
8488
|
-
type: "string"
|
|
8489
|
-
"x-title": "Action Attempt ID"
|
|
8600
|
+
type: "string"
|
|
8490
8601
|
},
|
|
8491
8602
|
action_type: {
|
|
8492
8603
|
enum: ["RESET_SANDBOX_WORKSPACE"],
|
|
8493
8604
|
type: "string"
|
|
8494
8605
|
},
|
|
8495
|
-
error: {
|
|
8496
|
-
|
|
8606
|
+
error: {
|
|
8607
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
8608
|
+
nullable: true
|
|
8609
|
+
},
|
|
8610
|
+
result: {
|
|
8611
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
8612
|
+
nullable: true
|
|
8613
|
+
},
|
|
8497
8614
|
status: { enum: ["pending"], type: "string" }
|
|
8498
8615
|
},
|
|
8499
8616
|
required: [
|
|
@@ -8509,16 +8626,18 @@ var openapi_default = {
|
|
|
8509
8626
|
description: "Resetting sandbox workspace succeeded.",
|
|
8510
8627
|
properties: {
|
|
8511
8628
|
action_attempt_id: {
|
|
8512
|
-
description: "
|
|
8629
|
+
description: "ID of the action attempt.",
|
|
8513
8630
|
format: "uuid",
|
|
8514
|
-
type: "string"
|
|
8515
|
-
"x-title": "Action Attempt ID"
|
|
8631
|
+
type: "string"
|
|
8516
8632
|
},
|
|
8517
8633
|
action_type: {
|
|
8518
8634
|
enum: ["RESET_SANDBOX_WORKSPACE"],
|
|
8519
8635
|
type: "string"
|
|
8520
8636
|
},
|
|
8521
|
-
error: {
|
|
8637
|
+
error: {
|
|
8638
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
8639
|
+
nullable: true
|
|
8640
|
+
},
|
|
8522
8641
|
result: { properties: {}, type: "object" },
|
|
8523
8642
|
status: { enum: ["success"], type: "string" }
|
|
8524
8643
|
},
|
|
@@ -8535,10 +8654,9 @@ var openapi_default = {
|
|
|
8535
8654
|
description: "Resetting sandbox workspace failed.",
|
|
8536
8655
|
properties: {
|
|
8537
8656
|
action_attempt_id: {
|
|
8538
|
-
description: "
|
|
8657
|
+
description: "ID of the action attempt.",
|
|
8539
8658
|
format: "uuid",
|
|
8540
|
-
type: "string"
|
|
8541
|
-
"x-title": "Action Attempt ID"
|
|
8659
|
+
type: "string"
|
|
8542
8660
|
},
|
|
8543
8661
|
action_type: {
|
|
8544
8662
|
enum: ["RESET_SANDBOX_WORKSPACE"],
|
|
@@ -8552,7 +8670,10 @@ var openapi_default = {
|
|
|
8552
8670
|
required: ["type", "message"],
|
|
8553
8671
|
type: "object"
|
|
8554
8672
|
},
|
|
8555
|
-
result: {
|
|
8673
|
+
result: {
|
|
8674
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
8675
|
+
nullable: true
|
|
8676
|
+
},
|
|
8556
8677
|
status: { enum: ["error"], type: "string" }
|
|
8557
8678
|
},
|
|
8558
8679
|
required: [
|
|
@@ -8568,14 +8689,19 @@ var openapi_default = {
|
|
|
8568
8689
|
description: "Setting fan mode.",
|
|
8569
8690
|
properties: {
|
|
8570
8691
|
action_attempt_id: {
|
|
8571
|
-
description: "
|
|
8692
|
+
description: "ID of the action attempt.",
|
|
8572
8693
|
format: "uuid",
|
|
8573
|
-
type: "string"
|
|
8574
|
-
"x-title": "Action Attempt ID"
|
|
8694
|
+
type: "string"
|
|
8575
8695
|
},
|
|
8576
8696
|
action_type: { enum: ["SET_FAN_MODE"], type: "string" },
|
|
8577
|
-
error: {
|
|
8578
|
-
|
|
8697
|
+
error: {
|
|
8698
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
8699
|
+
nullable: true
|
|
8700
|
+
},
|
|
8701
|
+
result: {
|
|
8702
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
8703
|
+
nullable: true
|
|
8704
|
+
},
|
|
8579
8705
|
status: { enum: ["pending"], type: "string" }
|
|
8580
8706
|
},
|
|
8581
8707
|
required: [
|
|
@@ -8591,13 +8717,15 @@ var openapi_default = {
|
|
|
8591
8717
|
description: "Setting fan mode succeeded.",
|
|
8592
8718
|
properties: {
|
|
8593
8719
|
action_attempt_id: {
|
|
8594
|
-
description: "
|
|
8720
|
+
description: "ID of the action attempt.",
|
|
8595
8721
|
format: "uuid",
|
|
8596
|
-
type: "string"
|
|
8597
|
-
"x-title": "Action Attempt ID"
|
|
8722
|
+
type: "string"
|
|
8598
8723
|
},
|
|
8599
8724
|
action_type: { enum: ["SET_FAN_MODE"], type: "string" },
|
|
8600
|
-
error: {
|
|
8725
|
+
error: {
|
|
8726
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
8727
|
+
nullable: true
|
|
8728
|
+
},
|
|
8601
8729
|
result: { properties: {}, type: "object" },
|
|
8602
8730
|
status: { enum: ["success"], type: "string" }
|
|
8603
8731
|
},
|
|
@@ -8614,10 +8742,9 @@ var openapi_default = {
|
|
|
8614
8742
|
description: "Setting fan mode failed.",
|
|
8615
8743
|
properties: {
|
|
8616
8744
|
action_attempt_id: {
|
|
8617
|
-
description: "
|
|
8745
|
+
description: "ID of the action attempt.",
|
|
8618
8746
|
format: "uuid",
|
|
8619
|
-
type: "string"
|
|
8620
|
-
"x-title": "Action Attempt ID"
|
|
8747
|
+
type: "string"
|
|
8621
8748
|
},
|
|
8622
8749
|
action_type: { enum: ["SET_FAN_MODE"], type: "string" },
|
|
8623
8750
|
error: {
|
|
@@ -8628,7 +8755,10 @@ var openapi_default = {
|
|
|
8628
8755
|
required: ["type", "message"],
|
|
8629
8756
|
type: "object"
|
|
8630
8757
|
},
|
|
8631
|
-
result: {
|
|
8758
|
+
result: {
|
|
8759
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
8760
|
+
nullable: true
|
|
8761
|
+
},
|
|
8632
8762
|
status: { enum: ["error"], type: "string" }
|
|
8633
8763
|
},
|
|
8634
8764
|
required: [
|
|
@@ -8644,14 +8774,19 @@ var openapi_default = {
|
|
|
8644
8774
|
description: "Setting HVAC mode.",
|
|
8645
8775
|
properties: {
|
|
8646
8776
|
action_attempt_id: {
|
|
8647
|
-
description: "
|
|
8777
|
+
description: "ID of the action attempt.",
|
|
8648
8778
|
format: "uuid",
|
|
8649
|
-
type: "string"
|
|
8650
|
-
"x-title": "Action Attempt ID"
|
|
8779
|
+
type: "string"
|
|
8651
8780
|
},
|
|
8652
8781
|
action_type: { enum: ["SET_HVAC_MODE"], type: "string" },
|
|
8653
|
-
error: {
|
|
8654
|
-
|
|
8782
|
+
error: {
|
|
8783
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
8784
|
+
nullable: true
|
|
8785
|
+
},
|
|
8786
|
+
result: {
|
|
8787
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
8788
|
+
nullable: true
|
|
8789
|
+
},
|
|
8655
8790
|
status: { enum: ["pending"], type: "string" }
|
|
8656
8791
|
},
|
|
8657
8792
|
required: [
|
|
@@ -8667,13 +8802,15 @@ var openapi_default = {
|
|
|
8667
8802
|
description: "Setting HVAC mode succeeded.",
|
|
8668
8803
|
properties: {
|
|
8669
8804
|
action_attempt_id: {
|
|
8670
|
-
description: "
|
|
8805
|
+
description: "ID of the action attempt.",
|
|
8671
8806
|
format: "uuid",
|
|
8672
|
-
type: "string"
|
|
8673
|
-
"x-title": "Action Attempt ID"
|
|
8807
|
+
type: "string"
|
|
8674
8808
|
},
|
|
8675
8809
|
action_type: { enum: ["SET_HVAC_MODE"], type: "string" },
|
|
8676
|
-
error: {
|
|
8810
|
+
error: {
|
|
8811
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
8812
|
+
nullable: true
|
|
8813
|
+
},
|
|
8677
8814
|
result: { properties: {}, type: "object" },
|
|
8678
8815
|
status: { enum: ["success"], type: "string" }
|
|
8679
8816
|
},
|
|
@@ -8690,10 +8827,9 @@ var openapi_default = {
|
|
|
8690
8827
|
description: "Setting HVAC mode failed.",
|
|
8691
8828
|
properties: {
|
|
8692
8829
|
action_attempt_id: {
|
|
8693
|
-
description: "
|
|
8830
|
+
description: "ID of the action attempt.",
|
|
8694
8831
|
format: "uuid",
|
|
8695
|
-
type: "string"
|
|
8696
|
-
"x-title": "Action Attempt ID"
|
|
8832
|
+
type: "string"
|
|
8697
8833
|
},
|
|
8698
8834
|
action_type: { enum: ["SET_HVAC_MODE"], type: "string" },
|
|
8699
8835
|
error: {
|
|
@@ -8704,7 +8840,10 @@ var openapi_default = {
|
|
|
8704
8840
|
required: ["type", "message"],
|
|
8705
8841
|
type: "object"
|
|
8706
8842
|
},
|
|
8707
|
-
result: {
|
|
8843
|
+
result: {
|
|
8844
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
8845
|
+
nullable: true
|
|
8846
|
+
},
|
|
8708
8847
|
status: { enum: ["error"], type: "string" }
|
|
8709
8848
|
},
|
|
8710
8849
|
required: [
|
|
@@ -8720,17 +8859,22 @@ var openapi_default = {
|
|
|
8720
8859
|
description: "Activating climate preset.",
|
|
8721
8860
|
properties: {
|
|
8722
8861
|
action_attempt_id: {
|
|
8723
|
-
description: "
|
|
8862
|
+
description: "ID of the action attempt.",
|
|
8724
8863
|
format: "uuid",
|
|
8725
|
-
type: "string"
|
|
8726
|
-
"x-title": "Action Attempt ID"
|
|
8864
|
+
type: "string"
|
|
8727
8865
|
},
|
|
8728
8866
|
action_type: {
|
|
8729
8867
|
enum: ["ACTIVATE_CLIMATE_PRESET"],
|
|
8730
8868
|
type: "string"
|
|
8731
8869
|
},
|
|
8732
|
-
error: {
|
|
8733
|
-
|
|
8870
|
+
error: {
|
|
8871
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
8872
|
+
nullable: true
|
|
8873
|
+
},
|
|
8874
|
+
result: {
|
|
8875
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
8876
|
+
nullable: true
|
|
8877
|
+
},
|
|
8734
8878
|
status: { enum: ["pending"], type: "string" }
|
|
8735
8879
|
},
|
|
8736
8880
|
required: [
|
|
@@ -8746,16 +8890,18 @@ var openapi_default = {
|
|
|
8746
8890
|
description: "Activating climate preset succeeded.",
|
|
8747
8891
|
properties: {
|
|
8748
8892
|
action_attempt_id: {
|
|
8749
|
-
description: "
|
|
8893
|
+
description: "ID of the action attempt.",
|
|
8750
8894
|
format: "uuid",
|
|
8751
|
-
type: "string"
|
|
8752
|
-
"x-title": "Action Attempt ID"
|
|
8895
|
+
type: "string"
|
|
8753
8896
|
},
|
|
8754
8897
|
action_type: {
|
|
8755
8898
|
enum: ["ACTIVATE_CLIMATE_PRESET"],
|
|
8756
8899
|
type: "string"
|
|
8757
8900
|
},
|
|
8758
|
-
error: {
|
|
8901
|
+
error: {
|
|
8902
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
8903
|
+
nullable: true
|
|
8904
|
+
},
|
|
8759
8905
|
result: { properties: {}, type: "object" },
|
|
8760
8906
|
status: { enum: ["success"], type: "string" }
|
|
8761
8907
|
},
|
|
@@ -8772,10 +8918,9 @@ var openapi_default = {
|
|
|
8772
8918
|
description: "Activating climate preset failed.",
|
|
8773
8919
|
properties: {
|
|
8774
8920
|
action_attempt_id: {
|
|
8775
|
-
description: "
|
|
8921
|
+
description: "ID of the action attempt.",
|
|
8776
8922
|
format: "uuid",
|
|
8777
|
-
type: "string"
|
|
8778
|
-
"x-title": "Action Attempt ID"
|
|
8923
|
+
type: "string"
|
|
8779
8924
|
},
|
|
8780
8925
|
action_type: {
|
|
8781
8926
|
enum: ["ACTIVATE_CLIMATE_PRESET"],
|
|
@@ -8789,7 +8934,10 @@ var openapi_default = {
|
|
|
8789
8934
|
required: ["type", "message"],
|
|
8790
8935
|
type: "object"
|
|
8791
8936
|
},
|
|
8792
|
-
result: {
|
|
8937
|
+
result: {
|
|
8938
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
8939
|
+
nullable: true
|
|
8940
|
+
},
|
|
8793
8941
|
status: { enum: ["error"], type: "string" }
|
|
8794
8942
|
},
|
|
8795
8943
|
required: [
|
|
@@ -8804,14 +8952,19 @@ var openapi_default = {
|
|
|
8804
8952
|
{
|
|
8805
8953
|
properties: {
|
|
8806
8954
|
action_attempt_id: {
|
|
8807
|
-
description: "
|
|
8955
|
+
description: "ID of the action attempt.",
|
|
8808
8956
|
format: "uuid",
|
|
8809
|
-
type: "string"
|
|
8810
|
-
"x-title": "Action Attempt ID"
|
|
8957
|
+
type: "string"
|
|
8811
8958
|
},
|
|
8812
8959
|
action_type: { enum: ["SYNC_ACCESS_CODES"], type: "string" },
|
|
8813
|
-
error: {
|
|
8814
|
-
|
|
8960
|
+
error: {
|
|
8961
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
8962
|
+
nullable: true
|
|
8963
|
+
},
|
|
8964
|
+
result: {
|
|
8965
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
8966
|
+
nullable: true
|
|
8967
|
+
},
|
|
8815
8968
|
status: { enum: ["pending"], type: "string" }
|
|
8816
8969
|
},
|
|
8817
8970
|
required: [
|
|
@@ -8826,13 +8979,15 @@ var openapi_default = {
|
|
|
8826
8979
|
{
|
|
8827
8980
|
properties: {
|
|
8828
8981
|
action_attempt_id: {
|
|
8829
|
-
description: "
|
|
8982
|
+
description: "ID of the action attempt.",
|
|
8830
8983
|
format: "uuid",
|
|
8831
|
-
type: "string"
|
|
8832
|
-
"x-title": "Action Attempt ID"
|
|
8984
|
+
type: "string"
|
|
8833
8985
|
},
|
|
8834
8986
|
action_type: { enum: ["SYNC_ACCESS_CODES"], type: "string" },
|
|
8835
|
-
error: {
|
|
8987
|
+
error: {
|
|
8988
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
8989
|
+
nullable: true
|
|
8990
|
+
},
|
|
8836
8991
|
result: { properties: {}, type: "object" },
|
|
8837
8992
|
status: { enum: ["success"], type: "string" }
|
|
8838
8993
|
},
|
|
@@ -8848,10 +9003,9 @@ var openapi_default = {
|
|
|
8848
9003
|
{
|
|
8849
9004
|
properties: {
|
|
8850
9005
|
action_attempt_id: {
|
|
8851
|
-
description: "
|
|
9006
|
+
description: "ID of the action attempt.",
|
|
8852
9007
|
format: "uuid",
|
|
8853
|
-
type: "string"
|
|
8854
|
-
"x-title": "Action Attempt ID"
|
|
9008
|
+
type: "string"
|
|
8855
9009
|
},
|
|
8856
9010
|
action_type: { enum: ["SYNC_ACCESS_CODES"], type: "string" },
|
|
8857
9011
|
error: {
|
|
@@ -8862,7 +9016,10 @@ var openapi_default = {
|
|
|
8862
9016
|
required: ["type", "message"],
|
|
8863
9017
|
type: "object"
|
|
8864
9018
|
},
|
|
8865
|
-
result: {
|
|
9019
|
+
result: {
|
|
9020
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
9021
|
+
nullable: true
|
|
9022
|
+
},
|
|
8866
9023
|
status: { enum: ["error"], type: "string" }
|
|
8867
9024
|
},
|
|
8868
9025
|
required: [
|
|
@@ -8877,14 +9034,19 @@ var openapi_default = {
|
|
|
8877
9034
|
{
|
|
8878
9035
|
properties: {
|
|
8879
9036
|
action_attempt_id: {
|
|
8880
|
-
description: "
|
|
9037
|
+
description: "ID of the action attempt.",
|
|
8881
9038
|
format: "uuid",
|
|
8882
|
-
type: "string"
|
|
8883
|
-
"x-title": "Action Attempt ID"
|
|
9039
|
+
type: "string"
|
|
8884
9040
|
},
|
|
8885
9041
|
action_type: { enum: ["CREATE_ACCESS_CODE"], type: "string" },
|
|
8886
|
-
error: {
|
|
8887
|
-
|
|
9042
|
+
error: {
|
|
9043
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
9044
|
+
nullable: true
|
|
9045
|
+
},
|
|
9046
|
+
result: {
|
|
9047
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
9048
|
+
nullable: true
|
|
9049
|
+
},
|
|
8888
9050
|
status: { enum: ["pending"], type: "string" }
|
|
8889
9051
|
},
|
|
8890
9052
|
required: [
|
|
@@ -8899,13 +9061,15 @@ var openapi_default = {
|
|
|
8899
9061
|
{
|
|
8900
9062
|
properties: {
|
|
8901
9063
|
action_attempt_id: {
|
|
8902
|
-
description: "
|
|
9064
|
+
description: "ID of the action attempt.",
|
|
8903
9065
|
format: "uuid",
|
|
8904
|
-
type: "string"
|
|
8905
|
-
"x-title": "Action Attempt ID"
|
|
9066
|
+
type: "string"
|
|
8906
9067
|
},
|
|
8907
9068
|
action_type: { enum: ["CREATE_ACCESS_CODE"], type: "string" },
|
|
8908
|
-
error: {
|
|
9069
|
+
error: {
|
|
9070
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
9071
|
+
nullable: true
|
|
9072
|
+
},
|
|
8909
9073
|
result: { properties: { access_code: {} }, type: "object" },
|
|
8910
9074
|
status: { enum: ["success"], type: "string" }
|
|
8911
9075
|
},
|
|
@@ -8921,10 +9085,9 @@ var openapi_default = {
|
|
|
8921
9085
|
{
|
|
8922
9086
|
properties: {
|
|
8923
9087
|
action_attempt_id: {
|
|
8924
|
-
description: "
|
|
9088
|
+
description: "ID of the action attempt.",
|
|
8925
9089
|
format: "uuid",
|
|
8926
|
-
type: "string"
|
|
8927
|
-
"x-title": "Action Attempt ID"
|
|
9090
|
+
type: "string"
|
|
8928
9091
|
},
|
|
8929
9092
|
action_type: { enum: ["CREATE_ACCESS_CODE"], type: "string" },
|
|
8930
9093
|
error: {
|
|
@@ -8935,7 +9098,10 @@ var openapi_default = {
|
|
|
8935
9098
|
required: ["type", "message"],
|
|
8936
9099
|
type: "object"
|
|
8937
9100
|
},
|
|
8938
|
-
result: {
|
|
9101
|
+
result: {
|
|
9102
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
9103
|
+
nullable: true
|
|
9104
|
+
},
|
|
8939
9105
|
status: { enum: ["error"], type: "string" }
|
|
8940
9106
|
},
|
|
8941
9107
|
required: [
|
|
@@ -8950,14 +9116,19 @@ var openapi_default = {
|
|
|
8950
9116
|
{
|
|
8951
9117
|
properties: {
|
|
8952
9118
|
action_attempt_id: {
|
|
8953
|
-
description: "
|
|
9119
|
+
description: "ID of the action attempt.",
|
|
8954
9120
|
format: "uuid",
|
|
8955
|
-
type: "string"
|
|
8956
|
-
"x-title": "Action Attempt ID"
|
|
9121
|
+
type: "string"
|
|
8957
9122
|
},
|
|
8958
9123
|
action_type: { enum: ["DELETE_ACCESS_CODE"], type: "string" },
|
|
8959
|
-
error: {
|
|
8960
|
-
|
|
9124
|
+
error: {
|
|
9125
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
9126
|
+
nullable: true
|
|
9127
|
+
},
|
|
9128
|
+
result: {
|
|
9129
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
9130
|
+
nullable: true
|
|
9131
|
+
},
|
|
8961
9132
|
status: { enum: ["pending"], type: "string" }
|
|
8962
9133
|
},
|
|
8963
9134
|
required: [
|
|
@@ -8972,13 +9143,15 @@ var openapi_default = {
|
|
|
8972
9143
|
{
|
|
8973
9144
|
properties: {
|
|
8974
9145
|
action_attempt_id: {
|
|
8975
|
-
description: "
|
|
9146
|
+
description: "ID of the action attempt.",
|
|
8976
9147
|
format: "uuid",
|
|
8977
|
-
type: "string"
|
|
8978
|
-
"x-title": "Action Attempt ID"
|
|
9148
|
+
type: "string"
|
|
8979
9149
|
},
|
|
8980
9150
|
action_type: { enum: ["DELETE_ACCESS_CODE"], type: "string" },
|
|
8981
|
-
error: {
|
|
9151
|
+
error: {
|
|
9152
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
9153
|
+
nullable: true
|
|
9154
|
+
},
|
|
8982
9155
|
result: { properties: {}, type: "object" },
|
|
8983
9156
|
status: { enum: ["success"], type: "string" }
|
|
8984
9157
|
},
|
|
@@ -8994,10 +9167,9 @@ var openapi_default = {
|
|
|
8994
9167
|
{
|
|
8995
9168
|
properties: {
|
|
8996
9169
|
action_attempt_id: {
|
|
8997
|
-
description: "
|
|
9170
|
+
description: "ID of the action attempt.",
|
|
8998
9171
|
format: "uuid",
|
|
8999
|
-
type: "string"
|
|
9000
|
-
"x-title": "Action Attempt ID"
|
|
9172
|
+
type: "string"
|
|
9001
9173
|
},
|
|
9002
9174
|
action_type: { enum: ["DELETE_ACCESS_CODE"], type: "string" },
|
|
9003
9175
|
error: {
|
|
@@ -9008,7 +9180,10 @@ var openapi_default = {
|
|
|
9008
9180
|
required: ["type", "message"],
|
|
9009
9181
|
type: "object"
|
|
9010
9182
|
},
|
|
9011
|
-
result: {
|
|
9183
|
+
result: {
|
|
9184
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
9185
|
+
nullable: true
|
|
9186
|
+
},
|
|
9012
9187
|
status: { enum: ["error"], type: "string" }
|
|
9013
9188
|
},
|
|
9014
9189
|
required: [
|
|
@@ -9023,14 +9198,19 @@ var openapi_default = {
|
|
|
9023
9198
|
{
|
|
9024
9199
|
properties: {
|
|
9025
9200
|
action_attempt_id: {
|
|
9026
|
-
description: "
|
|
9201
|
+
description: "ID of the action attempt.",
|
|
9027
9202
|
format: "uuid",
|
|
9028
|
-
type: "string"
|
|
9029
|
-
"x-title": "Action Attempt ID"
|
|
9203
|
+
type: "string"
|
|
9030
9204
|
},
|
|
9031
9205
|
action_type: { enum: ["UPDATE_ACCESS_CODE"], type: "string" },
|
|
9032
|
-
error: {
|
|
9033
|
-
|
|
9206
|
+
error: {
|
|
9207
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
9208
|
+
nullable: true
|
|
9209
|
+
},
|
|
9210
|
+
result: {
|
|
9211
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
9212
|
+
nullable: true
|
|
9213
|
+
},
|
|
9034
9214
|
status: { enum: ["pending"], type: "string" }
|
|
9035
9215
|
},
|
|
9036
9216
|
required: [
|
|
@@ -9045,13 +9225,15 @@ var openapi_default = {
|
|
|
9045
9225
|
{
|
|
9046
9226
|
properties: {
|
|
9047
9227
|
action_attempt_id: {
|
|
9048
|
-
description: "
|
|
9228
|
+
description: "ID of the action attempt.",
|
|
9049
9229
|
format: "uuid",
|
|
9050
|
-
type: "string"
|
|
9051
|
-
"x-title": "Action Attempt ID"
|
|
9230
|
+
type: "string"
|
|
9052
9231
|
},
|
|
9053
9232
|
action_type: { enum: ["UPDATE_ACCESS_CODE"], type: "string" },
|
|
9054
|
-
error: {
|
|
9233
|
+
error: {
|
|
9234
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
9235
|
+
nullable: true
|
|
9236
|
+
},
|
|
9055
9237
|
result: { properties: { access_code: {} }, type: "object" },
|
|
9056
9238
|
status: { enum: ["success"], type: "string" }
|
|
9057
9239
|
},
|
|
@@ -9067,10 +9249,9 @@ var openapi_default = {
|
|
|
9067
9249
|
{
|
|
9068
9250
|
properties: {
|
|
9069
9251
|
action_attempt_id: {
|
|
9070
|
-
description: "
|
|
9252
|
+
description: "ID of the action attempt.",
|
|
9071
9253
|
format: "uuid",
|
|
9072
|
-
type: "string"
|
|
9073
|
-
"x-title": "Action Attempt ID"
|
|
9254
|
+
type: "string"
|
|
9074
9255
|
},
|
|
9075
9256
|
action_type: { enum: ["UPDATE_ACCESS_CODE"], type: "string" },
|
|
9076
9257
|
error: {
|
|
@@ -9081,7 +9262,10 @@ var openapi_default = {
|
|
|
9081
9262
|
required: ["type", "message"],
|
|
9082
9263
|
type: "object"
|
|
9083
9264
|
},
|
|
9084
|
-
result: {
|
|
9265
|
+
result: {
|
|
9266
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
9267
|
+
nullable: true
|
|
9268
|
+
},
|
|
9085
9269
|
status: { enum: ["error"], type: "string" }
|
|
9086
9270
|
},
|
|
9087
9271
|
required: [
|
|
@@ -9096,14 +9280,19 @@ var openapi_default = {
|
|
|
9096
9280
|
{
|
|
9097
9281
|
properties: {
|
|
9098
9282
|
action_attempt_id: {
|
|
9099
|
-
description: "
|
|
9283
|
+
description: "ID of the action attempt.",
|
|
9100
9284
|
format: "uuid",
|
|
9101
|
-
type: "string"
|
|
9102
|
-
"x-title": "Action Attempt ID"
|
|
9285
|
+
type: "string"
|
|
9103
9286
|
},
|
|
9104
9287
|
action_type: { enum: ["CREATE_NOISE_THRESHOLD"], type: "string" },
|
|
9105
|
-
error: {
|
|
9106
|
-
|
|
9288
|
+
error: {
|
|
9289
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
9290
|
+
nullable: true
|
|
9291
|
+
},
|
|
9292
|
+
result: {
|
|
9293
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
9294
|
+
nullable: true
|
|
9295
|
+
},
|
|
9107
9296
|
status: { enum: ["pending"], type: "string" }
|
|
9108
9297
|
},
|
|
9109
9298
|
required: [
|
|
@@ -9118,13 +9307,15 @@ var openapi_default = {
|
|
|
9118
9307
|
{
|
|
9119
9308
|
properties: {
|
|
9120
9309
|
action_attempt_id: {
|
|
9121
|
-
description: "
|
|
9310
|
+
description: "ID of the action attempt.",
|
|
9122
9311
|
format: "uuid",
|
|
9123
|
-
type: "string"
|
|
9124
|
-
"x-title": "Action Attempt ID"
|
|
9312
|
+
type: "string"
|
|
9125
9313
|
},
|
|
9126
9314
|
action_type: { enum: ["CREATE_NOISE_THRESHOLD"], type: "string" },
|
|
9127
|
-
error: {
|
|
9315
|
+
error: {
|
|
9316
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
9317
|
+
nullable: true
|
|
9318
|
+
},
|
|
9128
9319
|
result: { properties: { noise_threshold: {} }, type: "object" },
|
|
9129
9320
|
status: { enum: ["success"], type: "string" }
|
|
9130
9321
|
},
|
|
@@ -9140,10 +9331,9 @@ var openapi_default = {
|
|
|
9140
9331
|
{
|
|
9141
9332
|
properties: {
|
|
9142
9333
|
action_attempt_id: {
|
|
9143
|
-
description: "
|
|
9334
|
+
description: "ID of the action attempt.",
|
|
9144
9335
|
format: "uuid",
|
|
9145
|
-
type: "string"
|
|
9146
|
-
"x-title": "Action Attempt ID"
|
|
9336
|
+
type: "string"
|
|
9147
9337
|
},
|
|
9148
9338
|
action_type: { enum: ["CREATE_NOISE_THRESHOLD"], type: "string" },
|
|
9149
9339
|
error: {
|
|
@@ -9154,7 +9344,10 @@ var openapi_default = {
|
|
|
9154
9344
|
required: ["type", "message"],
|
|
9155
9345
|
type: "object"
|
|
9156
9346
|
},
|
|
9157
|
-
result: {
|
|
9347
|
+
result: {
|
|
9348
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
9349
|
+
nullable: true
|
|
9350
|
+
},
|
|
9158
9351
|
status: { enum: ["error"], type: "string" }
|
|
9159
9352
|
},
|
|
9160
9353
|
required: [
|
|
@@ -9169,14 +9362,19 @@ var openapi_default = {
|
|
|
9169
9362
|
{
|
|
9170
9363
|
properties: {
|
|
9171
9364
|
action_attempt_id: {
|
|
9172
|
-
description: "
|
|
9365
|
+
description: "ID of the action attempt.",
|
|
9173
9366
|
format: "uuid",
|
|
9174
|
-
type: "string"
|
|
9175
|
-
"x-title": "Action Attempt ID"
|
|
9367
|
+
type: "string"
|
|
9176
9368
|
},
|
|
9177
9369
|
action_type: { enum: ["DELETE_NOISE_THRESHOLD"], type: "string" },
|
|
9178
|
-
error: {
|
|
9179
|
-
|
|
9370
|
+
error: {
|
|
9371
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
9372
|
+
nullable: true
|
|
9373
|
+
},
|
|
9374
|
+
result: {
|
|
9375
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
9376
|
+
nullable: true
|
|
9377
|
+
},
|
|
9180
9378
|
status: { enum: ["pending"], type: "string" }
|
|
9181
9379
|
},
|
|
9182
9380
|
required: [
|
|
@@ -9191,13 +9389,15 @@ var openapi_default = {
|
|
|
9191
9389
|
{
|
|
9192
9390
|
properties: {
|
|
9193
9391
|
action_attempt_id: {
|
|
9194
|
-
description: "
|
|
9392
|
+
description: "ID of the action attempt.",
|
|
9195
9393
|
format: "uuid",
|
|
9196
|
-
type: "string"
|
|
9197
|
-
"x-title": "Action Attempt ID"
|
|
9394
|
+
type: "string"
|
|
9198
9395
|
},
|
|
9199
9396
|
action_type: { enum: ["DELETE_NOISE_THRESHOLD"], type: "string" },
|
|
9200
|
-
error: {
|
|
9397
|
+
error: {
|
|
9398
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
9399
|
+
nullable: true
|
|
9400
|
+
},
|
|
9201
9401
|
result: { properties: {}, type: "object" },
|
|
9202
9402
|
status: { enum: ["success"], type: "string" }
|
|
9203
9403
|
},
|
|
@@ -9213,10 +9413,9 @@ var openapi_default = {
|
|
|
9213
9413
|
{
|
|
9214
9414
|
properties: {
|
|
9215
9415
|
action_attempt_id: {
|
|
9216
|
-
description: "
|
|
9416
|
+
description: "ID of the action attempt.",
|
|
9217
9417
|
format: "uuid",
|
|
9218
|
-
type: "string"
|
|
9219
|
-
"x-title": "Action Attempt ID"
|
|
9418
|
+
type: "string"
|
|
9220
9419
|
},
|
|
9221
9420
|
action_type: { enum: ["DELETE_NOISE_THRESHOLD"], type: "string" },
|
|
9222
9421
|
error: {
|
|
@@ -9227,7 +9426,10 @@ var openapi_default = {
|
|
|
9227
9426
|
required: ["type", "message"],
|
|
9228
9427
|
type: "object"
|
|
9229
9428
|
},
|
|
9230
|
-
result: {
|
|
9429
|
+
result: {
|
|
9430
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
9431
|
+
nullable: true
|
|
9432
|
+
},
|
|
9231
9433
|
status: { enum: ["error"], type: "string" }
|
|
9232
9434
|
},
|
|
9233
9435
|
required: [
|
|
@@ -9242,14 +9444,19 @@ var openapi_default = {
|
|
|
9242
9444
|
{
|
|
9243
9445
|
properties: {
|
|
9244
9446
|
action_attempt_id: {
|
|
9245
|
-
description: "
|
|
9447
|
+
description: "ID of the action attempt.",
|
|
9246
9448
|
format: "uuid",
|
|
9247
|
-
type: "string"
|
|
9248
|
-
"x-title": "Action Attempt ID"
|
|
9449
|
+
type: "string"
|
|
9249
9450
|
},
|
|
9250
9451
|
action_type: { enum: ["UPDATE_NOISE_THRESHOLD"], type: "string" },
|
|
9251
|
-
error: {
|
|
9252
|
-
|
|
9452
|
+
error: {
|
|
9453
|
+
description: "Errors associated with the action attempt. Null for pending action attempts.",
|
|
9454
|
+
nullable: true
|
|
9455
|
+
},
|
|
9456
|
+
result: {
|
|
9457
|
+
description: "Result of the action attempt. Null for pending action attempts.",
|
|
9458
|
+
nullable: true
|
|
9459
|
+
},
|
|
9253
9460
|
status: { enum: ["pending"], type: "string" }
|
|
9254
9461
|
},
|
|
9255
9462
|
required: [
|
|
@@ -9264,13 +9471,15 @@ var openapi_default = {
|
|
|
9264
9471
|
{
|
|
9265
9472
|
properties: {
|
|
9266
9473
|
action_attempt_id: {
|
|
9267
|
-
description: "
|
|
9474
|
+
description: "ID of the action attempt.",
|
|
9268
9475
|
format: "uuid",
|
|
9269
|
-
type: "string"
|
|
9270
|
-
"x-title": "Action Attempt ID"
|
|
9476
|
+
type: "string"
|
|
9271
9477
|
},
|
|
9272
9478
|
action_type: { enum: ["UPDATE_NOISE_THRESHOLD"], type: "string" },
|
|
9273
|
-
error: {
|
|
9479
|
+
error: {
|
|
9480
|
+
description: "Errors associated with the action attempt. Null for successful action attempts.",
|
|
9481
|
+
nullable: true
|
|
9482
|
+
},
|
|
9274
9483
|
result: { properties: { noise_threshold: {} }, type: "object" },
|
|
9275
9484
|
status: { enum: ["success"], type: "string" }
|
|
9276
9485
|
},
|
|
@@ -9286,10 +9495,9 @@ var openapi_default = {
|
|
|
9286
9495
|
{
|
|
9287
9496
|
properties: {
|
|
9288
9497
|
action_attempt_id: {
|
|
9289
|
-
description: "
|
|
9498
|
+
description: "ID of the action attempt.",
|
|
9290
9499
|
format: "uuid",
|
|
9291
|
-
type: "string"
|
|
9292
|
-
"x-title": "Action Attempt ID"
|
|
9500
|
+
type: "string"
|
|
9293
9501
|
},
|
|
9294
9502
|
action_type: { enum: ["UPDATE_NOISE_THRESHOLD"], type: "string" },
|
|
9295
9503
|
error: {
|
|
@@ -9300,7 +9508,10 @@ var openapi_default = {
|
|
|
9300
9508
|
required: ["type", "message"],
|
|
9301
9509
|
type: "object"
|
|
9302
9510
|
},
|
|
9303
|
-
result: {
|
|
9511
|
+
result: {
|
|
9512
|
+
description: "Result of the action attempt. Null for failed action attempts.",
|
|
9513
|
+
nullable: true
|
|
9514
|
+
},
|
|
9304
9515
|
status: { enum: ["error"], type: "string" }
|
|
9305
9516
|
},
|
|
9306
9517
|
required: [
|