@seamapi/types 1.384.0 → 1.385.0

package/dist/connect.cjs

@@ -3009,21 +3009,62 @@ var set_hvac_mode_action_attempt = zod.z.discriminatedUnion("status", [
   }).describe("Setting HVAC mode succeeded."),
   common_failed_action_attempt.extend({ action_type: action_type7, error: error8 }).describe("Setting HVAC mode failed.")
 ]);
-var action_type8 = zod.z.literal("UNLOCK_DOOR");
+var action_type8 = zod.z.literal("SIMULATE_KEYPAD_CODE_ENTRY");
 var error9 = zod.z.object({
   type: zod.z.string(),
   message: zod.z.string()
 });
 var result9 = zod.z.object({});
+var simulate_keypad_code_entry_action_attempt = zod.z.discriminatedUnion(
+  "status",
+  [
+    common_pending_action_attempt.extend({
+      action_type: action_type8
+    }).describe("Simulating keypad code entry."),
+    common_succeeded_action_attempt.extend({
+      action_type: action_type8,
+      result: result9
+    }).describe("Simulating keypad code entry succeeded."),
+    common_failed_action_attempt.extend({
+      action_type: action_type8,
+      error: error9
+    }).describe("Simulating keypad code entry failed.")
+  ]
+);
+var action_type9 = zod.z.literal("SIMULATE_MANUAL_LOCK_VIA_KEYPAD");
+var error10 = zod.z.object({
+  type: zod.z.string(),
+  message: zod.z.string()
+});
+var result10 = zod.z.object({});
+var simulate_manual_lock_via_keypad_action_attempt = zod.z.discriminatedUnion("status", [
+  common_pending_action_attempt.extend({
+    action_type: action_type9
+  }).describe("Simulating manual lock via keypad."),
+  common_succeeded_action_attempt.extend({
+    action_type: action_type9,
+    result: result10
+  }).describe("Simulating manual lock via keypad succeeded."),
+  common_failed_action_attempt.extend({
+    action_type: action_type9,
+    error: error10
+  }).describe("Simulating manual lock via keypad failed.")
+]);
+var action_type10 = zod.z.literal("UNLOCK_DOOR");
+var error11 = zod.z.object({
+  type: zod.z.string(),
+  message: zod.z.string()
+});
+var result11 = zod.z.object({});
 var unlock_door_action_attempt = zod.z.discriminatedUnion("status", [
   common_pending_action_attempt.extend({
-    action_type: action_type8
+    action_type: action_type10
   }).describe("Unlocking door."),
   common_succeeded_action_attempt.extend({
-    action_type: action_type8,
-    result: result9
+    action_type: action_type10,
+    result: result11
   }).describe("Unlocking door succeeded."),
-  common_failed_action_attempt.extend({ action_type: action_type8, error: error9 }).describe("Unlocking door failed.")
+  common_failed_action_attempt.extend({ action_type: action_type10, error: error11 }).describe("Unlocking door failed.")
 ]);
 
 // src/lib/seam/connect/models/action-attempts/action-attempt.ts
@@ -3036,6 +3077,8 @@ var action_attempt = zod.z.union([
   ...set_fan_mode_action_attempt.options,
   ...set_hvac_mode_action_attempt.options,
   ...activate_climate_preset_action_attempt.options,
+  ...simulate_keypad_code_entry_action_attempt.options,
+  ...simulate_manual_lock_via_keypad_action_attempt.options,
   ...deprecated_action_attempts
 ]).describe(`
   ---
@@ -9466,6 +9509,194 @@ var openapi_default = {
             ],
             type: "object"
           },
+          {
+            description: "Simulating keypad code entry.",
+            properties: {
+              action_attempt_id: {
+                description: "ID of the action attempt.",
+                format: "uuid",
+                type: "string"
+              },
+              action_type: {
+                enum: ["SIMULATE_KEYPAD_CODE_ENTRY"],
+                type: "string"
+              },
+              error: {
+                description: "Errors associated with the action attempt. Null for pending action attempts.",
+                nullable: true
+              },
+              result: {
+                description: "Result of the action attempt. Null for pending action attempts.",
+                nullable: true
+              },
+              status: { enum: ["pending"], type: "string" }
+            },
+            required: [
+              "action_attempt_id",
+              "status",
+              "result",
+              "error",
+              "action_type"
+            ],
+            type: "object"
+          },
+          {
+            description: "Simulating keypad code entry succeeded.",
+            properties: {
+              action_attempt_id: {
+                description: "ID of the action attempt.",
+                format: "uuid",
+                type: "string"
+              },
+              action_type: {
+                enum: ["SIMULATE_KEYPAD_CODE_ENTRY"],
+                type: "string"
+              },
+              error: {
+                description: "Errors associated with the action attempt. Null for successful action attempts.",
+                nullable: true
+              },
+              result: { properties: {}, type: "object" },
+              status: { enum: ["success"], type: "string" }
+            },
+            required: [
+              "action_attempt_id",
+              "status",
+              "error",
+              "action_type",
+              "result"
+            ],
+            type: "object"
+          },
+          {
+            description: "Simulating keypad code entry failed.",
+            properties: {
+              action_attempt_id: {
+                description: "ID of the action attempt.",
+                format: "uuid",
+                type: "string"
+              },
+              action_type: {
+                enum: ["SIMULATE_KEYPAD_CODE_ENTRY"],
+                type: "string"
+              },
+              error: {
+                properties: {
+                  message: { type: "string" },
+                  type: { type: "string" }
+                },
+                required: ["type", "message"],
+                type: "object"
+              },
+              result: {
+                description: "Result of the action attempt. Null for failed action attempts.",
+                nullable: true
+              },
+              status: { enum: ["error"], type: "string" }
+            },
+            required: [
+              "action_attempt_id",
+              "status",
+              "result",
+              "action_type",
+              "error"
+            ],
+            type: "object"
+          },
+          {
+            description: "Simulating manual lock via keypad.",
+            properties: {
+              action_attempt_id: {
+                description: "ID of the action attempt.",
+                format: "uuid",
+                type: "string"
+              },
+              action_type: {
+                enum: ["SIMULATE_MANUAL_LOCK_VIA_KEYPAD"],
+                type: "string"
+              },
+              error: {
+                description: "Errors associated with the action attempt. Null for pending action attempts.",
+                nullable: true
+              },
+              result: {
+                description: "Result of the action attempt. Null for pending action attempts.",
+                nullable: true
+              },
+              status: { enum: ["pending"], type: "string" }
+            },
+            required: [
+              "action_attempt_id",
+              "status",
+              "result",
+              "error",
+              "action_type"
+            ],
+            type: "object"
+          },
+          {
+            description: "Simulating manual lock via keypad succeeded.",
+            properties: {
+              action_attempt_id: {
+                description: "ID of the action attempt.",
+                format: "uuid",
+                type: "string"
+              },
+              action_type: {
+                enum: ["SIMULATE_MANUAL_LOCK_VIA_KEYPAD"],
+                type: "string"
+              },
+              error: {
+                description: "Errors associated with the action attempt. Null for successful action attempts.",
+                nullable: true
+              },
+              result: { properties: {}, type: "object" },
+              status: { enum: ["success"], type: "string" }
+            },
+            required: [
+              "action_attempt_id",
+              "status",
+              "error",
+              "action_type",
+              "result"
+            ],
+            type: "object"
+          },
+          {
+            description: "Simulating manual lock via keypad failed.",
+            properties: {
+              action_attempt_id: {
+                description: "ID of the action attempt.",
+                format: "uuid",
+                type: "string"
+              },
+              action_type: {
+                enum: ["SIMULATE_MANUAL_LOCK_VIA_KEYPAD"],
+                type: "string"
+              },
+              error: {
+                properties: {
+                  message: { type: "string" },
+                  type: { type: "string" }
+                },
+                required: ["type", "message"],
+                type: "object"
+              },
+              result: {
+                description: "Result of the action attempt. Null for failed action attempts.",
+                nullable: true
+              },
+              status: { enum: ["error"], type: "string" }
+            },
+            required: [
+              "action_attempt_id",
+              "status",
+              "result",
+              "action_type",
+              "error"
+            ],
+            type: "object"
+          },
           {
             properties: {
               action_attempt_id: {
@@ -27158,98 +27389,6 @@ var openapi_default = {
         "x-response-key": "device_providers"
       }
     },
-    "/devices/simulate/access_code_lock": {
-      post: {
-        operationId: "devicesSimulateAccessCodeLockPost",
-        requestBody: {
-          content: {
-            "application/json": {
-              schema: {
-                properties: {
-                  access_code_id: { format: "uuid", type: "string" },
-                  device_id: { format: "uuid", type: "string" }
-                },
-                required: ["device_id", "access_code_id"],
-                type: "object"
-              }
-            }
-          }
-        },
-        responses: {
-          200: {
-            content: {
-              "application/json": {
-                schema: {
-                  properties: { ok: { type: "boolean" } },
-                  required: ["ok"],
-                  type: "object"
-                }
-              }
-            },
-            description: "OK"
-          },
-          400: { description: "Bad Request" },
-          401: { description: "Unauthorized" }
-        },
-        security: [
-          { api_key: [] },
-          { pat_with_workspace: [] },
-          { console_session_with_workspace: [] }
-        ],
-        summary: "/devices/simulate/access_code_lock",
-        tags: ["/devices"],
-        "x-fern-sdk-group-name": ["devices", "simulate"],
-        "x-fern-sdk-method-name": "access_code_lock",
-        "x-response-key": null,
-        "x-undocumented": "Unreleased."
-      }
-    },
-    "/devices/simulate/access_code_unlock": {
-      post: {
-        operationId: "devicesSimulateAccessCodeUnlockPost",
-        requestBody: {
-          content: {
-            "application/json": {
-              schema: {
-                properties: {
-                  access_code_id: { format: "uuid", type: "string" },
-                  device_id: { format: "uuid", type: "string" }
-                },
-                required: ["device_id", "access_code_id"],
-                type: "object"
-              }
-            }
-          }
-        },
-        responses: {
-          200: {
-            content: {
-              "application/json": {
-                schema: {
-                  properties: { ok: { type: "boolean" } },
-                  required: ["ok"],
-                  type: "object"
-                }
-              }
-            },
-            description: "OK"
-          },
-          400: { description: "Bad Request" },
-          401: { description: "Unauthorized" }
-        },
-        security: [
-          { api_key: [] },
-          { pat_with_workspace: [] },
-          { console_session_with_workspace: [] }
-        ],
-        summary: "/devices/simulate/access_code_unlock",
-        tags: ["/devices"],
-        "x-fern-sdk-group-name": ["devices", "simulate"],
-        "x-fern-sdk-method-name": "access_code_unlock",
-        "x-response-key": null,
-        "x-undocumented": "Unreleased."
-      }
-    },
     "/devices/simulate/connect": {
       post: {
         operationId: "devicesSimulateConnectPost",
@@ -28583,6 +28722,108 @@ var openapi_default = {
         "x-response-key": "action_attempt"
       }
     },
+    "/locks/simulate/keypad_code_entry": {
+      post: {
+        operationId: "locksSimulateKeypadCodeEntryPost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  code: { type: "string" },
+                  device_id: { format: "uuid", type: "string" }
+                },
+                required: ["device_id", "code"],
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    action_attempt: {
+                      $ref: "#/components/schemas/access_code"
+                    },
+                    ok: { type: "boolean" }
+                  },
+                  required: ["ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [
+          { api_key: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] }
+        ],
+        summary: "/locks/simulate/keypad_code_entry",
+        tags: ["/locks"],
+        "x-action-attempt-type": "SIMULATE_KEYPAD_CODE_ENTRY",
+        "x-fern-sdk-group-name": ["locks", "simulate"],
+        "x-fern-sdk-method-name": "keypad_code_entry",
+        "x-fern-sdk-return-value": "action_attempt",
+        "x-response-key": "action_attempt",
+        "x-undocumented": "Unreleased."
+      }
+    },
+    "/locks/simulate/manual_lock_via_keypad": {
+      post: {
+        operationId: "locksSimulateManualLockViaKeypadPost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: { device_id: { format: "uuid", type: "string" } },
+                required: ["device_id"],
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    action_attempt: {
+                      $ref: "#/components/schemas/access_code"
+                    },
+                    ok: { type: "boolean" }
+                  },
+                  required: ["ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [
+          { api_key: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] }
+        ],
+        summary: "/locks/simulate/manual_lock_via_keypad",
+        tags: ["/locks"],
+        "x-action-attempt-type": "SIMULATE_MANUAL_LOCK_VIA_KEYPAD",
+        "x-fern-sdk-group-name": ["locks", "simulate"],
+        "x-fern-sdk-method-name": "manual_lock_via_keypad",
+        "x-response-key": null,
+        "x-undocumented": "Unreleased."
+      }
+    },
     "/locks/unlock_door": {
       post: {
         operationId: "locksUnlockDoorPost",
@@ -30651,6 +30892,62 @@ var openapi_default = {
         "x-undocumented": "Seam Bridge Client only."
       }
     },
+    "/seam/instant_key/v1/client_sessions/exchange_short_code": {
+      post: {
+        description: "Exchanges a short code for a Client Session Token (CST).\nThis endpoint is used by mobile apps to securely retrieve a client session token \nusing a short code obtained from an instant key URL.",
+        operationId: "seamInstantKeyV1ClientSessionsExchangeShortCodePost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  short_code: {
+                    description: "The short code to exchange for a client session token",
+                    type: "string"
+                  }
+                },
+                required: ["short_code"],
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    client_session: {
+                      $ref: "#/components/schemas/client_session"
+                    },
+                    ok: { type: "boolean" }
+                  },
+                  required: ["client_session", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [{ certified_client: [] }],
+        summary: "/seam/instant_key/v1/client_sessions/exchange_short_code",
+        tags: ["/client_sessions"],
+        "x-fern-sdk-group-name": [
+          "seam",
+          "instant_key",
+          "v1",
+          "client_sessions"
+        ],
+        "x-fern-sdk-method-name": "exchange_short_code",
+        "x-fern-sdk-return-value": "client_session",
+        "x-response-key": "client_session",
+        "x-title": "Exchange Instant Key Short Code"
+      }
+    },
     "/thermostats/activate_climate_preset": {
       post: {
         description: "Activates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
@@ -32684,20 +32981,6 @@ var openapi_default = {
                   },
                   {
                     properties: {
-                      desired_access_methods: {
-                        items: {
-                          properties: {
-                            mode: {
-                              description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
-                              enum: ["code", "card", "mobile_key"],
-                              type: "string"
-                            }
-                          },
-                          required: ["mode"],
-                          type: "object"
-                        },
-                        type: "array"
-                      },
                       ends_at: {
                         description: "Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
                         format: "date-time",
@@ -32717,6 +33000,10 @@ var openapi_default = {
                             description: "Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to add to the location to which access is being granted.",
                             items: { format: "uuid", type: "string" },
                             type: "array"
+                          },
+                          name: {
+                            description: "Name of the location.",
+                            type: "string"
                           }
                         },
                         type: "object"
@@ -32726,13 +33013,27 @@ var openapi_default = {
                         items: { format: "uuid", type: "string" },
                         type: "array"
                       },
+                      requested_access_methods: {
+                        items: {
+                          properties: {
+                            mode: {
+                              description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
+                              enum: ["code", "card", "mobile_key"],
+                              type: "string"
+                            }
+                          },
+                          required: ["mode"],
+                          type: "object"
+                        },
+                        type: "array"
+                      },
                       starts_at: {
                         description: "Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
                         format: "date-time",
                         type: "string"
                       }
                     },
-                    required: ["desired_access_methods"],
+                    required: ["requested_access_methods"],
                     type: "object"
                   }
                 ]
@@ -32753,6 +33054,11 @@ var openapi_default = {
                           format: "uuid",
                           type: "string"
                         },
+                        access_method_ids: {
+                          description: "IDs of the access methods that were created for this access grant.",
+                          items: { format: "uuid", type: "string" },
+                          type: "array"
+                        },
                         created_at: {
                           description: "Date and time at which the access grant was created.",
                           format: "date-time",
@@ -32771,6 +33077,11 @@ var openapi_default = {
                           description: "Access methods that the user requested for this access grant.",
                           items: {
                             properties: {
+                              created_access_method_ids: {
+                                description: "IDs of the access methods that were created for this requested access method.",
+                                items: { format: "uuid", type: "string" },
+                                type: "array"
+                              },
                               created_at: {
                                 description: "Date and time at which the requested access method was added to this access grant.",
                                 format: "date-time",
@@ -32784,18 +33095,13 @@ var openapi_default = {
                                 description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
                                 enum: ["code", "card", "mobile_key"],
                                 type: "string"
-                              },
-                              provisioned_access_method_ids: {
-                                description: "IDs of the locations to which access is being given.",
-                                items: { format: "uuid", type: "string" },
-                                type: "array"
                               }
                             },
                             required: [
                               "display_name",
                               "mode",
                               "created_at",
-                              "provisioned_access_method_ids"
+                              "created_access_method_ids"
                             ],
                             type: "object",
                             "x-undocumented": "Unreleased."
@@ -32819,6 +33125,7 @@ var openapi_default = {
                         "user_identity_id",
                         "location_ids",
                         "requested_access_methods",
+                        "access_method_ids",
                         "display_name",
                         "created_at"
                       ],
@@ -32886,6 +33193,11 @@ var openapi_default = {
                           format: "uuid",
                           type: "string"
                         },
+                        access_method_ids: {
+                          description: "IDs of the access methods that were created for this access grant.",
+                          items: { format: "uuid", type: "string" },
+                          type: "array"
+                        },
                         created_at: {
                           description: "Date and time at which the access grant was created.",
                           format: "date-time",
@@ -32904,6 +33216,11 @@ var openapi_default = {
                           description: "Access methods that the user requested for this access grant.",
                           items: {
                             properties: {
+                              created_access_method_ids: {
+                                description: "IDs of the access methods that were created for this requested access method.",
+                                items: { format: "uuid", type: "string" },
+                                type: "array"
+                              },
                               created_at: {
                                 description: "Date and time at which the requested access method was added to this access grant.",
                                 format: "date-time",
@@ -32917,18 +33234,13 @@ var openapi_default = {
                                 description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
                                 enum: ["code", "card", "mobile_key"],
                                 type: "string"
-                              },
-                              provisioned_access_method_ids: {
-                                description: "IDs of the locations to which access is being given.",
-                                items: { format: "uuid", type: "string" },
-                                type: "array"
                               }
                             },
                             required: [
                               "display_name",
                               "mode",
                               "created_at",
-                              "provisioned_access_method_ids"
+                              "created_access_method_ids"
                             ],
                             type: "object",
                             "x-undocumented": "Unreleased."
@@ -32952,6 +33264,7 @@ var openapi_default = {
                         "user_identity_id",
                         "location_ids",
                         "requested_access_methods",
+                        "access_method_ids",
                         "display_name",
                         "created_at"
                       ],
@@ -33034,6 +33347,11 @@ var openapi_default = {
                             format: "uuid",
                             type: "string"
                           },
+                          access_method_ids: {
+                            description: "IDs of the access methods that were created for this access grant.",
+                            items: { format: "uuid", type: "string" },
+                            type: "array"
+                          },
                           created_at: {
                             description: "Date and time at which the access grant was created.",
                             format: "date-time",
@@ -33052,6 +33370,11 @@ var openapi_default = {
                             description: "Access methods that the user requested for this access grant.",
                             items: {
                               properties: {
+                                created_access_method_ids: {
+                                  description: "IDs of the access methods that were created for this requested access method.",
+                                  items: { format: "uuid", type: "string" },
+                                  type: "array"
+                                },
                                 created_at: {
                                   description: "Date and time at which the requested access method was added to this access grant.",
                                   format: "date-time",
@@ -33065,18 +33388,13 @@ var openapi_default = {
                                   description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
                                   enum: ["code", "card", "mobile_key"],
                                   type: "string"
-                                },
-                                provisioned_access_method_ids: {
-                                  description: "IDs of the locations to which access is being given.",
-                                  items: { format: "uuid", type: "string" },
-                                  type: "array"
                                 }
                               },
                               required: [
                                 "display_name",
                                 "mode",
                                 "created_at",
-                                "provisioned_access_method_ids"
+                                "created_access_method_ids"
                               ],
                               type: "object",
                               "x-undocumented": "Unreleased."
@@ -33100,6 +33418,7 @@ var openapi_default = {
                           "user_identity_id",
                           "location_ids",
                           "requested_access_methods",
+                          "access_method_ids",
                           "display_name",
                           "created_at"
                         ],
@@ -33135,10 +33454,10 @@ var openapi_default = {
         "x-undocumented": "Unreleased."
       }
     },
-    "/unstable_access_grants/list_access_methods": {
+    "/unstable_access_methods/list": {
       post: {
-        description: "List all access methods for an access grant.",
-        operationId: "unstableAccessGrantsListAccessMethodsPost",
+        description: "List all access methods, usually filtered by access grant.",
+        operationId: "unstableAccessMethodsListPost",
         requestBody: {
           content: {
             "application/json": {
@@ -33226,13 +33545,13 @@ var openapi_default = {
           { console_session_with_workspace: [] },
           { api_key: [] }
         ],
-        summary: "/unstable_access_grants/list_access_methods",
+        summary: "/unstable_access_methods/list",
         tags: [],
-        "x-fern-sdk-group-name": ["unstable_access_grants"],
-        "x-fern-sdk-method-name": "list_access_methods",
+        "x-fern-sdk-group-name": ["unstable_access_methods"],
+        "x-fern-sdk-method-name": "list",
         "x-fern-sdk-return-value": "access_methods",
         "x-response-key": "access_methods",
-        "x-title": "Get the Access Methods for an Access Grant",
+        "x-title": "List Access Methods",
         "x-undocumented": "Unreleased."
       }
     },