@seamapi/types 1.535.0 → 1.537.0

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

@@ -31061,6 +31061,28 @@ export type Routes = {
             };
             /** Whether the portal is embedded in another application. */
             is_embedded?: boolean;
+            /** Configuration for the landing page when the portal loads. */
+            landing_page?: {
+                manage?: ({
+                    space_key: string;
+                } | {
+                    property_key: string;
+                } | {
+                    room_key: string;
+                } | {
+                    common_area_key: string;
+                } | {
+                    unit_key: string;
+                } | {
+                    facility_key: string;
+                } | {
+                    building_key: string;
+                } | {
+                    listing_key: string;
+                } | {
+                    property_listing_key: string;
+                }) | undefined;
+            } | undefined;
         } & {
             customer_data?: {
                 /** Your unique identifier for the customer. */
@@ -57671,6 +57693,27 @@ export type Routes = {
                     } | undefined;
                 } | undefined;
                 is_embedded?: boolean | undefined;
+                landing_page?: {
+                    manage?: ({
+                        space_key: string;
+                    } | {
+                        property_key: string;
+                    } | {
+                        room_key: string;
+                    } | {
+                        common_area_key: string;
+                    } | {
+                        unit_key: string;
+                    } | {
+                        facility_key: string;
+                    } | {
+                        building_key: string;
+                    } | {
+                        listing_key: string;
+                    } | {
+                        property_listing_key: string;
+                    }) | undefined;
+                } | undefined;
                 /** Business vertical of the customer portal. */
                 business_vertical?: ('short_term_rental' | 'hospitality' | 'multi_family' | 'gym_management' | 'property_tours') | undefined;
             };
@@ -57749,6 +57792,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';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.535.0",
+  "version": "1.537.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/customer/customer-portal.ts

@@ -1,5 +1,7 @@
 import { z } from 'zod'
 
+import { location_key_aliases } from './location-resources.js'
+
 const base_feature = z.object({
   exclude: z
     .boolean()
@@ -48,6 +50,12 @@ export const portal_configuration = z
       .boolean()
       .default(false)
       .describe('Whether the portal is embedded in another application.'),
+    landing_page: z
+      .object({
+        manage: location_key_aliases.optional(),
+      })
+      .optional()
+      .describe('Configuration for the landing page when the portal loads.'),
   })
   .default({
     features: {

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>