@seamapi/types 1.604.0 → 1.606.0

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

@@ -2903,13 +2903,12 @@ export default {
             description:
               'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
             properties: {
-              display_name: {
+              common_area_name: {
                 description: 'Display name of the entrance.',
                 type: 'string',
               },
-              door_type: {
-                description: 'Type of door.',
-                enum: ['common_area', 'guest'],
+              common_area_number: {
+                description: 'Display name of the entrance.',
                 type: 'string',
               },
               room_number: {
@@ -2917,7 +2916,6 @@ export default {
                 type: 'string',
               },
             },
-            required: ['room_number', 'display_name', 'door_type'],
             type: 'object',
           },
           latch_metadata: {
@@ -19937,13 +19935,12 @@ export default {
                               description:
                                 'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
                               properties: {
-                                display_name: {
+                                common_area_name: {
                                   description: 'Display name of the entrance.',
                                   type: 'string',
                                 },
-                                door_type: {
-                                  description: 'Type of door.',
-                                  enum: ['common_area', 'guest'],
+                                common_area_number: {
+                                  description: 'Display name of the entrance.',
                                   type: 'string',
                                 },
                                 room_number: {
@@ -19951,11 +19948,6 @@ export default {
                                   type: 'string',
                                 },
                               },
-                              required: [
-                                'room_number',
-                                'display_name',
-                                'door_type',
-                              ],
                               type: 'object',
                             },
                             latch_metadata: {
@@ -20872,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.',
@@ -36365,6 +36387,119 @@ export default {
         'x-title': 'List Compatible Credential Manager ACS Systems',
       },
     },
+    '/acs/systems/report_devices': {
+      post: {
+        description:
+          'Reports ACS system resources including encoders and entrances with their metadata.\n\nThis endpoint allows reporting of:\n- ACS encoders with removal status and encoder port metadata\n- ACS entrances with room number metadata',
+        operationId: 'acsSystemsReportDevicesPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  acs_encoders: {
+                    default: [],
+                    description: 'Array of ACS encoders to report',
+                    items: {
+                      properties: {
+                        hotek_metadata: {
+                          properties: {
+                            encoder_number: {
+                              description:
+                                'The encoder number determined by the USB port connection.',
+                              type: 'string',
+                            },
+                          },
+                          required: ['encoder_number'],
+                          type: 'object',
+                        },
+                        is_removed: {
+                          default: false,
+                          description: 'Whether the encoder is removed',
+                          type: 'boolean',
+                        },
+                      },
+                      required: ['hotek_metadata'],
+                      type: 'object',
+                    },
+                    type: 'array',
+                  },
+                  acs_entrances: {
+                    default: [],
+                    description: 'Array of ACS entrances to report',
+                    items: {
+                      properties: {
+                        hotek_metadata: {
+                          description:
+                            'Hotek-specific metadata associated with the entrance.',
+                          properties: {
+                            common_area_name: {
+                              description: 'The common area name',
+                              type: 'string',
+                            },
+                            common_area_number: {
+                              description: 'The room number identifier',
+                              type: 'string',
+                            },
+                            room_number: {
+                              description: 'The room number identifier',
+                              type: 'string',
+                            },
+                          },
+                          type: 'object',
+                        },
+                        is_removed: {
+                          default: false,
+                          description: 'Whether the entrance is removed',
+                          type: 'boolean',
+                        },
+                      },
+                      required: ['hotek_metadata'],
+                      type: 'object',
+                    },
+                    type: 'array',
+                  },
+                  acs_system_id: {
+                    description: 'ID of the ACS system to report resources for',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                },
+                required: ['acs_system_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: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/acs/systems/report_devices',
+        tags: ['/acs'],
+        'x-fern-sdk-group-name': ['acs', 'systems'],
+        'x-fern-sdk-method-name': 'report_devices',
+        'x-response-key': null,
+        'x-title': 'Report ACS Resources',
+      },
+    },
     '/acs/users/add_to_access_group': {
       post: {
         description:
@@ -41552,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: {
@@ -42627,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: {
@@ -53677,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: