@seamapi/types 1.421.1 → 1.422.0

package/package.json

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

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

@@ -1,6 +1,9 @@
 export {
   access_code_code_constraint,
   access_grant,
+  access_grant_key_aliases,
+  access_grant_resource,
+  access_grant_resource_union,
   access_method,
   acs_access_group,
   acs_access_group_external_type,
@@ -18,18 +21,22 @@ export {
   acs_user_external_type,
   any_device_type,
   battery_status,
+  booking_resource,
   bridge,
   bridge_client_session,
   bridge_connected_system,
   building_block_type,
+  building_resource,
   capabilities,
   climate_preset,
   climate_setting,
+  common_area_resource,
   common_device_properties,
   common_event,
   connect_webview_device_selection_mode,
   connected_account,
   custom_metadata_input,
+  customer_data,
   device_capability_flags,
   device_metadata,
   device_provider,
@@ -37,31 +44,42 @@ export {
   enrollment_automation,
   seam_event as event,
   seam_event_type as event_type,
+  facility_resource,
   fan_mode_setting,
   geolocation,
+  guest_resource,
   instant_key,
+  listing_resource,
   location,
   lock_device_type,
   magic_link,
   access_code as managed_access_code,
   device as managed_device,
+  neutral_resource,
   noise_sensor_device_type,
   noise_threshold,
   pagination,
-  partner_resource,
   phone,
   phone_number,
   phone_registration,
   phone_session,
+  portal_configuration,
+  property_resource,
+  reservation_resource,
+  resident_resource,
+  room_resource,
   space,
-  space_resource,
+  neutral_resource as space_resource,
+  tenant_resource,
   thermostat_capability_properties,
   thermostat_device_type,
   thermostat_schedule,
-  typed_partner_resource,
+  unit_resource,
   unmanaged_access_code,
   unmanaged_device,
   user_identity,
+  user_identity_resource,
+  user_resource,
   webhook,
 } from '../models/index.js'
 export * from '../schemas.js'

package/src/lib/seam/connect/models/customer/access-grant-resources.ts

@@ -0,0 +1,129 @@
+import { z } from 'zod'
+
+// Base access grant resource with common fields
+const base_access_grant_resource = z.object({
+  name: z
+    .string()
+    .describe('Your display name for this access grant resource.'),
+  starts_at: z
+    .string()
+    .optional()
+    .describe('Starting date and time for the access grant.'),
+  ends_at: z
+    .string()
+    .optional()
+    .describe('Ending date and time for the access grant.'),
+})
+
+// User identity key reference - allows any user identity key alias
+export const user_identity_reference = z.object({
+  // Allow any user identity key alias (only one should be present)
+  guest_key: z
+    .string()
+    .optional()
+    .describe('Guest key associated with the access grant.'),
+  tenant_key: z
+    .string()
+    .optional()
+    .describe('Tenant key associated with the access grant.'),
+  resident_key: z
+    .string()
+    .optional()
+    .describe('Resident key associated with the access grant.'),
+  user_key: z
+    .string()
+    .optional()
+    .describe('User key associated with the access grant.'),
+  user_identity_key: z
+    .string()
+    .optional()
+    .describe('User identity key associated with the access grant.'),
+})
+
+// Location key references - separate arrays for each location key alias
+export const location_references = z.object({
+  // Allow arrays of strings for each location key alias
+  space_keys: z
+    .array(z.string())
+    .optional()
+    .describe('Space keys associated with the access grant.'),
+  property_keys: z
+    .array(z.string())
+    .optional()
+    .describe('Property keys associated with the access grant.'),
+  room_keys: z
+    .array(z.string())
+    .optional()
+    .describe('Room keys associated with the access grant.'),
+  common_area_keys: z
+    .array(z.string())
+    .optional()
+    .describe('Common area keys associated with the access grant.'),
+  unit_keys: z
+    .array(z.string())
+    .optional()
+    .describe('Unit keys associated with the access grant.'),
+  facility_keys: z
+    .array(z.string())
+    .optional()
+    .describe('Facility keys associated with the access grant.'),
+  building_keys: z
+    .array(z.string())
+    .optional()
+    .describe('Building keys associated with the access grant.'),
+  listing_keys: z
+    .array(z.string())
+    .optional()
+    .describe('Listing keys associated with the access grant.'),
+})
+
+// Access grant resource types with their key aliases
+export const reservation_resource = base_access_grant_resource
+  .extend({
+    reservation_key: z
+      .string()
+      .describe('Your unique identifier for the reservation.'),
+  })
+  .merge(user_identity_reference)
+  .merge(location_references)
+
+export const booking_resource = base_access_grant_resource
+  .extend({
+    booking_key: z.string().describe('Your unique identifier for the booking.'),
+  })
+  .merge(user_identity_reference)
+  .merge(location_references)
+
+export const access_grant_resource = base_access_grant_resource
+  .extend({
+    access_grant_key: z
+      .string()
+      .describe('Your unique identifier for the access grant.'),
+  })
+  .merge(user_identity_reference)
+  .merge(location_references)
+
+// Union of all access grant resource types
+export const access_grant_resource_union = z.union([
+  reservation_resource,
+  booking_resource,
+  access_grant_resource,
+])
+
+// All access grant key aliases for use in references
+export const access_grant_key_aliases = z.union([
+  z.object({ reservation_key: z.string() }),
+  z.object({ booking_key: z.string() }),
+  z.object({ access_grant_key: z.string() }),
+])
+
+// Export types
+export type ReservationResource = z.infer<typeof reservation_resource>
+export type BookingResource = z.infer<typeof booking_resource>
+export type AccessGrantResource = z.infer<typeof access_grant_resource>
+export type AccessGrantResourceUnion = z.infer<
+  typeof access_grant_resource_union
+>
+export type AccessGrantKeyAliases = z.infer<typeof access_grant_key_aliases>
+export type UserIdentityReference = z.infer<typeof user_identity_reference>
+export type LocationReferences = z.infer<typeof location_references>

package/src/lib/seam/connect/models/customer/business-vertical.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod'
+
+export const business_vertical = z
+  .enum([
+    'short_term_rental',
+    'hospitality',
+    'multi_family',
+    'gym_management',
+    'property_tours',
+  ])
+  .describe('Business vertical of the customer portal.')
+
+export type BusinessVertical = z.infer<typeof business_vertical>

package/src/lib/seam/connect/models/customer/customer-data.ts

@@ -0,0 +1,93 @@
+import { z } from 'zod'
+
+import {
+  access_grant_resource,
+  booking_resource,
+  reservation_resource,
+} from './access-grant-resources.js'
+import {
+  building_resource,
+  common_area_resource,
+  facility_resource,
+  listing_resource,
+  neutral_resource,
+  property_resource,
+  room_resource,
+  unit_resource,
+} from './location-resources.js'
+import {
+  guest_resource,
+  resident_resource,
+  tenant_resource,
+  user_identity_resource,
+  user_resource,
+} from './user-identity-resources.js'
+
+export const customer_data = z.object({
+  customer_key: z.string().describe('Your unique identifier for the customer.'),
+
+  // Location resources
+  spaces: z
+    .array(neutral_resource)
+    .optional()
+    .describe('List of general spaces or areas.'),
+  properties: z
+    .array(property_resource)
+    .optional()
+    .describe('List of short-term rental properties.'),
+  rooms: z
+    .array(room_resource)
+    .optional()
+    .describe('List of hotel or hospitality rooms.'),
+  common_areas: z
+    .array(common_area_resource)
+    .optional()
+    .describe('List of shared common areas.'),
+  units: z
+    .array(unit_resource)
+    .optional()
+    .describe('List of multi-family residential units.'),
+  facilities: z
+    .array(facility_resource)
+    .optional()
+    .describe('List of gym or fitness facilities.'),
+  buildings: z
+    .array(building_resource)
+    .optional()
+    .describe('List of buildings.'),
+  listings: z
+    .array(listing_resource)
+    .optional()
+    .describe('List of property listings.'),
+
+  // User identity resources
+  guests: z.array(guest_resource).optional().describe('List of guests.'),
+  tenants: z.array(tenant_resource).optional().describe('List of tenants.'),
+  residents: z
+    .array(resident_resource)
+    .optional()
+    .describe('List of residents.'),
+  users: z.array(user_resource).optional().describe('List of users.'),
+  user_identities: z
+    .array(user_identity_resource)
+    .optional()
+    .describe('List of user identities.'),
+
+  // Access grant resources
+  reservations: z
+    .array(reservation_resource)
+    .optional()
+    .describe('List of reservations.'),
+  bookings: z.array(booking_resource).optional().describe('List of bookings.'),
+  access_grants: z
+    .array(access_grant_resource)
+    .optional()
+    .describe('List of access grants.'),
+})
+
+export type CustomerData = z.infer<typeof customer_data>
+
+// Re-export all resource types for convenience
+export * from './access-grant-resources.js'
+export * from './location-resources.js'
+export * from './user-identity-resources.js'

package/src/lib/seam/connect/models/customer/customer-portal.ts

@@ -0,0 +1,39 @@
+import { z } from 'zod'
+
+const base_feature = z.object({
+  exclude: z
+    .boolean()
+    .default(false)
+    .describe('Whether to exclude this feature from the portal.'),
+})
+
+const base_connect_feature = base_feature
+const base_manage_devices_feature = base_feature
+const base_organize_feature = base_feature
+
+const base_features = z.object({
+  connect: base_connect_feature
+    .default({})
+    .describe('Configuration for the connect accounts feature.'),
+  manage_devices: base_manage_devices_feature
+    .default({})
+    .describe('Configuration for the manage devices feature.'),
+  organize: base_organize_feature
+    .default({})
+    .describe('Configuration for the organize feature.'),
+})
+
+export const portal_configuration = z
+  .object({
+    features: base_features.default({}),
+  })
+  .default({
+    features: {
+      connect: { exclude: false },
+      organize: { exclude: false },
+      manage_devices: { exclude: false },
+    },
+  })
+  .describe(`Configuration for a customer portal`)
+
+export type PortalConfiguration = z.infer<typeof portal_configuration>

package/src/lib/seam/connect/models/customer/index.ts

@@ -0,0 +1,3 @@
+export * from './business-vertical.js'
+export * from './customer-data.js'
+export * from './customer-portal.js'

package/src/lib/seam/connect/models/customer/location-resources.ts

@@ -0,0 +1,77 @@
+import { z } from 'zod'
+
+// Base location resource with common fields
+const base_location_resource = z.object({
+  name: z.string().describe('Your display name for this location resource.'),
+})
+
+// Location resource types with their key aliases
+export const neutral_resource = base_location_resource.extend({
+  space_key: z.string().describe('Your unique identifier for the space.'),
+})
+
+export const property_resource = base_location_resource.extend({
+  property_key: z.string().describe('Your unique identifier for the property.'),
+})
+
+export const room_resource = base_location_resource.extend({
+  room_key: z.string().describe('Your unique identifier for the room.'),
+})
+
+export const common_area_resource = base_location_resource.extend({
+  common_area_key: z
+    .string()
+    .describe('Your unique identifier for the common area.'),
+})
+
+export const unit_resource = base_location_resource.extend({
+  unit_key: z.string().describe('Your unique identifier for the unit.'),
+})
+
+export const facility_resource = base_location_resource.extend({
+  facility_key: z.string().describe('Your unique identifier for the facility.'),
+})
+
+export const building_resource = base_location_resource.extend({
+  building_key: z.string().describe('Your unique identifier for the building.'),
+})
+
+export const listing_resource = base_location_resource.extend({
+  listing_key: z.string().describe('Your unique identifier for the listing.'),
+})
+
+// Union of all location resource types
+export const location_resource = z.union([
+  neutral_resource,
+  property_resource,
+  room_resource,
+  common_area_resource,
+  unit_resource,
+  facility_resource,
+  building_resource,
+  listing_resource,
+])
+
+// All location key aliases for use in references
+export const location_key_aliases = z.union([
+  z.object({ space_key: z.string() }),
+  z.object({ property_key: z.string() }),
+  z.object({ room_key: z.string() }),
+  z.object({ common_area_key: z.string() }),
+  z.object({ unit_key: z.string() }),
+  z.object({ facility_key: z.string() }),
+  z.object({ building_key: z.string() }),
+  z.object({ listing_key: z.string() }),
+])
+
+// Export types
+export type NeutralResource = z.infer<typeof neutral_resource>
+export type PropertyResource = z.infer<typeof property_resource>
+export type RoomResource = z.infer<typeof room_resource>
+export type CommonAreaResource = z.infer<typeof common_area_resource>
+export type UnitResource = z.infer<typeof unit_resource>
+export type FacilityResource = z.infer<typeof facility_resource>
+export type BuildingResource = z.infer<typeof building_resource>
+export type ListingResource = z.infer<typeof listing_resource>
+export type LocationResource = z.infer<typeof location_resource>
+export type LocationKeyAliases = z.infer<typeof location_key_aliases>

package/src/lib/seam/connect/models/customer/user-identity-resources.ts

@@ -0,0 +1,68 @@
+import { z } from 'zod'
+
+// Base user identity resource with common fields
+const base_user_identity_resource = z.object({
+  name: z
+    .string()
+    .describe('Your display name for this user identity resource.'),
+  email_address: z
+    .string()
+    .optional()
+    .describe('Email address associated with the user identity.'),
+  phone_number: z
+    .string()
+    .optional()
+    .describe('Phone number associated with the user identity.'),
+})
+
+// User identity resource types with their key aliases
+export const guest_resource = base_user_identity_resource.extend({
+  guest_key: z.string().describe('Your unique identifier for the guest.'),
+})
+
+export const tenant_resource = base_user_identity_resource.extend({
+  tenant_key: z.string().describe('Your unique identifier for the tenant.'),
+})
+
+export const resident_resource = base_user_identity_resource.extend({
+  resident_key: z.string().describe('Your unique identifier for the resident.'),
+})
+
+export const user_resource = base_user_identity_resource.extend({
+  user_key: z.string().describe('Your unique identifier for the user.'),
+})
+
+export const user_identity_resource = base_user_identity_resource.extend({
+  user_identity_key: z
+    .string()
+    .describe('Your unique identifier for the user identity.'),
+})
+
+// Union of all user identity resource types
+export const user_identity_resource_union = z.union([
+  guest_resource,
+  tenant_resource,
+  resident_resource,
+  user_resource,
+  user_identity_resource,
+])
+
+// All user identity key aliases for use in references
+export const user_identity_key_aliases = z.union([
+  z.object({ guest_key: z.string() }),
+  z.object({ tenant_key: z.string() }),
+  z.object({ resident_key: z.string() }),
+  z.object({ user_key: z.string() }),
+  z.object({ user_identity_key: z.string() }),
+])
+
+// Export types
+export type GuestResource = z.infer<typeof guest_resource>
+export type TenantResource = z.infer<typeof tenant_resource>
+export type ResidentResource = z.infer<typeof resident_resource>
+export type UserResource = z.infer<typeof user_resource>
+export type UserIdentityResource = z.infer<typeof user_identity_resource>
+export type UserIdentityResourceUnion = z.infer<
+  typeof user_identity_resource_union
+>
+export type UserIdentityKeyAliases = z.infer<typeof user_identity_key_aliases>

package/src/lib/seam/connect/models/index.ts

@@ -8,6 +8,10 @@ export * from './client-sessions/index.js'
 export * from './connect-webviews/index.js'
 export * from './connected-accounts/index.js'
 export * from './custom-metadata.js'
+export * from './customer/access-grant-resources.js'
+export * from './customer/index.js'
+export * from './customer/location-resources.js'
+export * from './customer/user-identity-resources.js'
 export * from './devices/index.js'
 export * from './events/index.js'
 export * from './instant-keys/index.js'

package/src/lib/seam/connect/models/partner/index.ts

@@ -1,2 +1 @@
 export * from './magic-link.js'
-export * from './resources.js'