@seamapi/types 1.534.0 → 1.536.0

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

@@ -25316,10 +25316,6 @@ export type Routes = {
             location_id?: (string | null) | undefined;
             /** ID of the space for which you want to list entrances. */
             space_id?: string | undefined;
-            /** ID of the access grant for which you want to retrieve all entrances. */
-            access_grant_id?: string | undefined;
-            /** ID of the access method for which you want to retrieve all entrances. */
-            access_method_id?: string | undefined;
             /** ID of the connected account for which you want to retrieve all entrances. */
             connected_account_id?: string | undefined;
             /** IDs of the entrances for which you want to retrieve all entrances. */
@@ -32865,8 +32861,6 @@ export type Routes = {
             space_id?: string | undefined;
             /** String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`. */
             search?: string | undefined;
-            /** ID of the access method for which you want to retrieve all devices. */
-            access_method_id?: string | undefined;
         };
         formData: {};
         jsonResponse: {
@@ -34612,8 +34606,6 @@ export type Routes = {
             space_id?: string | undefined;
             /** String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`. */
             search?: string | undefined;
-            /** ID of the access method for which you want to retrieve all devices. */
-            access_method_id?: string | undefined;
         };
         formData: {};
         jsonResponse: {
@@ -41327,8 +41319,6 @@ export type Routes = {
             space_id?: string | undefined;
             /** String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`. */
             search?: string | undefined;
-            /** ID of the access method for which you want to retrieve all devices. */
-            access_method_id?: string | undefined;
         };
         formData: {};
         jsonResponse: {
@@ -48761,8 +48751,6 @@ export type Routes = {
             space_id?: string | undefined;
             /** String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`. */
             search?: string | undefined;
-            /** ID of the access method for which you want to retrieve all devices. */
-            access_method_id?: string | undefined;
         };
         formData: {};
         jsonResponse: {
@@ -57761,6 +57749,57 @@ export type Routes = {
             };
         };
     };
+    '/seam/instant_key/v1/preview/get': {
+        route: '/seam/instant_key/v1/preview/get';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {
+            /** The short code of the instant key to preview. */
+            instant_key_url: string;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            /** Represents a preview of an Instant Key with hotel, guest, and access information. */
+            instant_key_preview: {
+                shortcode: string;
+                hotel: {
+                    hotel_name: string;
+                    primary_color: string;
+                    accent_color: string;
+                    secondary_color: string;
+                    logo_url?: string | undefined;
+                    verified: boolean;
+                };
+                guest: {
+                    first_name: string;
+                    last_name: string;
+                    full_name: string;
+                    email: string;
+                    check_in_date: string;
+                    check_out_date: string;
+                };
+                room: {
+                    room_number: string;
+                    room_type: string;
+                    floor: number;
+                };
+                access: {
+                    name: string;
+                    icon: string;
+                    hours?: string | undefined;
+                    location?: string | undefined;
+                    available: boolean;
+                }[];
+                key_status: 'ready' | 'expired' | 'used';
+                support_phone: string;
+                support_email: string;
+                created_at: string;
+                updated_at: string;
+                expires_at: string;
+            };
+        };
+    };
     '/seam/mobile_sdk/v1/acs/credentials/list': {
         route: '/seam/mobile_sdk/v1/acs/credentials/list';
         method: 'GET' | 'POST';
@@ -67722,8 +67761,6 @@ export type Routes = {
             space_id?: string | undefined;
             /** String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`. */
             search?: string | undefined;
-            /** ID of the access method for which you want to retrieve all devices. */
-            access_method_id?: string | undefined;
         };
         formData: {};
         jsonResponse: {

package/package.json

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

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

@@ -51,6 +51,7 @@ export {
   fan_mode_setting,
   guest_resource,
   instant_key,
+  instant_key_preview,
   listing_resource,
   lock_device_type,
   magic_link,

package/src/lib/seam/connect/models/instant-keys/index.ts

@@ -1 +1,2 @@
 export * from './instant-key.js'
+export * from './instant-key-preview.js'

package/src/lib/seam/connect/models/instant-keys/instant-key-preview.ts

@@ -0,0 +1,58 @@
+import { z } from 'zod'
+
+const instant_key_preview_hotel = z.object({
+  hotel_name: z.string(),
+  primary_color: z.string(),
+  accent_color: z.string(),
+  secondary_color: z.string(),
+  logo_url: z.string().optional(),
+  verified: z.boolean(),
+})
+
+const instant_key_preview_guest = z.object({
+  first_name: z.string(),
+  last_name: z.string(),
+  full_name: z.string(),
+  email: z.string(),
+  check_in_date: z.string(),
+  check_out_date: z.string(),
+})
+
+const instant_key_preview_room = z.object({
+  room_number: z.string(),
+  room_type: z.string(),
+  floor: z.number(),
+})
+
+const instant_key_preview_access = z.object({
+  name: z.string(),
+  icon: z.string(),
+  hours: z.string().optional(),
+  location: z.string().optional(),
+  available: z.boolean(),
+})
+
+export const instant_key_preview = z.object({
+  shortcode: z.string(),
+  hotel: instant_key_preview_hotel,
+  guest: instant_key_preview_guest,
+  room: instant_key_preview_room,
+  access: z.array(instant_key_preview_access),
+  key_status: z.enum(['ready', 'expired', 'used']),
+  support_phone: z.string(),
+  support_email: z.string(),
+  created_at: z.string(),
+  updated_at: z.string(),
+  expires_at: z.string(),
+}).describe(`
+  ---
+  route_path: /instant_keys/preview
+  ---
+  Represents a preview of an Instant Key with hotel, guest, and access information.
+`)
+
+export type InstantKeyPreview = z.infer<typeof instant_key_preview>
+export type InstantKeyPreviewHotel = z.infer<typeof instant_key_preview_hotel>
+export type InstantKeyPreviewGuest = z.infer<typeof instant_key_preview_guest>
+export type InstantKeyPreviewRoom = z.infer<typeof instant_key_preview_room>
+export type InstantKeyPreviewAccess = z.infer<typeof instant_key_preview_access>

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

@@ -33420,26 +33420,6 @@ export default {
               type: 'string',
             },
           },
-          {
-            in: 'query',
-            name: 'access_grant_id',
-            schema: {
-              description:
-                'ID of the access grant for which you want to retrieve all entrances.',
-              format: 'uuid',
-              type: 'string',
-            },
-          },
-          {
-            in: 'query',
-            name: 'access_method_id',
-            schema: {
-              description:
-                'ID of the access method for which you want to retrieve all entrances.',
-              format: 'uuid',
-              type: 'string',
-            },
-          },
           {
             in: 'query',
             name: 'connected_account_id',
@@ -33539,18 +33519,6 @@ export default {
             'application/json': {
               schema: {
                 properties: {
-                  access_grant_id: {
-                    description:
-                      'ID of the access grant for which you want to retrieve all entrances.',
-                    format: 'uuid',
-                    type: 'string',
-                  },
-                  access_method_id: {
-                    description:
-                      'ID of the access method for which you want to retrieve all entrances.',
-                    format: 'uuid',
-                    type: 'string',
-                  },
                   acs_credential_id: {
                     description:
                       'ID of the credential for which you want to retrieve all entrances.',
@@ -40822,16 +40790,6 @@ export default {
               type: 'string',
             },
           },
-          {
-            in: 'query',
-            name: 'access_method_id',
-            schema: {
-              description:
-                'ID of the access method for which you want to retrieve all devices.',
-              format: 'uuid',
-              type: 'string',
-            },
-          },
         ],
         responses: {
           200: {
@@ -40880,12 +40838,6 @@ export default {
             'application/json': {
               schema: {
                 properties: {
-                  access_method_id: {
-                    description:
-                      'ID of the access method for which you want to retrieve all devices.',
-                    format: 'uuid',
-                    type: 'string',
-                  },
                   connect_webview_id: {
                     description:
                       'ID of the Connect Webview for which you want to list devices.',
@@ -42167,16 +42119,6 @@ export default {
               type: 'string',
             },
           },
-          {
-            in: 'query',
-            name: 'access_method_id',
-            schema: {
-              description:
-                'ID of the access method for which you want to retrieve all devices.',
-              format: 'uuid',
-              type: 'string',
-            },
-          },
         ],
         responses: {
           200: {
@@ -42222,12 +42164,6 @@ export default {
             'application/json': {
               schema: {
                 properties: {
-                  access_method_id: {
-                    description:
-                      'ID of the access method for which you want to retrieve all devices.',
-                    format: 'uuid',
-                    type: 'string',
-                  },
                   connect_webview_id: {
                     description:
                       'ID of the Connect Webview for which you want to list devices.',
@@ -44496,16 +44432,6 @@ export default {
               type: 'string',
             },
           },
-          {
-            in: 'query',
-            name: 'access_method_id',
-            schema: {
-              description:
-                'ID of the access method for which you want to retrieve all devices.',
-              format: 'uuid',
-              type: 'string',
-            },
-          },
         ],
         responses: {
           200: {
@@ -44556,12 +44482,6 @@ export default {
             'application/json': {
               schema: {
                 properties: {
-                  access_method_id: {
-                    description:
-                      'ID of the access method for which you want to retrieve all devices.',
-                    format: 'uuid',
-                    type: 'string',
-                  },
                   connect_webview_id: {
                     description:
                       'ID of the Connect Webview for which you want to list devices.',
@@ -45328,16 +45248,6 @@ export default {
               type: 'string',
             },
           },
-          {
-            in: 'query',
-            name: 'access_method_id',
-            schema: {
-              description:
-                'ID of the access method for which you want to retrieve all devices.',
-              format: 'uuid',
-              type: 'string',
-            },
-          },
         ],
         responses: {
           200: {
@@ -45388,12 +45298,6 @@ export default {
             'application/json': {
               schema: {
                 properties: {
-                  access_method_id: {
-                    description:
-                      'ID of the access method for which you want to retrieve all devices.',
-                    format: 'uuid',
-                    type: 'string',
-                  },
                   connect_webview_id: {
                     description:
                       'ID of the Connect Webview for which you want to list devices.',
@@ -49697,6 +49601,284 @@ export default {
         'x-undocumented': 'Seam Instant Key only.',
       },
     },
+    '/seam/instant_key/v1/preview/get': {
+      get: {
+        operationId: 'seamInstantKeyV1PreviewGetGet',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  instant_key_url: {
+                    description:
+                      'The short code of the instant key to preview.',
+                    type: 'string',
+                  },
+                },
+                required: ['instant_key_url'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    instant_key_preview: {
+                      description:
+                        'Represents a preview of an Instant Key with hotel, guest, and access information.',
+                      properties: {
+                        access: {
+                          items: {
+                            properties: {
+                              available: { type: 'boolean' },
+                              hours: { type: 'string' },
+                              icon: { type: 'string' },
+                              location: { type: 'string' },
+                              name: { type: 'string' },
+                            },
+                            required: ['name', 'icon', 'available'],
+                            type: 'object',
+                          },
+                          type: 'array',
+                        },
+                        created_at: { type: 'string' },
+                        expires_at: { type: 'string' },
+                        guest: {
+                          properties: {
+                            check_in_date: { type: 'string' },
+                            check_out_date: { type: 'string' },
+                            email: { type: 'string' },
+                            first_name: { type: 'string' },
+                            full_name: { type: 'string' },
+                            last_name: { type: 'string' },
+                          },
+                          required: [
+                            'first_name',
+                            'last_name',
+                            'full_name',
+                            'email',
+                            'check_in_date',
+                            'check_out_date',
+                          ],
+                          type: 'object',
+                        },
+                        hotel: {
+                          properties: {
+                            accent_color: { type: 'string' },
+                            hotel_name: { type: 'string' },
+                            logo_url: { type: 'string' },
+                            primary_color: { type: 'string' },
+                            secondary_color: { type: 'string' },
+                            verified: { type: 'boolean' },
+                          },
+                          required: [
+                            'hotel_name',
+                            'primary_color',
+                            'accent_color',
+                            'secondary_color',
+                            'verified',
+                          ],
+                          type: 'object',
+                        },
+                        key_status: {
+                          enum: ['ready', 'expired', 'used'],
+                          type: 'string',
+                        },
+                        room: {
+                          properties: {
+                            floor: { format: 'float', type: 'number' },
+                            room_number: { type: 'string' },
+                            room_type: { type: 'string' },
+                          },
+                          required: ['room_number', 'room_type', 'floor'],
+                          type: 'object',
+                        },
+                        shortcode: { type: 'string' },
+                        support_email: { type: 'string' },
+                        support_phone: { type: 'string' },
+                        updated_at: { type: 'string' },
+                      },
+                      required: [
+                        'shortcode',
+                        'hotel',
+                        'guest',
+                        'room',
+                        'access',
+                        'key_status',
+                        'support_phone',
+                        'support_email',
+                        'created_at',
+                        'updated_at',
+                        'expires_at',
+                      ],
+                      type: 'object',
+                      'x-route-path': '/instant_keys/preview',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['instant_key_preview', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [{ certified_client: [] }],
+        summary: '/seam/instant_key/v1/preview/get',
+        tags: [],
+        'x-fern-sdk-group-name': ['seam', 'instant_key', 'v1', 'preview'],
+        'x-fern-sdk-method-name': 'get',
+        'x-fern-sdk-return-value': 'instant_key_preview',
+        'x-response-key': 'instant_key_preview',
+        'x-title': 'Preview Instant Key',
+        'x-undocumented': 'Seam Instant Key only.',
+      },
+      post: {
+        operationId: 'seamInstantKeyV1PreviewGetPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  instant_key_url: {
+                    description:
+                      'The short code of the instant key to preview.',
+                    type: 'string',
+                  },
+                },
+                required: ['instant_key_url'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    instant_key_preview: {
+                      description:
+                        'Represents a preview of an Instant Key with hotel, guest, and access information.',
+                      properties: {
+                        access: {
+                          items: {
+                            properties: {
+                              available: { type: 'boolean' },
+                              hours: { type: 'string' },
+                              icon: { type: 'string' },
+                              location: { type: 'string' },
+                              name: { type: 'string' },
+                            },
+                            required: ['name', 'icon', 'available'],
+                            type: 'object',
+                          },
+                          type: 'array',
+                        },
+                        created_at: { type: 'string' },
+                        expires_at: { type: 'string' },
+                        guest: {
+                          properties: {
+                            check_in_date: { type: 'string' },
+                            check_out_date: { type: 'string' },
+                            email: { type: 'string' },
+                            first_name: { type: 'string' },
+                            full_name: { type: 'string' },
+                            last_name: { type: 'string' },
+                          },
+                          required: [
+                            'first_name',
+                            'last_name',
+                            'full_name',
+                            'email',
+                            'check_in_date',
+                            'check_out_date',
+                          ],
+                          type: 'object',
+                        },
+                        hotel: {
+                          properties: {
+                            accent_color: { type: 'string' },
+                            hotel_name: { type: 'string' },
+                            logo_url: { type: 'string' },
+                            primary_color: { type: 'string' },
+                            secondary_color: { type: 'string' },
+                            verified: { type: 'boolean' },
+                          },
+                          required: [
+                            'hotel_name',
+                            'primary_color',
+                            'accent_color',
+                            'secondary_color',
+                            'verified',
+                          ],
+                          type: 'object',
+                        },
+                        key_status: {
+                          enum: ['ready', 'expired', 'used'],
+                          type: 'string',
+                        },
+                        room: {
+                          properties: {
+                            floor: { format: 'float', type: 'number' },
+                            room_number: { type: 'string' },
+                            room_type: { type: 'string' },
+                          },
+                          required: ['room_number', 'room_type', 'floor'],
+                          type: 'object',
+                        },
+                        shortcode: { type: 'string' },
+                        support_email: { type: 'string' },
+                        support_phone: { type: 'string' },
+                        updated_at: { type: 'string' },
+                      },
+                      required: [
+                        'shortcode',
+                        'hotel',
+                        'guest',
+                        'room',
+                        'access',
+                        'key_status',
+                        'support_phone',
+                        'support_email',
+                        'created_at',
+                        'updated_at',
+                        'expires_at',
+                      ],
+                      type: 'object',
+                      'x-route-path': '/instant_keys/preview',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['instant_key_preview', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [{ certified_client: [] }],
+        summary: '/seam/instant_key/v1/preview/get',
+        tags: [],
+        'x-fern-sdk-group-name': ['seam', 'instant_key', 'v1', 'preview'],
+        'x-fern-sdk-method-name': 'get',
+        'x-fern-sdk-return-value': 'instant_key_preview',
+        'x-response-key': 'instant_key_preview',
+        'x-title': 'Preview Instant Key',
+        'x-undocumented': 'Seam Instant Key only.',
+      },
+    },
     '/seam/mobile_sdk/v1/acs/credentials/list': {
       get: {
         description:
@@ -52642,16 +52824,6 @@ export default {
               type: 'string',
             },
           },
-          {
-            in: 'query',
-            name: 'access_method_id',
-            schema: {
-              description:
-                'ID of the access method for which you want to retrieve all devices.',
-              format: 'uuid',
-              type: 'string',
-            },
-          },
         ],
         responses: {
           200: {
@@ -52702,12 +52874,6 @@ export default {
             'application/json': {
               schema: {
                 properties: {
-                  access_method_id: {
-                    description:
-                      'ID of the access method for which you want to retrieve all devices.',
-                    format: 'uuid',
-                    type: 'string',
-                  },
                   connect_webview_id: {
                     description:
                       'ID of the Connect Webview for which you want to list devices.',