@seamapi/types 1.502.0 → 1.504.0

package/dist/connect.d.cts

@@ -561,6 +561,7 @@ declare const access_code_warning: z.ZodDiscriminatedUnion<"warning_code", [z.Zo
 }>]>;
 type AccessCodeWarning = z.infer<typeof access_code_warning>;
 declare const access_code: z.ZodObject<{
+    workspace_id: z.ZodString;
     common_code_key: z.ZodNullable<z.ZodString>;
     is_scheduled_on_device: z.ZodOptional<z.ZodBoolean>;
     type: z.ZodEnum<["time_bound", "ongoing"]>;
@@ -1498,6 +1499,7 @@ declare const access_code: z.ZodObject<{
     status: "unknown" | "set" | "setting" | "unset" | "removing";
     name: string | null;
     device_id: string;
+    workspace_id: string;
     created_at: string;
     errors: ({
         message: string;
@@ -1797,6 +1799,7 @@ declare const access_code: z.ZodObject<{
     status: "unknown" | "set" | "setting" | "unset" | "removing";
     name: string | null;
     device_id: string;
+    workspace_id: string;
     created_at: string;
     errors: ({
         message: string;
@@ -2098,6 +2101,7 @@ declare const unmanaged_access_code: z.ZodObject<{
     type: z.ZodEnum<["time_bound", "ongoing"]>;
     name: z.ZodNullable<z.ZodString>;
     device_id: z.ZodString;
+    workspace_id: z.ZodString;
     created_at: z.ZodString;
     starts_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     ends_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -3023,6 +3027,7 @@ declare const unmanaged_access_code: z.ZodObject<{
     status: "set";
     name: string | null;
     device_id: string;
+    workspace_id: string;
     created_at: string;
     errors: ({
         message: string;
@@ -3313,6 +3318,7 @@ declare const unmanaged_access_code: z.ZodObject<{
     status: "set";
     name: string | null;
     device_id: string;
+    workspace_id: string;
     created_at: string;
     errors: ({
         message: string;
@@ -27304,6 +27310,7 @@ declare const batch: z.ZodObject<{
         } | undefined;
     }>, "many">>;
     access_codes: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        workspace_id: z.ZodString;
         common_code_key: z.ZodNullable<z.ZodString>;
         is_scheduled_on_device: z.ZodOptional<z.ZodBoolean>;
         type: z.ZodEnum<["time_bound", "ongoing"]>;
@@ -28241,6 +28248,7 @@ declare const batch: z.ZodObject<{
         status: "unknown" | "set" | "setting" | "unset" | "removing";
         name: string | null;
         device_id: string;
+        workspace_id: string;
         created_at: string;
         errors: ({
             message: string;
@@ -28540,6 +28548,7 @@ declare const batch: z.ZodObject<{
         status: "unknown" | "set" | "setting" | "unset" | "removing";
         name: string | null;
         device_id: string;
+        workspace_id: string;
         created_at: string;
         errors: ({
             message: string;
@@ -28839,6 +28848,7 @@ declare const batch: z.ZodObject<{
         type: z.ZodEnum<["time_bound", "ongoing"]>;
         name: z.ZodNullable<z.ZodString>;
         device_id: z.ZodString;
+        workspace_id: z.ZodString;
         created_at: z.ZodString;
         starts_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         ends_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -29764,6 +29774,7 @@ declare const batch: z.ZodObject<{
         status: "set";
         name: string | null;
         device_id: string;
+        workspace_id: string;
         created_at: string;
         errors: ({
             message: string;
@@ -30054,6 +30065,7 @@ declare const batch: z.ZodObject<{
         status: "set";
         name: string | null;
         device_id: string;
+        workspace_id: string;
         created_at: string;
         errors: ({
             message: string;
@@ -33692,6 +33704,7 @@ declare const batch: z.ZodObject<{
         status: "unknown" | "set" | "setting" | "unset" | "removing";
         name: string | null;
         device_id: string;
+        workspace_id: string;
         created_at: string;
         errors: ({
             message: string;
@@ -33992,6 +34005,7 @@ declare const batch: z.ZodObject<{
         status: "set";
         name: string | null;
         device_id: string;
+        workspace_id: string;
         created_at: string;
         errors: ({
             message: string;
@@ -37525,6 +37539,7 @@ declare const batch: z.ZodObject<{
         status: "unknown" | "set" | "setting" | "unset" | "removing";
         name: string | null;
         device_id: string;
+        workspace_id: string;
         created_at: string;
         errors: ({
             message: string;
@@ -37825,6 +37840,7 @@ declare const batch: z.ZodObject<{
         status: "set";
         name: string | null;
         device_id: string;
+        workspace_id: string;
         created_at: string;
         errors: ({
             message: string;
@@ -50825,6 +50841,11 @@ declare const _default: {
                             };
                         };
                     };
+                    workspace_id: {
+                        description: string;
+                        format: string;
+                        type: string;
+                    };
                 };
                 required: string[];
                 type: string;
@@ -62257,6 +62278,11 @@ declare const _default: {
                             };
                         };
                     };
+                    workspace_id: {
+                        description: string;
+                        format: string;
+                        type: string;
+                    };
                 };
                 required: string[];
                 type: string;
@@ -79896,6 +79922,243 @@ declare const _default: {
                 'x-title': string;
             };
         };
+        '/customers/delete_data': {
+            delete: {
+                description: string;
+                operationId: string;
+                parameters: {
+                    in: string;
+                    name: string;
+                    schema: {
+                        description: string;
+                        items: {
+                            type: string;
+                        };
+                        type: string;
+                    };
+                }[];
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    pat_with_workspace: never[];
+                    console_session_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    pat_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    api_key: never[];
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-response-key': null;
+                'x-title': string;
+            };
+            post: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    access_grant_keys: {
+                                        description: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    booking_keys: {
+                                        description: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    building_keys: {
+                                        description: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    common_area_keys: {
+                                        description: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    facility_keys: {
+                                        description: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    guest_keys: {
+                                        description: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    listing_keys: {
+                                        description: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    property_keys: {
+                                        description: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    property_listing_keys: {
+                                        description: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    reservation_keys: {
+                                        description: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    resident_keys: {
+                                        description: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    room_keys: {
+                                        description: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    space_keys: {
+                                        description: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    tenant_keys: {
+                                        description: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    unit_keys: {
+                                        description: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    user_identity_keys: {
+                                        description: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    user_keys: {
+                                        description: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                };
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    pat_with_workspace: never[];
+                    console_session_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    pat_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    api_key: never[];
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-response-key': null;
+                'x-title': string;
+            };
+        };
         '/customers/push_data': {
             post: {
                 description: string;
@@ -101312,6 +101575,8 @@ type Routes = {
           
           In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
             access_code: {
+                /** Unique identifier for the Seam workspace associated with the access code. */
+                workspace_id: string;
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
                 /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -101866,6 +102131,8 @@ type Routes = {
         formData: {};
         jsonResponse: {
             access_codes: {
+                /** Unique identifier for the Seam workspace associated with the access code. */
+                workspace_id: string;
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
                 /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -103674,6 +103941,8 @@ type Routes = {
           
           In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
             access_code: {
+                /** Unique identifier for the Seam workspace associated with the access code. */
+                workspace_id: string;
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
                 /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -104201,6 +104470,8 @@ type Routes = {
         formData: {};
         jsonResponse: {
             access_codes: {
+                /** Unique identifier for the Seam workspace associated with the access code. */
+                workspace_id: string;
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
                 /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -104735,6 +105006,8 @@ type Routes = {
           
           In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
             backup_access_code: {
+                /** Unique identifier for the Seam workspace associated with the access code. */
+                workspace_id: string;
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
                 /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -105247,6 +105520,8 @@ type Routes = {
           
           In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
             access_code: {
+                /** Unique identifier for the Seam workspace associated with the access code. */
+                workspace_id: string;
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
                 /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -105798,6 +106073,8 @@ type Routes = {
           
           - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) */
             access_code: {
+                /** Unique identifier for the Seam workspace associated with the access code. */
+                workspace_id: string;
                 /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
                 type: 'time_bound' | 'ongoing';
                 /** Unique identifier for the access code. */
@@ -107593,6 +107870,8 @@ type Routes = {
           
           - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) */
             access_code: {
+                /** Unique identifier for the Seam workspace associated with the access code. */
+                workspace_id: string;
                 /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
                 type: 'time_bound' | 'ongoing';
                 /** Unique identifier for the access code. */
@@ -108099,6 +108378,8 @@ type Routes = {
         formData: {};
         jsonResponse: {
             access_codes: {
+                /** Unique identifier for the Seam workspace associated with the access code. */
+                workspace_id: string;
                 /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
                 type: 'time_bound' | 'ongoing';
                 /** Unique identifier for the access code. */
@@ -119041,6 +119322,8 @@ type Routes = {
                     } | undefined;
                 }[] | undefined;
                 access_codes?: {
+                    /** Unique identifier for the Seam workspace associated with the access code. */
+                    workspace_id: string;
                     /** Unique identifier for a group of access codes that share the same code. */
                     common_code_key: string | null;
                     /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -119546,6 +119829,8 @@ type Routes = {
                     is_offline_access_code: boolean;
                 }[] | undefined;
                 unmanaged_access_codes?: {
+                    /** Unique identifier for the Seam workspace associated with the access code. */
+                    workspace_id: string;
                     /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
                     type: 'time_bound' | 'ongoing';
                     /** Unique identifier for the access code. */
@@ -131190,6 +131475,50 @@ type Routes = {
             };
         };
     };
+    '/customers/delete_data': {
+        route: '/customers/delete_data';
+        method: 'DELETE' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** List of space keys to delete. */
+            space_keys?: string[] | undefined;
+            /** List of property keys to delete. */
+            property_keys?: string[] | undefined;
+            /** List of room keys to delete. */
+            room_keys?: string[] | undefined;
+            /** List of common area keys to delete. */
+            common_area_keys?: string[] | undefined;
+            /** List of unit keys to delete. */
+            unit_keys?: string[] | undefined;
+            /** List of facility keys to delete. */
+            facility_keys?: string[] | undefined;
+            /** List of building keys to delete. */
+            building_keys?: string[] | undefined;
+            /** List of listing keys to delete. */
+            listing_keys?: string[] | undefined;
+            /** List of property listing keys to delete. */
+            property_listing_keys?: string[] | undefined;
+            /** List of guest keys to delete. */
+            guest_keys?: string[] | undefined;
+            /** List of tenant keys to delete. */
+            tenant_keys?: string[] | undefined;
+            /** List of resident keys to delete. */
+            resident_keys?: string[] | undefined;
+            /** List of user keys to delete. */
+            user_keys?: string[] | undefined;
+            /** List of user identity keys to delete. */
+            user_identity_keys?: string[] | undefined;
+            /** List of reservation keys to delete. */
+            reservation_keys?: string[] | undefined;
+            /** List of booking keys to delete. */
+            booking_keys?: string[] | undefined;
+            /** List of access grant keys to delete. */
+            access_grant_keys?: string[] | undefined;
+        };
+        formData: {};
+        jsonResponse: {};
+    };
     '/customers/push_data': {
         route: '/customers/push_data';
         method: 'POST';
@@ -184446,6 +184775,8 @@ type Routes = {
                     } | undefined;
                 }[] | undefined;
                 access_codes?: {
+                    /** Unique identifier for the Seam workspace associated with the access code. */
+                    workspace_id: string;
                     /** Unique identifier for a group of access codes that share the same code. */
                     common_code_key: string | null;
                     /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -184951,6 +185282,8 @@ type Routes = {
                     is_offline_access_code: boolean;
                 }[] | undefined;
                 unmanaged_access_codes?: {
+                    /** Unique identifier for the Seam workspace associated with the access code. */
+                    workspace_id: string;
                     /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
                     type: 'time_bound' | 'ongoing';
                     /** Unique identifier for the access code. */