@seamapi/types 1.605.0 → 1.606.0

package/dist/connect.cjs

@@ -38,6 +38,7 @@ __export(schemas_exports, {
   noise_threshold: () => noise_threshold,
   pagination: () => pagination,
   seam_event: () => seam_event,
+  staff_member_resource: () => staff_member_resource,
   thermostat_daily_program: () => thermostat_daily_program,
   thermostat_schedule: () => thermostat_schedule,
   thermostat_weekly_program: () => thermostat_weekly_program,
@@ -5705,6 +5706,52 @@ var bridge_client_session = zod.z.object({
   ---
   Represents a [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.
 `);
+var base_user_identity_resource = zod.z.object({
+  name: zod.z.string().describe("Your display name for this user identity resource."),
+  email_address: zod.z.string().optional().describe("Email address associated with the user identity."),
+  phone_number: zod.z.string().optional().describe("Phone number associated with the user identity.")
+});
+var guest_resource = base_user_identity_resource.extend({
+  guest_key: zod.z.string().describe("Your unique identifier for the guest.")
+});
+var tenant_resource = base_user_identity_resource.extend({
+  tenant_key: zod.z.string().describe("Your unique identifier for the tenant.")
+});
+var resident_resource = base_user_identity_resource.extend({
+  resident_key: zod.z.string().describe("Your unique identifier for the resident.")
+});
+var user_resource = base_user_identity_resource.extend({
+  user_key: zod.z.string().describe("Your unique identifier for the user.")
+});
+var staff_member_resource = base_user_identity_resource.extend({
+  staff_member_key: zod.z.string().describe("Your unique identifier for the staff."),
+  site_keys: zod.z.array(zod.z.string()).describe(
+    "List of unique identifiers for the sites the staff member is associated with."
+  )
+}).describe(`
+  ---
+  route_path: /seam/customer/v1/staff_members
+  ---
+  Represents a staff member for a specific customer.
+`);
+var user_identity_resource = base_user_identity_resource.extend({
+  user_identity_key: zod.z.string().describe("Your unique identifier for the user identity.")
+});
+zod.z.union([
+  guest_resource,
+  tenant_resource,
+  resident_resource,
+  user_resource,
+  user_identity_resource,
+  staff_member_resource
+]);
+zod.z.union([
+  zod.z.object({ guest_key: zod.z.string() }),
+  zod.z.object({ tenant_key: zod.z.string() }),
+  zod.z.object({ resident_key: zod.z.string() }),
+  zod.z.object({ user_key: zod.z.string() }),
+  zod.z.object({ user_identity_key: zod.z.string() })
+]);
 var pagination = zod.z.object({
   next_page_cursor: zod.z.string().base64().nullable().describe(
     "Opaque value that can be used to select the next page of results via the `page_cursor` parameter."
@@ -24528,6 +24575,35 @@ var openapi_default = {
         "x-draft": "Early access.",
         "x-route-path": "/spaces"
       },
+      staff_member: {
+        description: "Represents a staff member for a specific customer.",
+        properties: {
+          email_address: {
+            description: "Email address associated with the user identity.",
+            type: "string"
+          },
+          name: {
+            description: "Your display name for this user identity resource.",
+            type: "string"
+          },
+          phone_number: {
+            description: "Phone number associated with the user identity.",
+            type: "string"
+          },
+          site_keys: {
+            description: "List of unique identifiers for the sites the staff member is associated with.",
+            items: { type: "string" },
+            type: "array"
+          },
+          staff_member_key: {
+            description: "Your unique identifier for the staff.",
+            type: "string"
+          }
+        },
+        required: ["name", "staff_member_key", "site_keys"],
+        type: "object",
+        "x-route-path": "/seam/customer/v1/staff_members"
+      },
       thermostat_daily_program: {
         description: "Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.",
         properties: {
@@ -43730,6 +43806,43 @@ var openapi_default = {
                             },
                             type: "array"
                           },
+                          staff_members: {
+                            description: "List of staff members.",
+                            items: {
+                              description: "Represents a staff member for a specific customer.",
+                              properties: {
+                                email_address: {
+                                  description: "Email address associated with the user identity.",
+                                  type: "string"
+                                },
+                                name: {
+                                  description: "Your display name for this user identity resource.",
+                                  type: "string"
+                                },
+                                phone_number: {
+                                  description: "Phone number associated with the user identity.",
+                                  type: "string"
+                                },
+                                site_keys: {
+                                  description: "List of unique identifiers for the sites the staff member is associated with.",
+                                  items: { type: "string" },
+                                  type: "array"
+                                },
+                                staff_member_key: {
+                                  description: "Your unique identifier for the staff.",
+                                  type: "string"
+                                }
+                              },
+                              required: [
+                                "name",
+                                "staff_member_key",
+                                "site_keys"
+                              ],
+                              type: "object",
+                              "x-route-path": "/seam/customer/v1/staff_members"
+                            },
+                            type: "array"
+                          },
                           tenants: {
                             description: "List of tenants.",
                             items: {
@@ -44709,6 +44822,39 @@ var openapi_default = {
                     },
                     type: "array"
                   },
+                  staff_members: {
+                    description: "List of staff members.",
+                    items: {
+                      description: "Represents a staff member for a specific customer.",
+                      properties: {
+                        email_address: {
+                          description: "Email address associated with the user identity.",
+                          type: "string"
+                        },
+                        name: {
+                          description: "Your display name for this user identity resource.",
+                          type: "string"
+                        },
+                        phone_number: {
+                          description: "Phone number associated with the user identity.",
+                          type: "string"
+                        },
+                        site_keys: {
+                          description: "List of unique identifiers for the sites the staff member is associated with.",
+                          items: { type: "string" },
+                          type: "array"
+                        },
+                        staff_member_key: {
+                          description: "Your unique identifier for the staff.",
+                          type: "string"
+                        }
+                      },
+                      required: ["name", "staff_member_key", "site_keys"],
+                      type: "object",
+                      "x-route-path": "/seam/customer/v1/staff_members"
+                    },
+                    type: "array"
+                  },
                   tenants: {
                     description: "List of tenants.",
                     items: {
@@ -55348,6 +55494,165 @@ var openapi_default = {
         "x-title": "List Spaces"
       }
     },
+    "/seam/customer/v1/staff_members/list": {
+      get: {
+        description: "Returns a list of staff members for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.\nProvided space_key or space_id can be a child space, in which case the staff members for the parent space will be returned.",
+        operationId: "seamCustomerV1StaffMembersListGet",
+        parameters: [
+          {
+            in: "query",
+            name: "space_key",
+            schema: {
+              description: "Filter staff members by space key.",
+              type: "string"
+            }
+          },
+          {
+            in: "query",
+            name: "space_id",
+            schema: {
+              description: "Filter staff members by space ID (UUID).",
+              format: "uuid",
+              type: "string"
+            }
+          },
+          {
+            in: "query",
+            name: "limit",
+            schema: {
+              default: 500,
+              description: "Maximum number of records to return per page.",
+              exclusiveMinimum: true,
+              minimum: 0,
+              type: "integer"
+            }
+          },
+          {
+            in: "query",
+            name: "created_before",
+            schema: {
+              description: "Timestamp by which to limit returned staff members. Returns staff members created before this timestamp.",
+              format: "date-time",
+              type: "string"
+            }
+          },
+          {
+            in: "query",
+            name: "page_cursor",
+            schema: {
+              description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
+              nullable: true,
+              type: "string"
+            }
+          }
+        ],
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    ok: { type: "boolean" },
+                    pagination: { $ref: "#/components/schemas/pagination" },
+                    staff_members: {
+                      items: { $ref: "#/components/schemas/staff_member" },
+                      type: "array"
+                    }
+                  },
+                  required: ["staff_members", "pagination", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: "/seam/customer/v1/staff_members/list",
+        tags: [],
+        "x-fern-sdk-group-name": ["seam", "customer", "v1", "staff_members"],
+        "x-fern-sdk-method-name": "list",
+        "x-fern-sdk-return-value": "staff_members",
+        "x-response-key": "staff_members",
+        "x-title": "List Staff Members for Customer Space",
+        "x-undocumented": "Internal endpoint for customer portals."
+      },
+      post: {
+        description: "Returns a list of staff members for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.\nProvided space_key or space_id can be a child space, in which case the staff members for the parent space will be returned.",
+        operationId: "seamCustomerV1StaffMembersListPost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  created_before: {
+                    description: "Timestamp by which to limit returned staff members. Returns staff members created before this timestamp.",
+                    format: "date-time",
+                    type: "string"
+                  },
+                  limit: {
+                    default: 500,
+                    description: "Maximum number of records to return per page.",
+                    exclusiveMinimum: true,
+                    minimum: 0,
+                    type: "integer"
+                  },
+                  page_cursor: {
+                    description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
+                    nullable: true,
+                    type: "string"
+                  },
+                  space_id: {
+                    description: "Filter staff members by space ID (UUID).",
+                    format: "uuid",
+                    type: "string"
+                  },
+                  space_key: {
+                    description: "Filter staff members by space key.",
+                    type: "string"
+                  }
+                },
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    ok: { type: "boolean" },
+                    pagination: { $ref: "#/components/schemas/pagination" },
+                    staff_members: {
+                      items: { $ref: "#/components/schemas/staff_member" },
+                      type: "array"
+                    }
+                  },
+                  required: ["staff_members", "pagination", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: "/seam/customer/v1/staff_members/list",
+        tags: [],
+        "x-fern-sdk-group-name": ["seam", "customer", "v1", "staff_members"],
+        "x-fern-sdk-method-name": "list",
+        "x-fern-sdk-return-value": "staff_members",
+        "x-response-key": "staff_members",
+        "x-title": "List Staff Members for Customer Space",
+        "x-undocumented": "Internal endpoint for customer portals."
+      }
+    },
     "/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]": {
       post: {
         description: "Receives webhook events from external connector APIs and processes them into partner resources.",