@seamapi/types 1.473.0 → 1.475.0

package/dist/connect.cjs

@@ -30,6 +30,7 @@ __export(schemas_exports, {
   connect_webview: () => connect_webview,
   connected_account: () => connected_account,
   custom_metadata: () => custom_metadata,
+  customization_profile: () => customization_profile,
   device: () => device,
   device_provider: () => device_provider,
   instant_key: () => instant_key,
@@ -2265,6 +2266,29 @@ var unmanaged_access_code = access_code.pick({
     
     - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks)
   `);
+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."),
+  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 access method was created."),
+  issued_at: zod.z.string().datetime().nullable().describe("Date and time at which the access method was issued."),
+  is_issued: zod.z.boolean().describe("Indicates whether the access method has been issued."),
+  instant_key_url: zod.z.string().url().optional().describe("URL of the Instant Key for mobile key access methods."),
+  client_session_token: zod.z.string().optional().describe("Token of the client session associated with the access method."),
+  is_encoding_required: zod.z.boolean().optional().describe(
+    "Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method."
+  ),
+  code: zod.z.string().optional().describe("The actual PIN code for code access methods.")
+}).describe(`
+  ---
+  draft: Early access.
+  route_path: /access_methods
+  ---
+  Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.
+  `);
 var acs_access_group_external_type = zod.z.enum([
   "pti_unit",
   "pti_access_level",
@@ -4134,7 +4158,8 @@ zod.z.object({
   unmanaged_acs_users: unmanaged_acs_user.array().optional(),
   unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
   unmanaged_devices: unmanaged_device.array().optional(),
-  connect_webviews: connect_webview.array().optional()
+  connect_webviews: connect_webview.array().optional(),
+  access_methods: access_method.array().optional()
 }).describe("A batch of workspace resources.");
 var batch = zod.z.object({
   batch_type: zod.z.enum([
@@ -4157,7 +4182,8 @@ var batch = zod.z.object({
   unmanaged_acs_users: unmanaged_acs_user.array().optional(),
   unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
   unmanaged_devices: unmanaged_device.array().optional(),
-  connect_webviews: connect_webview.array().optional()
+  connect_webviews: connect_webview.array().optional(),
+  access_methods: access_method.array().optional()
 }).describe("A batch of workspace resources.");
 var bridge = zod.z.object({
   bridge_id: zod.z.string().uuid().describe("ID of Seam Bridge."),
@@ -4236,6 +4262,13 @@ 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(),
+  primary_color: zod.z.string().optional(),
+  secondary_color: zod.z.string().optional()
+});
 var common_event = zod.z.object({
   event_id: zod.z.string().uuid().describe("ID of the event."),
   workspace_id: zod.z.string().uuid().describe(
@@ -31685,6 +31718,10 @@ var openapi_default = {
                     batch: {
                       description: "A batch of workspace resources.",
                       properties: {
+                        access_methods: {
+                          items: { $ref: "#/components/schemas/access_method" },
+                          type: "array"
+                        },
                         acs_access_groups: {
                           items: {
                             $ref: "#/components/schemas/acs_access_group"
@@ -31842,6 +31879,10 @@ var openapi_default = {
                     batch: {
                       description: "A batch of workspace resources.",
                       properties: {
+                        access_methods: {
+                          items: { $ref: "#/components/schemas/access_method" },
+                          type: "array"
+                        },
                         acs_access_groups: {
                           items: {
                             $ref: "#/components/schemas/acs_access_group"
@@ -57195,6 +57236,389 @@ var openapi_default = {
         "x-title": "Create a Workspace"
       }
     },
+    "/workspaces/customization_profiles/create": {
+      post: {
+        description: "Updates the customization profile for the workspace.",
+        operationId: "workspacesCustomizationProfilesCreatePost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  primary_color: { type: "string" },
+                  secondary_color: { type: "string" }
+                },
+                required: ["primary_color", "secondary_color"],
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    customization_profile: {
+                      properties: {
+                        customization_profile_id: {
+                          format: "uuid",
+                          type: "string"
+                        },
+                        logo_url: { type: "string" },
+                        primary_color: { type: "string" },
+                        secondary_color: { type: "string" },
+                        workspace_id: { format: "uuid", type: "string" }
+                      },
+                      required: ["workspace_id", "customization_profile_id"],
+                      type: "object"
+                    },
+                    ok: { type: "boolean" }
+                  },
+                  required: ["customization_profile", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: "/workspaces/customization_profiles/create",
+        tags: ["/workspaces"],
+        "x-fern-sdk-group-name": ["workspaces", "customization_profiles"],
+        "x-fern-sdk-method-name": "create",
+        "x-fern-sdk-return-value": "customization_profile",
+        "x-response-key": "customization_profile",
+        "x-title": "Update Customization Profile"
+      }
+    },
+    "/workspaces/customization_profiles/get": {
+      get: {
+        description: "Retrieves the customization profile for the workspace.",
+        operationId: "workspacesCustomizationProfilesGetGet",
+        parameters: [
+          {
+            in: "query",
+            name: "customization_profile_id",
+            required: true,
+            schema: { format: "uuid", type: "string" }
+          }
+        ],
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    customization_profile: {
+                      properties: {
+                        customization_profile_id: {
+                          format: "uuid",
+                          type: "string"
+                        },
+                        logo_url: { type: "string" },
+                        primary_color: { type: "string" },
+                        secondary_color: { type: "string" },
+                        workspace_id: { format: "uuid", type: "string" }
+                      },
+                      required: ["workspace_id", "customization_profile_id"],
+                      type: "object"
+                    },
+                    ok: { type: "boolean" }
+                  },
+                  required: ["customization_profile", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: "/workspaces/customization_profiles/get",
+        tags: ["/workspaces"],
+        "x-fern-sdk-group-name": ["workspaces", "customization_profiles"],
+        "x-fern-sdk-method-name": "get",
+        "x-fern-sdk-return-value": "customization_profile",
+        "x-response-key": "customization_profile",
+        "x-title": "Get Customization Profile"
+      },
+      post: {
+        description: "Retrieves the customization profile for the workspace.",
+        operationId: "workspacesCustomizationProfilesGetPost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  customization_profile_id: { format: "uuid", type: "string" }
+                },
+                required: ["customization_profile_id"],
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    customization_profile: {
+                      properties: {
+                        customization_profile_id: {
+                          format: "uuid",
+                          type: "string"
+                        },
+                        logo_url: { type: "string" },
+                        primary_color: { type: "string" },
+                        secondary_color: { type: "string" },
+                        workspace_id: { format: "uuid", type: "string" }
+                      },
+                      required: ["workspace_id", "customization_profile_id"],
+                      type: "object"
+                    },
+                    ok: { type: "boolean" }
+                  },
+                  required: ["customization_profile", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: "/workspaces/customization_profiles/get",
+        tags: ["/workspaces"],
+        "x-fern-sdk-group-name": ["workspaces", "customization_profiles"],
+        "x-fern-sdk-method-name": "get",
+        "x-fern-sdk-return-value": "customization_profile",
+        "x-response-key": "customization_profile",
+        "x-title": "Get Customization Profile"
+      }
+    },
+    "/workspaces/customization_profiles/list": {
+      get: {
+        description: "Retrieves the customization profile for the workspace.",
+        operationId: "workspacesCustomizationProfilesListGet",
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    customization_profiles: {
+                      items: {
+                        properties: {
+                          customization_profile_id: {
+                            format: "uuid",
+                            type: "string"
+                          },
+                          logo_url: { type: "string" },
+                          primary_color: { type: "string" },
+                          secondary_color: { type: "string" },
+                          workspace_id: { format: "uuid", type: "string" }
+                        },
+                        required: ["workspace_id", "customization_profile_id"],
+                        type: "object"
+                      },
+                      type: "array"
+                    },
+                    ok: { type: "boolean" }
+                  },
+                  required: ["customization_profiles", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: "/workspaces/customization_profiles/list",
+        tags: ["/workspaces"],
+        "x-fern-sdk-group-name": ["workspaces", "customization_profiles"],
+        "x-fern-sdk-method-name": "list",
+        "x-fern-sdk-return-value": "customization_profiles",
+        "x-response-key": "customization_profiles",
+        "x-title": "Get Customization Profile"
+      },
+      post: {
+        description: "Retrieves the customization profile for the workspace.",
+        operationId: "workspacesCustomizationProfilesListPost",
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    customization_profiles: {
+                      items: {
+                        properties: {
+                          customization_profile_id: {
+                            format: "uuid",
+                            type: "string"
+                          },
+                          logo_url: { type: "string" },
+                          primary_color: { type: "string" },
+                          secondary_color: { type: "string" },
+                          workspace_id: { format: "uuid", type: "string" }
+                        },
+                        required: ["workspace_id", "customization_profile_id"],
+                        type: "object"
+                      },
+                      type: "array"
+                    },
+                    ok: { type: "boolean" }
+                  },
+                  required: ["customization_profiles", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: "/workspaces/customization_profiles/list",
+        tags: ["/workspaces"],
+        "x-fern-sdk-group-name": ["workspaces", "customization_profiles"],
+        "x-fern-sdk-method-name": "list",
+        "x-fern-sdk-return-value": "customization_profiles",
+        "x-response-key": "customization_profiles",
+        "x-title": "Get Customization Profile"
+      }
+    },
+    "/workspaces/customization_profiles/update": {
+      patch: {
+        description: "Updates the customization profile for the workspace.",
+        operationId: "workspacesCustomizationProfilesUpdatePatch",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  customization_profile_id: { format: "uuid", type: "string" },
+                  primary_color: { type: "string" },
+                  secondary_color: { type: "string" }
+                },
+                required: ["customization_profile_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: [{ client_session_with_customer: [] }],
+        summary: "/workspaces/customization_profiles/update",
+        tags: ["/workspaces"],
+        "x-fern-sdk-group-name": ["workspaces", "customization_profiles"],
+        "x-fern-sdk-method-name": "update",
+        "x-response-key": null,
+        "x-title": "Update Customization Profile"
+      },
+      post: {
+        description: "Updates the customization profile for the workspace.",
+        operationId: "workspacesCustomizationProfilesUpdatePost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  customization_profile_id: { format: "uuid", type: "string" },
+                  primary_color: { type: "string" },
+                  secondary_color: { type: "string" }
+                },
+                required: ["customization_profile_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: [{ client_session_with_customer: [] }],
+        summary: "/workspaces/customization_profiles/update",
+        tags: ["/workspaces"],
+        "x-fern-sdk-group-name": ["workspaces", "customization_profiles"],
+        "x-fern-sdk-method-name": "update",
+        "x-response-key": null,
+        "x-title": "Update Customization Profile"
+      }
+    },
+    "/workspaces/customization_profiles/upload_images": {
+      post: {
+        description: "Uploads a logo for the customization profile.",
+        operationId: "workspacesCustomizationProfilesUploadImagesPost",
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: { ok: { type: "boolean" } },
+                  required: ["ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: "/workspaces/customization_profiles/upload_images",
+        tags: ["/workspaces"],
+        "x-fern-sdk-group-name": ["workspaces", "customization_profiles"],
+        "x-fern-sdk-method-name": "upload_images",
+        "x-response-key": null,
+        "x-title": "Upload Customization Profile Logo",
+        "x-undocumented": "Internal endpoint for customer portals."
+      }
+    },
     "/workspaces/find_resources": {
       get: {
         description: "Search for resources inside a workspace.",
@@ -57216,6 +57640,10 @@ var openapi_default = {
                     batch: {
                       description: "A batch of workspace resources.",
                       properties: {
+                        access_methods: {
+                          items: { $ref: "#/components/schemas/access_method" },
+                          type: "array"
+                        },
                         acs_access_groups: {
                           items: {
                             $ref: "#/components/schemas/acs_access_group"
@@ -57350,6 +57778,10 @@ var openapi_default = {
                     batch: {
                       description: "A batch of workspace resources.",
                       properties: {
+                        access_methods: {
+                          items: { $ref: "#/components/schemas/access_method" },
+                          type: "array"
+                        },
                         acs_access_groups: {
                           items: {
                             $ref: "#/components/schemas/acs_access_group"