@seamapi/types 1.409.0 → 1.410.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 +101 -41
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +83 -14
- package/lib/seam/connect/models/connect-webviews/connect-webview.d.ts +5 -0
- package/lib/seam/connect/models/connect-webviews/connect-webview.js +12 -0
- package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +2 -0
- package/lib/seam/connect/models/devices/device-provider.js +8 -0
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/events/access-grants.js +5 -5
- package/lib/seam/connect/models/events/access-methods.js +4 -4
- package/lib/seam/connect/models/partner/resources.d.ts +1 -0
- package/lib/seam/connect/openapi.d.ts +63 -11
- package/lib/seam/connect/openapi.js +72 -24
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +17 -3
- package/package.json +1 -1
- package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +20 -0
- package/src/lib/seam/connect/models/devices/device-provider.ts +13 -0
- package/src/lib/seam/connect/models/events/access-grants.ts +5 -5
- package/src/lib/seam/connect/models/events/access-methods.ts +4 -4
- package/src/lib/seam/connect/models/partner/resources.ts +2 -0
- package/src/lib/seam/connect/openapi.ts +77 -24
- package/src/lib/seam/connect/route-types.ts +33 -7
|
@@ -19051,6 +19051,8 @@ export interface Routes {
|
|
|
19051
19051
|
automatically_manage_new_devices?: boolean;
|
|
19052
19052
|
/** Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews). */
|
|
19053
19053
|
wait_for_device_creation?: boolean;
|
|
19054
|
+
/** List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. If not provided, defaults will be determined based on the accepted providers. */
|
|
19055
|
+
accepted_capabilities?: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'> | undefined;
|
|
19054
19056
|
};
|
|
19055
19057
|
commonParams: {};
|
|
19056
19058
|
formData: {};
|
|
@@ -19080,6 +19082,8 @@ export interface Routes {
|
|
|
19080
19082
|
device_selection_mode: 'none' | 'single' | 'multiple';
|
|
19081
19083
|
/** List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
|
|
19082
19084
|
accepted_providers: string[];
|
|
19085
|
+
/** List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. */
|
|
19086
|
+
accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>;
|
|
19083
19087
|
/**
|
|
19084
19088
|
* @deprecated Unused. Will be removed. */
|
|
19085
19089
|
accepted_devices: string[];
|
|
@@ -19157,6 +19161,8 @@ export interface Routes {
|
|
|
19157
19161
|
device_selection_mode: 'none' | 'single' | 'multiple';
|
|
19158
19162
|
/** List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
|
|
19159
19163
|
accepted_providers: string[];
|
|
19164
|
+
/** List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. */
|
|
19165
|
+
accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>;
|
|
19160
19166
|
/**
|
|
19161
19167
|
* @deprecated Unused. Will be removed. */
|
|
19162
19168
|
accepted_devices: string[];
|
|
@@ -19216,6 +19222,8 @@ export interface Routes {
|
|
|
19216
19222
|
device_selection_mode: 'none' | 'single' | 'multiple';
|
|
19217
19223
|
/** List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
|
|
19218
19224
|
accepted_providers: string[];
|
|
19225
|
+
/** List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. */
|
|
19226
|
+
accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>;
|
|
19219
19227
|
/**
|
|
19220
19228
|
* @deprecated Unused. Will be removed. */
|
|
19221
19229
|
accepted_devices: string[];
|
|
@@ -56811,7 +56819,13 @@ export interface Routes {
|
|
|
56811
56819
|
} | {
|
|
56812
56820
|
building_block_type: 'organize_spaces';
|
|
56813
56821
|
customer_key: string;
|
|
56814
|
-
|
|
56822
|
+
/** Optional list of partner resources to include in the magic link. */
|
|
56823
|
+
partner_resources?: Array<{
|
|
56824
|
+
partner_resource_key: string;
|
|
56825
|
+
name: string;
|
|
56826
|
+
description?: string | undefined;
|
|
56827
|
+
custom_metadata?: Record<string, string> | undefined;
|
|
56828
|
+
}> | undefined;
|
|
56815
56829
|
};
|
|
56816
56830
|
formData: {};
|
|
56817
56831
|
jsonResponse: {
|
|
@@ -56854,12 +56868,12 @@ export interface Routes {
|
|
|
56854
56868
|
jsonBody: {};
|
|
56855
56869
|
commonParams: {
|
|
56856
56870
|
customer_key: string;
|
|
56857
|
-
partner_resources
|
|
56871
|
+
partner_resources?: Array<{
|
|
56858
56872
|
partner_resource_key: string;
|
|
56859
56873
|
name: string;
|
|
56860
56874
|
description?: string | undefined;
|
|
56861
56875
|
custom_metadata?: Record<string, string> | undefined;
|
|
56862
|
-
}
|
|
56876
|
+
}> | undefined;
|
|
56863
56877
|
};
|
|
56864
56878
|
formData: {};
|
|
56865
56879
|
jsonResponse: {
|
package/package.json
CHANGED
|
@@ -8,6 +8,20 @@ export const connect_webview_device_selection_mode = z.enum([
|
|
|
8
8
|
'multiple',
|
|
9
9
|
])
|
|
10
10
|
|
|
11
|
+
export const connect_webview_accepted_capabilities = z.enum([
|
|
12
|
+
'lock',
|
|
13
|
+
'thermostat',
|
|
14
|
+
'noise_sensor',
|
|
15
|
+
'access_control',
|
|
16
|
+
]).describe(`
|
|
17
|
+
High-level device capabilities that can be restricted in connect webviews.
|
|
18
|
+
These represent the main device categories that customers can opt into.
|
|
19
|
+
`)
|
|
20
|
+
|
|
21
|
+
export type ConnectWebviewAcceptedCapabilities = z.infer<
|
|
22
|
+
typeof connect_webview_accepted_capabilities
|
|
23
|
+
>
|
|
24
|
+
|
|
11
25
|
export const connect_webview = z.object({
|
|
12
26
|
connect_webview_id: z.string().uuid().describe('ID of the Connect Webview.'),
|
|
13
27
|
workspace_id: z
|
|
@@ -42,6 +56,12 @@ export const connect_webview = z.object({
|
|
|
42
56
|
'List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).',
|
|
43
57
|
),
|
|
44
58
|
|
|
59
|
+
accepted_capabilities: z
|
|
60
|
+
.array(connect_webview_accepted_capabilities)
|
|
61
|
+
.describe(
|
|
62
|
+
'List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview.',
|
|
63
|
+
),
|
|
64
|
+
|
|
45
65
|
accepted_devices: z.array(z.string()).describe(
|
|
46
66
|
`
|
|
47
67
|
---
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { z } from 'zod'
|
|
2
2
|
|
|
3
|
+
import type { ConnectWebviewAcceptedCapabilities } from '../connect-webviews/index.js'
|
|
3
4
|
import { device_capability_flags } from './device.js'
|
|
4
5
|
|
|
5
6
|
export const DEVICE_PROVIDERS = {
|
|
@@ -145,3 +146,15 @@ export const device_provider = z
|
|
|
145
146
|
`)
|
|
146
147
|
|
|
147
148
|
export type DeviceProvider = z.infer<typeof device_provider>
|
|
149
|
+
|
|
150
|
+
export const PROVIDER_CATEGORY_CAPABILITY_MAP: Record<
|
|
151
|
+
ProviderCategory,
|
|
152
|
+
ConnectWebviewAcceptedCapabilities[]
|
|
153
|
+
> = {
|
|
154
|
+
stable: ['lock', 'thermostat', 'noise_sensor', 'access_control'],
|
|
155
|
+
consumer_smartlocks: ['lock'],
|
|
156
|
+
thermostats: ['thermostat'],
|
|
157
|
+
noise_sensors: ['noise_sensor'],
|
|
158
|
+
access_control_systems: ['access_control'],
|
|
159
|
+
internal_beta: ['lock', 'thermostat', 'noise_sensor', 'access_control'],
|
|
160
|
+
}
|
|
@@ -13,7 +13,7 @@ export const access_grant_created_event = access_grant_event.extend({
|
|
|
13
13
|
event_type: z.literal('access_grant.created'),
|
|
14
14
|
}).describe(`
|
|
15
15
|
---
|
|
16
|
-
route_path: /
|
|
16
|
+
route_path: /access_grants
|
|
17
17
|
---
|
|
18
18
|
An access grant was created.
|
|
19
19
|
`)
|
|
@@ -24,7 +24,7 @@ export const access_grant_deleted_event = access_grant_event.extend({
|
|
|
24
24
|
event_type: z.literal('access_grant.deleted'),
|
|
25
25
|
}).describe(`
|
|
26
26
|
---
|
|
27
|
-
route_path: /
|
|
27
|
+
route_path: /access_grants
|
|
28
28
|
---
|
|
29
29
|
An access grant was deleted.
|
|
30
30
|
`)
|
|
@@ -38,7 +38,7 @@ export const access_grant_access_granted_to_all_doors_event =
|
|
|
38
38
|
event_type: z.literal('access_grant.access_granted_to_all_doors'),
|
|
39
39
|
}).describe(`
|
|
40
40
|
---
|
|
41
|
-
route_path: /
|
|
41
|
+
route_path: /access_grants
|
|
42
42
|
---
|
|
43
43
|
All access requested for an access grant was successfully granted.
|
|
44
44
|
`)
|
|
@@ -60,7 +60,7 @@ export const access_grant_access_granted_to_door_event =
|
|
|
60
60
|
acs_entrance_id,
|
|
61
61
|
}).describe(`
|
|
62
62
|
---
|
|
63
|
-
route_path: /
|
|
63
|
+
route_path: /access_grants
|
|
64
64
|
---
|
|
65
65
|
Access requested as part of an access grant to a particular door was successfully granted.
|
|
66
66
|
`)
|
|
@@ -76,7 +76,7 @@ export const access_grant_access_to_door_lost_event = access_grant_event.extend(
|
|
|
76
76
|
},
|
|
77
77
|
).describe(`
|
|
78
78
|
---
|
|
79
|
-
route_path: /
|
|
79
|
+
route_path: /access_grants
|
|
80
80
|
---
|
|
81
81
|
Access to a particular door that was requested as part of an access grant was lost.
|
|
82
82
|
`)
|
|
@@ -13,7 +13,7 @@ export const access_method_issued_event = access_method_event.extend({
|
|
|
13
13
|
event_type: z.literal('access_method.issued'),
|
|
14
14
|
}).describe(`
|
|
15
15
|
---
|
|
16
|
-
route_path: /
|
|
16
|
+
route_path: /access_methods
|
|
17
17
|
---
|
|
18
18
|
An access method was issued.
|
|
19
19
|
`)
|
|
@@ -25,7 +25,7 @@ export const access_method_card_encoding_required_event =
|
|
|
25
25
|
event_type: z.literal('access_method.card_encoding_required'),
|
|
26
26
|
}).describe(`
|
|
27
27
|
---
|
|
28
|
-
route_path: /
|
|
28
|
+
route_path: /access_methods
|
|
29
29
|
---
|
|
30
30
|
An access method representing a physical card requires encoding.
|
|
31
31
|
`)
|
|
@@ -38,7 +38,7 @@ export const access_method_revoked_event = access_method_event.extend({
|
|
|
38
38
|
event_type: z.literal('access_method.revoked'),
|
|
39
39
|
}).describe(`
|
|
40
40
|
---
|
|
41
|
-
route_path: /
|
|
41
|
+
route_path: /access_methods
|
|
42
42
|
---
|
|
43
43
|
An access method was revoked.
|
|
44
44
|
`)
|
|
@@ -47,7 +47,7 @@ export const access_method_deleted_event = access_method_event.extend({
|
|
|
47
47
|
event_type: z.literal('access_method.deleted'),
|
|
48
48
|
}).describe(`
|
|
49
49
|
---
|
|
50
|
-
route_path: /
|
|
50
|
+
route_path: /access_methods
|
|
51
51
|
---
|
|
52
52
|
An access method was deleted.
|
|
53
53
|
`)
|
|
@@ -7186,6 +7186,17 @@ export default {
|
|
|
7186
7186
|
description:
|
|
7187
7187
|
'Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nConnect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.\n\nConnect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.\n\nTo enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.\n\nWhen you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.\n\nTo list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters.',
|
|
7188
7188
|
properties: {
|
|
7189
|
+
accepted_capabilities: {
|
|
7190
|
+
description:
|
|
7191
|
+
'List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview.',
|
|
7192
|
+
items: {
|
|
7193
|
+
description:
|
|
7194
|
+
'\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n',
|
|
7195
|
+
enum: ['lock', 'thermostat', 'noise_sensor', 'access_control'],
|
|
7196
|
+
type: 'string',
|
|
7197
|
+
},
|
|
7198
|
+
type: 'array',
|
|
7199
|
+
},
|
|
7189
7200
|
accepted_devices: {
|
|
7190
7201
|
deprecated: true,
|
|
7191
7202
|
items: { type: 'string' },
|
|
@@ -7308,6 +7319,7 @@ export default {
|
|
|
7308
7319
|
'url',
|
|
7309
7320
|
'device_selection_mode',
|
|
7310
7321
|
'accepted_providers',
|
|
7322
|
+
'accepted_capabilities',
|
|
7311
7323
|
'accepted_devices',
|
|
7312
7324
|
'any_device_allowed',
|
|
7313
7325
|
'any_provider_allowed',
|
|
@@ -12080,7 +12092,7 @@ export default {
|
|
|
12080
12092
|
'event_type',
|
|
12081
12093
|
],
|
|
12082
12094
|
type: 'object',
|
|
12083
|
-
'x-route-path': '/
|
|
12095
|
+
'x-route-path': '/access_grants',
|
|
12084
12096
|
},
|
|
12085
12097
|
{
|
|
12086
12098
|
description: 'An access grant was deleted.',
|
|
@@ -12121,7 +12133,7 @@ export default {
|
|
|
12121
12133
|
'event_type',
|
|
12122
12134
|
],
|
|
12123
12135
|
type: 'object',
|
|
12124
|
-
'x-route-path': '/
|
|
12136
|
+
'x-route-path': '/access_grants',
|
|
12125
12137
|
},
|
|
12126
12138
|
{
|
|
12127
12139
|
description:
|
|
@@ -12166,7 +12178,7 @@ export default {
|
|
|
12166
12178
|
'event_type',
|
|
12167
12179
|
],
|
|
12168
12180
|
type: 'object',
|
|
12169
|
-
'x-route-path': '/
|
|
12181
|
+
'x-route-path': '/access_grants',
|
|
12170
12182
|
},
|
|
12171
12183
|
{
|
|
12172
12184
|
description:
|
|
@@ -12218,7 +12230,7 @@ export default {
|
|
|
12218
12230
|
'acs_entrance_id',
|
|
12219
12231
|
],
|
|
12220
12232
|
type: 'object',
|
|
12221
|
-
'x-route-path': '/
|
|
12233
|
+
'x-route-path': '/access_grants',
|
|
12222
12234
|
},
|
|
12223
12235
|
{
|
|
12224
12236
|
description:
|
|
@@ -12270,7 +12282,7 @@ export default {
|
|
|
12270
12282
|
'acs_entrance_id',
|
|
12271
12283
|
],
|
|
12272
12284
|
type: 'object',
|
|
12273
|
-
'x-route-path': '/
|
|
12285
|
+
'x-route-path': '/access_grants',
|
|
12274
12286
|
},
|
|
12275
12287
|
{
|
|
12276
12288
|
description: 'An access method was issued.',
|
|
@@ -12311,7 +12323,7 @@ export default {
|
|
|
12311
12323
|
'event_type',
|
|
12312
12324
|
],
|
|
12313
12325
|
type: 'object',
|
|
12314
|
-
'x-route-path': '/
|
|
12326
|
+
'x-route-path': '/access_methods',
|
|
12315
12327
|
},
|
|
12316
12328
|
{
|
|
12317
12329
|
description: 'An access method was revoked.',
|
|
@@ -12352,7 +12364,7 @@ export default {
|
|
|
12352
12364
|
'event_type',
|
|
12353
12365
|
],
|
|
12354
12366
|
type: 'object',
|
|
12355
|
-
'x-route-path': '/
|
|
12367
|
+
'x-route-path': '/access_methods',
|
|
12356
12368
|
},
|
|
12357
12369
|
{
|
|
12358
12370
|
description:
|
|
@@ -12397,7 +12409,7 @@ export default {
|
|
|
12397
12409
|
'event_type',
|
|
12398
12410
|
],
|
|
12399
12411
|
type: 'object',
|
|
12400
|
-
'x-route-path': '/
|
|
12412
|
+
'x-route-path': '/access_methods',
|
|
12401
12413
|
},
|
|
12402
12414
|
{
|
|
12403
12415
|
description: 'An access method was deleted.',
|
|
@@ -12438,7 +12450,7 @@ export default {
|
|
|
12438
12450
|
'event_type',
|
|
12439
12451
|
],
|
|
12440
12452
|
type: 'object',
|
|
12441
|
-
'x-route-path': '/
|
|
12453
|
+
'x-route-path': '/access_methods',
|
|
12442
12454
|
},
|
|
12443
12455
|
{
|
|
12444
12456
|
description:
|
|
@@ -22956,12 +22968,12 @@ export default {
|
|
|
22956
22968
|
],
|
|
22957
22969
|
summary: '/access_grants/create',
|
|
22958
22970
|
tags: [],
|
|
22971
|
+
'x-draft': 'Early access.',
|
|
22959
22972
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
22960
22973
|
'x-fern-sdk-method-name': 'create',
|
|
22961
22974
|
'x-fern-sdk-return-value': 'access_grant',
|
|
22962
22975
|
'x-response-key': 'access_grant',
|
|
22963
22976
|
'x-title': 'Create an Access Grant',
|
|
22964
|
-
'x-undocumented': 'Unreleased.',
|
|
22965
22977
|
},
|
|
22966
22978
|
},
|
|
22967
22979
|
'/access_grants/delete': {
|
|
@@ -23009,11 +23021,11 @@ export default {
|
|
|
23009
23021
|
],
|
|
23010
23022
|
summary: '/access_grants/delete',
|
|
23011
23023
|
tags: [],
|
|
23024
|
+
'x-draft': 'Early access.',
|
|
23012
23025
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
23013
23026
|
'x-fern-sdk-method-name': 'delete',
|
|
23014
23027
|
'x-response-key': null,
|
|
23015
23028
|
'x-title': 'Delete an Access Grant',
|
|
23016
|
-
'x-undocumented': 'Unreleased.',
|
|
23017
23029
|
},
|
|
23018
23030
|
},
|
|
23019
23031
|
'/access_grants/get': {
|
|
@@ -23165,12 +23177,12 @@ export default {
|
|
|
23165
23177
|
],
|
|
23166
23178
|
summary: '/access_grants/get',
|
|
23167
23179
|
tags: [],
|
|
23180
|
+
'x-draft': 'Early access.',
|
|
23168
23181
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
23169
23182
|
'x-fern-sdk-method-name': 'get',
|
|
23170
23183
|
'x-fern-sdk-return-value': 'access_grant',
|
|
23171
23184
|
'x-response-key': 'access_grant',
|
|
23172
23185
|
'x-title': 'Get an Access Grant',
|
|
23173
|
-
'x-undocumented': 'Unreleased.',
|
|
23174
23186
|
},
|
|
23175
23187
|
},
|
|
23176
23188
|
'/access_grants/list': {
|
|
@@ -23349,12 +23361,12 @@ export default {
|
|
|
23349
23361
|
],
|
|
23350
23362
|
summary: '/access_grants/list',
|
|
23351
23363
|
tags: [],
|
|
23364
|
+
'x-draft': 'Early access.',
|
|
23352
23365
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
23353
23366
|
'x-fern-sdk-method-name': 'list',
|
|
23354
23367
|
'x-fern-sdk-return-value': 'access_grants',
|
|
23355
23368
|
'x-response-key': 'access_grants',
|
|
23356
23369
|
'x-title': 'List Access Grants',
|
|
23357
|
-
'x-undocumented': 'Unreleased.',
|
|
23358
23370
|
},
|
|
23359
23371
|
},
|
|
23360
23372
|
'/access_methods/delete': {
|
|
@@ -23401,11 +23413,11 @@ export default {
|
|
|
23401
23413
|
],
|
|
23402
23414
|
summary: '/access_methods/delete',
|
|
23403
23415
|
tags: [],
|
|
23416
|
+
'x-draft': 'Early access.',
|
|
23404
23417
|
'x-fern-sdk-group-name': ['access_methods'],
|
|
23405
23418
|
'x-fern-sdk-method-name': 'delete',
|
|
23406
23419
|
'x-response-key': null,
|
|
23407
23420
|
'x-title': 'Delete an Access Method',
|
|
23408
|
-
'x-undocumented': 'Unreleased.',
|
|
23409
23421
|
},
|
|
23410
23422
|
},
|
|
23411
23423
|
'/access_methods/get': {
|
|
@@ -23511,12 +23523,12 @@ export default {
|
|
|
23511
23523
|
],
|
|
23512
23524
|
summary: '/access_methods/get',
|
|
23513
23525
|
tags: [],
|
|
23526
|
+
'x-draft': 'Early access.',
|
|
23514
23527
|
'x-fern-sdk-group-name': ['access_methods'],
|
|
23515
23528
|
'x-fern-sdk-method-name': 'get',
|
|
23516
23529
|
'x-fern-sdk-return-value': 'access_method',
|
|
23517
23530
|
'x-response-key': 'access_method',
|
|
23518
23531
|
'x-title': 'Get an Access Method',
|
|
23519
|
-
'x-undocumented': 'Unreleased.',
|
|
23520
23532
|
},
|
|
23521
23533
|
},
|
|
23522
23534
|
'/access_methods/list': {
|
|
@@ -23627,12 +23639,12 @@ export default {
|
|
|
23627
23639
|
],
|
|
23628
23640
|
summary: '/access_methods/list',
|
|
23629
23641
|
tags: [],
|
|
23642
|
+
'x-draft': 'Early access.',
|
|
23630
23643
|
'x-fern-sdk-group-name': ['access_methods'],
|
|
23631
23644
|
'x-fern-sdk-method-name': 'list',
|
|
23632
23645
|
'x-fern-sdk-return-value': 'access_methods',
|
|
23633
23646
|
'x-response-key': 'access_methods',
|
|
23634
23647
|
'x-title': 'List Access Methods',
|
|
23635
|
-
'x-undocumented': 'Unreleased.',
|
|
23636
23648
|
},
|
|
23637
23649
|
},
|
|
23638
23650
|
'/acs/access_groups/add_user': {
|
|
@@ -28645,6 +28657,22 @@ export default {
|
|
|
28645
28657
|
'application/json': {
|
|
28646
28658
|
schema: {
|
|
28647
28659
|
properties: {
|
|
28660
|
+
accepted_capabilities: {
|
|
28661
|
+
description:
|
|
28662
|
+
'List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. If not provided, defaults will be determined based on the accepted providers.',
|
|
28663
|
+
items: {
|
|
28664
|
+
description:
|
|
28665
|
+
'\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n',
|
|
28666
|
+
enum: [
|
|
28667
|
+
'lock',
|
|
28668
|
+
'thermostat',
|
|
28669
|
+
'noise_sensor',
|
|
28670
|
+
'access_control',
|
|
28671
|
+
],
|
|
28672
|
+
type: 'string',
|
|
28673
|
+
},
|
|
28674
|
+
type: 'array',
|
|
28675
|
+
},
|
|
28648
28676
|
accepted_providers: {
|
|
28649
28677
|
description:
|
|
28650
28678
|
'Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters.',
|
|
@@ -34433,6 +34461,7 @@ export default {
|
|
|
34433
34461
|
],
|
|
34434
34462
|
summary: '/spaces/add_acs_entrances',
|
|
34435
34463
|
tags: [],
|
|
34464
|
+
'x-draft': 'Early access.',
|
|
34436
34465
|
'x-fern-sdk-group-name': ['spaces'],
|
|
34437
34466
|
'x-fern-sdk-method-name': 'add_acs_entrances',
|
|
34438
34467
|
'x-response-key': null,
|
|
@@ -34482,6 +34511,7 @@ export default {
|
|
|
34482
34511
|
],
|
|
34483
34512
|
summary: '/spaces/add_acs_entrances',
|
|
34484
34513
|
tags: [],
|
|
34514
|
+
'x-draft': 'Early access.',
|
|
34485
34515
|
'x-fern-ignore': true,
|
|
34486
34516
|
'x-response-key': null,
|
|
34487
34517
|
'x-title': 'Add ACS Entrances',
|
|
@@ -34532,6 +34562,7 @@ export default {
|
|
|
34532
34562
|
],
|
|
34533
34563
|
summary: '/spaces/add_devices',
|
|
34534
34564
|
tags: [],
|
|
34565
|
+
'x-draft': 'Early access.',
|
|
34535
34566
|
'x-fern-sdk-group-name': ['spaces'],
|
|
34536
34567
|
'x-fern-sdk-method-name': 'add_devices',
|
|
34537
34568
|
'x-response-key': null,
|
|
@@ -34581,6 +34612,7 @@ export default {
|
|
|
34581
34612
|
],
|
|
34582
34613
|
summary: '/spaces/add_devices',
|
|
34583
34614
|
tags: [],
|
|
34615
|
+
'x-draft': 'Early access.',
|
|
34584
34616
|
'x-fern-ignore': true,
|
|
34585
34617
|
'x-response-key': null,
|
|
34586
34618
|
'x-title': 'Add Space Devices',
|
|
@@ -34637,6 +34669,7 @@ export default {
|
|
|
34637
34669
|
],
|
|
34638
34670
|
summary: '/spaces/create',
|
|
34639
34671
|
tags: [],
|
|
34672
|
+
'x-draft': 'Early access.',
|
|
34640
34673
|
'x-fern-sdk-group-name': ['spaces'],
|
|
34641
34674
|
'x-fern-sdk-method-name': 'create',
|
|
34642
34675
|
'x-fern-sdk-return-value': 'space',
|
|
@@ -34769,6 +34802,7 @@ export default {
|
|
|
34769
34802
|
],
|
|
34770
34803
|
summary: '/spaces/list',
|
|
34771
34804
|
tags: [],
|
|
34805
|
+
'x-draft': 'Early access.',
|
|
34772
34806
|
'x-fern-ignore': true,
|
|
34773
34807
|
'x-response-key': 'spaces',
|
|
34774
34808
|
'x-title': 'List Spaces',
|
|
@@ -34805,6 +34839,7 @@ export default {
|
|
|
34805
34839
|
],
|
|
34806
34840
|
summary: '/spaces/list',
|
|
34807
34841
|
tags: [],
|
|
34842
|
+
'x-draft': 'Early access.',
|
|
34808
34843
|
'x-fern-sdk-group-name': ['spaces'],
|
|
34809
34844
|
'x-fern-sdk-method-name': 'list',
|
|
34810
34845
|
'x-fern-sdk-return-value': 'spaces',
|
|
@@ -34856,6 +34891,7 @@ export default {
|
|
|
34856
34891
|
],
|
|
34857
34892
|
summary: '/spaces/remove_acs_entrances',
|
|
34858
34893
|
tags: [],
|
|
34894
|
+
'x-draft': 'Early access.',
|
|
34859
34895
|
'x-fern-sdk-group-name': ['spaces'],
|
|
34860
34896
|
'x-fern-sdk-method-name': 'remove_acs_entrances',
|
|
34861
34897
|
'x-response-key': null,
|
|
@@ -34906,6 +34942,7 @@ export default {
|
|
|
34906
34942
|
],
|
|
34907
34943
|
summary: '/spaces/remove_devices',
|
|
34908
34944
|
tags: [],
|
|
34945
|
+
'x-draft': 'Early access.',
|
|
34909
34946
|
'x-fern-sdk-group-name': ['spaces'],
|
|
34910
34947
|
'x-fern-sdk-method-name': 'remove_devices',
|
|
34911
34948
|
'x-response-key': null,
|
|
@@ -34956,6 +34993,7 @@ export default {
|
|
|
34956
34993
|
],
|
|
34957
34994
|
summary: '/spaces/update',
|
|
34958
34995
|
tags: [],
|
|
34996
|
+
'x-draft': 'Early access.',
|
|
34959
34997
|
'x-fern-ignore': true,
|
|
34960
34998
|
'x-response-key': 'space',
|
|
34961
34999
|
'x-title': 'Update Space',
|
|
@@ -35003,6 +35041,7 @@ export default {
|
|
|
35003
35041
|
],
|
|
35004
35042
|
summary: '/spaces/update',
|
|
35005
35043
|
tags: [],
|
|
35044
|
+
'x-draft': 'Early access.',
|
|
35006
35045
|
'x-fern-sdk-group-name': ['spaces'],
|
|
35007
35046
|
'x-fern-sdk-method-name': 'update',
|
|
35008
35047
|
'x-fern-sdk-return-value': 'space',
|
|
@@ -39654,14 +39693,29 @@ export default {
|
|
|
39654
39693
|
enum: ['organize_spaces'],
|
|
39655
39694
|
type: 'string',
|
|
39656
39695
|
},
|
|
39657
|
-
collection_key: { type: 'string' },
|
|
39658
39696
|
customer_key: { type: 'string' },
|
|
39697
|
+
partner_resources: {
|
|
39698
|
+
description:
|
|
39699
|
+
'Optional list of partner resources to include in the magic link.',
|
|
39700
|
+
items: {
|
|
39701
|
+
properties: {
|
|
39702
|
+
custom_metadata: {
|
|
39703
|
+
additionalProperties: { type: 'string' },
|
|
39704
|
+
type: 'object',
|
|
39705
|
+
},
|
|
39706
|
+
description: { type: 'string' },
|
|
39707
|
+
name: { type: 'string' },
|
|
39708
|
+
partner_resource_key: { type: 'string' },
|
|
39709
|
+
},
|
|
39710
|
+
required: ['partner_resource_key', 'name'],
|
|
39711
|
+
type: 'object',
|
|
39712
|
+
'x-route-path': '/unstable_partner/resources',
|
|
39713
|
+
'x-undocumented': 'Unreleased.',
|
|
39714
|
+
},
|
|
39715
|
+
type: 'array',
|
|
39716
|
+
},
|
|
39659
39717
|
},
|
|
39660
|
-
required: [
|
|
39661
|
-
'building_block_type',
|
|
39662
|
-
'customer_key',
|
|
39663
|
-
'collection_key',
|
|
39664
|
-
],
|
|
39718
|
+
required: ['building_block_type', 'customer_key'],
|
|
39665
39719
|
type: 'object',
|
|
39666
39720
|
},
|
|
39667
39721
|
],
|
|
@@ -39780,11 +39834,10 @@ export default {
|
|
|
39780
39834
|
'x-route-path': '/unstable_partner/resources',
|
|
39781
39835
|
'x-undocumented': 'Unreleased.',
|
|
39782
39836
|
},
|
|
39783
|
-
minItems: 1,
|
|
39784
39837
|
type: 'array',
|
|
39785
39838
|
},
|
|
39786
39839
|
},
|
|
39787
|
-
required: ['customer_key'
|
|
39840
|
+
required: ['customer_key'],
|
|
39788
39841
|
type: 'object',
|
|
39789
39842
|
},
|
|
39790
39843
|
},
|
|
@@ -22096,6 +22096,10 @@ export interface Routes {
|
|
|
22096
22096
|
automatically_manage_new_devices?: boolean
|
|
22097
22097
|
/** Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews). */
|
|
22098
22098
|
wait_for_device_creation?: boolean
|
|
22099
|
+
/** List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. If not provided, defaults will be determined based on the accepted providers. */
|
|
22100
|
+
accepted_capabilities?:
|
|
22101
|
+
| Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>
|
|
22102
|
+
| undefined
|
|
22099
22103
|
}
|
|
22100
22104
|
commonParams: {}
|
|
22101
22105
|
formData: {}
|
|
@@ -22125,6 +22129,10 @@ export interface Routes {
|
|
|
22125
22129
|
device_selection_mode: 'none' | 'single' | 'multiple'
|
|
22126
22130
|
/** List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
|
|
22127
22131
|
accepted_providers: string[]
|
|
22132
|
+
/** List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. */
|
|
22133
|
+
accepted_capabilities: Array<
|
|
22134
|
+
'lock' | 'thermostat' | 'noise_sensor' | 'access_control'
|
|
22135
|
+
>
|
|
22128
22136
|
/**
|
|
22129
22137
|
* @deprecated Unused. Will be removed. */
|
|
22130
22138
|
accepted_devices: string[]
|
|
@@ -22202,6 +22210,10 @@ export interface Routes {
|
|
|
22202
22210
|
device_selection_mode: 'none' | 'single' | 'multiple'
|
|
22203
22211
|
/** List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
|
|
22204
22212
|
accepted_providers: string[]
|
|
22213
|
+
/** List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. */
|
|
22214
|
+
accepted_capabilities: Array<
|
|
22215
|
+
'lock' | 'thermostat' | 'noise_sensor' | 'access_control'
|
|
22216
|
+
>
|
|
22205
22217
|
/**
|
|
22206
22218
|
* @deprecated Unused. Will be removed. */
|
|
22207
22219
|
accepted_devices: string[]
|
|
@@ -22261,6 +22273,10 @@ export interface Routes {
|
|
|
22261
22273
|
device_selection_mode: 'none' | 'single' | 'multiple'
|
|
22262
22274
|
/** List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
|
|
22263
22275
|
accepted_providers: string[]
|
|
22276
|
+
/** List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. */
|
|
22277
|
+
accepted_capabilities: Array<
|
|
22278
|
+
'lock' | 'thermostat' | 'noise_sensor' | 'access_control'
|
|
22279
|
+
>
|
|
22264
22280
|
/**
|
|
22265
22281
|
* @deprecated Unused. Will be removed. */
|
|
22266
22282
|
accepted_devices: string[]
|
|
@@ -66778,7 +66794,15 @@ export interface Routes {
|
|
|
66778
66794
|
| {
|
|
66779
66795
|
building_block_type: 'organize_spaces'
|
|
66780
66796
|
customer_key: string
|
|
66781
|
-
|
|
66797
|
+
/** Optional list of partner resources to include in the magic link. */
|
|
66798
|
+
partner_resources?:
|
|
66799
|
+
| Array<{
|
|
66800
|
+
partner_resource_key: string
|
|
66801
|
+
name: string
|
|
66802
|
+
description?: string | undefined
|
|
66803
|
+
custom_metadata?: Record<string, string> | undefined
|
|
66804
|
+
}>
|
|
66805
|
+
| undefined
|
|
66782
66806
|
}
|
|
66783
66807
|
formData: {}
|
|
66784
66808
|
jsonResponse: {
|
|
@@ -66827,12 +66851,14 @@ export interface Routes {
|
|
|
66827
66851
|
jsonBody: {}
|
|
66828
66852
|
commonParams: {
|
|
66829
66853
|
customer_key: string
|
|
66830
|
-
partner_resources
|
|
66831
|
-
|
|
66832
|
-
|
|
66833
|
-
|
|
66834
|
-
|
|
66835
|
-
|
|
66854
|
+
partner_resources?:
|
|
66855
|
+
| Array<{
|
|
66856
|
+
partner_resource_key: string
|
|
66857
|
+
name: string
|
|
66858
|
+
description?: string | undefined
|
|
66859
|
+
custom_metadata?: Record<string, string> | undefined
|
|
66860
|
+
}>
|
|
66861
|
+
| undefined
|
|
66836
66862
|
}
|
|
66837
66863
|
formData: {}
|
|
66838
66864
|
jsonResponse: {
|