@seamapi/types 1.1011.0 → 1.1013.0

package/package.json

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

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

@@ -73,6 +73,7 @@ export {
   provider_capability,
   reservation_resource,
   resident_resource,
+  resource_key,
   room_resource,
   space,
   space_customer_data,

package/src/lib/seam/connect/models/custom-metadata.ts

@@ -1,15 +1,22 @@
 import { z } from 'zod'
 
+const custom_metadata_key = z
+  .string()
+  .max(40)
+  .refine((key) => !key.includes('.'), {
+    message: 'Custom metadata key names cannot contain a period (.)',
+  })
+
 export const custom_metadata_input = z
   .record(
-    z.string().max(40),
+    custom_metadata_key,
     z.union([z.string().max(500), z.boolean(), z.null()]),
   )
   .refine((val) => Object.keys(val).length <= 50, {
     message: 'Custom metadata is limited to a maximum of 50 keys',
   })
   .describe(
-    'Set of up to 50 key:value pairs, with key names up to 40 characters long. Accepts string or Boolean values. Strings are limited to 500 characters. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
+    'Set of up to 50 key:value pairs, with key names up to 40 characters long that cannot contain a period (.). Accepts string or Boolean values. Strings are limited to 500 characters. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
   )
 
 export const custom_metadata = z

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

@@ -24,6 +24,7 @@ export * from './partner/index.js'
 export * from './phone-number.js'
 export * from './phones/index.js'
 export * from './provider-capability.js'
+export * from './resource-key.js'
 export * from './spaces/index.js'
 export * from './thermostats/index.js'
 export * from './user-identities/index.js'

package/src/lib/seam/connect/models/resource-key.ts

@@ -0,0 +1,16 @@
+import { z } from 'zod'
+
+/**
+ * Shared schema for every customer-supplied `*_key` identifier
+ * (`customer_key`, `access_grant_key`, `space_key`, `user_identity_key`, ...).
+ *
+ * A whitespace-only key is never a usable identifier: it cannot be looked back
+ * up, and once stored it silently shadows the "no key set" case that the
+ * underlying columns model as NULL.
+ */
+export const resource_key = z
+  .string()
+  .min(1)
+  .refine((value) => value.trim() !== '', {
+    message: 'Must not consist only of whitespace',
+  })