@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.
@@ -12055,7 +12055,7 @@ export type Routes = {
12055
12055
  /** Your unique key for the customer associated with this connected account. */
12056
12056
  customer_key?: string | undefined;
12057
12057
  /** List of capabilities that were accepted during the account connection process. */
12058
- accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
12058
+ accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
12059
12059
  }[] | undefined;
12060
12060
  acs_systems?: {
12061
12061
  /** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
@@ -13131,8 +13131,14 @@ export type Routes = {
13131
13131
  queryParams: {};
13132
13132
  jsonBody: {};
13133
13133
  commonParams: {
13134
- /** ID of access method to get. */
13134
+ /** ID of access method to delete. */
13135
13135
  access_method_id: string;
13136
+ } | {
13137
+ /** ID of access grant whose access methods should be deleted. */
13138
+ access_grant_id: string;
13139
+ } | {
13140
+ /** Reservation key of the access grant whose access methods should be deleted. */
13141
+ reservation_key: string;
13136
13142
  };
13137
13143
  formData: {};
13138
13144
  jsonResponse: {};
@@ -27279,9 +27285,9 @@ export type Routes = {
27279
27285
  /** 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. */
27280
27286
  customer_key?: string | undefined;
27281
27287
  /** 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. */
27282
- 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;
27288
+ 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;
27283
27289
  /** 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. */
27284
- provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'internal_beta') | undefined;
27290
+ provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'internal_beta') | undefined;
27285
27291
  /** 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). */
27286
27292
  custom_metadata?: {
27287
27293
  [x: string]: string | boolean | null;
@@ -27291,7 +27297,7 @@ export type Routes = {
27291
27297
  /** 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). */
27292
27298
  wait_for_device_creation?: boolean;
27293
27299
  /** 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. */
27294
- accepted_capabilities?: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[] | undefined;
27300
+ accepted_capabilities?: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[] | undefined;
27295
27301
  /** List of provider keys to exclude from the Connect Webview. These providers will not be shown when the user tries to connect an account. */
27296
27302
  excluded_providers?: string[] | undefined;
27297
27303
  };
@@ -27324,7 +27330,7 @@ export type Routes = {
27324
27330
  /** 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). */
27325
27331
  accepted_providers: string[];
27326
27332
  /** 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`. */
27327
- accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
27333
+ accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
27328
27334
  /**
27329
27335
  * @deprecated Unused. Will be removed.*/
27330
27336
  accepted_devices: string[];
@@ -27409,7 +27415,7 @@ export type Routes = {
27409
27415
  /** 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). */
27410
27416
  accepted_providers: string[];
27411
27417
  /** 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`. */
27412
- accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
27418
+ accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
27413
27419
  /**
27414
27420
  * @deprecated Unused. Will be removed.*/
27415
27421
  accepted_devices: string[];
@@ -27482,7 +27488,7 @@ export type Routes = {
27482
27488
  /** 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). */
27483
27489
  accepted_providers: string[];
27484
27490
  /** 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`. */
27485
- accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
27491
+ accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
27486
27492
  /**
27487
27493
  * @deprecated Unused. Will be removed.*/
27488
27494
  accepted_devices: string[];
@@ -27692,7 +27698,7 @@ export type Routes = {
27692
27698
  /** Your unique key for the customer associated with this connected account. */
27693
27699
  customer_key?: string | undefined;
27694
27700
  /** List of capabilities that were accepted during the account connection process. */
27695
- accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
27701
+ accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
27696
27702
  };
27697
27703
  };
27698
27704
  maxDuration: undefined;
@@ -27856,7 +27862,7 @@ export type Routes = {
27856
27862
  /** Your unique key for the customer associated with this connected account. */
27857
27863
  customer_key?: string | undefined;
27858
27864
  /** List of capabilities that were accepted during the account connection process. */
27859
- accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
27865
+ accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
27860
27866
  }[];
27861
27867
  /** Information about the current page of results. */
27862
27868
  pagination: {
@@ -27910,7 +27916,7 @@ export type Routes = {
27910
27916
  [x: string]: string | boolean | null;
27911
27917
  } | undefined;
27912
27918
  /** 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`. */
27913
- accepted_capabilities?: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[] | undefined;
27919
+ accepted_capabilities?: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[] | undefined;
27914
27920
  /** 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. */
27915
27921
  customer_key?: string | undefined;
27916
27922
  };
@@ -28054,7 +28060,7 @@ export type Routes = {
28054
28060
  /** Your unique key for the customer associated with this connected account. */
28055
28061
  customer_key?: string | undefined;
28056
28062
  /** List of capabilities that were accepted during the account connection process. */
28057
- accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
28063
+ accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
28058
28064
  };
28059
28065
  };
28060
28066
  maxDuration: undefined;
@@ -30214,7 +30220,7 @@ export type Routes = {
30214
30220
  /** Array of device types for which you want to list devices. */
30215
30221
  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;
30216
30222
  /** Manufacturer for which you want to list devices. */
30217
- 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;
30223
+ 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;
30218
30224
  /** Array of device IDs for which you want to list devices. */
30219
30225
  device_ids?: string[] | undefined;
30220
30226
  /** Numerical limit on the number of devices to return. */
@@ -31567,15 +31573,15 @@ export type Routes = {
31567
31573
  jsonBody: {};
31568
31574
  commonParams: {
31569
31575
  /** Category for which you want to list providers. */
31570
- provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems') | undefined;
31576
+ provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras') | undefined;
31571
31577
  };
31572
31578
  formData: {};
31573
31579
  jsonResponse: {
31574
31580
  device_providers: {
31575
- 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';
31581
+ 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';
31576
31582
  display_name: string;
31577
31583
  image_url: string;
31578
- provider_categories: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems')[];
31584
+ provider_categories: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras')[];
31579
31585
  can_remotely_unlock?: boolean | undefined;
31580
31586
  can_remotely_lock?: boolean | undefined;
31581
31587
  can_program_offline_access_codes?: boolean | undefined;
@@ -32156,7 +32162,7 @@ export type Routes = {
32156
32162
  /** Array of device types for which you want to list devices. */
32157
32163
  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;
32158
32164
  /** Manufacturer for which you want to list devices. */
32159
- 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;
32165
+ 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;
32160
32166
  /** Array of device IDs for which you want to list devices. */
32161
32167
  device_ids?: string[] | undefined;
32162
32168
  /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
@@ -63850,7 +63856,7 @@ export type Routes = {
63850
63856
  /** Your unique key for the customer associated with this connected account. */
63851
63857
  customer_key?: string | undefined;
63852
63858
  /** List of capabilities that were accepted during the account connection process. */
63853
- accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
63859
+ accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
63854
63860
  }[] | undefined;
63855
63861
  acs_systems?: {
63856
63862
  /** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
@@ -88166,7 +88172,7 @@ export type Routes = {
88166
88172
  /** 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). */
88167
88173
  accepted_providers: string[];
88168
88174
  /** 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`. */
88169
- accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
88175
+ accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
88170
88176
  /**
88171
88177
  * @deprecated Unused. Will be removed.*/
88172
88178
  accepted_devices: string[];
@@ -88612,7 +88618,7 @@ export type Routes = {
88612
88618
  /** Your unique key for the customer associated with this connected account. */
88613
88619
  customer_key?: string | undefined;
88614
88620
  /** List of capabilities that were accepted during the account connection process. */
88615
- accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[];
88621
+ accepted_capabilities: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera')[];
88616
88622
  }[] | undefined;
88617
88623
  events?: ({
88618
88624
  /** ID of the event. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.734.0",
3
+ "version": "1.736.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -52,6 +52,7 @@ export const DEVICE_PROVIDERS = {
52
52
  KORELOCK: 'korelock',
53
53
  DORMAKABA_AMBIANCE: 'dormakaba_ambiance',
54
54
  ULTRALOQ: 'ultraloq',
55
+ RING: 'ring',
55
56
  } as const
56
57
 
57
58
  export type DeviceProviderName =
@@ -132,6 +133,8 @@ export const PROVIDER_CATEGORY_MAP = {
132
133
  'hotek',
133
134
  ],
134
135
 
136
+ cameras: ['ring'],
137
+
135
138
  internal_beta: ALL_DEVICE_PROVIDERS,
136
139
  } as const satisfies Record<string, readonly DeviceProviderName[]>
137
140
 
@@ -166,5 +169,12 @@ export const PROVIDER_CATEGORY_CAPABILITY_MAP: Record<
166
169
  thermostats: ['thermostat'],
167
170
  noise_sensors: ['noise_sensor'],
168
171
  access_control_systems: ['access_control'],
169
- internal_beta: ['lock', 'thermostat', 'noise_sensor', 'access_control'],
172
+ cameras: ['camera'],
173
+ internal_beta: [
174
+ 'lock',
175
+ 'thermostat',
176
+ 'noise_sensor',
177
+ 'access_control',
178
+ 'camera',
179
+ ],
170
180
  }
@@ -5,6 +5,7 @@ export const provider_capability = z.enum([
5
5
  'thermostat',
6
6
  'noise_sensor',
7
7
  'access_control',
8
+ 'camera',
8
9
  ]).describe(`
9
10
  High-level device capabilities that can be restricted in connect webviews.
10
11
  These represent the main device categories that customers can opt into.
@@ -9601,7 +9601,13 @@ export default {
9601
9601
  items: {
9602
9602
  description:
9603
9603
  '\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',
9604
- enum: ['lock', 'thermostat', 'noise_sensor', 'access_control'],
9604
+ enum: [
9605
+ 'lock',
9606
+ 'thermostat',
9607
+ 'noise_sensor',
9608
+ 'access_control',
9609
+ 'camera',
9610
+ ],
9605
9611
  type: 'string',
9606
9612
  },
9607
9613
  type: 'array',
@@ -9760,7 +9766,13 @@ export default {
9760
9766
  items: {
9761
9767
  description:
9762
9768
  '\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',
9763
- enum: ['lock', 'thermostat', 'noise_sensor', 'access_control'],
9769
+ enum: [
9770
+ 'lock',
9771
+ 'thermostat',
9772
+ 'noise_sensor',
9773
+ 'access_control',
9774
+ 'camera',
9775
+ ],
9764
9776
  type: 'string',
9765
9777
  },
9766
9778
  type: 'array',
@@ -14402,6 +14414,7 @@ export default {
14402
14414
  'korelock',
14403
14415
  'dormakaba_ambiance',
14404
14416
  'ultraloq',
14417
+ 'ring',
14405
14418
  ],
14406
14419
  type: 'string',
14407
14420
  },
@@ -14416,6 +14429,7 @@ export default {
14416
14429
  'thermostats',
14417
14430
  'noise_sensors',
14418
14431
  'access_control_systems',
14432
+ 'cameras',
14419
14433
  ],
14420
14434
  type: 'string',
14421
14435
  },
@@ -36568,18 +36582,6 @@ export default {
36568
36582
  delete: {
36569
36583
  description: 'Deletes an access method.',
36570
36584
  operationId: 'accessMethodsDeleteDelete',
36571
- parameters: [
36572
- {
36573
- in: 'query',
36574
- name: 'access_method_id',
36575
- required: true,
36576
- schema: {
36577
- description: 'ID of access method to get.',
36578
- format: 'uuid',
36579
- type: 'string',
36580
- },
36581
- },
36582
- ],
36583
36585
  responses: {
36584
36586
  200: {
36585
36587
  content: {
@@ -36617,15 +36619,42 @@ export default {
36617
36619
  content: {
36618
36620
  'application/json': {
36619
36621
  schema: {
36620
- properties: {
36621
- access_method_id: {
36622
- description: 'ID of access method to get.',
36623
- format: 'uuid',
36624
- type: 'string',
36622
+ oneOf: [
36623
+ {
36624
+ properties: {
36625
+ access_method_id: {
36626
+ description: 'ID of access method to delete.',
36627
+ format: 'uuid',
36628
+ type: 'string',
36629
+ },
36630
+ },
36631
+ required: ['access_method_id'],
36632
+ type: 'object',
36625
36633
  },
36626
- },
36627
- required: ['access_method_id'],
36628
- type: 'object',
36634
+ {
36635
+ properties: {
36636
+ access_grant_id: {
36637
+ description:
36638
+ 'ID of access grant whose access methods should be deleted.',
36639
+ format: 'uuid',
36640
+ type: 'string',
36641
+ },
36642
+ },
36643
+ required: ['access_grant_id'],
36644
+ type: 'object',
36645
+ },
36646
+ {
36647
+ properties: {
36648
+ reservation_key: {
36649
+ description:
36650
+ 'Reservation key of the access grant whose access methods should be deleted.',
36651
+ type: 'string',
36652
+ },
36653
+ },
36654
+ required: ['reservation_key'],
36655
+ type: 'object',
36656
+ },
36657
+ ],
36629
36658
  },
36630
36659
  },
36631
36660
  },
@@ -46676,6 +46705,7 @@ export default {
46676
46705
  'thermostat',
46677
46706
  'noise_sensor',
46678
46707
  'access_control',
46708
+ 'camera',
46679
46709
  ],
46680
46710
  type: 'string',
46681
46711
  },
@@ -46734,6 +46764,7 @@ export default {
46734
46764
  'korelock',
46735
46765
  'dormakaba_ambiance',
46736
46766
  'ultraloq',
46767
+ 'ring',
46737
46768
  'yale_access',
46738
46769
  'hid_cm',
46739
46770
  'google_nest',
@@ -46796,6 +46827,7 @@ export default {
46796
46827
  'thermostats',
46797
46828
  'noise_sensors',
46798
46829
  'access_control_systems',
46830
+ 'cameras',
46799
46831
  'internal_beta',
46800
46832
  ],
46801
46833
  type: 'string',
@@ -47811,6 +47843,7 @@ export default {
47811
47843
  'thermostat',
47812
47844
  'noise_sensor',
47813
47845
  'access_control',
47846
+ 'camera',
47814
47847
  ],
47815
47848
  type: 'string',
47816
47849
  },
@@ -47905,6 +47938,7 @@ export default {
47905
47938
  'thermostat',
47906
47939
  'noise_sensor',
47907
47940
  'access_control',
47941
+ 'camera',
47908
47942
  ],
47909
47943
  type: 'string',
47910
47944
  },
@@ -50993,6 +51027,7 @@ export default {
50993
51027
  'smartthings',
50994
51028
  'tado',
50995
51029
  'ultraloq',
51030
+ 'ring',
50996
51031
  ],
50997
51032
  type: 'string',
50998
51033
  },
@@ -51502,6 +51537,7 @@ export default {
51502
51537
  'smartthings',
51503
51538
  'tado',
51504
51539
  'ultraloq',
51540
+ 'ring',
51505
51541
  ],
51506
51542
  type: 'string',
51507
51543
  },
@@ -51598,6 +51634,7 @@ export default {
51598
51634
  'thermostats',
51599
51635
  'noise_sensors',
51600
51636
  'access_control_systems',
51637
+ 'cameras',
51601
51638
  ],
51602
51639
  type: 'string',
51603
51640
  },
@@ -51658,6 +51695,7 @@ export default {
51658
51695
  'thermostats',
51659
51696
  'noise_sensors',
51660
51697
  'access_control_systems',
51698
+ 'cameras',
51661
51699
  ],
51662
51700
  type: 'string',
51663
51701
  },
@@ -52883,6 +52921,7 @@ export default {
52883
52921
  'smartthings',
52884
52922
  'tado',
52885
52923
  'ultraloq',
52924
+ 'ring',
52886
52925
  ],
52887
52926
  type: 'string',
52888
52927
  },
@@ -53391,6 +53430,7 @@ export default {
53391
53430
  'smartthings',
53392
53431
  'tado',
53393
53432
  'ultraloq',
53433
+ 'ring',
53394
53434
  ],
53395
53435
  type: 'string',
53396
53436
  },
@@ -13800,6 +13800,7 @@ export type Routes = {
13800
13800
  | 'thermostat'
13801
13801
  | 'noise_sensor'
13802
13802
  | 'access_control'
13803
+ | 'camera'
13803
13804
  )[]
13804
13805
  }[]
13805
13806
  | undefined
@@ -15004,10 +15005,19 @@ export type Routes = {
15004
15005
  method: 'DELETE' | 'POST'
15005
15006
  queryParams: {}
15006
15007
  jsonBody: {}
15007
- commonParams: {
15008
- /** ID of access method to get. */
15009
- access_method_id: string
15010
- }
15008
+ commonParams:
15009
+ | {
15010
+ /** ID of access method to delete. */
15011
+ access_method_id: string
15012
+ }
15013
+ | {
15014
+ /** ID of access grant whose access methods should be deleted. */
15015
+ access_grant_id: string
15016
+ }
15017
+ | {
15018
+ /** Reservation key of the access grant whose access methods should be deleted. */
15019
+ reservation_key: string
15020
+ }
15011
15021
  formData: {}
15012
15022
  jsonResponse: {}
15013
15023
  maxDuration: undefined
@@ -31556,6 +31566,7 @@ export type Routes = {
31556
31566
  | 'korelock'
31557
31567
  | 'dormakaba_ambiance'
31558
31568
  | 'ultraloq'
31569
+ | 'ring'
31559
31570
  | 'yale_access'
31560
31571
  | 'hid_cm'
31561
31572
  | 'google_nest'
@@ -31570,6 +31581,7 @@ export type Routes = {
31570
31581
  | 'thermostats'
31571
31582
  | 'noise_sensors'
31572
31583
  | 'access_control_systems'
31584
+ | 'cameras'
31573
31585
  | 'internal_beta'
31574
31586
  )
31575
31587
  | undefined
@@ -31585,7 +31597,13 @@ export type Routes = {
31585
31597
  wait_for_device_creation?: boolean
31586
31598
  /** 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. */
31587
31599
  accepted_capabilities?:
31588
- | ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[]
31600
+ | (
31601
+ | 'lock'
31602
+ | 'thermostat'
31603
+ | 'noise_sensor'
31604
+ | 'access_control'
31605
+ | 'camera'
31606
+ )[]
31589
31607
  | undefined
31590
31608
  /** List of provider keys to exclude from the Connect Webview. These providers will not be shown when the user tries to connect an account. */
31591
31609
  excluded_providers?: string[] | undefined
@@ -31624,6 +31642,7 @@ export type Routes = {
31624
31642
  | 'thermostat'
31625
31643
  | 'noise_sensor'
31626
31644
  | 'access_control'
31645
+ | 'camera'
31627
31646
  )[]
31628
31647
  /**
31629
31648
  * @deprecated Unused. Will be removed.*/
@@ -31714,6 +31733,7 @@ export type Routes = {
31714
31733
  | 'thermostat'
31715
31734
  | 'noise_sensor'
31716
31735
  | 'access_control'
31736
+ | 'camera'
31717
31737
  )[]
31718
31738
  /**
31719
31739
  * @deprecated Unused. Will be removed.*/
@@ -31794,6 +31814,7 @@ export type Routes = {
31794
31814
  | 'thermostat'
31795
31815
  | 'noise_sensor'
31796
31816
  | 'access_control'
31817
+ | 'camera'
31797
31818
  )[]
31798
31819
  /**
31799
31820
  * @deprecated Unused. Will be removed.*/
@@ -32023,6 +32044,7 @@ export type Routes = {
32023
32044
  | 'thermostat'
32024
32045
  | 'noise_sensor'
32025
32046
  | 'access_control'
32047
+ | 'camera'
32026
32048
  )[]
32027
32049
  }
32028
32050
  }
@@ -32206,6 +32228,7 @@ export type Routes = {
32206
32228
  | 'thermostat'
32207
32229
  | 'noise_sensor'
32208
32230
  | 'access_control'
32231
+ | 'camera'
32209
32232
  )[]
32210
32233
  }[]
32211
32234
  /** Information about the current page of results. */
@@ -32263,7 +32286,13 @@ export type Routes = {
32263
32286
  | undefined
32264
32287
  /** 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`. */
32265
32288
  accepted_capabilities?:
32266
- | ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[]
32289
+ | (
32290
+ | 'lock'
32291
+ | 'thermostat'
32292
+ | 'noise_sensor'
32293
+ | 'access_control'
32294
+ | 'camera'
32295
+ )[]
32267
32296
  | undefined
32268
32297
  /** 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. */
32269
32298
  customer_key?: string | undefined
@@ -32425,6 +32454,7 @@ export type Routes = {
32425
32454
  | 'thermostat'
32426
32455
  | 'noise_sensor'
32427
32456
  | 'access_control'
32457
+ | 'camera'
32428
32458
  )[]
32429
32459
  }
32430
32460
  }
@@ -35152,6 +35182,7 @@ export type Routes = {
35152
35182
  | 'smartthings'
35153
35183
  | 'tado'
35154
35184
  | 'ultraloq'
35185
+ | 'ring'
35155
35186
  )
35156
35187
  | undefined
35157
35188
  /** Array of device IDs for which you want to list devices. */
@@ -36882,6 +36913,7 @@ export type Routes = {
36882
36913
  | 'thermostats'
36883
36914
  | 'noise_sensors'
36884
36915
  | 'access_control_systems'
36916
+ | 'cameras'
36885
36917
  )
36886
36918
  | undefined
36887
36919
  }
@@ -36937,6 +36969,7 @@ export type Routes = {
36937
36969
  | 'korelock'
36938
36970
  | 'dormakaba_ambiance'
36939
36971
  | 'ultraloq'
36972
+ | 'ring'
36940
36973
  display_name: string
36941
36974
  image_url: string
36942
36975
  provider_categories: (
@@ -36946,6 +36979,7 @@ export type Routes = {
36946
36979
  | 'thermostats'
36947
36980
  | 'noise_sensors'
36948
36981
  | 'access_control_systems'
36982
+ | 'cameras'
36949
36983
  )[]
36950
36984
  can_remotely_unlock?: boolean | undefined
36951
36985
  can_remotely_lock?: boolean | undefined
@@ -38186,6 +38220,7 @@ export type Routes = {
38186
38220
  | 'smartthings'
38187
38221
  | 'tado'
38188
38222
  | 'ultraloq'
38223
+ | 'ring'
38189
38224
  )
38190
38225
  | undefined
38191
38226
  /** Array of device IDs for which you want to list devices. */
@@ -75850,6 +75885,7 @@ export type Routes = {
75850
75885
  | 'thermostat'
75851
75886
  | 'noise_sensor'
75852
75887
  | 'access_control'
75888
+ | 'camera'
75853
75889
  )[]
75854
75890
  }[]
75855
75891
  | undefined
@@ -104672,6 +104708,7 @@ export type Routes = {
104672
104708
  | 'thermostat'
104673
104709
  | 'noise_sensor'
104674
104710
  | 'access_control'
104711
+ | 'camera'
104675
104712
  )[]
104676
104713
  /**
104677
104714
  * @deprecated Unused. Will be removed.*/
@@ -105160,6 +105197,7 @@ export type Routes = {
105160
105197
  | 'thermostat'
105161
105198
  | 'noise_sensor'
105162
105199
  | 'access_control'
105200
+ | 'camera'
105163
105201
  )[]
105164
105202
  }[]
105165
105203
  | undefined