@seamapi/types 1.406.4 → 1.406.6

package/lib/seam/connect/route-types.d.ts

@@ -21,11 +21,11 @@ export interface Routes {
             common_code_key?: string | undefined;
             /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
             prefer_native_scheduling?: boolean | undefined;
-            /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code). */
+            /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). */
             use_backup_access_code_pool?: boolean | undefined;
-            /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
+            /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
             allow_external_modification?: boolean | undefined;
-            /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
+            /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
             is_external_modification_allowed?: boolean | undefined;
             /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
             preferred_code_length?: number | undefined;
@@ -1629,11 +1629,11 @@ export interface Routes {
             attempt_for_offline_device?: boolean;
             /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
             prefer_native_scheduling?: boolean | undefined;
-            /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code). */
+            /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). */
             use_backup_access_code_pool?: boolean | undefined;
-            /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
+            /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
             allow_external_modification?: boolean | undefined;
-            /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
+            /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
             is_external_modification_allowed?: boolean | undefined;
             use_offline_access_code?: boolean | undefined;
             /** Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). */
@@ -7716,11 +7716,11 @@ export interface Routes {
             attempt_for_offline_device?: boolean;
             /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
             prefer_native_scheduling?: boolean | undefined;
-            /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code). */
+            /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). */
             use_backup_access_code_pool?: boolean | undefined;
-            /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
+            /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
             allow_external_modification?: boolean | undefined;
-            /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
+            /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
             is_external_modification_allowed?: boolean | undefined;
             /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
             preferred_code_length?: number | undefined;
@@ -18560,6 +18560,7 @@ export interface Routes {
                 token: string;
                 user_identifier_key: string | null;
                 device_count: number;
+                customer_id?: string | undefined;
                 connected_account_ids: string[];
                 connect_webview_ids: string[];
                 user_identity_ids: string[];
@@ -18608,6 +18609,7 @@ export interface Routes {
                 token: string;
                 user_identifier_key: string | null;
                 device_count: number;
+                customer_id?: string | undefined;
                 connected_account_ids: string[];
                 connect_webview_ids: string[];
                 user_identity_ids: string[];
@@ -18650,6 +18652,7 @@ export interface Routes {
                 token: string;
                 user_identifier_key: string | null;
                 device_count: number;
+                customer_id?: string | undefined;
                 connected_account_ids: string[];
                 connect_webview_ids: string[];
                 user_identity_ids: string[];
@@ -18692,6 +18695,7 @@ export interface Routes {
                 token: string;
                 user_identifier_key: string | null;
                 device_count: number;
+                customer_id?: string | undefined;
                 connected_account_ids: string[];
                 connect_webview_ids: string[];
                 user_identity_ids: string[];
@@ -18725,6 +18729,7 @@ export interface Routes {
                 token: string;
                 user_identifier_key: string | null;
                 device_count: number;
+                customer_id?: string | undefined;
                 connected_account_ids: string[];
                 connect_webview_ids: string[];
                 user_identity_ids: string[];
@@ -18906,7 +18911,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            customer_id?: string | undefined;
+            customer_ids?: string[] | undefined;
             /** Your user ID for the user by which you want to filter Connect Webviews. */
             user_identifier_key?: string | undefined;
             /** Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. */
@@ -25460,7 +25465,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the lock that you want to get. */
             device_id?: string | undefined;
+            /** Name of the lock that you want to get. */
             name?: string | undefined;
         };
         formData: {};
@@ -27888,11 +27895,11 @@ export interface Routes {
             connected_account_ids?: string[] | undefined;
             /** ID of the Connect Webview for which you want to list devices. */
             connect_webview_id?: string | undefined;
-            /** Device type by which to filter devices. */
+            /** Device type of the locks that you want to list. */
             device_type?: ('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' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | undefined;
-            /** Array of device types by which to filter devices. */
+            /** Device types of the locks that you want to list. */
             device_types?: Array<'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' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock'> | undefined;
-            /** Manufacturer by which to filter devices. */
+            /** Manufacturer of the locks that you want to list. */
             manufacturer?: ('akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'lockly' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | 'wyze' | 'yale' | 'two_n' | 'controlbyweb' | 'ttlock' | 'igloohome' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'tedee' | 'akiles' | 'kwikset2' | 'smartthings') | undefined;
             /** Array of device IDs for which you want to list devices. */
             device_ids?: string[] | undefined;
@@ -30328,7 +30335,9 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the lock that you want to lock. */
             device_id: string;
+            /**  */
             sync?: boolean;
         };
         commonParams: {};
@@ -31444,7 +31453,9 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the device for which you want to simulate a keypad code entry. */
             device_id: string;
+            /** Code that you want to simulate entering on a keypad. */
             code: string;
         };
         commonParams: {};
@@ -32560,6 +32571,7 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the device for which you want to simulate a manual lock action using a keypad. */
             device_id: string;
         };
         commonParams: {};
@@ -33675,7 +33687,9 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the lock that you want to unlock. */
             device_id: string;
+            /**  */
             sync?: boolean;
         };
         commonParams: {};
@@ -41194,6 +41208,7 @@ export interface Routes {
                 token: string;
                 user_identifier_key: string | null;
                 device_count: number;
+                customer_id?: string | undefined;
                 connected_account_ids: string[];
                 connect_webview_ids: string[];
                 user_identity_ids: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.406.4",
+  "version": "1.406.6",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/client-sessions/client-session.ts

@@ -8,6 +8,7 @@ export const client_session = z.object({
   token: z.string(),
   user_identifier_key: z.string().nullable(),
   device_count: z.number(),
+  customer_id: z.string().uuid().optional(),
   connected_account_ids: z.array(z.string().uuid()),
   connect_webview_ids: z.array(z.string().uuid()),
   user_identity_ids: z.array(z.string().uuid()),
@@ -16,11 +17,11 @@ export const client_session = z.object({
   route_path: /client_sessions
   ---
   Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
-  
+
   You create each client session with a custom \`user_identifier_key\`. Normally, the \`user_identifier_key\` is a user ID that your application provides.
-  
+
   When calling the Seam API from your backend using an API key, you can pass the \`user_identifier_key\` as a parameter to limit results to the associated client session. For example, \`/devices/list?user_identifier_key=123\` only returns devices associated with the client session created with the \`user_identifier_key\` \`123\`.
-  
+
   A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
 
   See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).