@seamapi/types 1.605.0 → 1.606.0

package/lib/seam/connect/route-types.d.ts

@@ -31804,6 +31804,19 @@ export type Routes = {
                     /** Your unique identifier for the user identity. */
                     user_identity_key: string;
                 }[] | undefined;
+                /** List of staff members. */
+                staff_members?: {
+                    /** Your display name for this user identity resource. */
+                    name: string;
+                    /** Email address associated with the user identity. */
+                    email_address?: string | undefined;
+                    /** Phone number associated with the user identity. */
+                    phone_number?: string | undefined;
+                    /** Your unique identifier for the staff. */
+                    staff_member_key: string;
+                    /** List of unique identifiers for the sites the staff member is associated with. */
+                    site_keys: string[];
+                }[] | undefined;
                 /** List of reservations. */
                 reservations?: {
                     /** Your name for this access grant resource. */
@@ -32129,6 +32142,19 @@ export type Routes = {
                 /** Your unique identifier for the user identity. */
                 user_identity_key: string;
             }[] | undefined;
+            /** List of staff members. */
+            staff_members?: {
+                /** Your display name for this user identity resource. */
+                name: string;
+                /** Email address associated with the user identity. */
+                email_address?: string | undefined;
+                /** Phone number associated with the user identity. */
+                phone_number?: string | undefined;
+                /** Your unique identifier for the staff. */
+                staff_member_key: string;
+                /** List of unique identifiers for the sites the staff member is associated with. */
+                site_keys: string[];
+            }[] | undefined;
             /** List of reservations. */
             reservations?: {
                 /** Your name for this access grant resource. */
@@ -59154,6 +59180,48 @@ export type Routes = {
             }[];
         };
     };
+    '/seam/customer/v1/staff_members/list': {
+        route: '/seam/customer/v1/staff_members/list';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** Filter staff members by space key. */
+            space_key?: string | undefined;
+            /** Filter staff members by space ID (UUID). */
+            space_id?: string | undefined;
+            /** Maximum number of records to return per page. */
+            limit?: number;
+            /** Timestamp by which to limit returned staff members. Returns staff members created before this timestamp. */
+            created_before?: Date | undefined;
+            /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
+            page_cursor?: ((string | undefined) | null) | undefined;
+        };
+        formData: {};
+        jsonResponse: {
+            staff_members: {
+                /** Your display name for this user identity resource. */
+                name: string;
+                /** Email address associated with the user identity. */
+                email_address?: string | undefined;
+                /** Phone number associated with the user identity. */
+                phone_number?: string | undefined;
+                /** Your unique identifier for the staff. */
+                staff_member_key: string;
+                /** List of unique identifiers for the sites the staff member is associated with. */
+                site_keys: string[];
+            }[];
+            /** Information about the current page of results. */
+            pagination: {
+                /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
+                next_page_cursor: string | null;
+                /** Indicates whether there is another page of results after this one. */
+                has_next_page: boolean;
+                /** URL to get the next page of results. */
+                next_page_url: string | null;
+            };
+        };
+    };
     '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
         route: '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]';
         method: 'POST';

package/lib/seam/connect/schemas.d.ts

@@ -1 +1 @@
-export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
+export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, staff_member_resource, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';

package/lib/seam/connect/schemas.js

@@ -1,2 +1,2 @@
-export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
+export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, staff_member_resource, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
 //# sourceMappingURL=schemas.js.map

package/lib/seam/connect/schemas.js.map

@@ -1 +1 @@
-{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,KAAK,EACL,MAAM,EACN,qBAAqB,EACrB,mBAAmB,EACnB,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,qBAAqB,EACrB,MAAM,EACN,eAAe,EACf,WAAW,EACX,UAAU,EACV,eAAe,EACf,UAAU,EACV,UAAU,EACV,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,KAAK,EACL,MAAM,EACN,qBAAqB,EACrB,mBAAmB,EACnB,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,qBAAqB,EACrB,MAAM,EACN,eAAe,EACf,WAAW,EACX,UAAU,EACV,eAAe,EACf,UAAU,EACV,UAAU,EACV,qBAAqB,EACrB,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.605.0",
+  "version": "1.606.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/internal/schemas.ts

@@ -74,6 +74,7 @@ export {
   space,
   neutral_resource as space_resource,
   spaces_batch,
+  staff_member_resource,
   tenant_resource,
   thermostat_capability_properties,
   thermostat_device_type,

package/src/lib/seam/connect/models/customer/customer-data.ts

@@ -20,6 +20,7 @@ import {
 import {
   guest_resource,
   resident_resource,
+  staff_member_resource,
   tenant_resource,
   user_identity_resource,
   user_resource,
@@ -82,6 +83,10 @@ export const customer_data = z.object({
     .array(user_identity_resource)
     .optional()
     .describe('List of user identities.'),
+  staff_members: z
+    .array(staff_member_resource)
+    .optional()
+    .describe('List of staff members.'),
 
   // Access grant resources
   reservations: z

package/src/lib/seam/connect/models/customer/user-identity-resources.ts

@@ -32,6 +32,23 @@ export const user_resource = base_user_identity_resource.extend({
   user_key: z.string().describe('Your unique identifier for the user.'),
 })
 
+// staff resource
+export const staff_member_resource = base_user_identity_resource.extend({
+  staff_member_key: z
+    .string()
+    .describe('Your unique identifier for the staff.'),
+  site_keys: z
+    .array(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.
+`)
+
 export const user_identity_resource = base_user_identity_resource.extend({
   user_identity_key: z
     .string()
@@ -45,6 +62,7 @@ export const user_identity_resource_union = z.union([
   resident_resource,
   user_resource,
   user_identity_resource,
+  staff_member_resource,
 ])
 
 // All user identity key aliases for use in references

package/src/lib/seam/connect/openapi.ts

@@ -20864,6 +20864,36 @@ export 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.',
@@ -41657,6 +41687,49 @@ export 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: {
@@ -42732,6 +42805,44 @@ export 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: {
@@ -53782,6 +53893,172 @@ export 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:

package/src/lib/seam/connect/route-types.ts

@@ -36966,6 +36966,21 @@ export type Routes = {
                   user_identity_key: string
                 }[]
               | undefined
+            /** List of staff members. */
+            staff_members?:
+              | {
+                  /** Your display name for this user identity resource. */
+                  name: string
+                  /** Email address associated with the user identity. */
+                  email_address?: string | undefined
+                  /** Phone number associated with the user identity. */
+                  phone_number?: string | undefined
+                  /** Your unique identifier for the staff. */
+                  staff_member_key: string
+                  /** List of unique identifiers for the sites the staff member is associated with. */
+                  site_keys: string[]
+                }[]
+              | undefined
             /** List of reservations. */
             reservations?:
               | {
@@ -37328,6 +37343,21 @@ export type Routes = {
             user_identity_key: string
           }[]
         | undefined
+      /** List of staff members. */
+      staff_members?:
+        | {
+            /** Your display name for this user identity resource. */
+            name: string
+            /** Email address associated with the user identity. */
+            email_address?: string | undefined
+            /** Phone number associated with the user identity. */
+            phone_number?: string | undefined
+            /** Your unique identifier for the staff. */
+            staff_member_key: string
+            /** List of unique identifiers for the sites the staff member is associated with. */
+            site_keys: string[]
+          }[]
+        | undefined
       /** List of reservations. */
       reservations?:
         | {
@@ -70477,6 +70507,48 @@ export type Routes = {
       }[]
     }
   }
+  '/seam/customer/v1/staff_members/list': {
+    route: '/seam/customer/v1/staff_members/list'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      /** Filter staff members by space key. */
+      space_key?: string | undefined
+      /** Filter staff members by space ID (UUID). */
+      space_id?: string | undefined
+      /** Maximum number of records to return per page. */
+      limit?: number
+      /** Timestamp by which to limit returned staff members. Returns staff members created before this timestamp. */
+      created_before?: Date | undefined
+      /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
+      page_cursor?: ((string | undefined) | null) | undefined
+    }
+    formData: {}
+    jsonResponse: {
+      staff_members: {
+        /** Your display name for this user identity resource. */
+        name: string
+        /** Email address associated with the user identity. */
+        email_address?: string | undefined
+        /** Phone number associated with the user identity. */
+        phone_number?: string | undefined
+        /** Your unique identifier for the staff. */
+        staff_member_key: string
+        /** List of unique identifiers for the sites the staff member is associated with. */
+        site_keys: string[]
+      }[]
+      /** Information about the current page of results. */
+      pagination: {
+        /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
+        next_page_cursor: string | null
+        /** Indicates whether there is another page of results after this one. */
+        has_next_page: boolean
+        /** URL to get the next page of results. */
+        next_page_url: string | null
+      }
+    }
+  }
   '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
     route: '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]'
     method: 'POST'

package/src/lib/seam/connect/schemas.ts

@@ -26,6 +26,7 @@ export {
   noise_threshold,
   pagination,
   seam_event,
+  staff_member_resource,
   thermostat_daily_program,
   thermostat_schedule,
   thermostat_weekly_program,