@seamapi/types 1.460.1 → 1.462.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 +505 -86
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +18022 -1242
- package/dist/index.cjs +505 -86
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +26164 -2844
- package/lib/seam/connect/models/batch.js +31 -11
- package/lib/seam/connect/models/batch.js.map +1 -1
- package/lib/seam/connect/models/client-sessions/client-session.d.ts +2 -2
- package/lib/seam/connect/models/devices/device-provider.d.ts +1 -1
- package/lib/seam/connect/models/devices/device-provider.js +1 -0
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/spaces/space.d.ts +2 -2
- package/lib/seam/connect/openapi.d.ts +495 -4
- package/lib/seam/connect/openapi.js +417 -12
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +15025 -10396
- package/package.json +1 -1
- package/src/lib/seam/connect/models/batch.ts +44 -21
- package/src/lib/seam/connect/models/devices/device-provider.ts +1 -0
- package/src/lib/seam/connect/openapi.ts +425 -12
- package/src/lib/seam/connect/route-types.ts +6727 -1192
package/dist/index.cjs
CHANGED
|
@@ -1792,7 +1792,8 @@ var PROVIDER_CATEGORY_MAP = {
|
|
|
1792
1792
|
"latch",
|
|
1793
1793
|
"akiles",
|
|
1794
1794
|
"sensi",
|
|
1795
|
-
"assa_abloy_vostio"
|
|
1795
|
+
"assa_abloy_vostio",
|
|
1796
|
+
"avigilon_alta"
|
|
1796
1797
|
],
|
|
1797
1798
|
consumer_smartlocks: [
|
|
1798
1799
|
"akiles",
|
|
@@ -3789,6 +3790,60 @@ var action_attempt = zod.z.union([
|
|
|
3789
3790
|
|
|
3790
3791
|
See also [Action Attempts](https://docs.seam.co/latest/core-concepts/action-attempts).
|
|
3791
3792
|
`);
|
|
3793
|
+
var client_session = zod.z.object({
|
|
3794
|
+
client_session_id: zod.z.string().uuid().describe(
|
|
3795
|
+
"ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
|
|
3796
|
+
),
|
|
3797
|
+
workspace_id: zod.z.string().uuid().describe(
|
|
3798
|
+
"ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
|
|
3799
|
+
),
|
|
3800
|
+
created_at: zod.z.string().datetime().describe(
|
|
3801
|
+
"Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was created."
|
|
3802
|
+
),
|
|
3803
|
+
expires_at: zod.z.string().datetime().describe(
|
|
3804
|
+
"Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) expires."
|
|
3805
|
+
),
|
|
3806
|
+
token: zod.z.string().describe(
|
|
3807
|
+
"Client session token associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
|
|
3808
|
+
),
|
|
3809
|
+
user_identifier_key: zod.z.string().nullable().describe(
|
|
3810
|
+
"Your user ID for the user associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
|
|
3811
|
+
),
|
|
3812
|
+
device_count: zod.z.number().describe(
|
|
3813
|
+
"Number of devices associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
|
|
3814
|
+
),
|
|
3815
|
+
customer_id: zod.z.string().uuid().optional().describe(
|
|
3816
|
+
"Customer ID associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
|
|
3817
|
+
),
|
|
3818
|
+
connected_account_ids: zod.z.array(zod.z.string().uuid()).describe(
|
|
3819
|
+
"IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
|
|
3820
|
+
),
|
|
3821
|
+
connect_webview_ids: zod.z.array(zod.z.string().uuid()).describe(
|
|
3822
|
+
"IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
|
|
3823
|
+
),
|
|
3824
|
+
user_identity_ids: zod.z.array(zod.z.string().uuid()).describe(`
|
|
3825
|
+
---
|
|
3826
|
+
deprecated: Use \`user_identity_id\` instead.
|
|
3827
|
+
---
|
|
3828
|
+
IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.
|
|
3829
|
+
`),
|
|
3830
|
+
user_identity_id: zod.z.string().uuid().optional().describe(
|
|
3831
|
+
"ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session."
|
|
3832
|
+
)
|
|
3833
|
+
}).describe(`
|
|
3834
|
+
---
|
|
3835
|
+
route_path: /client_sessions
|
|
3836
|
+
---
|
|
3837
|
+
Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
|
|
3838
|
+
|
|
3839
|
+
You create each client session with a custom \`user_identifier_key\`. Normally, the \`user_identifier_key\` is a user ID that your application provides.
|
|
3840
|
+
|
|
3841
|
+
When calling the Seam API from your backend using an API key, you can pass the \`user_identifier_key\` as a parameter to limit results to the associated client session. For example, \`/devices/list?user_identifier_key=123\` only returns devices associated with the client session created with the \`user_identifier_key\` \`123\`.
|
|
3842
|
+
|
|
3843
|
+
A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
|
|
3844
|
+
|
|
3845
|
+
See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).
|
|
3846
|
+
`);
|
|
3792
3847
|
var space = zod.z.object({
|
|
3793
3848
|
space_id: zod.z.string().uuid().describe("ID of the space."),
|
|
3794
3849
|
workspace_id: zod.z.string().uuid().describe(
|
|
@@ -3969,26 +4024,39 @@ zod.z.object({
|
|
|
3969
4024
|
workspaces: workspace.array().optional(),
|
|
3970
4025
|
spaces: space.array().optional(),
|
|
3971
4026
|
devices: device.array().optional(),
|
|
3972
|
-
acs_entrances: acs_entrance.array().optional()
|
|
3973
|
-
|
|
4027
|
+
acs_entrances: acs_entrance.array().optional(),
|
|
4028
|
+
acs_systems: acs_system.array().optional(),
|
|
4029
|
+
acs_users: acs_user.array().optional(),
|
|
4030
|
+
acs_access_groups: acs_access_group.array().optional(),
|
|
4031
|
+
acs_encoders: acs_encoder.array().optional(),
|
|
4032
|
+
action_attempts: action_attempt.array().optional(),
|
|
4033
|
+
client_sessions: client_session.array().optional(),
|
|
4034
|
+
unmanaged_acs_users: unmanaged_acs_user.array().optional(),
|
|
4035
|
+
unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
|
|
4036
|
+
unmanaged_devices: unmanaged_device.array().optional()
|
|
4037
|
+
}).describe("A batch of workspace resources.");
|
|
3974
4038
|
var batch = zod.z.object({
|
|
3975
4039
|
batch_type: zod.z.enum([
|
|
3976
4040
|
"workspaces",
|
|
4041
|
+
"spaces",
|
|
3977
4042
|
"access_grants",
|
|
3978
|
-
"access_methods"
|
|
3979
|
-
"spaces"
|
|
4043
|
+
"access_methods"
|
|
3980
4044
|
]),
|
|
3981
4045
|
user_identities: user_identity.array().optional(),
|
|
3982
4046
|
workspaces: workspace.array().optional(),
|
|
3983
4047
|
spaces: space.array().optional(),
|
|
3984
4048
|
devices: device.array().optional(),
|
|
3985
|
-
acs_entrances: acs_entrance.array().optional()
|
|
3986
|
-
|
|
3987
|
-
|
|
3988
|
-
|
|
3989
|
-
|
|
3990
|
-
|
|
3991
|
-
|
|
4049
|
+
acs_entrances: acs_entrance.array().optional(),
|
|
4050
|
+
acs_systems: acs_system.array().optional(),
|
|
4051
|
+
acs_users: acs_user.array().optional(),
|
|
4052
|
+
acs_access_groups: acs_access_group.array().optional(),
|
|
4053
|
+
acs_encoders: acs_encoder.array().optional(),
|
|
4054
|
+
action_attempts: action_attempt.array().optional(),
|
|
4055
|
+
client_sessions: client_session.array().optional(),
|
|
4056
|
+
unmanaged_acs_users: unmanaged_acs_user.array().optional(),
|
|
4057
|
+
unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
|
|
4058
|
+
unmanaged_devices: unmanaged_device.array().optional()
|
|
4059
|
+
}).describe("A batch of workspace resources.");
|
|
3992
4060
|
var bridge = zod.z.object({
|
|
3993
4061
|
bridge_id: zod.z.string().uuid().describe("ID of Seam Bridge."),
|
|
3994
4062
|
workspace_id: zod.z.string().uuid().describe(
|
|
@@ -4066,60 +4134,6 @@ var bridge_client_session = zod.z.object({
|
|
|
4066
4134
|
---
|
|
4067
4135
|
Represents a [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.
|
|
4068
4136
|
`);
|
|
4069
|
-
var client_session = zod.z.object({
|
|
4070
|
-
client_session_id: zod.z.string().uuid().describe(
|
|
4071
|
-
"ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
|
|
4072
|
-
),
|
|
4073
|
-
workspace_id: zod.z.string().uuid().describe(
|
|
4074
|
-
"ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
|
|
4075
|
-
),
|
|
4076
|
-
created_at: zod.z.string().datetime().describe(
|
|
4077
|
-
"Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was created."
|
|
4078
|
-
),
|
|
4079
|
-
expires_at: zod.z.string().datetime().describe(
|
|
4080
|
-
"Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) expires."
|
|
4081
|
-
),
|
|
4082
|
-
token: zod.z.string().describe(
|
|
4083
|
-
"Client session token associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
|
|
4084
|
-
),
|
|
4085
|
-
user_identifier_key: zod.z.string().nullable().describe(
|
|
4086
|
-
"Your user ID for the user associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
|
|
4087
|
-
),
|
|
4088
|
-
device_count: zod.z.number().describe(
|
|
4089
|
-
"Number of devices associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
|
|
4090
|
-
),
|
|
4091
|
-
customer_id: zod.z.string().uuid().optional().describe(
|
|
4092
|
-
"Customer ID associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
|
|
4093
|
-
),
|
|
4094
|
-
connected_account_ids: zod.z.array(zod.z.string().uuid()).describe(
|
|
4095
|
-
"IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
|
|
4096
|
-
),
|
|
4097
|
-
connect_webview_ids: zod.z.array(zod.z.string().uuid()).describe(
|
|
4098
|
-
"IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
|
|
4099
|
-
),
|
|
4100
|
-
user_identity_ids: zod.z.array(zod.z.string().uuid()).describe(`
|
|
4101
|
-
---
|
|
4102
|
-
deprecated: Use \`user_identity_id\` instead.
|
|
4103
|
-
---
|
|
4104
|
-
IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.
|
|
4105
|
-
`),
|
|
4106
|
-
user_identity_id: zod.z.string().uuid().optional().describe(
|
|
4107
|
-
"ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session."
|
|
4108
|
-
)
|
|
4109
|
-
}).describe(`
|
|
4110
|
-
---
|
|
4111
|
-
route_path: /client_sessions
|
|
4112
|
-
---
|
|
4113
|
-
Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
|
|
4114
|
-
|
|
4115
|
-
You create each client session with a custom \`user_identifier_key\`. Normally, the \`user_identifier_key\` is a user ID that your application provides.
|
|
4116
|
-
|
|
4117
|
-
When calling the Seam API from your backend using an API key, you can pass the \`user_identifier_key\` as a parameter to limit results to the associated client session. For example, \`/devices/list?user_identifier_key=123\` only returns devices associated with the client session created with the \`user_identifier_key\` \`123\`.
|
|
4118
|
-
|
|
4119
|
-
A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
|
|
4120
|
-
|
|
4121
|
-
See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).
|
|
4122
|
-
`);
|
|
4123
4137
|
var connect_webview_device_selection_mode = zod.z.enum([
|
|
4124
4138
|
"none",
|
|
4125
4139
|
"single",
|
|
@@ -30492,6 +30506,12 @@ var openapi_default = {
|
|
|
30492
30506
|
description: "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).",
|
|
30493
30507
|
nullable: true,
|
|
30494
30508
|
type: "string"
|
|
30509
|
+
},
|
|
30510
|
+
user_identity_key: {
|
|
30511
|
+
description: "Unique key for the user identity.",
|
|
30512
|
+
minLength: 1,
|
|
30513
|
+
nullable: true,
|
|
30514
|
+
type: "string"
|
|
30495
30515
|
}
|
|
30496
30516
|
},
|
|
30497
30517
|
type: "object"
|
|
@@ -30578,6 +30598,11 @@ var openapi_default = {
|
|
|
30578
30598
|
items: { format: "uuid", type: "string" },
|
|
30579
30599
|
type: "array"
|
|
30580
30600
|
},
|
|
30601
|
+
space_keys: {
|
|
30602
|
+
description: "Set of keys of existing spaces to which access is being granted.",
|
|
30603
|
+
items: { type: "string" },
|
|
30604
|
+
type: "array"
|
|
30605
|
+
},
|
|
30581
30606
|
starts_at: {
|
|
30582
30607
|
description: "Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
30583
30608
|
type: "string"
|
|
@@ -31691,21 +31716,51 @@ var openapi_default = {
|
|
|
31691
31716
|
schema: {
|
|
31692
31717
|
properties: {
|
|
31693
31718
|
batch: {
|
|
31694
|
-
description: "
|
|
31719
|
+
description: "A batch of workspace resources.",
|
|
31695
31720
|
properties: {
|
|
31721
|
+
acs_access_groups: {
|
|
31722
|
+
items: {
|
|
31723
|
+
$ref: "#/components/schemas/acs_access_group"
|
|
31724
|
+
},
|
|
31725
|
+
type: "array"
|
|
31726
|
+
},
|
|
31727
|
+
acs_encoders: {
|
|
31728
|
+
items: { $ref: "#/components/schemas/acs_encoder" },
|
|
31729
|
+
type: "array"
|
|
31730
|
+
},
|
|
31696
31731
|
acs_entrances: {
|
|
31697
31732
|
items: { $ref: "#/components/schemas/acs_entrance" },
|
|
31698
31733
|
type: "array"
|
|
31699
31734
|
},
|
|
31735
|
+
acs_systems: {
|
|
31736
|
+
items: { $ref: "#/components/schemas/acs_system" },
|
|
31737
|
+
type: "array"
|
|
31738
|
+
},
|
|
31739
|
+
acs_users: {
|
|
31740
|
+
items: { $ref: "#/components/schemas/acs_user" },
|
|
31741
|
+
type: "array"
|
|
31742
|
+
},
|
|
31743
|
+
action_attempts: {
|
|
31744
|
+
items: {
|
|
31745
|
+
$ref: "#/components/schemas/action_attempt"
|
|
31746
|
+
},
|
|
31747
|
+
type: "array"
|
|
31748
|
+
},
|
|
31700
31749
|
batch_type: {
|
|
31701
31750
|
enum: [
|
|
31702
31751
|
"workspaces",
|
|
31752
|
+
"spaces",
|
|
31703
31753
|
"access_grants",
|
|
31704
|
-
"access_methods"
|
|
31705
|
-
"spaces"
|
|
31754
|
+
"access_methods"
|
|
31706
31755
|
],
|
|
31707
31756
|
type: "string"
|
|
31708
31757
|
},
|
|
31758
|
+
client_sessions: {
|
|
31759
|
+
items: {
|
|
31760
|
+
$ref: "#/components/schemas/client_session"
|
|
31761
|
+
},
|
|
31762
|
+
type: "array"
|
|
31763
|
+
},
|
|
31709
31764
|
devices: {
|
|
31710
31765
|
items: { $ref: "#/components/schemas/device" },
|
|
31711
31766
|
type: "array"
|
|
@@ -31714,6 +31769,24 @@ var openapi_default = {
|
|
|
31714
31769
|
items: { $ref: "#/components/schemas/space" },
|
|
31715
31770
|
type: "array"
|
|
31716
31771
|
},
|
|
31772
|
+
unmanaged_acs_access_groups: {
|
|
31773
|
+
items: {
|
|
31774
|
+
$ref: "#/components/schemas/unmanaged_acs_access_group"
|
|
31775
|
+
},
|
|
31776
|
+
type: "array"
|
|
31777
|
+
},
|
|
31778
|
+
unmanaged_acs_users: {
|
|
31779
|
+
items: {
|
|
31780
|
+
$ref: "#/components/schemas/unmanaged_acs_user"
|
|
31781
|
+
},
|
|
31782
|
+
type: "array"
|
|
31783
|
+
},
|
|
31784
|
+
unmanaged_devices: {
|
|
31785
|
+
items: {
|
|
31786
|
+
$ref: "#/components/schemas/unmanaged_device"
|
|
31787
|
+
},
|
|
31788
|
+
type: "array"
|
|
31789
|
+
},
|
|
31717
31790
|
user_identities: {
|
|
31718
31791
|
items: { $ref: "#/components/schemas/user_identity" },
|
|
31719
31792
|
type: "array"
|
|
@@ -31724,8 +31797,7 @@ var openapi_default = {
|
|
|
31724
31797
|
}
|
|
31725
31798
|
},
|
|
31726
31799
|
required: ["batch_type"],
|
|
31727
|
-
type: "object"
|
|
31728
|
-
"x-route-path": "/"
|
|
31800
|
+
type: "object"
|
|
31729
31801
|
},
|
|
31730
31802
|
ok: { type: "boolean" }
|
|
31731
31803
|
},
|
|
@@ -31795,21 +31867,51 @@ var openapi_default = {
|
|
|
31795
31867
|
schema: {
|
|
31796
31868
|
properties: {
|
|
31797
31869
|
batch: {
|
|
31798
|
-
description: "
|
|
31870
|
+
description: "A batch of workspace resources.",
|
|
31799
31871
|
properties: {
|
|
31872
|
+
acs_access_groups: {
|
|
31873
|
+
items: {
|
|
31874
|
+
$ref: "#/components/schemas/acs_access_group"
|
|
31875
|
+
},
|
|
31876
|
+
type: "array"
|
|
31877
|
+
},
|
|
31878
|
+
acs_encoders: {
|
|
31879
|
+
items: { $ref: "#/components/schemas/acs_encoder" },
|
|
31880
|
+
type: "array"
|
|
31881
|
+
},
|
|
31800
31882
|
acs_entrances: {
|
|
31801
31883
|
items: { $ref: "#/components/schemas/acs_entrance" },
|
|
31802
31884
|
type: "array"
|
|
31803
31885
|
},
|
|
31886
|
+
acs_systems: {
|
|
31887
|
+
items: { $ref: "#/components/schemas/acs_system" },
|
|
31888
|
+
type: "array"
|
|
31889
|
+
},
|
|
31890
|
+
acs_users: {
|
|
31891
|
+
items: { $ref: "#/components/schemas/acs_user" },
|
|
31892
|
+
type: "array"
|
|
31893
|
+
},
|
|
31894
|
+
action_attempts: {
|
|
31895
|
+
items: {
|
|
31896
|
+
$ref: "#/components/schemas/action_attempt"
|
|
31897
|
+
},
|
|
31898
|
+
type: "array"
|
|
31899
|
+
},
|
|
31804
31900
|
batch_type: {
|
|
31805
31901
|
enum: [
|
|
31806
31902
|
"workspaces",
|
|
31903
|
+
"spaces",
|
|
31807
31904
|
"access_grants",
|
|
31808
|
-
"access_methods"
|
|
31809
|
-
"spaces"
|
|
31905
|
+
"access_methods"
|
|
31810
31906
|
],
|
|
31811
31907
|
type: "string"
|
|
31812
31908
|
},
|
|
31909
|
+
client_sessions: {
|
|
31910
|
+
items: {
|
|
31911
|
+
$ref: "#/components/schemas/client_session"
|
|
31912
|
+
},
|
|
31913
|
+
type: "array"
|
|
31914
|
+
},
|
|
31813
31915
|
devices: {
|
|
31814
31916
|
items: { $ref: "#/components/schemas/device" },
|
|
31815
31917
|
type: "array"
|
|
@@ -31818,6 +31920,24 @@ var openapi_default = {
|
|
|
31818
31920
|
items: { $ref: "#/components/schemas/space" },
|
|
31819
31921
|
type: "array"
|
|
31820
31922
|
},
|
|
31923
|
+
unmanaged_acs_access_groups: {
|
|
31924
|
+
items: {
|
|
31925
|
+
$ref: "#/components/schemas/unmanaged_acs_access_group"
|
|
31926
|
+
},
|
|
31927
|
+
type: "array"
|
|
31928
|
+
},
|
|
31929
|
+
unmanaged_acs_users: {
|
|
31930
|
+
items: {
|
|
31931
|
+
$ref: "#/components/schemas/unmanaged_acs_user"
|
|
31932
|
+
},
|
|
31933
|
+
type: "array"
|
|
31934
|
+
},
|
|
31935
|
+
unmanaged_devices: {
|
|
31936
|
+
items: {
|
|
31937
|
+
$ref: "#/components/schemas/unmanaged_device"
|
|
31938
|
+
},
|
|
31939
|
+
type: "array"
|
|
31940
|
+
},
|
|
31821
31941
|
user_identities: {
|
|
31822
31942
|
items: { $ref: "#/components/schemas/user_identity" },
|
|
31823
31943
|
type: "array"
|
|
@@ -31828,8 +31948,7 @@ var openapi_default = {
|
|
|
31828
31948
|
}
|
|
31829
31949
|
},
|
|
31830
31950
|
required: ["batch_type"],
|
|
31831
|
-
type: "object"
|
|
31832
|
-
"x-route-path": "/"
|
|
31951
|
+
type: "object"
|
|
31833
31952
|
},
|
|
31834
31953
|
ok: { type: "boolean" }
|
|
31835
31954
|
},
|
|
@@ -44518,6 +44637,212 @@ var openapi_default = {
|
|
|
44518
44637
|
"x-title": "List Events"
|
|
44519
44638
|
}
|
|
44520
44639
|
},
|
|
44640
|
+
"/instant_keys/get": {
|
|
44641
|
+
get: {
|
|
44642
|
+
description: "Gets an [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).",
|
|
44643
|
+
operationId: "instantKeysGetGet",
|
|
44644
|
+
parameters: [
|
|
44645
|
+
{
|
|
44646
|
+
in: "query",
|
|
44647
|
+
name: "instant_key_id",
|
|
44648
|
+
required: true,
|
|
44649
|
+
schema: {
|
|
44650
|
+
description: "ID of the instant key to get.",
|
|
44651
|
+
format: "uuid",
|
|
44652
|
+
type: "string"
|
|
44653
|
+
}
|
|
44654
|
+
}
|
|
44655
|
+
],
|
|
44656
|
+
responses: {
|
|
44657
|
+
200: {
|
|
44658
|
+
content: {
|
|
44659
|
+
"application/json": {
|
|
44660
|
+
schema: {
|
|
44661
|
+
properties: {
|
|
44662
|
+
instant_key: { $ref: "#/components/schemas/instant_key" },
|
|
44663
|
+
ok: { type: "boolean" }
|
|
44664
|
+
},
|
|
44665
|
+
required: ["instant_key", "ok"],
|
|
44666
|
+
type: "object"
|
|
44667
|
+
}
|
|
44668
|
+
}
|
|
44669
|
+
},
|
|
44670
|
+
description: "OK"
|
|
44671
|
+
},
|
|
44672
|
+
400: { description: "Bad Request" },
|
|
44673
|
+
401: { description: "Unauthorized" }
|
|
44674
|
+
},
|
|
44675
|
+
security: [
|
|
44676
|
+
{ api_key: [] },
|
|
44677
|
+
{ pat_with_workspace: [] },
|
|
44678
|
+
{ console_session_with_workspace: [] }
|
|
44679
|
+
],
|
|
44680
|
+
summary: "/instant_keys/get",
|
|
44681
|
+
tags: [],
|
|
44682
|
+
"x-fern-sdk-group-name": ["instant_keys"],
|
|
44683
|
+
"x-fern-sdk-method-name": "get",
|
|
44684
|
+
"x-fern-sdk-return-value": "instant_key",
|
|
44685
|
+
"x-response-key": "instant_key",
|
|
44686
|
+
"x-title": "Get an Instant Key"
|
|
44687
|
+
},
|
|
44688
|
+
post: {
|
|
44689
|
+
description: "Gets an [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).",
|
|
44690
|
+
operationId: "instantKeysGetPost",
|
|
44691
|
+
requestBody: {
|
|
44692
|
+
content: {
|
|
44693
|
+
"application/json": {
|
|
44694
|
+
schema: {
|
|
44695
|
+
properties: {
|
|
44696
|
+
instant_key_id: {
|
|
44697
|
+
description: "ID of the instant key to get.",
|
|
44698
|
+
format: "uuid",
|
|
44699
|
+
type: "string"
|
|
44700
|
+
}
|
|
44701
|
+
},
|
|
44702
|
+
required: ["instant_key_id"],
|
|
44703
|
+
type: "object"
|
|
44704
|
+
}
|
|
44705
|
+
}
|
|
44706
|
+
}
|
|
44707
|
+
},
|
|
44708
|
+
responses: {
|
|
44709
|
+
200: {
|
|
44710
|
+
content: {
|
|
44711
|
+
"application/json": {
|
|
44712
|
+
schema: {
|
|
44713
|
+
properties: {
|
|
44714
|
+
instant_key: { $ref: "#/components/schemas/instant_key" },
|
|
44715
|
+
ok: { type: "boolean" }
|
|
44716
|
+
},
|
|
44717
|
+
required: ["instant_key", "ok"],
|
|
44718
|
+
type: "object"
|
|
44719
|
+
}
|
|
44720
|
+
}
|
|
44721
|
+
},
|
|
44722
|
+
description: "OK"
|
|
44723
|
+
},
|
|
44724
|
+
400: { description: "Bad Request" },
|
|
44725
|
+
401: { description: "Unauthorized" }
|
|
44726
|
+
},
|
|
44727
|
+
security: [
|
|
44728
|
+
{ api_key: [] },
|
|
44729
|
+
{ pat_with_workspace: [] },
|
|
44730
|
+
{ console_session_with_workspace: [] }
|
|
44731
|
+
],
|
|
44732
|
+
summary: "/instant_keys/get",
|
|
44733
|
+
tags: [],
|
|
44734
|
+
"x-fern-sdk-group-name": ["instant_keys"],
|
|
44735
|
+
"x-fern-sdk-method-name": "get",
|
|
44736
|
+
"x-fern-sdk-return-value": "instant_key",
|
|
44737
|
+
"x-response-key": "instant_key",
|
|
44738
|
+
"x-title": "Get an Instant Key"
|
|
44739
|
+
}
|
|
44740
|
+
},
|
|
44741
|
+
"/instant_keys/list": {
|
|
44742
|
+
get: {
|
|
44743
|
+
description: "Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).",
|
|
44744
|
+
operationId: "instantKeysListGet",
|
|
44745
|
+
parameters: [
|
|
44746
|
+
{
|
|
44747
|
+
in: "query",
|
|
44748
|
+
name: "user_identity_id",
|
|
44749
|
+
schema: {
|
|
44750
|
+
description: "ID of the user identity by which you want to filter the list of Instant Keys.",
|
|
44751
|
+
format: "uuid",
|
|
44752
|
+
type: "string"
|
|
44753
|
+
}
|
|
44754
|
+
}
|
|
44755
|
+
],
|
|
44756
|
+
responses: {
|
|
44757
|
+
200: {
|
|
44758
|
+
content: {
|
|
44759
|
+
"application/json": {
|
|
44760
|
+
schema: {
|
|
44761
|
+
properties: {
|
|
44762
|
+
instant_keys: {
|
|
44763
|
+
items: { $ref: "#/components/schemas/instant_key" },
|
|
44764
|
+
type: "array"
|
|
44765
|
+
},
|
|
44766
|
+
ok: { type: "boolean" }
|
|
44767
|
+
},
|
|
44768
|
+
required: ["instant_keys", "ok"],
|
|
44769
|
+
type: "object"
|
|
44770
|
+
}
|
|
44771
|
+
}
|
|
44772
|
+
},
|
|
44773
|
+
description: "OK"
|
|
44774
|
+
},
|
|
44775
|
+
400: { description: "Bad Request" },
|
|
44776
|
+
401: { description: "Unauthorized" }
|
|
44777
|
+
},
|
|
44778
|
+
security: [
|
|
44779
|
+
{ api_key: [] },
|
|
44780
|
+
{ pat_with_workspace: [] },
|
|
44781
|
+
{ console_session_with_workspace: [] }
|
|
44782
|
+
],
|
|
44783
|
+
summary: "/instant_keys/list",
|
|
44784
|
+
tags: [],
|
|
44785
|
+
"x-fern-sdk-group-name": ["instant_keys"],
|
|
44786
|
+
"x-fern-sdk-method-name": "list",
|
|
44787
|
+
"x-fern-sdk-return-value": "instant_keys",
|
|
44788
|
+
"x-response-key": "instant_keys",
|
|
44789
|
+
"x-title": "List Instant Keys"
|
|
44790
|
+
},
|
|
44791
|
+
post: {
|
|
44792
|
+
description: "Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).",
|
|
44793
|
+
operationId: "instantKeysListPost",
|
|
44794
|
+
requestBody: {
|
|
44795
|
+
content: {
|
|
44796
|
+
"application/json": {
|
|
44797
|
+
schema: {
|
|
44798
|
+
properties: {
|
|
44799
|
+
user_identity_id: {
|
|
44800
|
+
description: "ID of the user identity by which you want to filter the list of Instant Keys.",
|
|
44801
|
+
format: "uuid",
|
|
44802
|
+
type: "string"
|
|
44803
|
+
}
|
|
44804
|
+
},
|
|
44805
|
+
type: "object"
|
|
44806
|
+
}
|
|
44807
|
+
}
|
|
44808
|
+
}
|
|
44809
|
+
},
|
|
44810
|
+
responses: {
|
|
44811
|
+
200: {
|
|
44812
|
+
content: {
|
|
44813
|
+
"application/json": {
|
|
44814
|
+
schema: {
|
|
44815
|
+
properties: {
|
|
44816
|
+
instant_keys: {
|
|
44817
|
+
items: { $ref: "#/components/schemas/instant_key" },
|
|
44818
|
+
type: "array"
|
|
44819
|
+
},
|
|
44820
|
+
ok: { type: "boolean" }
|
|
44821
|
+
},
|
|
44822
|
+
required: ["instant_keys", "ok"],
|
|
44823
|
+
type: "object"
|
|
44824
|
+
}
|
|
44825
|
+
}
|
|
44826
|
+
},
|
|
44827
|
+
description: "OK"
|
|
44828
|
+
},
|
|
44829
|
+
400: { description: "Bad Request" },
|
|
44830
|
+
401: { description: "Unauthorized" }
|
|
44831
|
+
},
|
|
44832
|
+
security: [
|
|
44833
|
+
{ api_key: [] },
|
|
44834
|
+
{ pat_with_workspace: [] },
|
|
44835
|
+
{ console_session_with_workspace: [] }
|
|
44836
|
+
],
|
|
44837
|
+
summary: "/instant_keys/list",
|
|
44838
|
+
tags: [],
|
|
44839
|
+
"x-fern-sdk-group-name": ["instant_keys"],
|
|
44840
|
+
"x-fern-sdk-method-name": "list",
|
|
44841
|
+
"x-fern-sdk-return-value": "instant_keys",
|
|
44842
|
+
"x-response-key": "instant_keys",
|
|
44843
|
+
"x-title": "List Instant Keys"
|
|
44844
|
+
}
|
|
44845
|
+
},
|
|
44521
44846
|
"/locks/get": {
|
|
44522
44847
|
get: {
|
|
44523
44848
|
description: "Returns a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks). **Use `/devices/get` instead.**",
|
|
@@ -57894,21 +58219,51 @@ var openapi_default = {
|
|
|
57894
58219
|
schema: {
|
|
57895
58220
|
properties: {
|
|
57896
58221
|
batch: {
|
|
57897
|
-
description: "
|
|
58222
|
+
description: "A batch of workspace resources.",
|
|
57898
58223
|
properties: {
|
|
58224
|
+
acs_access_groups: {
|
|
58225
|
+
items: {
|
|
58226
|
+
$ref: "#/components/schemas/acs_access_group"
|
|
58227
|
+
},
|
|
58228
|
+
type: "array"
|
|
58229
|
+
},
|
|
58230
|
+
acs_encoders: {
|
|
58231
|
+
items: { $ref: "#/components/schemas/acs_encoder" },
|
|
58232
|
+
type: "array"
|
|
58233
|
+
},
|
|
57899
58234
|
acs_entrances: {
|
|
57900
58235
|
items: { $ref: "#/components/schemas/acs_entrance" },
|
|
57901
58236
|
type: "array"
|
|
57902
58237
|
},
|
|
58238
|
+
acs_systems: {
|
|
58239
|
+
items: { $ref: "#/components/schemas/acs_system" },
|
|
58240
|
+
type: "array"
|
|
58241
|
+
},
|
|
58242
|
+
acs_users: {
|
|
58243
|
+
items: { $ref: "#/components/schemas/acs_user" },
|
|
58244
|
+
type: "array"
|
|
58245
|
+
},
|
|
58246
|
+
action_attempts: {
|
|
58247
|
+
items: {
|
|
58248
|
+
$ref: "#/components/schemas/action_attempt"
|
|
58249
|
+
},
|
|
58250
|
+
type: "array"
|
|
58251
|
+
},
|
|
57903
58252
|
batch_type: {
|
|
57904
58253
|
enum: [
|
|
57905
58254
|
"workspaces",
|
|
58255
|
+
"spaces",
|
|
57906
58256
|
"access_grants",
|
|
57907
|
-
"access_methods"
|
|
57908
|
-
"spaces"
|
|
58257
|
+
"access_methods"
|
|
57909
58258
|
],
|
|
57910
58259
|
type: "string"
|
|
57911
58260
|
},
|
|
58261
|
+
client_sessions: {
|
|
58262
|
+
items: {
|
|
58263
|
+
$ref: "#/components/schemas/client_session"
|
|
58264
|
+
},
|
|
58265
|
+
type: "array"
|
|
58266
|
+
},
|
|
57912
58267
|
devices: {
|
|
57913
58268
|
items: { $ref: "#/components/schemas/device" },
|
|
57914
58269
|
type: "array"
|
|
@@ -57917,6 +58272,24 @@ var openapi_default = {
|
|
|
57917
58272
|
items: { $ref: "#/components/schemas/space" },
|
|
57918
58273
|
type: "array"
|
|
57919
58274
|
},
|
|
58275
|
+
unmanaged_acs_access_groups: {
|
|
58276
|
+
items: {
|
|
58277
|
+
$ref: "#/components/schemas/unmanaged_acs_access_group"
|
|
58278
|
+
},
|
|
58279
|
+
type: "array"
|
|
58280
|
+
},
|
|
58281
|
+
unmanaged_acs_users: {
|
|
58282
|
+
items: {
|
|
58283
|
+
$ref: "#/components/schemas/unmanaged_acs_user"
|
|
58284
|
+
},
|
|
58285
|
+
type: "array"
|
|
58286
|
+
},
|
|
58287
|
+
unmanaged_devices: {
|
|
58288
|
+
items: {
|
|
58289
|
+
$ref: "#/components/schemas/unmanaged_device"
|
|
58290
|
+
},
|
|
58291
|
+
type: "array"
|
|
58292
|
+
},
|
|
57920
58293
|
user_identities: {
|
|
57921
58294
|
items: { $ref: "#/components/schemas/user_identity" },
|
|
57922
58295
|
type: "array"
|
|
@@ -57927,8 +58300,7 @@ var openapi_default = {
|
|
|
57927
58300
|
}
|
|
57928
58301
|
},
|
|
57929
58302
|
required: ["batch_type"],
|
|
57930
|
-
type: "object"
|
|
57931
|
-
"x-route-path": "/"
|
|
58303
|
+
type: "object"
|
|
57932
58304
|
},
|
|
57933
58305
|
ok: { type: "boolean" }
|
|
57934
58306
|
},
|
|
@@ -57975,21 +58347,51 @@ var openapi_default = {
|
|
|
57975
58347
|
schema: {
|
|
57976
58348
|
properties: {
|
|
57977
58349
|
batch: {
|
|
57978
|
-
description: "
|
|
58350
|
+
description: "A batch of workspace resources.",
|
|
57979
58351
|
properties: {
|
|
58352
|
+
acs_access_groups: {
|
|
58353
|
+
items: {
|
|
58354
|
+
$ref: "#/components/schemas/acs_access_group"
|
|
58355
|
+
},
|
|
58356
|
+
type: "array"
|
|
58357
|
+
},
|
|
58358
|
+
acs_encoders: {
|
|
58359
|
+
items: { $ref: "#/components/schemas/acs_encoder" },
|
|
58360
|
+
type: "array"
|
|
58361
|
+
},
|
|
57980
58362
|
acs_entrances: {
|
|
57981
58363
|
items: { $ref: "#/components/schemas/acs_entrance" },
|
|
57982
58364
|
type: "array"
|
|
57983
58365
|
},
|
|
58366
|
+
acs_systems: {
|
|
58367
|
+
items: { $ref: "#/components/schemas/acs_system" },
|
|
58368
|
+
type: "array"
|
|
58369
|
+
},
|
|
58370
|
+
acs_users: {
|
|
58371
|
+
items: { $ref: "#/components/schemas/acs_user" },
|
|
58372
|
+
type: "array"
|
|
58373
|
+
},
|
|
58374
|
+
action_attempts: {
|
|
58375
|
+
items: {
|
|
58376
|
+
$ref: "#/components/schemas/action_attempt"
|
|
58377
|
+
},
|
|
58378
|
+
type: "array"
|
|
58379
|
+
},
|
|
57984
58380
|
batch_type: {
|
|
57985
58381
|
enum: [
|
|
57986
58382
|
"workspaces",
|
|
58383
|
+
"spaces",
|
|
57987
58384
|
"access_grants",
|
|
57988
|
-
"access_methods"
|
|
57989
|
-
"spaces"
|
|
58385
|
+
"access_methods"
|
|
57990
58386
|
],
|
|
57991
58387
|
type: "string"
|
|
57992
58388
|
},
|
|
58389
|
+
client_sessions: {
|
|
58390
|
+
items: {
|
|
58391
|
+
$ref: "#/components/schemas/client_session"
|
|
58392
|
+
},
|
|
58393
|
+
type: "array"
|
|
58394
|
+
},
|
|
57993
58395
|
devices: {
|
|
57994
58396
|
items: { $ref: "#/components/schemas/device" },
|
|
57995
58397
|
type: "array"
|
|
@@ -57998,6 +58400,24 @@ var openapi_default = {
|
|
|
57998
58400
|
items: { $ref: "#/components/schemas/space" },
|
|
57999
58401
|
type: "array"
|
|
58000
58402
|
},
|
|
58403
|
+
unmanaged_acs_access_groups: {
|
|
58404
|
+
items: {
|
|
58405
|
+
$ref: "#/components/schemas/unmanaged_acs_access_group"
|
|
58406
|
+
},
|
|
58407
|
+
type: "array"
|
|
58408
|
+
},
|
|
58409
|
+
unmanaged_acs_users: {
|
|
58410
|
+
items: {
|
|
58411
|
+
$ref: "#/components/schemas/unmanaged_acs_user"
|
|
58412
|
+
},
|
|
58413
|
+
type: "array"
|
|
58414
|
+
},
|
|
58415
|
+
unmanaged_devices: {
|
|
58416
|
+
items: {
|
|
58417
|
+
$ref: "#/components/schemas/unmanaged_device"
|
|
58418
|
+
},
|
|
58419
|
+
type: "array"
|
|
58420
|
+
},
|
|
58001
58421
|
user_identities: {
|
|
58002
58422
|
items: { $ref: "#/components/schemas/user_identity" },
|
|
58003
58423
|
type: "array"
|
|
@@ -58008,8 +58428,7 @@ var openapi_default = {
|
|
|
58008
58428
|
}
|
|
58009
58429
|
},
|
|
58010
58430
|
required: ["batch_type"],
|
|
58011
|
-
type: "object"
|
|
58012
|
-
"x-route-path": "/"
|
|
58431
|
+
type: "object"
|
|
58013
58432
|
},
|
|
58014
58433
|
ok: { type: "boolean" }
|
|
58015
58434
|
},
|