@seamapi/types 1.476.0 → 1.478.0

package/dist/index.cjs

@@ -2268,6 +2268,53 @@ var unmanaged_access_code = access_code.pick({
     
     - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks)
   `);
+var requested_access_method = zod.z.object({
+  display_name: zod.z.string().describe("Display name of the access method."),
+  mode: zod.z.enum(["code", "card", "mobile_key"]).describe(
+    "Access method mode. Supported values: `code`, `card`, `mobile_key`."
+  ),
+  created_at: zod.z.string().datetime().describe(
+    "Date and time at which the requested access method was added to the Access Grant."
+  ),
+  created_access_method_ids: zod.z.array(zod.z.string().uuid()).describe(
+    "IDs of the access methods created for the requested access method."
+  )
+});
+
+// src/lib/seam/connect/models/access-grants/access-grant.ts
+var access_grant = zod.z.object({
+  workspace_id: zod.z.string().uuid().describe("ID of the Seam workspace associated with the Access Grant."),
+  access_grant_id: zod.z.string().uuid().describe("ID of the Access Grant."),
+  access_grant_key: zod.z.string().optional().describe("Unique key for the access grant within the workspace."),
+  user_identity_id: zod.z.string().uuid().describe("ID of user identity to which the Access Grant gives access."),
+  location_ids: zod.z.array(zod.z.string().uuid()).describe(`
+    ---
+    deprecated: Use \`space_ids\`.
+    ---
+  `),
+  space_ids: zod.z.array(zod.z.string().uuid()).describe("IDs of the spaces to which the Access Grant gives access."),
+  requested_access_methods: zod.z.array(requested_access_method).describe("Access methods that the user requested for the Access Grant."),
+  access_method_ids: zod.z.array(zod.z.string().uuid()).describe("IDs of the access methods created for the Access Grant."),
+  client_session_token: zod.z.string().optional().describe(
+    "Client Session Token. Only returned if the Access Grant has a mobile_key access method."
+  ),
+  name: zod.z.string().nullable().describe(
+    "Name of the Access Grant. If not provided, the display name will be computed."
+  ),
+  display_name: zod.z.string().describe("Display name of the Access Grant."),
+  instant_key_url: zod.z.string().url().optional().describe(
+    "Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. "
+  ),
+  created_at: zod.z.string().datetime().describe("Date and time at which the Access Grant was created."),
+  starts_at: zod.z.string().datetime().describe("Date and time at which the Access Grant starts."),
+  ends_at: zod.z.string().datetime().nullable().describe("Date and time at which the Access Grant ends.")
+}).describe(`
+  ---
+  draft: Early access.
+  route_path: /access_grants
+  ---
+  Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant.
+  `);
 var access_method = zod.z.object({
   workspace_id: zod.z.string().uuid().describe("ID of the Seam workspace associated with the access method."),
   access_method_id: zod.z.string().uuid().describe("ID of the access method."),
@@ -4161,7 +4208,8 @@ zod.z.object({
   unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
   unmanaged_devices: unmanaged_device.array().optional(),
   connect_webviews: connect_webview.array().optional(),
-  access_methods: access_method.array().optional()
+  access_methods: access_method.array().optional(),
+  access_grants: access_grant.array().optional()
 }).describe("A batch of workspace resources.");
 var batch = zod.z.object({
   batch_type: zod.z.enum([
@@ -4185,7 +4233,8 @@ var batch = zod.z.object({
   unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
   unmanaged_devices: unmanaged_device.array().optional(),
   connect_webviews: connect_webview.array().optional(),
-  access_methods: access_method.array().optional()
+  access_methods: access_method.array().optional(),
+  access_grants: access_grant.array().optional()
 }).describe("A batch of workspace resources.");
 var bridge = zod.z.object({
   bridge_id: zod.z.string().uuid().describe("ID of Seam Bridge."),
@@ -4265,12 +4314,20 @@ var bridge_client_session = zod.z.object({
   Represents a [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.
 `);
 var customization_profile = zod.z.object({
-  workspace_id: zod.z.string().uuid(),
   customization_profile_id: zod.z.string().uuid(),
-  logo_url: zod.z.string().optional(),
+  workspace_id: zod.z.string().uuid(),
+  created_at: zod.z.string().datetime(),
+  logo_url: zod.z.string().url().optional(),
   primary_color: zod.z.string().optional(),
   secondary_color: zod.z.string().optional()
-});
+}).describe(`
+  ---
+  title: Customization Profile
+  undocumented: Unreleased.
+  route_path: /workspaces/customization_profiles
+  ---
+  A customization profile.
+`);
 var common_event = zod.z.object({
   event_id: zod.z.string().uuid().describe("ID of the event."),
   workspace_id: zod.z.string().uuid().describe(
@@ -31721,6 +31778,10 @@ var openapi_default = {
                     batch: {
                       description: "A batch of workspace resources.",
                       properties: {
+                        access_grants: {
+                          items: { $ref: "#/components/schemas/access_grant" },
+                          type: "array"
+                        },
                         access_methods: {
                           items: { $ref: "#/components/schemas/access_method" },
                           type: "array"
@@ -31882,6 +31943,10 @@ var openapi_default = {
                     batch: {
                       description: "A batch of workspace resources.",
                       properties: {
+                        access_grants: {
+                          items: { $ref: "#/components/schemas/access_grant" },
+                          type: "array"
+                        },
                         access_methods: {
                           items: { $ref: "#/components/schemas/access_method" },
                           type: "array"
@@ -57264,18 +57329,27 @@ var openapi_default = {
                 schema: {
                   properties: {
                     customization_profile: {
+                      description: "A customization profile.",
                       properties: {
+                        created_at: { format: "date-time", type: "string" },
                         customization_profile_id: {
                           format: "uuid",
                           type: "string"
                         },
-                        logo_url: { type: "string" },
+                        logo_url: { format: "uri", type: "string" },
                         primary_color: { type: "string" },
                         secondary_color: { type: "string" },
                         workspace_id: { format: "uuid", type: "string" }
                       },
-                      required: ["workspace_id", "customization_profile_id"],
-                      type: "object"
+                      required: [
+                        "customization_profile_id",
+                        "workspace_id",
+                        "created_at"
+                      ],
+                      type: "object",
+                      "x-route-path": "/workspaces/customization_profiles",
+                      "x-title": "Customization Profile",
+                      "x-undocumented": "Unreleased."
                     },
                     ok: { type: "boolean" }
                   },
@@ -57296,7 +57370,8 @@ var openapi_default = {
         "x-fern-sdk-method-name": "create",
         "x-fern-sdk-return-value": "customization_profile",
         "x-response-key": "customization_profile",
-        "x-title": "Update Customization Profile"
+        "x-title": "Update Customization Profile",
+        "x-undocumented": "Unreleased."
       }
     },
     "/workspaces/customization_profiles/get": {
@@ -57318,18 +57393,27 @@ var openapi_default = {
                 schema: {
                   properties: {
                     customization_profile: {
+                      description: "A customization profile.",
                       properties: {
+                        created_at: { format: "date-time", type: "string" },
                         customization_profile_id: {
                           format: "uuid",
                           type: "string"
                         },
-                        logo_url: { type: "string" },
+                        logo_url: { format: "uri", type: "string" },
                         primary_color: { type: "string" },
                         secondary_color: { type: "string" },
                         workspace_id: { format: "uuid", type: "string" }
                       },
-                      required: ["workspace_id", "customization_profile_id"],
-                      type: "object"
+                      required: [
+                        "customization_profile_id",
+                        "workspace_id",
+                        "created_at"
+                      ],
+                      type: "object",
+                      "x-route-path": "/workspaces/customization_profiles",
+                      "x-title": "Customization Profile",
+                      "x-undocumented": "Unreleased."
                     },
                     ok: { type: "boolean" }
                   },
@@ -57350,7 +57434,8 @@ var openapi_default = {
         "x-fern-sdk-method-name": "get",
         "x-fern-sdk-return-value": "customization_profile",
         "x-response-key": "customization_profile",
-        "x-title": "Get Customization Profile"
+        "x-title": "Get Customization Profile",
+        "x-undocumented": "Unreleased."
       },
       post: {
         description: "Retrieves the customization profile for the workspace.",
@@ -57375,18 +57460,27 @@ var openapi_default = {
                 schema: {
                   properties: {
                     customization_profile: {
+                      description: "A customization profile.",
                       properties: {
+                        created_at: { format: "date-time", type: "string" },
                         customization_profile_id: {
                           format: "uuid",
                           type: "string"
                         },
-                        logo_url: { type: "string" },
+                        logo_url: { format: "uri", type: "string" },
                         primary_color: { type: "string" },
                         secondary_color: { type: "string" },
                         workspace_id: { format: "uuid", type: "string" }
                       },
-                      required: ["workspace_id", "customization_profile_id"],
-                      type: "object"
+                      required: [
+                        "customization_profile_id",
+                        "workspace_id",
+                        "created_at"
+                      ],
+                      type: "object",
+                      "x-route-path": "/workspaces/customization_profiles",
+                      "x-title": "Customization Profile",
+                      "x-undocumented": "Unreleased."
                     },
                     ok: { type: "boolean" }
                   },
@@ -57407,7 +57501,8 @@ var openapi_default = {
         "x-fern-sdk-method-name": "get",
         "x-fern-sdk-return-value": "customization_profile",
         "x-response-key": "customization_profile",
-        "x-title": "Get Customization Profile"
+        "x-title": "Get Customization Profile",
+        "x-undocumented": "Unreleased."
       }
     },
     "/workspaces/customization_profiles/list": {
@@ -57422,18 +57517,27 @@ var openapi_default = {
                   properties: {
                     customization_profiles: {
                       items: {
+                        description: "A customization profile.",
                         properties: {
+                          created_at: { format: "date-time", type: "string" },
                           customization_profile_id: {
                             format: "uuid",
                             type: "string"
                           },
-                          logo_url: { type: "string" },
+                          logo_url: { format: "uri", type: "string" },
                           primary_color: { type: "string" },
                           secondary_color: { type: "string" },
                           workspace_id: { format: "uuid", type: "string" }
                         },
-                        required: ["workspace_id", "customization_profile_id"],
-                        type: "object"
+                        required: [
+                          "customization_profile_id",
+                          "workspace_id",
+                          "created_at"
+                        ],
+                        type: "object",
+                        "x-route-path": "/workspaces/customization_profiles",
+                        "x-title": "Customization Profile",
+                        "x-undocumented": "Unreleased."
                       },
                       type: "array"
                     },
@@ -57456,7 +57560,8 @@ var openapi_default = {
         "x-fern-sdk-method-name": "list",
         "x-fern-sdk-return-value": "customization_profiles",
         "x-response-key": "customization_profiles",
-        "x-title": "Get Customization Profile"
+        "x-title": "Get Customization Profile",
+        "x-undocumented": "Unreleased."
       },
       post: {
         description: "Retrieves the customization profile for the workspace.",
@@ -57469,18 +57574,27 @@ var openapi_default = {
                   properties: {
                     customization_profiles: {
                       items: {
+                        description: "A customization profile.",
                         properties: {
+                          created_at: { format: "date-time", type: "string" },
                           customization_profile_id: {
                             format: "uuid",
                             type: "string"
                           },
-                          logo_url: { type: "string" },
+                          logo_url: { format: "uri", type: "string" },
                           primary_color: { type: "string" },
                           secondary_color: { type: "string" },
                           workspace_id: { format: "uuid", type: "string" }
                         },
-                        required: ["workspace_id", "customization_profile_id"],
-                        type: "object"
+                        required: [
+                          "customization_profile_id",
+                          "workspace_id",
+                          "created_at"
+                        ],
+                        type: "object",
+                        "x-route-path": "/workspaces/customization_profiles",
+                        "x-title": "Customization Profile",
+                        "x-undocumented": "Unreleased."
                       },
                       type: "array"
                     },
@@ -57503,7 +57617,8 @@ var openapi_default = {
         "x-fern-sdk-method-name": "list",
         "x-fern-sdk-return-value": "customization_profiles",
         "x-response-key": "customization_profiles",
-        "x-title": "Get Customization Profile"
+        "x-title": "Get Customization Profile",
+        "x-undocumented": "Unreleased."
       }
     },
     "/workspaces/customization_profiles/update": {
@@ -57547,7 +57662,8 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["workspaces", "customization_profiles"],
         "x-fern-sdk-method-name": "update",
         "x-response-key": null,
-        "x-title": "Update Customization Profile"
+        "x-title": "Update Customization Profile",
+        "x-undocumented": "Unreleased."
       },
       post: {
         description: "Updates the customization profile for the workspace.",
@@ -57589,7 +57705,8 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["workspaces", "customization_profiles"],
         "x-fern-sdk-method-name": "update",
         "x-response-key": null,
-        "x-title": "Update Customization Profile"
+        "x-title": "Update Customization Profile",
+        "x-undocumented": "Unreleased."
       }
     },
     "/workspaces/customization_profiles/upload_images": {
@@ -57619,7 +57736,7 @@ var openapi_default = {
         "x-fern-sdk-method-name": "upload_images",
         "x-response-key": null,
         "x-title": "Upload Customization Profile Logo",
-        "x-undocumented": "Internal endpoint for customer portals."
+        "x-undocumented": "Internal form-data endpoint for Console and Customer Portal."
       }
     },
     "/workspaces/find_resources": {
@@ -57643,6 +57760,10 @@ var openapi_default = {
                     batch: {
                       description: "A batch of workspace resources.",
                       properties: {
+                        access_grants: {
+                          items: { $ref: "#/components/schemas/access_grant" },
+                          type: "array"
+                        },
                         access_methods: {
                           items: { $ref: "#/components/schemas/access_method" },
                           type: "array"
@@ -57781,6 +57902,10 @@ var openapi_default = {
                     batch: {
                       description: "A batch of workspace resources.",
                       properties: {
+                        access_grants: {
+                          items: { $ref: "#/components/schemas/access_grant" },
+                          type: "array"
+                        },
                         access_methods: {
                           items: { $ref: "#/components/schemas/access_method" },
                           type: "array"