@seamapi/types 1.406.4 → 1.406.6

package/src/lib/seam/connect/route-types.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
@@ -1872,11 +1872,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). */
@@ -8769,11 +8769,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
@@ -21538,6 +21538,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[]
@@ -21586,6 +21587,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[]
@@ -21628,6 +21630,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[]
@@ -21670,6 +21673,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[]
@@ -21703,6 +21707,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[]
@@ -21946,7 +21951,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. */
@@ -29940,7 +29945,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: {}
@@ -32838,7 +32845,7 @@ 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'
@@ -32870,7 +32877,7 @@ export interface Routes {
             | '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'
@@ -32902,7 +32909,7 @@ export interface Routes {
             | 'akiles_lock'
           >
         | undefined
-      /** Manufacturer by which to filter devices. */
+      /** Manufacturer of the locks that you want to list. */
       manufacturer?:
         | (
             | 'akuvox'
@@ -35867,7 +35874,9 @@ export interface Routes {
     method: 'POST'
     queryParams: {}
     jsonBody: {
+      /** ID of the lock that you want to lock. */
       device_id: string
+      /**  */
       sync?: boolean
     }
     commonParams: {}
@@ -37172,7 +37181,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: {}
@@ -38477,6 +38488,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: {}
@@ -39781,7 +39793,9 @@ export interface Routes {
     method: 'POST'
     queryParams: {}
     jsonBody: {
+      /** ID of the lock that you want to unlock. */
       device_id: string
+      /**  */
       sync?: boolean
     }
     commonParams: {}
@@ -48580,6 +48594,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[]