@seamapi/types 1.469.0 → 1.470.0

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

@@ -53294,881 +53294,6 @@ export default {
         'x-title': 'Update the Thermostat Weekly Program',
       },
     },
-    '/unstable_access_grants/create': {
-      post: {
-        description: 'Creates a new access grant.',
-        operationId: 'unstableAccessGrantsCreatePost',
-        requestBody: {
-          content: {
-            'application/json': {
-              schema: {
-                allOf: [
-                  {
-                    oneOf: [
-                      {
-                        properties: {
-                          user_identity_id: {
-                            description:
-                              'ID of user identity for whom you want to grant access.',
-                            format: 'uuid',
-                            type: 'string',
-                          },
-                        },
-                        required: ['user_identity_id'],
-                        type: 'object',
-                      },
-                      {
-                        properties: {
-                          user_identity: {
-                            description:
-                              'User identity. When used, creates a new user identity with the specified details and grants them access.',
-                            properties: {
-                              email_address: {
-                                description:
-                                  'Unique email address for the user identity.',
-                                format: 'email',
-                                nullable: true,
-                                type: 'string',
-                              },
-                              full_name: {
-                                minLength: 1,
-                                nullable: true,
-                                type: 'string',
-                              },
-                              phone_number: {
-                                description:
-                                  'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
-                                nullable: true,
-                                type: 'string',
-                              },
-                            },
-                            type: 'object',
-                          },
-                        },
-                        required: ['user_identity'],
-                        type: 'object',
-                      },
-                    ],
-                  },
-                  {
-                    properties: {
-                      acs_entrance_ids: {
-                        default: [],
-                        description:
-                          'IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to which you want to grant access.',
-                        items: { format: 'uuid', type: 'string' },
-                        type: 'array',
-                      },
-                      device_ids: {
-                        default: [],
-                        description:
-                          'IDs of the devices to which you want to grant access.',
-                        items: { format: 'uuid', type: 'string' },
-                        type: 'array',
-                      },
-                      ends_at: {
-                        description:
-                          'Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
-                        format: 'date-time',
-                        type: 'string',
-                      },
-                      location: {
-                        description:
-                          'Location. When used, creates a new location with the specified entrances and devices, and gives the user access to this location.',
-                        properties: {
-                          acs_entrance_ids: {
-                            default: [],
-                            deprecated: true,
-                            items: { format: 'uuid', type: 'string' },
-                            type: 'array',
-                            'x-deprecated':
-                              'Use `acs_entrance_ids` at the top level.',
-                          },
-                          device_ids: {
-                            default: [],
-                            deprecated: true,
-                            items: { format: 'uuid', type: 'string' },
-                            type: 'array',
-                            'x-deprecated':
-                              'Use `device_ids` at the top level.',
-                          },
-                          name: {
-                            description: 'Name of the location.',
-                            type: 'string',
-                          },
-                        },
-                        type: 'object',
-                      },
-                      location_ids: {
-                        deprecated: true,
-                        items: { format: 'uuid', type: 'string' },
-                        type: 'array',
-                        'x-deprecated': 'Use `space_ids`.',
-                      },
-                      requested_access_methods: {
-                        items: {
-                          properties: {
-                            mode: {
-                              description: 'Access method mode.',
-                              enum: ['code', 'card', 'mobile_key'],
-                              type: 'string',
-                            },
-                          },
-                          required: ['mode'],
-                          type: 'object',
-                        },
-                        type: 'array',
-                      },
-                      space_ids: {
-                        description:
-                          'IDs of the existing spaces to which you want to grant access.',
-                        items: { format: 'uuid', type: 'string' },
-                        type: 'array',
-                      },
-                      starts_at: {
-                        description:
-                          'Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
-                        format: 'date-time',
-                        type: 'string',
-                      },
-                    },
-                    required: ['requested_access_methods'],
-                    type: 'object',
-                  },
-                ],
-              },
-            },
-          },
-        },
-        responses: {
-          200: {
-            content: {
-              'application/json': {
-                schema: {
-                  properties: {
-                    access_grant: { $ref: '#/components/schemas/access_grant' },
-                    ok: { type: 'boolean' },
-                  },
-                  required: ['access_grant', 'ok'],
-                  type: 'object',
-                },
-              },
-            },
-            description: 'OK',
-          },
-          400: { description: 'Bad Request' },
-          401: { description: 'Unauthorized' },
-        },
-        security: [
-          { pat_with_workspace: [] },
-          { console_session_with_workspace: [] },
-          { api_key: [] },
-          { client_session_with_customer: [] },
-        ],
-        summary: '/unstable_access_grants/create',
-        tags: [],
-        'x-fern-sdk-group-name': ['unstable_access_grants'],
-        'x-fern-sdk-method-name': 'create',
-        'x-fern-sdk-return-value': 'access_grant',
-        'x-response-key': 'access_grant',
-        'x-title': 'Create an Access Grant',
-        'x-undocumented': 'Unreleased.',
-      },
-    },
-    '/unstable_access_grants/delete': {
-      delete: {
-        description: 'Deletes an access grant.',
-        operationId: 'unstableAccessGrantsDeleteDelete',
-        parameters: [
-          {
-            in: 'query',
-            name: 'access_grant_id',
-            required: true,
-            schema: {
-              description: 'ID of access grant that you want to delete.',
-              format: 'uuid',
-              type: 'string',
-            },
-          },
-        ],
-        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: [] },
-          { client_session_with_customer: [] },
-        ],
-        summary: '/unstable_access_grants/delete',
-        tags: [],
-        'x-fern-sdk-group-name': ['unstable_access_grants'],
-        'x-fern-sdk-method-name': 'delete',
-        'x-response-key': null,
-        'x-title': 'Delete an Access Grant',
-        'x-undocumented': 'Unreleased.',
-      },
-      post: {
-        description: 'Deletes an access grant.',
-        operationId: 'unstableAccessGrantsDeletePost',
-        requestBody: {
-          content: {
-            'application/json': {
-              schema: {
-                properties: {
-                  access_grant_id: {
-                    description: 'ID of access grant that you want to delete.',
-                    format: 'uuid',
-                    type: 'string',
-                  },
-                },
-                required: ['access_grant_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: [] },
-          { client_session_with_customer: [] },
-        ],
-        summary: '/unstable_access_grants/delete',
-        tags: [],
-        'x-fern-sdk-group-name': ['unstable_access_grants'],
-        'x-fern-sdk-method-name': 'delete',
-        'x-response-key': null,
-        'x-title': 'Delete an Access Grant',
-        'x-undocumented': 'Unreleased.',
-      },
-    },
-    '/unstable_access_grants/get': {
-      get: {
-        description: 'Gets an access grant.',
-        operationId: 'unstableAccessGrantsGetGet',
-        parameters: [
-          {
-            in: 'query',
-            name: 'access_grant_id',
-            required: true,
-            schema: {
-              description: 'ID of access grant that you want to get.',
-              format: 'uuid',
-              type: 'string',
-            },
-          },
-        ],
-        responses: {
-          200: {
-            content: {
-              'application/json': {
-                schema: {
-                  properties: {
-                    access_grant: { $ref: '#/components/schemas/access_grant' },
-                    ok: { type: 'boolean' },
-                  },
-                  required: ['access_grant', 'ok'],
-                  type: 'object',
-                },
-              },
-            },
-            description: 'OK',
-          },
-          400: { description: 'Bad Request' },
-          401: { description: 'Unauthorized' },
-        },
-        security: [
-          { pat_with_workspace: [] },
-          { console_session_with_workspace: [] },
-          { api_key: [] },
-          { client_session_with_customer: [] },
-        ],
-        summary: '/unstable_access_grants/get',
-        tags: [],
-        'x-fern-sdk-group-name': ['unstable_access_grants'],
-        'x-fern-sdk-method-name': 'get',
-        'x-fern-sdk-return-value': 'access_grant',
-        'x-response-key': 'access_grant',
-        'x-title': 'Get an Access Grant',
-        'x-undocumented': 'Unreleased.',
-      },
-      post: {
-        description: 'Gets an access grant.',
-        operationId: 'unstableAccessGrantsGetPost',
-        requestBody: {
-          content: {
-            'application/json': {
-              schema: {
-                properties: {
-                  access_grant_id: {
-                    description: 'ID of access grant that you want to get.',
-                    format: 'uuid',
-                    type: 'string',
-                  },
-                },
-                required: ['access_grant_id'],
-                type: 'object',
-              },
-            },
-          },
-        },
-        responses: {
-          200: {
-            content: {
-              'application/json': {
-                schema: {
-                  properties: {
-                    access_grant: { $ref: '#/components/schemas/access_grant' },
-                    ok: { type: 'boolean' },
-                  },
-                  required: ['access_grant', 'ok'],
-                  type: 'object',
-                },
-              },
-            },
-            description: 'OK',
-          },
-          400: { description: 'Bad Request' },
-          401: { description: 'Unauthorized' },
-        },
-        security: [
-          { pat_with_workspace: [] },
-          { console_session_with_workspace: [] },
-          { api_key: [] },
-          { client_session_with_customer: [] },
-        ],
-        summary: '/unstable_access_grants/get',
-        tags: [],
-        'x-fern-sdk-group-name': ['unstable_access_grants'],
-        'x-fern-sdk-method-name': 'get',
-        'x-fern-sdk-return-value': 'access_grant',
-        'x-response-key': 'access_grant',
-        'x-title': 'Get an Access Grant',
-        'x-undocumented': 'Unreleased.',
-      },
-    },
-    '/unstable_access_grants/list': {
-      get: {
-        description: 'Returns a list of all access grants.',
-        operationId: 'unstableAccessGrantsListGet',
-        parameters: [
-          {
-            in: 'query',
-            name: 'user_identity_id',
-            schema: {
-              description:
-                'ID of the user identity by which you want to filter the list of access grants.',
-              format: 'uuid',
-              type: 'string',
-            },
-          },
-          {
-            in: 'query',
-            name: 'acs_system_id',
-            schema: {
-              description:
-                'ID of the access system by which you want to filter the list of access grants.',
-              format: 'uuid',
-              type: 'string',
-            },
-          },
-          {
-            in: 'query',
-            name: 'acs_entrance_id',
-            schema: {
-              description:
-                'ID of the entrance by which you want to filter the list of access grants.',
-              format: 'uuid',
-              type: 'string',
-            },
-          },
-          {
-            in: 'query',
-            name: 'location_id',
-            schema: {
-              deprecated: true,
-              format: 'uuid',
-              type: 'string',
-              'x-deprecated': 'Use `space_id`.',
-            },
-          },
-          {
-            in: 'query',
-            name: 'space_id',
-            schema: {
-              description:
-                'ID of the space by which you want to filter the list of access grants.',
-              format: 'uuid',
-              type: 'string',
-            },
-          },
-        ],
-        responses: {
-          200: {
-            content: {
-              'application/json': {
-                schema: {
-                  properties: {
-                    access_grants: {
-                      items: { $ref: '#/components/schemas/access_grant' },
-                      type: 'array',
-                    },
-                    ok: { type: 'boolean' },
-                  },
-                  required: ['access_grants', 'ok'],
-                  type: 'object',
-                },
-              },
-            },
-            description: 'OK',
-          },
-          400: { description: 'Bad Request' },
-          401: { description: 'Unauthorized' },
-        },
-        security: [
-          { pat_with_workspace: [] },
-          { console_session_with_workspace: [] },
-          { api_key: [] },
-          { client_session_with_customer: [] },
-        ],
-        summary: '/unstable_access_grants/list',
-        tags: [],
-        'x-fern-sdk-group-name': ['unstable_access_grants'],
-        'x-fern-sdk-method-name': 'list',
-        'x-fern-sdk-return-value': 'access_grants',
-        'x-response-key': 'access_grants',
-        'x-title': 'List Access Grants',
-        'x-undocumented': 'Unreleased.',
-      },
-      post: {
-        description: 'Returns a list of all access grants.',
-        operationId: 'unstableAccessGrantsListPost',
-        requestBody: {
-          content: {
-            'application/json': {
-              schema: {
-                properties: {
-                  acs_entrance_id: {
-                    description:
-                      'ID of the entrance by which you want to filter the list of access grants.',
-                    format: 'uuid',
-                    type: 'string',
-                  },
-                  acs_system_id: {
-                    description:
-                      'ID of the access system by which you want to filter the list of access grants.',
-                    format: 'uuid',
-                    type: 'string',
-                  },
-                  location_id: {
-                    deprecated: true,
-                    format: 'uuid',
-                    type: 'string',
-                    'x-deprecated': 'Use `space_id`.',
-                  },
-                  space_id: {
-                    description:
-                      'ID of the space by which you want to filter the list of access grants.',
-                    format: 'uuid',
-                    type: 'string',
-                  },
-                  user_identity_id: {
-                    description:
-                      'ID of the user identity by which you want to filter the list of access grants.',
-                    format: 'uuid',
-                    type: 'string',
-                  },
-                },
-                type: 'object',
-              },
-            },
-          },
-        },
-        responses: {
-          200: {
-            content: {
-              'application/json': {
-                schema: {
-                  properties: {
-                    access_grants: {
-                      items: { $ref: '#/components/schemas/access_grant' },
-                      type: 'array',
-                    },
-                    ok: { type: 'boolean' },
-                  },
-                  required: ['access_grants', 'ok'],
-                  type: 'object',
-                },
-              },
-            },
-            description: 'OK',
-          },
-          400: { description: 'Bad Request' },
-          401: { description: 'Unauthorized' },
-        },
-        security: [
-          { pat_with_workspace: [] },
-          { console_session_with_workspace: [] },
-          { api_key: [] },
-          { client_session_with_customer: [] },
-        ],
-        summary: '/unstable_access_grants/list',
-        tags: [],
-        'x-fern-sdk-group-name': ['unstable_access_grants'],
-        'x-fern-sdk-method-name': 'list',
-        'x-fern-sdk-return-value': 'access_grants',
-        'x-response-key': 'access_grants',
-        'x-title': 'List Access Grants',
-        'x-undocumented': 'Unreleased.',
-      },
-    },
-    '/unstable_access_methods/delete': {
-      delete: {
-        description: 'Deletes an access method.',
-        operationId: 'unstableAccessMethodsDeleteDelete',
-        parameters: [
-          {
-            in: 'query',
-            name: 'access_method_id',
-            required: true,
-            schema: {
-              description: 'ID of the access method that you want to delete.',
-              format: 'uuid',
-              type: 'string',
-            },
-          },
-        ],
-        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: '/unstable_access_methods/delete',
-        tags: [],
-        'x-fern-sdk-group-name': ['unstable_access_methods'],
-        'x-fern-sdk-method-name': 'delete',
-        'x-response-key': null,
-        'x-title': 'Delete an Access Method',
-        'x-undocumented': 'Unreleased.',
-      },
-      post: {
-        description: 'Deletes an access method.',
-        operationId: 'unstableAccessMethodsDeletePost',
-        requestBody: {
-          content: {
-            'application/json': {
-              schema: {
-                properties: {
-                  access_method_id: {
-                    description:
-                      'ID of the access method that you want to delete.',
-                    format: 'uuid',
-                    type: 'string',
-                  },
-                },
-                required: ['access_method_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: '/unstable_access_methods/delete',
-        tags: [],
-        'x-fern-sdk-group-name': ['unstable_access_methods'],
-        'x-fern-sdk-method-name': 'delete',
-        'x-response-key': null,
-        'x-title': 'Delete an Access Method',
-        'x-undocumented': 'Unreleased.',
-      },
-    },
-    '/unstable_access_methods/get': {
-      get: {
-        description: 'Gets an access method.',
-        operationId: 'unstableAccessMethodsGetGet',
-        parameters: [
-          {
-            in: 'query',
-            name: 'access_method_id',
-            required: true,
-            schema: {
-              description: 'ID of the access method that you want to get.',
-              format: 'uuid',
-              type: 'string',
-            },
-          },
-        ],
-        responses: {
-          200: {
-            content: {
-              'application/json': {
-                schema: {
-                  properties: {
-                    access_method: {
-                      $ref: '#/components/schemas/access_method',
-                    },
-                    ok: { type: 'boolean' },
-                  },
-                  required: ['access_method', 'ok'],
-                  type: 'object',
-                },
-              },
-            },
-            description: 'OK',
-          },
-          400: { description: 'Bad Request' },
-          401: { description: 'Unauthorized' },
-        },
-        security: [
-          { pat_with_workspace: [] },
-          { console_session_with_workspace: [] },
-          { api_key: [] },
-        ],
-        summary: '/unstable_access_methods/get',
-        tags: [],
-        'x-fern-sdk-group-name': ['unstable_access_methods'],
-        'x-fern-sdk-method-name': 'get',
-        'x-fern-sdk-return-value': 'access_method',
-        'x-response-key': 'access_method',
-        'x-title': 'Get an Access Method',
-        'x-undocumented': 'Unreleased.',
-      },
-      post: {
-        description: 'Gets an access method.',
-        operationId: 'unstableAccessMethodsGetPost',
-        requestBody: {
-          content: {
-            'application/json': {
-              schema: {
-                properties: {
-                  access_method_id: {
-                    description:
-                      'ID of the access method that you want to get.',
-                    format: 'uuid',
-                    type: 'string',
-                  },
-                },
-                required: ['access_method_id'],
-                type: 'object',
-              },
-            },
-          },
-        },
-        responses: {
-          200: {
-            content: {
-              'application/json': {
-                schema: {
-                  properties: {
-                    access_method: {
-                      $ref: '#/components/schemas/access_method',
-                    },
-                    ok: { type: 'boolean' },
-                  },
-                  required: ['access_method', 'ok'],
-                  type: 'object',
-                },
-              },
-            },
-            description: 'OK',
-          },
-          400: { description: 'Bad Request' },
-          401: { description: 'Unauthorized' },
-        },
-        security: [
-          { pat_with_workspace: [] },
-          { console_session_with_workspace: [] },
-          { api_key: [] },
-        ],
-        summary: '/unstable_access_methods/get',
-        tags: [],
-        'x-fern-sdk-group-name': ['unstable_access_methods'],
-        'x-fern-sdk-method-name': 'get',
-        'x-fern-sdk-return-value': 'access_method',
-        'x-response-key': 'access_method',
-        'x-title': 'Get an Access Method',
-        'x-undocumented': 'Unreleased.',
-      },
-    },
-    '/unstable_access_methods/list': {
-      get: {
-        description:
-          'Lists all access methods, usually filtered by access grant.',
-        operationId: 'unstableAccessMethodsListGet',
-        parameters: [
-          {
-            in: 'query',
-            name: 'access_grant_id',
-            required: true,
-            schema: {
-              description:
-                'ID of the access grant by which to filter the list of access methods.',
-              format: 'uuid',
-              type: 'string',
-            },
-          },
-        ],
-        responses: {
-          200: {
-            content: {
-              'application/json': {
-                schema: {
-                  properties: {
-                    access_methods: {
-                      items: { $ref: '#/components/schemas/access_method' },
-                      type: 'array',
-                    },
-                    ok: { type: 'boolean' },
-                  },
-                  required: ['access_methods', 'ok'],
-                  type: 'object',
-                },
-              },
-            },
-            description: 'OK',
-          },
-          400: { description: 'Bad Request' },
-          401: { description: 'Unauthorized' },
-        },
-        security: [
-          { pat_with_workspace: [] },
-          { console_session_with_workspace: [] },
-          { api_key: [] },
-        ],
-        summary: '/unstable_access_methods/list',
-        tags: [],
-        'x-fern-sdk-group-name': ['unstable_access_methods'],
-        'x-fern-sdk-method-name': 'list',
-        'x-fern-sdk-return-value': 'access_methods',
-        'x-response-key': 'access_methods',
-        'x-title': 'List Access Methods',
-        'x-undocumented': 'Unreleased.',
-      },
-      post: {
-        description:
-          'Lists all access methods, usually filtered by access grant.',
-        operationId: 'unstableAccessMethodsListPost',
-        requestBody: {
-          content: {
-            'application/json': {
-              schema: {
-                properties: {
-                  access_grant_id: {
-                    description:
-                      'ID of the access grant by which to filter the list of access methods.',
-                    format: 'uuid',
-                    type: 'string',
-                  },
-                },
-                required: ['access_grant_id'],
-                type: 'object',
-              },
-            },
-          },
-        },
-        responses: {
-          200: {
-            content: {
-              'application/json': {
-                schema: {
-                  properties: {
-                    access_methods: {
-                      items: { $ref: '#/components/schemas/access_method' },
-                      type: 'array',
-                    },
-                    ok: { type: 'boolean' },
-                  },
-                  required: ['access_methods', 'ok'],
-                  type: 'object',
-                },
-              },
-            },
-            description: 'OK',
-          },
-          400: { description: 'Bad Request' },
-          401: { description: 'Unauthorized' },
-        },
-        security: [
-          { pat_with_workspace: [] },
-          { console_session_with_workspace: [] },
-          { api_key: [] },
-        ],
-        summary: '/unstable_access_methods/list',
-        tags: [],
-        'x-fern-sdk-group-name': ['unstable_access_methods'],
-        'x-fern-sdk-method-name': 'list',
-        'x-fern-sdk-return-value': 'access_methods',
-        'x-response-key': 'access_methods',
-        'x-title': 'List Access Methods',
-        'x-undocumented': 'Unreleased.',
-      },
-    },
     '/unstable_locations/add_acs_entrances': {
       post: {
         description: