@seamapi/types 1.631.0 → 1.633.0

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

@@ -13016,6 +13016,14 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured'
                   }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities'
+                  }
               )[]
               /** Date and time at which the device object was created. */
               created_at: string
@@ -17134,6 +17142,14 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured'
                   }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities'
+                  }
               )[]
               /** Date and time at which the device object was created. */
               created_at: string
@@ -20318,6 +20334,14 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured'
                   }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities'
+                  }
               )[]
               /** Date and time at which the device object was created. */
               created_at: string
@@ -39271,6 +39295,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'lockly_time_zone_not_configured'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'hub_required_for_addtional_capabilities'
+            }
         )[]
         /** Date and time at which the device object was created. */
         created_at: string
@@ -41022,6 +41054,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'lockly_time_zone_not_configured'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'hub_required_for_addtional_capabilities'
+            }
         )[]
         /** Date and time at which the device object was created. */
         created_at: string
@@ -41621,6 +41661,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'lockly_time_zone_not_configured'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'hub_required_for_addtional_capabilities'
+            }
         )[]
         /** Date and time at which the device object was created. */
         created_at: string
@@ -42322,6 +42370,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'lockly_time_zone_not_configured'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'hub_required_for_addtional_capabilities'
+            }
         )[]
         /** Date and time at which the device object was created. */
         created_at: string
@@ -48851,6 +48907,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'lockly_time_zone_not_configured'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'hub_required_for_addtional_capabilities'
+            }
         )[]
         /** Date and time at which the device object was created. */
         created_at: string
@@ -50375,6 +50439,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'lockly_time_zone_not_configured'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'hub_required_for_addtional_capabilities'
+            }
         )[]
         /** Date and time at which the device object was created. */
         created_at: string
@@ -52088,6 +52160,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'lockly_time_zone_not_configured'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'hub_required_for_addtional_capabilities'
+            }
         )[]
         /** Date and time at which the device object was created. */
         created_at: string
@@ -53611,6 +53691,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'lockly_time_zone_not_configured'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'hub_required_for_addtional_capabilities'
+            }
         )[]
         /** Date and time at which the device object was created. */
         created_at: string
@@ -61072,6 +61160,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'lockly_time_zone_not_configured'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'hub_required_for_addtional_capabilities'
+            }
         )[]
         /** Date and time at which the device object was created. */
         created_at: string
@@ -62595,6 +62691,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'lockly_time_zone_not_configured'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'hub_required_for_addtional_capabilities'
+            }
         )[]
         /** Date and time at which the device object was created. */
         created_at: string
@@ -67820,6 +67924,73 @@ export type Routes = {
       }
     }
   }
+  '/seam/customer/v1/access_grants/list': {
+    route: '/seam/customer/v1/access_grants/list'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {}
+    formData: {}
+    jsonResponse: {
+      access_grants: {
+        /** ID of the Seam workspace associated with the Access Grant. */
+        workspace_id: string
+        /** ID of the Access Grant. */
+        access_grant_id: string
+        /** Unique key for the access grant within the workspace. */
+        access_grant_key?: string | undefined
+        /** Reservation key for the access grant. */
+        reservation_key?: string | undefined
+        /** ID of user identity to which the Access Grant gives access. */
+        user_identity_id: string
+        /**
+         * @deprecated Use `space_ids`.*/
+        location_ids: string[]
+        /** IDs of the spaces to which the Access Grant gives access. */
+        space_ids: string[]
+        /** Access methods that the user requested for the Access Grant. */
+        requested_access_methods: {
+          /** Display name of the access method. */
+          display_name: string
+          /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+          mode: 'code' | 'card' | 'mobile_key'
+          /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
+          code?: string | undefined
+          /** Date and time at which the requested access method was added to the Access Grant. */
+          created_at: string
+          /** IDs of the access methods created for the requested access method. */
+          created_access_method_ids: string[]
+        }[]
+        /** IDs of the access methods created for the Access Grant. */
+        access_method_ids: string[]
+        /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
+        client_session_token?: string | undefined
+        /** Name of the Access Grant. If not provided, the display name will be computed. */
+        name: string | null
+        /** Display name of the Access Grant. */
+        display_name: string
+        /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
+        instant_key_url?: string | undefined
+        /** Date and time at which the Access Grant was created. */
+        created_at: string
+        /** Date and time at which the Access Grant starts. */
+        starts_at: string
+        /** Date and time at which the Access Grant ends. */
+        ends_at: string | null
+        /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+        warnings: {
+          /** Date and time at which Seam created the warning. */
+          created_at: string
+          /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+          message: string
+          /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+          warning_code: 'being_deleted'
+        }[]
+        /** ID of the customization profile associated with the Access Grant. */
+        customization_profile_id?: string | undefined
+      }[]
+    }
+  }
   '/seam/customer/v1/automation_runs/list': {
     route: '/seam/customer/v1/automation_runs/list'
     method: 'GET' | 'POST'
@@ -73523,6 +73694,14 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured'
                   }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities'
+                  }
               )[]
               /** Date and time at which the device object was created. */
               created_at: string
@@ -80165,6 +80344,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'lockly_time_zone_not_configured'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'hub_required_for_addtional_capabilities'
+            }
         )[]
         /** Date and time at which the device object was created. */
         created_at: string
@@ -84745,6 +84932,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'lockly_time_zone_not_configured'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'hub_required_for_addtional_capabilities'
+            }
         )[]
         /** Date and time at which the device object was created. */
         created_at: string
@@ -86268,6 +86463,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'lockly_time_zone_not_configured'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'hub_required_for_addtional_capabilities'
+            }
         )[]
         /** Date and time at which the device object was created. */
         created_at: string
@@ -94605,6 +94808,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'lockly_time_zone_not_configured'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'hub_required_for_addtional_capabilities'
+            }
         )[]
         /** Date and time at which the device object was created. */
         created_at: string
@@ -96130,6 +96341,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'lockly_time_zone_not_configured'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'hub_required_for_addtional_capabilities'
+            }
         )[]
         /** Date and time at which the device object was created. */
         created_at: string
@@ -98707,6 +98926,14 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured'
                   }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities'
+                  }
               )[]
               /** Date and time at which the device object was created. */
               created_at: string
@@ -101891,6 +102118,14 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'lockly_time_zone_not_configured'
                   }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'hub_required_for_addtional_capabilities'
+                  }
               )[]
               /** Date and time at which the device object was created. */
               created_at: string