@seamapi/types 1.502.0 → 1.503.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;
@@ -101312,6 +101338,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 +101894,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 +103704,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 +104233,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 +104769,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 +105283,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 +105836,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 +107633,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 +108141,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 +119085,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 +119592,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. */
@@ -184446,6 +184494,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 +185001,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. */

package/dist/index.cjs

@@ -2112,6 +2112,9 @@ zod.z.object({
   kwikset_unable_to_confirm_code_warning: kwikset_unable_to_confirm_code_warning.optional().nullable()
 });
 var access_code = zod.z.object({
+  workspace_id: zod.z.string().uuid().describe(
+    "Unique identifier for the Seam workspace associated with the access code."
+  ),
   common_code_key: zod.z.string().nullable().describe(
     "Unique identifier for a group of access codes that share the same code."
   ),
@@ -2219,6 +2222,7 @@ var access_code = zod.z.object({
   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\u2014and you do not need to be near the locks\u2014to 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.
 `);
 var unmanaged_access_code = access_code.pick({
+  workspace_id: true,
   type: true,
   access_code_id: true,
   device_id: true,
@@ -7075,9 +7079,15 @@ var openapi_default = {
               provider_metadata: { name: "Provider Metadata" },
               thermostats: { name: "Thermostats" }
             }
+          },
+          workspace_id: {
+            description: "Unique identifier for the Seam workspace associated with the access code.",
+            format: "uuid",
+            type: "string"
           }
         },
         required: [
+          "workspace_id",
           "common_code_key",
           "type",
           "access_code_id",
@@ -25490,9 +25500,15 @@ var openapi_default = {
               provider_metadata: { name: "Provider Metadata" },
               thermostats: { name: "Thermostats" }
             }
+          },
+          workspace_id: {
+            description: "Unique identifier for the Seam workspace associated with the access code.",
+            format: "uuid",
+            type: "string"
           }
         },
         required: [
+          "workspace_id",
           "type",
           "access_code_id",
           "device_id",