@seamapi/types 1.559.0 → 1.561.0

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

@@ -58017,6 +58017,79 @@ export type Routes = {
             };
         };
     };
+    '/seam/customer/v1/reservations/get': {
+        route: '/seam/customer/v1/reservations/get';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** ID of the reservation to retrieve. */
+            reservation_id?: string | undefined;
+            /** Key of the reservation to retrieve. */
+            reservation_key?: string | undefined;
+        };
+        formData: {};
+        jsonResponse: {
+            reservation: {
+                reservation_id: string;
+                reservation_key: string;
+                name: string | null;
+                starts_at: string | null;
+                ends_at: string | null;
+                created_at: string;
+                guest_name: string | null;
+                access_methods: {
+                    access_method_id: string;
+                    mode: string;
+                    is_issued: boolean;
+                }[];
+            };
+        };
+    };
+    '/seam/customer/v1/reservations/list': {
+        route: '/seam/customer/v1/reservations/list';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** Filter reservations by space key. */
+            space_key?: string | undefined;
+            /** Filter reservations by space ID (UUID). */
+            space_id?: string | undefined;
+            /** Maximum number of records to return per page. */
+            limit?: number;
+            /** Timestamp by which to limit returned reservations. Returns reservations 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: {
+            reservations: {
+                reservation_id: string;
+                reservation_key: string;
+                name: string | null;
+                starts_at: string | null;
+                ends_at: string | null;
+                created_at: string;
+                guest_name: string | null;
+                access_methods: {
+                    access_method_id: string;
+                    mode: string;
+                    is_issued: boolean;
+                }[];
+            }[];
+            /** 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/settings/get': {
         route: '/seam/customer/v1/settings/get';
         method: 'GET' | 'POST';

package/package.json

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

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

@@ -49837,6 +49837,415 @@ 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.',
+        operationId: 'seamCustomerV1ReservationsListGet',
+        parameters: [
+          {
+            in: 'query',
+            name: 'space_key',
+            schema: {
+              description: 'Filter reservations by space key.',
+              type: 'string',
+            },
+          },
+          {
+            in: 'query',
+            name: 'space_id',
+            schema: {
+              description: 'Filter reservations 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 reservations. Returns reservations 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' },
+                    reservations: {
+                      items: {
+                        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',
+                      },
+                      type: 'array',
+                    },
+                  },
+                  required: ['reservations', 'pagination', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: '/seam/customer/v1/reservations/list',
+        tags: [],
+        'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'reservations'],
+        'x-fern-sdk-method-name': 'list',
+        'x-fern-sdk-return-value': 'reservations',
+        'x-response-key': 'reservations',
+        'x-title': 'List Reservations for Customer Space',
+        'x-undocumented': 'Internal endpoint for customer portals.',
+      },
+      post: {
+        description:
+          'Returns a list of reservations for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.',
+        operationId: 'seamCustomerV1ReservationsListPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  created_before: {
+                    description:
+                      'Timestamp by which to limit returned reservations. Returns reservations 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 reservations by space ID (UUID).',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  space_key: {
+                    description: 'Filter reservations by space key.',
+                    type: 'string',
+                  },
+                },
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    ok: { type: 'boolean' },
+                    pagination: { $ref: '#/components/schemas/pagination' },
+                    reservations: {
+                      items: {
+                        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',
+                      },
+                      type: 'array',
+                    },
+                  },
+                  required: ['reservations', 'pagination', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: '/seam/customer/v1/reservations/list',
+        tags: [],
+        'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'reservations'],
+        'x-fern-sdk-method-name': 'list',
+        'x-fern-sdk-return-value': 'reservations',
+        'x-response-key': 'reservations',
+        'x-title': 'List Reservations for Customer Space',
+        'x-undocumented': 'Internal endpoint for customer portals.',
+      },
+    },
     '/seam/customer/v1/settings/get': {
       get: {
         description: 'Retrieves the settings for a customer portal workspace.',

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

@@ -69109,6 +69109,79 @@ export type Routes = {
       }
     }
   }
+  '/seam/customer/v1/reservations/get': {
+    route: '/seam/customer/v1/reservations/get'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      /** ID of the reservation to retrieve. */
+      reservation_id?: string | undefined
+      /** Key of the reservation to retrieve. */
+      reservation_key?: string | undefined
+    }
+    formData: {}
+    jsonResponse: {
+      reservation: {
+        reservation_id: string
+        reservation_key: string
+        name: string | null
+        starts_at: string | null
+        ends_at: string | null
+        created_at: string
+        guest_name: string | null
+        access_methods: {
+          access_method_id: string
+          mode: string
+          is_issued: boolean
+        }[]
+      }
+    }
+  }
+  '/seam/customer/v1/reservations/list': {
+    route: '/seam/customer/v1/reservations/list'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      /** Filter reservations by space key. */
+      space_key?: string | undefined
+      /** Filter reservations by space ID (UUID). */
+      space_id?: string | undefined
+      /** Maximum number of records to return per page. */
+      limit?: number
+      /** Timestamp by which to limit returned reservations. Returns reservations 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: {
+      reservations: {
+        reservation_id: string
+        reservation_key: string
+        name: string | null
+        starts_at: string | null
+        ends_at: string | null
+        created_at: string
+        guest_name: string | null
+        access_methods: {
+          access_method_id: string
+          mode: string
+          is_issued: boolean
+        }[]
+      }[]
+      /** 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/settings/get': {
     route: '/seam/customer/v1/settings/get'
     method: 'GET' | 'POST'