@seamapi/types 1.734.0 → 1.736.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 +76 -35
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +81 -57
- package/dist/index.cjs +76 -35
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +10 -10
- package/lib/seam/connect/models/connect-webviews/connect-webview.d.ts +3 -3
- package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +3 -3
- package/lib/seam/connect/models/devices/device-provider.d.ts +5 -3
- package/lib/seam/connect/models/devices/device-provider.js +10 -1
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/provider-capability.d.ts +1 -1
- package/lib/seam/connect/models/provider-capability.js +1 -0
- package/lib/seam/connect/models/provider-capability.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +35 -18
- package/lib/seam/connect/openapi.js +60 -22
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +26 -20
- package/package.json +1 -1
- package/src/lib/seam/connect/models/devices/device-provider.ts +11 -1
- package/src/lib/seam/connect/models/provider-capability.ts +1 -0
- package/src/lib/seam/connect/openapi.ts +62 -22
- package/src/lib/seam/connect/route-types.ts +44 -6
package/dist/connect.d.cts
CHANGED
|
@@ -15879,7 +15879,7 @@ declare const batch: z.ZodObject<{
|
|
|
15879
15879
|
custom_metadata: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
|
|
15880
15880
|
automatically_manage_new_devices: z.ZodBoolean;
|
|
15881
15881
|
customer_key: z.ZodOptional<z.ZodString>;
|
|
15882
|
-
accepted_capabilities: z.ZodArray<z.ZodEnum<["lock", "thermostat", "noise_sensor", "access_control"]>, "many">;
|
|
15882
|
+
accepted_capabilities: z.ZodArray<z.ZodEnum<["lock", "thermostat", "noise_sensor", "access_control", "camera"]>, "many">;
|
|
15883
15883
|
}, "strip", z.ZodTypeAny, {
|
|
15884
15884
|
display_name: string;
|
|
15885
15885
|
errors: ({
|
|
@@ -15942,7 +15942,7 @@ declare const batch: z.ZodObject<{
|
|
|
15942
15942
|
})[];
|
|
15943
15943
|
custom_metadata: Record<string, string | boolean>;
|
|
15944
15944
|
automatically_manage_new_devices: boolean;
|
|
15945
|
-
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control")[];
|
|
15945
|
+
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control" | "camera")[];
|
|
15946
15946
|
created_at?: string | undefined;
|
|
15947
15947
|
user_identifier?: {
|
|
15948
15948
|
phone?: string | undefined;
|
|
@@ -16016,7 +16016,7 @@ declare const batch: z.ZodObject<{
|
|
|
16016
16016
|
})[];
|
|
16017
16017
|
custom_metadata: Record<string, string | boolean>;
|
|
16018
16018
|
automatically_manage_new_devices: boolean;
|
|
16019
|
-
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control")[];
|
|
16019
|
+
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control" | "camera")[];
|
|
16020
16020
|
created_at?: string | undefined;
|
|
16021
16021
|
user_identifier?: {
|
|
16022
16022
|
phone?: string | undefined;
|
|
@@ -26429,7 +26429,7 @@ declare const batch: z.ZodObject<{
|
|
|
26429
26429
|
url: z.ZodString;
|
|
26430
26430
|
device_selection_mode: z.ZodEnum<["none", "single", "multiple"]>;
|
|
26431
26431
|
accepted_providers: z.ZodArray<z.ZodString, "many">;
|
|
26432
|
-
accepted_capabilities: z.ZodArray<z.ZodEnum<["lock", "thermostat", "noise_sensor", "access_control"]>, "many">;
|
|
26432
|
+
accepted_capabilities: z.ZodArray<z.ZodEnum<["lock", "thermostat", "noise_sensor", "access_control", "camera"]>, "many">;
|
|
26433
26433
|
accepted_devices: z.ZodArray<z.ZodString, "many">;
|
|
26434
26434
|
any_device_allowed: z.ZodBoolean;
|
|
26435
26435
|
any_provider_allowed: z.ZodBoolean;
|
|
@@ -26450,7 +26450,7 @@ declare const batch: z.ZodObject<{
|
|
|
26450
26450
|
connected_account_id: string | null;
|
|
26451
26451
|
custom_metadata: Record<string, string | boolean>;
|
|
26452
26452
|
automatically_manage_new_devices: boolean;
|
|
26453
|
-
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control")[];
|
|
26453
|
+
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control" | "camera")[];
|
|
26454
26454
|
connect_webview_id: string;
|
|
26455
26455
|
url: string;
|
|
26456
26456
|
device_selection_mode: "none" | "single" | "multiple";
|
|
@@ -26472,7 +26472,7 @@ declare const batch: z.ZodObject<{
|
|
|
26472
26472
|
connected_account_id: string | null;
|
|
26473
26473
|
custom_metadata: Record<string, string | boolean>;
|
|
26474
26474
|
automatically_manage_new_devices: boolean;
|
|
26475
|
-
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control")[];
|
|
26475
|
+
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control" | "camera")[];
|
|
26476
26476
|
connect_webview_id: string;
|
|
26477
26477
|
url: string;
|
|
26478
26478
|
device_selection_mode: "none" | "single" | "multiple";
|
|
@@ -36039,7 +36039,7 @@ declare const batch: z.ZodObject<{
|
|
|
36039
36039
|
})[];
|
|
36040
36040
|
custom_metadata: Record<string, string | boolean>;
|
|
36041
36041
|
automatically_manage_new_devices: boolean;
|
|
36042
|
-
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control")[];
|
|
36042
|
+
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control" | "camera")[];
|
|
36043
36043
|
created_at?: string | undefined;
|
|
36044
36044
|
user_identifier?: {
|
|
36045
36045
|
phone?: string | undefined;
|
|
@@ -37669,7 +37669,7 @@ declare const batch: z.ZodObject<{
|
|
|
37669
37669
|
connected_account_id: string | null;
|
|
37670
37670
|
custom_metadata: Record<string, string | boolean>;
|
|
37671
37671
|
automatically_manage_new_devices: boolean;
|
|
37672
|
-
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control")[];
|
|
37672
|
+
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control" | "camera")[];
|
|
37673
37673
|
connect_webview_id: string;
|
|
37674
37674
|
url: string;
|
|
37675
37675
|
device_selection_mode: "none" | "single" | "multiple";
|
|
@@ -40674,7 +40674,7 @@ declare const batch: z.ZodObject<{
|
|
|
40674
40674
|
})[];
|
|
40675
40675
|
custom_metadata: Record<string, string | boolean>;
|
|
40676
40676
|
automatically_manage_new_devices: boolean;
|
|
40677
|
-
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control")[];
|
|
40677
|
+
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control" | "camera")[];
|
|
40678
40678
|
created_at?: string | undefined;
|
|
40679
40679
|
user_identifier?: {
|
|
40680
40680
|
phone?: string | undefined;
|
|
@@ -42304,7 +42304,7 @@ declare const batch: z.ZodObject<{
|
|
|
42304
42304
|
connected_account_id: string | null;
|
|
42305
42305
|
custom_metadata: Record<string, string | boolean>;
|
|
42306
42306
|
automatically_manage_new_devices: boolean;
|
|
42307
|
-
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control")[];
|
|
42307
|
+
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control" | "camera")[];
|
|
42308
42308
|
connect_webview_id: string;
|
|
42309
42309
|
url: string;
|
|
42310
42310
|
device_selection_mode: "none" | "single" | "multiple";
|
|
@@ -44647,7 +44647,7 @@ declare const connect_webview: z.ZodObject<{
|
|
|
44647
44647
|
url: z.ZodString;
|
|
44648
44648
|
device_selection_mode: z.ZodEnum<["none", "single", "multiple"]>;
|
|
44649
44649
|
accepted_providers: z.ZodArray<z.ZodString, "many">;
|
|
44650
|
-
accepted_capabilities: z.ZodArray<z.ZodEnum<["lock", "thermostat", "noise_sensor", "access_control"]>, "many">;
|
|
44650
|
+
accepted_capabilities: z.ZodArray<z.ZodEnum<["lock", "thermostat", "noise_sensor", "access_control", "camera"]>, "many">;
|
|
44651
44651
|
accepted_devices: z.ZodArray<z.ZodString, "many">;
|
|
44652
44652
|
any_device_allowed: z.ZodBoolean;
|
|
44653
44653
|
any_provider_allowed: z.ZodBoolean;
|
|
@@ -44668,7 +44668,7 @@ declare const connect_webview: z.ZodObject<{
|
|
|
44668
44668
|
connected_account_id: string | null;
|
|
44669
44669
|
custom_metadata: Record<string, string | boolean>;
|
|
44670
44670
|
automatically_manage_new_devices: boolean;
|
|
44671
|
-
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control")[];
|
|
44671
|
+
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control" | "camera")[];
|
|
44672
44672
|
connect_webview_id: string;
|
|
44673
44673
|
url: string;
|
|
44674
44674
|
device_selection_mode: "none" | "single" | "multiple";
|
|
@@ -44690,7 +44690,7 @@ declare const connect_webview: z.ZodObject<{
|
|
|
44690
44690
|
connected_account_id: string | null;
|
|
44691
44691
|
custom_metadata: Record<string, string | boolean>;
|
|
44692
44692
|
automatically_manage_new_devices: boolean;
|
|
44693
|
-
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control")[];
|
|
44693
|
+
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control" | "camera")[];
|
|
44694
44694
|
connect_webview_id: string;
|
|
44695
44695
|
url: string;
|
|
44696
44696
|
device_selection_mode: "none" | "single" | "multiple";
|
|
@@ -45179,7 +45179,7 @@ declare const connected_account: z.ZodObject<{
|
|
|
45179
45179
|
custom_metadata: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
|
|
45180
45180
|
automatically_manage_new_devices: z.ZodBoolean;
|
|
45181
45181
|
customer_key: z.ZodOptional<z.ZodString>;
|
|
45182
|
-
accepted_capabilities: z.ZodArray<z.ZodEnum<["lock", "thermostat", "noise_sensor", "access_control"]>, "many">;
|
|
45182
|
+
accepted_capabilities: z.ZodArray<z.ZodEnum<["lock", "thermostat", "noise_sensor", "access_control", "camera"]>, "many">;
|
|
45183
45183
|
}, "strip", z.ZodTypeAny, {
|
|
45184
45184
|
display_name: string;
|
|
45185
45185
|
errors: ({
|
|
@@ -45242,7 +45242,7 @@ declare const connected_account: z.ZodObject<{
|
|
|
45242
45242
|
})[];
|
|
45243
45243
|
custom_metadata: Record<string, string | boolean>;
|
|
45244
45244
|
automatically_manage_new_devices: boolean;
|
|
45245
|
-
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control")[];
|
|
45245
|
+
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control" | "camera")[];
|
|
45246
45246
|
created_at?: string | undefined;
|
|
45247
45247
|
user_identifier?: {
|
|
45248
45248
|
phone?: string | undefined;
|
|
@@ -45316,7 +45316,7 @@ declare const connected_account: z.ZodObject<{
|
|
|
45316
45316
|
})[];
|
|
45317
45317
|
custom_metadata: Record<string, string | boolean>;
|
|
45318
45318
|
automatically_manage_new_devices: boolean;
|
|
45319
|
-
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control")[];
|
|
45319
|
+
accepted_capabilities: ("lock" | "thermostat" | "noise_sensor" | "access_control" | "camera")[];
|
|
45320
45320
|
created_at?: string | undefined;
|
|
45321
45321
|
user_identifier?: {
|
|
45322
45322
|
phone?: string | undefined;
|
|
@@ -50479,13 +50479,14 @@ declare const DEVICE_PROVIDERS: {
|
|
|
50479
50479
|
readonly KORELOCK: "korelock";
|
|
50480
50480
|
readonly DORMAKABA_AMBIANCE: "dormakaba_ambiance";
|
|
50481
50481
|
readonly ULTRALOQ: "ultraloq";
|
|
50482
|
+
readonly RING: "ring";
|
|
50482
50483
|
};
|
|
50483
50484
|
type DeviceProviderName = (typeof DEVICE_PROVIDERS)[keyof typeof DEVICE_PROVIDERS];
|
|
50484
50485
|
declare const device_provider: z.ZodObject<{
|
|
50485
50486
|
device_provider_name: z.ZodEnum<[DeviceProviderName, ...DeviceProviderName[]]>;
|
|
50486
50487
|
display_name: z.ZodString;
|
|
50487
50488
|
image_url: z.ZodString;
|
|
50488
|
-
provider_categories: z.ZodArray<z.ZodEnum<["stable" | "consumer_smartlocks" | "beta" | "thermostats" | "noise_sensors" | "access_control_systems" | "internal_beta", ...("stable" | "consumer_smartlocks" | "beta" | "thermostats" | "noise_sensors" | "access_control_systems" | "internal_beta")[]]>, "many">;
|
|
50489
|
+
provider_categories: z.ZodArray<z.ZodEnum<["stable" | "consumer_smartlocks" | "beta" | "thermostats" | "noise_sensors" | "access_control_systems" | "cameras" | "internal_beta", ...("stable" | "consumer_smartlocks" | "beta" | "thermostats" | "noise_sensors" | "access_control_systems" | "cameras" | "internal_beta")[]]>, "many">;
|
|
50489
50490
|
} & {
|
|
50490
50491
|
can_remotely_unlock: z.ZodOptional<z.ZodBoolean>;
|
|
50491
50492
|
can_remotely_lock: z.ZodOptional<z.ZodBoolean>;
|
|
@@ -50510,7 +50511,7 @@ declare const device_provider: z.ZodObject<{
|
|
|
50510
50511
|
display_name: string;
|
|
50511
50512
|
image_url: string;
|
|
50512
50513
|
device_provider_name: DeviceProviderName;
|
|
50513
|
-
provider_categories: ("stable" | "consumer_smartlocks" | "beta" | "thermostats" | "noise_sensors" | "access_control_systems" | "internal_beta")[];
|
|
50514
|
+
provider_categories: ("stable" | "consumer_smartlocks" | "beta" | "thermostats" | "noise_sensors" | "access_control_systems" | "cameras" | "internal_beta")[];
|
|
50514
50515
|
can_remotely_unlock?: boolean | undefined;
|
|
50515
50516
|
can_remotely_lock?: boolean | undefined;
|
|
50516
50517
|
can_program_offline_access_codes?: boolean | undefined;
|
|
@@ -50534,7 +50535,7 @@ declare const device_provider: z.ZodObject<{
|
|
|
50534
50535
|
display_name: string;
|
|
50535
50536
|
image_url: string;
|
|
50536
50537
|
device_provider_name: DeviceProviderName;
|
|
50537
|
-
provider_categories: ("stable" | "consumer_smartlocks" | "beta" | "thermostats" | "noise_sensors" | "access_control_systems" | "internal_beta")[];
|
|
50538
|
+
provider_categories: ("stable" | "consumer_smartlocks" | "beta" | "thermostats" | "noise_sensors" | "access_control_systems" | "cameras" | "internal_beta")[];
|
|
50538
50539
|
can_remotely_unlock?: boolean | undefined;
|
|
50539
50540
|
can_remotely_lock?: boolean | undefined;
|
|
50540
50541
|
can_program_offline_access_codes?: boolean | undefined;
|
|
@@ -84588,16 +84589,6 @@ declare const _default: {
|
|
|
84588
84589
|
delete: {
|
|
84589
84590
|
description: string;
|
|
84590
84591
|
operationId: string;
|
|
84591
|
-
parameters: {
|
|
84592
|
-
in: string;
|
|
84593
|
-
name: string;
|
|
84594
|
-
required: boolean;
|
|
84595
|
-
schema: {
|
|
84596
|
-
description: string;
|
|
84597
|
-
format: string;
|
|
84598
|
-
type: string;
|
|
84599
|
-
};
|
|
84600
|
-
}[];
|
|
84601
84592
|
responses: {
|
|
84602
84593
|
200: {
|
|
84603
84594
|
content: {
|
|
@@ -84658,15 +84649,42 @@ declare const _default: {
|
|
|
84658
84649
|
content: {
|
|
84659
84650
|
'application/json': {
|
|
84660
84651
|
schema: {
|
|
84661
|
-
|
|
84662
|
-
|
|
84663
|
-
|
|
84664
|
-
|
|
84665
|
-
|
|
84652
|
+
oneOf: ({
|
|
84653
|
+
properties: {
|
|
84654
|
+
access_method_id: {
|
|
84655
|
+
description: string;
|
|
84656
|
+
format: string;
|
|
84657
|
+
type: string;
|
|
84658
|
+
};
|
|
84659
|
+
access_grant_id?: never;
|
|
84660
|
+
reservation_key?: never;
|
|
84666
84661
|
};
|
|
84667
|
-
|
|
84668
|
-
|
|
84669
|
-
|
|
84662
|
+
required: string[];
|
|
84663
|
+
type: string;
|
|
84664
|
+
} | {
|
|
84665
|
+
properties: {
|
|
84666
|
+
access_grant_id: {
|
|
84667
|
+
description: string;
|
|
84668
|
+
format: string;
|
|
84669
|
+
type: string;
|
|
84670
|
+
};
|
|
84671
|
+
access_method_id?: never;
|
|
84672
|
+
reservation_key?: never;
|
|
84673
|
+
};
|
|
84674
|
+
required: string[];
|
|
84675
|
+
type: string;
|
|
84676
|
+
} | {
|
|
84677
|
+
properties: {
|
|
84678
|
+
reservation_key: {
|
|
84679
|
+
description: string;
|
|
84680
|
+
type: string;
|
|
84681
|
+
};
|
|
84682
|
+
access_method_id?: never;
|
|
84683
|
+
access_grant_id?: never;
|
|
84684
|
+
};
|
|
84685
|
+
required: string[];
|
|
84686
|
+
type: string;
|
|
84687
|
+
})[];
|
|
84670
84688
|
};
|
|
84671
84689
|
};
|
|
84672
84690
|
};
|
|
@@ -139864,7 +139882,7 @@ type Routes = {
|
|
|
139864
139882
|
/** Your unique key for the customer associated with this connected account. */
|
|
139865
139883
|
customer_key?: string | undefined;
|
|
139866
139884
|
/** List of capabilities that were accepted during the account connection process. */
|
|
139867
|
-
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
|
|
139885
|
+
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
|
|
139868
139886
|
}[] | undefined;
|
|
139869
139887
|
acs_systems?: {
|
|
139870
139888
|
/** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
@@ -140940,8 +140958,14 @@ type Routes = {
|
|
|
140940
140958
|
queryParams: {};
|
|
140941
140959
|
jsonBody: {};
|
|
140942
140960
|
commonParams: {
|
|
140943
|
-
/** ID of access method to
|
|
140961
|
+
/** ID of access method to delete. */
|
|
140944
140962
|
access_method_id: string;
|
|
140963
|
+
} | {
|
|
140964
|
+
/** ID of access grant whose access methods should be deleted. */
|
|
140965
|
+
access_grant_id: string;
|
|
140966
|
+
} | {
|
|
140967
|
+
/** Reservation key of the access grant whose access methods should be deleted. */
|
|
140968
|
+
reservation_key: string;
|
|
140945
140969
|
};
|
|
140946
140970
|
formData: {};
|
|
140947
140971
|
jsonResponse: {};
|
|
@@ -155088,9 +155112,9 @@ type Routes = {
|
|
|
155088
155112
|
/** Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error. */
|
|
155089
155113
|
customer_key?: string | undefined;
|
|
155090
155114
|
/** 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. */
|
|
155091
|
-
accepted_providers?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'dormakaba_ambiance' | 'ultraloq' | 'yale_access' | 'hid_cm' | 'google_nest')[] | undefined;
|
|
155115
|
+
accepted_providers?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'dormakaba_ambiance' | 'ultraloq' | 'ring' | 'yale_access' | 'hid_cm' | 'google_nest')[] | undefined;
|
|
155092
155116
|
/** Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with the desired `provider_category` filter. */
|
|
155093
|
-
provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'internal_beta') | undefined;
|
|
155117
|
+
provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'internal_beta') | undefined;
|
|
155094
155118
|
/** Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/latest/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). */
|
|
155095
155119
|
custom_metadata?: {
|
|
155096
155120
|
[x: string]: string | boolean | null;
|
|
@@ -155100,7 +155124,7 @@ type Routes = {
|
|
|
155100
155124
|
/** 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). */
|
|
155101
155125
|
wait_for_device_creation?: boolean;
|
|
155102
155126
|
/** 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. */
|
|
155103
|
-
accepted_capabilities?: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[] | undefined;
|
|
155127
|
+
accepted_capabilities?: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[] | undefined;
|
|
155104
155128
|
/** List of provider keys to exclude from the Connect Webview. These providers will not be shown when the user tries to connect an account. */
|
|
155105
155129
|
excluded_providers?: string[] | undefined;
|
|
155106
155130
|
};
|
|
@@ -155133,7 +155157,7 @@ type Routes = {
|
|
|
155133
155157
|
/** 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). */
|
|
155134
155158
|
accepted_providers: string[];
|
|
155135
155159
|
/** High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`. */
|
|
155136
|
-
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
|
|
155160
|
+
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
|
|
155137
155161
|
/**
|
|
155138
155162
|
* @deprecated Unused. Will be removed.*/
|
|
155139
155163
|
accepted_devices: string[];
|
|
@@ -155218,7 +155242,7 @@ type Routes = {
|
|
|
155218
155242
|
/** 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). */
|
|
155219
155243
|
accepted_providers: string[];
|
|
155220
155244
|
/** High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`. */
|
|
155221
|
-
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
|
|
155245
|
+
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
|
|
155222
155246
|
/**
|
|
155223
155247
|
* @deprecated Unused. Will be removed.*/
|
|
155224
155248
|
accepted_devices: string[];
|
|
@@ -155291,7 +155315,7 @@ type Routes = {
|
|
|
155291
155315
|
/** 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). */
|
|
155292
155316
|
accepted_providers: string[];
|
|
155293
155317
|
/** High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`. */
|
|
155294
|
-
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
|
|
155318
|
+
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
|
|
155295
155319
|
/**
|
|
155296
155320
|
* @deprecated Unused. Will be removed.*/
|
|
155297
155321
|
accepted_devices: string[];
|
|
@@ -155501,7 +155525,7 @@ type Routes = {
|
|
|
155501
155525
|
/** Your unique key for the customer associated with this connected account. */
|
|
155502
155526
|
customer_key?: string | undefined;
|
|
155503
155527
|
/** List of capabilities that were accepted during the account connection process. */
|
|
155504
|
-
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
|
|
155528
|
+
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
|
|
155505
155529
|
};
|
|
155506
155530
|
};
|
|
155507
155531
|
maxDuration: undefined;
|
|
@@ -155665,7 +155689,7 @@ type Routes = {
|
|
|
155665
155689
|
/** Your unique key for the customer associated with this connected account. */
|
|
155666
155690
|
customer_key?: string | undefined;
|
|
155667
155691
|
/** List of capabilities that were accepted during the account connection process. */
|
|
155668
|
-
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
|
|
155692
|
+
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
|
|
155669
155693
|
}[];
|
|
155670
155694
|
/** Information about the current page of results. */
|
|
155671
155695
|
pagination: {
|
|
@@ -155719,7 +155743,7 @@ type Routes = {
|
|
|
155719
155743
|
[x: string]: string | boolean | null;
|
|
155720
155744
|
} | undefined;
|
|
155721
155745
|
/** List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are `lock`, `thermostat`, `noise_sensor`, and `access_control`. */
|
|
155722
|
-
accepted_capabilities?: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[] | undefined;
|
|
155746
|
+
accepted_capabilities?: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[] | undefined;
|
|
155723
155747
|
/** The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer. */
|
|
155724
155748
|
customer_key?: string | undefined;
|
|
155725
155749
|
};
|
|
@@ -155863,7 +155887,7 @@ type Routes = {
|
|
|
155863
155887
|
/** Your unique key for the customer associated with this connected account. */
|
|
155864
155888
|
customer_key?: string | undefined;
|
|
155865
155889
|
/** List of capabilities that were accepted during the account connection process. */
|
|
155866
|
-
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
|
|
155890
|
+
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
|
|
155867
155891
|
};
|
|
155868
155892
|
};
|
|
155869
155893
|
maxDuration: undefined;
|
|
@@ -158023,7 +158047,7 @@ type Routes = {
|
|
|
158023
158047
|
/** Array of device types for which you want to list devices. */
|
|
158024
158048
|
device_types?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'korelock_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | 'ring_camera')[] | undefined;
|
|
158025
158049
|
/** Manufacturer for which you want to list devices. */
|
|
158026
|
-
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'korelock' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq') | undefined;
|
|
158050
|
+
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'korelock' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring') | undefined;
|
|
158027
158051
|
/** Array of device IDs for which you want to list devices. */
|
|
158028
158052
|
device_ids?: string[] | undefined;
|
|
158029
158053
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -159376,15 +159400,15 @@ type Routes = {
|
|
|
159376
159400
|
jsonBody: {};
|
|
159377
159401
|
commonParams: {
|
|
159378
159402
|
/** Category for which you want to list providers. */
|
|
159379
|
-
provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems') | undefined;
|
|
159403
|
+
provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras') | undefined;
|
|
159380
159404
|
};
|
|
159381
159405
|
formData: {};
|
|
159382
159406
|
jsonResponse: {
|
|
159383
159407
|
device_providers: {
|
|
159384
|
-
device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'dormakaba_ambiance' | 'ultraloq';
|
|
159408
|
+
device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'dormakaba_ambiance' | 'ultraloq' | 'ring';
|
|
159385
159409
|
display_name: string;
|
|
159386
159410
|
image_url: string;
|
|
159387
|
-
provider_categories: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems')[];
|
|
159411
|
+
provider_categories: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras')[];
|
|
159388
159412
|
can_remotely_unlock?: boolean | undefined;
|
|
159389
159413
|
can_remotely_lock?: boolean | undefined;
|
|
159390
159414
|
can_program_offline_access_codes?: boolean | undefined;
|
|
@@ -159965,7 +159989,7 @@ type Routes = {
|
|
|
159965
159989
|
/** Array of device types for which you want to list devices. */
|
|
159966
159990
|
device_types?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'korelock_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | 'ring_camera')[] | undefined;
|
|
159967
159991
|
/** Manufacturer for which you want to list devices. */
|
|
159968
|
-
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'korelock' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq') | undefined;
|
|
159992
|
+
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'korelock' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring') | undefined;
|
|
159969
159993
|
/** Array of device IDs for which you want to list devices. */
|
|
159970
159994
|
device_ids?: string[] | undefined;
|
|
159971
159995
|
/** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
|
|
@@ -191659,7 +191683,7 @@ type Routes = {
|
|
|
191659
191683
|
/** Your unique key for the customer associated with this connected account. */
|
|
191660
191684
|
customer_key?: string | undefined;
|
|
191661
191685
|
/** List of capabilities that were accepted during the account connection process. */
|
|
191662
|
-
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
|
|
191686
|
+
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
|
|
191663
191687
|
}[] | undefined;
|
|
191664
191688
|
acs_systems?: {
|
|
191665
191689
|
/** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
@@ -215975,7 +215999,7 @@ type Routes = {
|
|
|
215975
215999
|
/** 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). */
|
|
215976
216000
|
accepted_providers: string[];
|
|
215977
216001
|
/** High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`. */
|
|
215978
|
-
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
|
|
216002
|
+
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
|
|
215979
216003
|
/**
|
|
215980
216004
|
* @deprecated Unused. Will be removed.*/
|
|
215981
216005
|
accepted_devices: string[];
|
|
@@ -216421,7 +216445,7 @@ type Routes = {
|
|
|
216421
216445
|
/** Your unique key for the customer associated with this connected account. */
|
|
216422
216446
|
customer_key?: string | undefined;
|
|
216423
216447
|
/** List of capabilities that were accepted during the account connection process. */
|
|
216424
|
-
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
|
|
216448
|
+
accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
|
|
216425
216449
|
}[] | undefined;
|
|
216426
216450
|
events?: ({
|
|
216427
216451
|
/** ID of the event. */
|