@seamapi/types 1.560.0 → 1.562.0

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

@@ -40629,7 +40629,7 @@ declare const _default: {
                 'x-undocumented': string;
             };
         };
-        '/seam/customer/v1/reservations/list': {
+        '/seam/customer/v1/reservations/get': {
             get: {
                 description: string;
                 operationId: string;
@@ -40638,23 +40638,210 @@ declare const _default: {
                     name: string;
                     schema: {
                         description: string;
+                        format: string;
                         type: string;
-                        default?: never;
-                        exclusiveMinimum?: never;
-                        minimum?: never;
-                        format?: never;
-                        nullable?: never;
                     };
                 } | {
                     in: string;
                     name: string;
                     schema: {
-                        default: number;
                         description: string;
-                        exclusiveMinimum: boolean;
-                        minimum: number;
                         type: string;
                         format?: never;
+                    };
+                })[];
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                        reservation: {
+                                            properties: {
+                                                access_methods: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
+                                                created_at: {
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                                ends_at: {
+                                                    format: string;
+                                                    nullable: boolean;
+                                                    type: string;
+                                                };
+                                                guest_name: {
+                                                    nullable: boolean;
+                                                    type: string;
+                                                };
+                                                name: {
+                                                    nullable: boolean;
+                                                    type: string;
+                                                };
+                                                reservation_id: {
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                                reservation_key: {
+                                                    type: string;
+                                                };
+                                                starts_at: {
+                                                    format: string;
+                                                    nullable: boolean;
+                                                    type: string;
+                                                };
+                                            };
+                                            required: string[];
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: {
+                    client_session_with_customer: never[];
+                }[];
+                summary: string;
+                tags: never[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
+                'x-response-key': string;
+                'x-title': string;
+                'x-undocumented': string;
+            };
+            post: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    reservation_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                    reservation_key: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                };
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                        reservation: {
+                                            properties: {
+                                                access_methods: {
+                                                    items: {
+                                                        $ref: string;
+                                                    };
+                                                    type: string;
+                                                };
+                                                created_at: {
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                                ends_at: {
+                                                    format: string;
+                                                    nullable: boolean;
+                                                    type: string;
+                                                };
+                                                guest_name: {
+                                                    nullable: boolean;
+                                                    type: string;
+                                                };
+                                                name: {
+                                                    nullable: boolean;
+                                                    type: string;
+                                                };
+                                                reservation_id: {
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                                reservation_key: {
+                                                    type: string;
+                                                };
+                                                starts_at: {
+                                                    format: string;
+                                                    nullable: boolean;
+                                                    type: string;
+                                                };
+                                            };
+                                            required: string[];
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: {
+                    client_session_with_customer: never[];
+                }[];
+                summary: string;
+                tags: never[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
+                'x-response-key': string;
+                'x-title': string;
+                'x-undocumented': string;
+            };
+        };
+        '/seam/customer/v1/reservations/list': {
+            get: {
+                description: string;
+                operationId: string;
+                parameters: ({
+                    in: string;
+                    name: string;
+                    schema: {
+                        description: string;
+                        type: string;
+                        format?: never;
+                        default?: never;
+                        exclusiveMinimum?: never;
+                        minimum?: never;
                         nullable?: never;
                     };
                 } | {
@@ -40669,6 +40856,18 @@ declare const _default: {
                         minimum?: never;
                         nullable?: never;
                     };
+                } | {
+                    in: string;
+                    name: string;
+                    schema: {
+                        default: number;
+                        description: string;
+                        exclusiveMinimum: boolean;
+                        minimum: number;
+                        type: string;
+                        format?: never;
+                        nullable?: never;
+                    };
                 } | {
                     in: string;
                     name: string;
@@ -40676,10 +40875,10 @@ declare const _default: {
                         description: string;
                         nullable: boolean;
                         type: string;
+                        format?: never;
                         default?: never;
                         exclusiveMinimum?: never;
                         minimum?: never;
-                        format?: never;
                     };
                 })[];
                 responses: {
@@ -40790,6 +40989,11 @@ declare const _default: {
                                         nullable: boolean;
                                         type: string;
                                     };
+                                    space_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
                                     space_key: {
                                         description: string;
                                         type: string;

package/lib/seam/connect/openapi.js

@@ -694,6 +694,32 @@ export default {
                                     required: ['message', 'is_access_code_error', 'error_code'],
                                     type: 'object',
                                 },
+                                {
+                                    description: 'Admin role required—insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.',
+                                    properties: {
+                                        created_at: {
+                                            description: 'Date and time at which Seam created the error.',
+                                            format: 'date-time',
+                                            type: 'string',
+                                        },
+                                        error_code: {
+                                            description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                                            enum: ['kwikset_insufficient_permissions'],
+                                            type: 'string',
+                                        },
+                                        is_access_code_error: {
+                                            description: 'Indicates that this is an access code error.',
+                                            enum: [true],
+                                            type: 'boolean',
+                                        },
+                                        message: {
+                                            description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                                            type: 'string',
+                                        },
+                                    },
+                                    required: ['message', 'is_access_code_error', 'error_code'],
+                                    type: 'object',
+                                },
                                 {
                                     description: 'Indicates that the account is disconnected.',
                                     properties: {
@@ -19451,6 +19477,32 @@ export default {
                                     required: ['message', 'is_access_code_error', 'error_code'],
                                     type: 'object',
                                 },
+                                {
+                                    description: 'Admin role required—insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.',
+                                    properties: {
+                                        created_at: {
+                                            description: 'Date and time at which Seam created the error.',
+                                            format: 'date-time',
+                                            type: 'string',
+                                        },
+                                        error_code: {
+                                            description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                                            enum: ['kwikset_insufficient_permissions'],
+                                            type: 'string',
+                                        },
+                                        is_access_code_error: {
+                                            description: 'Indicates that this is an access code error.',
+                                            enum: [true],
+                                            type: 'boolean',
+                                        },
+                                        message: {
+                                            description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                                            type: 'string',
+                                        },
+                                    },
+                                    required: ['message', 'is_access_code_error', 'error_code'],
+                                    type: 'object',
+                                },
                                 {
                                     description: 'Indicates that the account is disconnected.',
                                     properties: {
@@ -45912,6 +45964,177 @@ export default {
                 'x-undocumented': 'Internal endpoint for customer portals.',
             },
         },
+        '/seam/customer/v1/reservations/get': {
+            get: {
+                description: 'Returns a single reservation for a specific customer by reservation ID.',
+                operationId: 'seamCustomerV1ReservationsGetGet',
+                parameters: [
+                    {
+                        in: 'query',
+                        name: 'reservation_id',
+                        schema: {
+                            description: 'ID of the reservation to retrieve.',
+                            format: 'uuid',
+                            type: 'string',
+                        },
+                    },
+                    {
+                        in: 'query',
+                        name: 'reservation_key',
+                        schema: {
+                            description: 'Key of the reservation to retrieve.',
+                            type: 'string',
+                        },
+                    },
+                ],
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: { type: 'boolean' },
+                                        reservation: {
+                                            properties: {
+                                                access_methods: {
+                                                    items: { $ref: '#/components/schemas/access_method' },
+                                                    type: 'array',
+                                                },
+                                                created_at: { format: 'date-time', type: 'string' },
+                                                ends_at: {
+                                                    format: 'date-time',
+                                                    nullable: true,
+                                                    type: 'string',
+                                                },
+                                                guest_name: { nullable: true, type: 'string' },
+                                                name: { nullable: true, type: 'string' },
+                                                reservation_id: { format: 'uuid', type: 'string' },
+                                                reservation_key: { type: 'string' },
+                                                starts_at: {
+                                                    format: 'date-time',
+                                                    nullable: true,
+                                                    type: 'string',
+                                                },
+                                            },
+                                            required: [
+                                                'reservation_id',
+                                                'reservation_key',
+                                                'name',
+                                                'starts_at',
+                                                'ends_at',
+                                                'created_at',
+                                                'guest_name',
+                                                'access_methods',
+                                            ],
+                                            type: 'object',
+                                        },
+                                    },
+                                    required: ['reservation', 'ok'],
+                                    type: 'object',
+                                },
+                            },
+                        },
+                        description: 'OK',
+                    },
+                    400: { description: 'Bad Request' },
+                    401: { description: 'Unauthorized' },
+                },
+                security: [{ client_session_with_customer: [] }],
+                summary: '/seam/customer/v1/reservations/get',
+                tags: [],
+                'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'reservations'],
+                'x-fern-sdk-method-name': 'get',
+                'x-fern-sdk-return-value': 'reservation',
+                'x-response-key': 'reservation',
+                'x-title': 'Get Reservation for Customer',
+                'x-undocumented': 'Internal endpoint for customer portals.',
+            },
+            post: {
+                description: 'Returns a single reservation for a specific customer by reservation ID.',
+                operationId: 'seamCustomerV1ReservationsGetPost',
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    reservation_id: {
+                                        description: 'ID of the reservation to retrieve.',
+                                        format: 'uuid',
+                                        type: 'string',
+                                    },
+                                    reservation_key: {
+                                        description: 'Key of the reservation to retrieve.',
+                                        type: 'string',
+                                    },
+                                },
+                                type: 'object',
+                            },
+                        },
+                    },
+                },
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: { type: 'boolean' },
+                                        reservation: {
+                                            properties: {
+                                                access_methods: {
+                                                    items: { $ref: '#/components/schemas/access_method' },
+                                                    type: 'array',
+                                                },
+                                                created_at: { format: 'date-time', type: 'string' },
+                                                ends_at: {
+                                                    format: 'date-time',
+                                                    nullable: true,
+                                                    type: 'string',
+                                                },
+                                                guest_name: { nullable: true, type: 'string' },
+                                                name: { nullable: true, type: 'string' },
+                                                reservation_id: { format: 'uuid', type: 'string' },
+                                                reservation_key: { type: 'string' },
+                                                starts_at: {
+                                                    format: 'date-time',
+                                                    nullable: true,
+                                                    type: 'string',
+                                                },
+                                            },
+                                            required: [
+                                                'reservation_id',
+                                                'reservation_key',
+                                                'name',
+                                                'starts_at',
+                                                'ends_at',
+                                                'created_at',
+                                                'guest_name',
+                                                'access_methods',
+                                            ],
+                                            type: 'object',
+                                        },
+                                    },
+                                    required: ['reservation', 'ok'],
+                                    type: 'object',
+                                },
+                            },
+                        },
+                        description: 'OK',
+                    },
+                    400: { description: 'Bad Request' },
+                    401: { description: 'Unauthorized' },
+                },
+                security: [{ client_session_with_customer: [] }],
+                summary: '/seam/customer/v1/reservations/get',
+                tags: [],
+                'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'reservations'],
+                'x-fern-sdk-method-name': 'get',
+                'x-fern-sdk-return-value': 'reservation',
+                'x-response-key': 'reservation',
+                'x-title': 'Get Reservation for Customer',
+                'x-undocumented': 'Internal endpoint for customer portals.',
+            },
+        },
         '/seam/customer/v1/reservations/list': {
             get: {
                 description: 'Returns a list of reservations for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.',
@@ -45925,6 +46148,15 @@ export default {
                             type: 'string',
                         },
                     },
+                    {
+                        in: 'query',
+                        name: 'space_id',
+                        schema: {
+                            description: 'Filter reservations by space ID (UUID).',
+                            format: 'uuid',
+                            type: 'string',
+                        },
+                    },
                     {
                         in: 'query',
                         name: 'limit',
@@ -46048,6 +46280,11 @@ export default {
                                         nullable: true,
                                         type: 'string',
                                     },
+                                    space_id: {
+                                        description: 'Filter reservations by space ID (UUID).',
+                                        format: 'uuid',
+                                        type: 'string',
+                                    },
                                     space_key: {
                                         description: 'Filter reservations by space key.',
                                         type: 'string',