@seamapi/types 1.462.0 → 1.463.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.
@@ -11623,7 +11623,7 @@ export interface Routes {
11623
11623
  acs_user_count?: number | undefined;
11624
11624
  acs_access_group_count?: number | undefined;
11625
11625
  /** Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
11626
- external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
11626
+ external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'dormakaba_ambiance_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
11627
11627
  /** Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
11628
11628
  external_type_display_name?: string | undefined;
11629
11629
  /** Indicates whether the `acs_system` is a credential manager. */
@@ -11638,7 +11638,7 @@ export interface Routes {
11638
11638
  } | undefined;
11639
11639
  /**
11640
11640
  * @deprecated Use `external_type`. */
11641
- system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
11641
+ system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'dormakaba_ambiance_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
11642
11642
  /**
11643
11643
  * @deprecated Use `external_type_display_name`. */
11644
11644
  system_type_display_name?: string | undefined;
@@ -11813,7 +11813,7 @@ export interface Routes {
11813
11813
  /** ID of the Access Grant to update. */
11814
11814
  access_grant_id: string;
11815
11815
  /** Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
11816
- starts_at?: (string | null) | undefined;
11816
+ starts_at?: string | undefined;
11817
11817
  /** Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
11818
11818
  ends_at?: (string | null) | undefined;
11819
11819
  };
@@ -14552,7 +14552,7 @@ export interface Routes {
14552
14552
  acs_user_count?: number | undefined;
14553
14553
  acs_access_group_count?: number | undefined;
14554
14554
  /** Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
14555
- external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
14555
+ external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'dormakaba_ambiance_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
14556
14556
  /** Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
14557
14557
  external_type_display_name?: string | undefined;
14558
14558
  /** Indicates whether the `acs_system` is a credential manager. */
@@ -14567,7 +14567,7 @@ export interface Routes {
14567
14567
  } | undefined;
14568
14568
  /**
14569
14569
  * @deprecated Use `external_type`. */
14570
- system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
14570
+ system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'dormakaba_ambiance_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
14571
14571
  /**
14572
14572
  * @deprecated Use `external_type_display_name`. */
14573
14573
  system_type_display_name?: string | undefined;
@@ -16826,6 +16826,51 @@ export interface Routes {
16826
16826
  can_simulate_disconnection?: boolean | undefined;
16827
16827
  can_unlock_with_code?: boolean | undefined;
16828
16828
  }> | undefined;
16829
+ connect_webviews?: Array<{
16830
+ /** ID of the Connect Webview. */
16831
+ connect_webview_id: string;
16832
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview. */
16833
+ workspace_id: string;
16834
+ /** Date and time at which the Connect Webview was created. */
16835
+ created_at: string;
16836
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview. */
16837
+ connected_account_id: string | null;
16838
+ /** URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user. */
16839
+ url: string;
16840
+ device_selection_mode: 'none' | 'single' | 'multiple';
16841
+ /** 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). */
16842
+ accepted_providers: string[];
16843
+ /** 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`. */
16844
+ accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>;
16845
+ /**
16846
+ * @deprecated Unused. Will be removed. */
16847
+ accepted_devices: string[];
16848
+ /**
16849
+ * @deprecated Unused. Will be removed. */
16850
+ any_device_allowed: boolean;
16851
+ /** Indicates whether any provider is allowed. */
16852
+ any_provider_allowed: boolean;
16853
+ /** Indicates whether the user logged in successfully using the Connect Webview. */
16854
+ login_successful: boolean;
16855
+ /** Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview. */
16856
+ status: 'pending' | 'failed' | 'authorized';
16857
+ /** URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs. */
16858
+ custom_redirect_url: string | null;
16859
+ /** URL to which the Connect Webview should redirect when an unexpected error occurs. */
16860
+ custom_redirect_failure_url: string | null;
16861
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
16862
+ custom_metadata: Record<string, string | boolean>;
16863
+ /** Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. */
16864
+ automatically_manage_new_devices: boolean;
16865
+ /** Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview. */
16866
+ wait_for_device_creation: boolean;
16867
+ /** Date and time at which the user authorized (through the Connect Webview) the management of their devices. */
16868
+ authorized_at: string | null;
16869
+ /** Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
16870
+ selected_provider: string | null;
16871
+ /** The customer key associated with this webview, if any. */
16872
+ customer_key?: string | undefined;
16873
+ }> | undefined;
16829
16874
  };
16830
16875
  };
16831
16876
  };
@@ -22182,7 +22227,7 @@ export interface Routes {
22182
22227
  acs_user_count?: number | undefined;
22183
22228
  acs_access_group_count?: number | undefined;
22184
22229
  /** Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
22185
- external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
22230
+ external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'dormakaba_ambiance_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
22186
22231
  /** Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
22187
22232
  external_type_display_name?: string | undefined;
22188
22233
  /** Indicates whether the `acs_system` is a credential manager. */
@@ -22197,7 +22242,7 @@ export interface Routes {
22197
22242
  } | undefined;
22198
22243
  /**
22199
22244
  * @deprecated Use `external_type`. */
22200
- system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
22245
+ system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'dormakaba_ambiance_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
22201
22246
  /**
22202
22247
  * @deprecated Use `external_type_display_name`. */
22203
22248
  system_type_display_name?: string | undefined;
@@ -22313,7 +22358,7 @@ export interface Routes {
22313
22358
  acs_user_count?: number | undefined;
22314
22359
  acs_access_group_count?: number | undefined;
22315
22360
  /** Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
22316
- external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
22361
+ external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'dormakaba_ambiance_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
22317
22362
  /** Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
22318
22363
  external_type_display_name?: string | undefined;
22319
22364
  /** Indicates whether the `acs_system` is a credential manager. */
@@ -22328,7 +22373,7 @@ export interface Routes {
22328
22373
  } | undefined;
22329
22374
  /**
22330
22375
  * @deprecated Use `external_type`. */
22331
- system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
22376
+ system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'dormakaba_ambiance_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
22332
22377
  /**
22333
22378
  * @deprecated Use `external_type_display_name`. */
22334
22379
  system_type_display_name?: string | undefined;
@@ -22444,7 +22489,7 @@ export interface Routes {
22444
22489
  acs_user_count?: number | undefined;
22445
22490
  acs_access_group_count?: number | undefined;
22446
22491
  /** Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
22447
- external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
22492
+ external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'dormakaba_ambiance_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
22448
22493
  /** Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
22449
22494
  external_type_display_name?: string | undefined;
22450
22495
  /** Indicates whether the `acs_system` is a credential manager. */
@@ -22459,7 +22504,7 @@ export interface Routes {
22459
22504
  } | undefined;
22460
22505
  /**
22461
22506
  * @deprecated Use `external_type`. */
22462
- system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
22507
+ system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'dormakaba_ambiance_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
22463
22508
  /**
22464
22509
  * @deprecated Use `external_type_display_name`. */
22465
22510
  system_type_display_name?: string | undefined;
@@ -26846,7 +26891,7 @@ export interface Routes {
26846
26891
  /** Optional unique string key that can be used to identify the customer. If provided, the customer will be created or retrieved based on this key. */
26847
26892
  customer_key?: string | undefined;
26848
26893
  /** 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. */
26849
- accepted_providers?: Array<'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | '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' | 'kwikset2' | 'keynest' | 'yale_access' | 'hid_cm' | 'google_nest'> | undefined;
26894
+ accepted_providers?: Array<'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | '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' | 'kwikset2' | 'keynest' | 'dormakaba_ambiance' | 'yale_access' | 'hid_cm' | 'google_nest'> | undefined;
26850
26895
  /** 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. */
26851
26896
  provider_category?: ('stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'internal_beta') | undefined;
26852
26897
  /** 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). */
@@ -30578,7 +30623,7 @@ export interface Routes {
30578
30623
  formData: {};
30579
30624
  jsonResponse: {
30580
30625
  device_providers: Array<{
30581
- device_provider_name: 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | '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' | 'kwikset2' | 'keynest';
30626
+ device_provider_name: 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | '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' | 'kwikset2' | 'keynest' | 'dormakaba_ambiance';
30582
30627
  display_name: string;
30583
30628
  image_url: string;
30584
30629
  provider_categories: Array<'stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems'>;
@@ -53999,7 +54044,7 @@ export interface Routes {
53999
54044
  acs_user_count?: number | undefined;
54000
54045
  acs_access_group_count?: number | undefined;
54001
54046
  /** Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
54002
- external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
54047
+ external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'dormakaba_ambiance_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
54003
54048
  /** Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
54004
54049
  external_type_display_name?: string | undefined;
54005
54050
  /** Indicates whether the `acs_system` is a credential manager. */
@@ -54014,7 +54059,7 @@ export interface Routes {
54014
54059
  } | undefined;
54015
54060
  /**
54016
54061
  * @deprecated Use `external_type`. */
54017
- system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
54062
+ system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'dormakaba_ambiance_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
54018
54063
  /**
54019
54064
  * @deprecated Use `external_type_display_name`. */
54020
54065
  system_type_display_name?: string | undefined;
@@ -73213,7 +73258,7 @@ export interface Routes {
73213
73258
  acs_user_count?: number | undefined;
73214
73259
  acs_access_group_count?: number | undefined;
73215
73260
  /** Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
73216
- external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
73261
+ external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'dormakaba_ambiance_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
73217
73262
  /** Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
73218
73263
  external_type_display_name?: string | undefined;
73219
73264
  /** Indicates whether the `acs_system` is a credential manager. */
@@ -73228,7 +73273,7 @@ export interface Routes {
73228
73273
  } | undefined;
73229
73274
  /**
73230
73275
  * @deprecated Use `external_type`. */
73231
- system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
73276
+ system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'dormakaba_ambiance_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
73232
73277
  /**
73233
73278
  * @deprecated Use `external_type_display_name`. */
73234
73279
  system_type_display_name?: string | undefined;
@@ -75179,7 +75224,7 @@ export interface Routes {
75179
75224
  acs_user_count?: number | undefined;
75180
75225
  acs_access_group_count?: number | undefined;
75181
75226
  /** Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
75182
- external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
75227
+ external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'dormakaba_ambiance_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
75183
75228
  /** Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
75184
75229
  external_type_display_name?: string | undefined;
75185
75230
  /** Indicates whether the `acs_system` is a credential manager. */
@@ -75194,7 +75239,7 @@ export interface Routes {
75194
75239
  } | undefined;
75195
75240
  /**
75196
75241
  * @deprecated Use `external_type`. */
75197
- system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
75242
+ system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'dormakaba_ambiance_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
75198
75243
  /**
75199
75244
  * @deprecated Use `external_type_display_name`. */
75200
75245
  system_type_display_name?: string | undefined;
@@ -77453,6 +77498,51 @@ export interface Routes {
77453
77498
  can_simulate_disconnection?: boolean | undefined;
77454
77499
  can_unlock_with_code?: boolean | undefined;
77455
77500
  }> | undefined;
77501
+ connect_webviews?: Array<{
77502
+ /** ID of the Connect Webview. */
77503
+ connect_webview_id: string;
77504
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview. */
77505
+ workspace_id: string;
77506
+ /** Date and time at which the Connect Webview was created. */
77507
+ created_at: string;
77508
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview. */
77509
+ connected_account_id: string | null;
77510
+ /** URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user. */
77511
+ url: string;
77512
+ device_selection_mode: 'none' | 'single' | 'multiple';
77513
+ /** 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). */
77514
+ accepted_providers: string[];
77515
+ /** 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`. */
77516
+ accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>;
77517
+ /**
77518
+ * @deprecated Unused. Will be removed. */
77519
+ accepted_devices: string[];
77520
+ /**
77521
+ * @deprecated Unused. Will be removed. */
77522
+ any_device_allowed: boolean;
77523
+ /** Indicates whether any provider is allowed. */
77524
+ any_provider_allowed: boolean;
77525
+ /** Indicates whether the user logged in successfully using the Connect Webview. */
77526
+ login_successful: boolean;
77527
+ /** Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview. */
77528
+ status: 'pending' | 'failed' | 'authorized';
77529
+ /** URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs. */
77530
+ custom_redirect_url: string | null;
77531
+ /** URL to which the Connect Webview should redirect when an unexpected error occurs. */
77532
+ custom_redirect_failure_url: string | null;
77533
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
77534
+ custom_metadata: Record<string, string | boolean>;
77535
+ /** Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. */
77536
+ automatically_manage_new_devices: boolean;
77537
+ /** Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview. */
77538
+ wait_for_device_creation: boolean;
77539
+ /** Date and time at which the user authorized (through the Connect Webview) the management of their devices. */
77540
+ authorized_at: string | null;
77541
+ /** Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
77542
+ selected_provider: string | null;
77543
+ /** The customer key associated with this webview, if any. */
77544
+ customer_key?: string | undefined;
77545
+ }> | undefined;
77456
77546
  };
77457
77547
  };
77458
77548
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.462.0",
3
+ "version": "1.463.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -26,6 +26,7 @@ export const acs_system_external_type = z.enum([
26
26
  'assa_abloy_credential_service',
27
27
  'latch_building',
28
28
  'dormakaba_community_site',
29
+ 'dormakaba_ambiance_site',
29
30
  'legic_connect_credential_service',
30
31
  'assa_abloy_vostio',
31
32
  'assa_abloy_vostio_credential_service',
@@ -9,6 +9,7 @@ import { acs_user, unmanaged_acs_user } from './acs/acs-users/acs-user.js'
9
9
  import { acs_entrance, acs_system } from './acs/index.js'
10
10
  import { action_attempt } from './action-attempts/action-attempt.js'
11
11
  import { client_session } from './client-sessions/client-session.js'
12
+ import { connect_webview } from './connect-webviews/connect-webview.js'
12
13
  import { connected_account } from './connected-accounts/index.js'
13
14
  import { device } from './devices/index.js'
14
15
  import { unmanaged_device } from './devices/unmanaged-device.js'
@@ -61,6 +62,7 @@ export const workspaces_batch = z
61
62
  unmanaged_acs_users: unmanaged_acs_user.array().optional(),
62
63
  unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
63
64
  unmanaged_devices: unmanaged_device.array().optional(),
65
+ connect_webviews: connect_webview.array().optional(),
64
66
  })
65
67
  .describe('A batch of workspace resources.')
66
68
 
@@ -86,6 +88,7 @@ export const batch = z
86
88
  unmanaged_acs_users: unmanaged_acs_user.array().optional(),
87
89
  unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
88
90
  unmanaged_devices: unmanaged_device.array().optional(),
91
+ connect_webviews: connect_webview.array().optional(),
89
92
  })
90
93
  .describe('A batch of workspace resources.')
91
94
 
@@ -51,6 +51,7 @@ export const DEVICE_PROVIDERS = {
51
51
  SENSI: 'sensi',
52
52
  KWIKSET2: 'kwikset2',
53
53
  KEYNEST: 'keynest',
54
+ DORMAKABA_AMBIANCE: 'dormakaba_ambiance',
54
55
  } as const
55
56
 
56
57
  export type DeviceProviderName =
@@ -118,6 +119,7 @@ export const PROVIDER_CATEGORY_MAP = {
118
119
  'salto_ks',
119
120
  'assa_abloy_vostio',
120
121
  'salto_space',
122
+ 'dormakaba_ambiance',
121
123
  ],
122
124
 
123
125
  internal_beta: ALL_DEVICE_PROVIDERS,
@@ -3222,6 +3222,7 @@ export default {
3222
3222
  'assa_abloy_credential_service',
3223
3223
  'latch_building',
3224
3224
  'dormakaba_community_site',
3225
+ 'dormakaba_ambiance_site',
3225
3226
  'legic_connect_credential_service',
3226
3227
  'assa_abloy_vostio',
3227
3228
  'assa_abloy_vostio_credential_service',
@@ -3278,6 +3279,7 @@ export default {
3278
3279
  'assa_abloy_credential_service',
3279
3280
  'latch_building',
3280
3281
  'dormakaba_community_site',
3282
+ 'dormakaba_ambiance_site',
3281
3283
  'legic_connect_credential_service',
3282
3284
  'assa_abloy_vostio',
3283
3285
  'assa_abloy_vostio_credential_service',
@@ -13021,6 +13023,7 @@ export default {
13021
13023
  'sensi',
13022
13024
  'kwikset2',
13023
13025
  'keynest',
13026
+ 'dormakaba_ambiance',
13024
13027
  ],
13025
13028
  type: 'string',
13026
13029
  },
@@ -28776,7 +28779,6 @@ export default {
28776
28779
  description:
28777
28780
  'Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
28778
28781
  format: 'date-time',
28779
- nullable: true,
28780
28782
  type: 'string',
28781
28783
  },
28782
28784
  },
@@ -28845,7 +28847,6 @@ export default {
28845
28847
  description:
28846
28848
  'Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
28847
28849
  format: 'date-time',
28848
- nullable: true,
28849
28850
  type: 'string',
28850
28851
  },
28851
28852
  },
@@ -29247,6 +29248,12 @@ export default {
29247
29248
  },
29248
29249
  type: 'array',
29249
29250
  },
29251
+ connect_webviews: {
29252
+ items: {
29253
+ $ref: '#/components/schemas/connect_webview',
29254
+ },
29255
+ type: 'array',
29256
+ },
29250
29257
  devices: {
29251
29258
  items: { $ref: '#/components/schemas/device' },
29252
29259
  type: 'array',
@@ -29400,6 +29407,12 @@ export default {
29400
29407
  },
29401
29408
  type: 'array',
29402
29409
  },
29410
+ connect_webviews: {
29411
+ items: {
29412
+ $ref: '#/components/schemas/connect_webview',
29413
+ },
29414
+ type: 'array',
29415
+ },
29403
29416
  devices: {
29404
29417
  items: { $ref: '#/components/schemas/device' },
29405
29418
  type: 'array',
@@ -36984,6 +36997,7 @@ export default {
36984
36997
  'sensi',
36985
36998
  'kwikset2',
36986
36999
  'keynest',
37000
+ 'dormakaba_ambiance',
36987
37001
  'yale_access',
36988
37002
  'hid_cm',
36989
37003
  'google_nest',
@@ -57177,6 +57191,12 @@ export default {
57177
57191
  },
57178
57192
  type: 'array',
57179
57193
  },
57194
+ connect_webviews: {
57195
+ items: {
57196
+ $ref: '#/components/schemas/connect_webview',
57197
+ },
57198
+ type: 'array',
57199
+ },
57180
57200
  devices: {
57181
57201
  items: { $ref: '#/components/schemas/device' },
57182
57202
  type: 'array',
@@ -57305,6 +57325,12 @@ export default {
57305
57325
  },
57306
57326
  type: 'array',
57307
57327
  },
57328
+ connect_webviews: {
57329
+ items: {
57330
+ $ref: '#/components/schemas/connect_webview',
57331
+ },
57332
+ type: 'array',
57333
+ },
57308
57334
  devices: {
57309
57335
  items: { $ref: '#/components/schemas/device' },
57310
57336
  type: 'array',