@seamapi/types 1.1021.0 → 1.1023.0

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

@@ -35949,10 +35949,10 @@ export type Routes = {
         commonParams: {
             /** ID of the user identity for which you want to retrieve all access system users. */
             user_identity_id?: string | undefined;
-            /** Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). */
-            user_identity_phone_number?: string | undefined;
-            /** Email address of the user identity for which you want to retrieve all access system users. */
-            user_identity_email_address?: string | undefined;
+            /** Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). Specify `null` to retrieve access system users whose user identity has no phone number. */
+            user_identity_phone_number?: (string | null) | undefined;
+            /** Email address of the user identity for which you want to retrieve all access system users. Specify `null` to retrieve access system users whose user identity has no email address. */
+            user_identity_email_address?: (string | null) | undefined;
             /** ID of the `acs_system` for which you want to retrieve all access system users. */
             acs_system_id?: string | undefined;
             /** String for which to search. Filters returned access system users to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`. */
@@ -36804,10 +36804,10 @@ export type Routes = {
         commonParams: {
             /** ID of the user identity for which you want to retrieve all unmanaged access system users. */
             user_identity_id?: string | undefined;
-            /** Phone number of the user identity for which you want to retrieve all unmanaged access system users. */
-            user_identity_phone_number?: string | undefined;
-            /** Email address of the user identity for which you want to retrieve all unmanaged access system users. */
-            user_identity_email_address?: string | undefined;
+            /** Phone number of the user identity for which you want to retrieve all unmanaged access system users. Specify `null` to retrieve unmanaged access system users whose user identity has no phone number. */
+            user_identity_phone_number?: (string | null) | undefined;
+            /** Email address of the user identity for which you want to retrieve all unmanaged access system users. Specify `null` to retrieve unmanaged access system users whose user identity has no email address. */
+            user_identity_email_address?: (string | null) | undefined;
             /** ID of the access system for which you want to retrieve all unmanaged access system users. */
             acs_system_id?: string | undefined;
             /** Number of unmanaged access system users to return. */
@@ -41042,12 +41042,12 @@ export type Routes = {
             client_session_id?: string | undefined;
             /** Your user ID for the user by which you want to filter client sessions. */
             user_identifier_key?: string | undefined;
-            /** ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) for which you want to retrieve client sessions. */
-            connect_webview_id?: string | undefined;
+            /** ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) for which you want to retrieve client sessions. Specify `null` to retrieve client sessions that are not associated with a Connect Webview. */
+            connect_webview_id?: (string | null) | undefined;
             /** Indicates whether to retrieve only client sessions without associated user identifier keys. */
             without_user_identifier_key?: boolean | undefined;
-            /** ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions. */
-            user_identity_id?: string | undefined;
+            /** ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions. Specify `null` to retrieve client sessions that are not associated with a user identity. */
+            user_identity_id?: (string | null) | undefined;
         };
         formData: {};
         jsonResponse: {
@@ -78876,8 +78876,8 @@ export type Routes = {
             entry_types?: ('resource_created' | 'resource_updated' | 'resource_deleted' | 'event' | 'provider_call' | 'automation_run' | 'webhook_processed')[] | undefined;
             /** Filter timeline entries by context type. 'request' for API requests, 'job' for background jobs. */
             context_type?: ('request' | 'job') | undefined;
-            /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
-            page_cursor?: string | undefined;
+            /** Identifies the specific page of results to return. Specify `null` or omit this parameter to return the first page. */
+            page_cursor?: (string | null) | undefined;
         };
         formData: {};
         jsonResponse: {

package/package.json

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

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

@@ -1,87 +1,89 @@
 import { z } from 'zod'
 
+import { resource_key } from '../../models/resource-key.js'
+
 export const customer_delete_data = z.object({
   // Customer keys to delete all data for
   customer_keys: z
-    .array(z.string())
+    .array(resource_key)
     .optional()
     .describe('List of customer keys to delete all data for.'),
 
   // Location resources to delete
   space_keys: z
-    .array(z.string())
+    .array(resource_key)
     .optional()
     .describe('List of space keys to delete.'),
   property_keys: z
-    .array(z.string())
+    .array(resource_key)
     .optional()
     .describe('List of property keys to delete.'),
   room_keys: z
-    .array(z.string())
+    .array(resource_key)
     .optional()
     .describe('List of room keys to delete.'),
   common_area_keys: z
-    .array(z.string())
+    .array(resource_key)
     .optional()
     .describe('List of common area keys to delete.'),
   unit_keys: z
-    .array(z.string())
+    .array(resource_key)
     .optional()
     .describe('List of unit keys to delete.'),
   facility_keys: z
-    .array(z.string())
+    .array(resource_key)
     .optional()
     .describe('List of facility keys to delete.'),
   building_keys: z
-    .array(z.string())
+    .array(resource_key)
     .optional()
     .describe('List of building keys to delete.'),
   listing_keys: z
-    .array(z.string())
+    .array(resource_key)
     .optional()
     .describe('List of listing keys to delete.'),
   property_listing_keys: z
-    .array(z.string())
+    .array(resource_key)
     .optional()
     .describe('List of property listing keys to delete.'),
 
   // User identity resources to delete
   guest_keys: z
-    .array(z.string())
+    .array(resource_key)
     .optional()
     .describe('List of guest keys to delete.'),
   tenant_keys: z
-    .array(z.string())
+    .array(resource_key)
     .optional()
     .describe('List of tenant keys to delete.'),
   resident_keys: z
-    .array(z.string())
+    .array(resource_key)
     .optional()
     .describe('List of resident keys to delete.'),
   user_keys: z
-    .array(z.string())
+    .array(resource_key)
     .optional()
     .describe('List of user keys to delete.'),
   user_identity_keys: z
-    .array(z.string())
+    .array(resource_key)
     .optional()
     .describe('List of user identity keys to delete.'),
 
   // Access grant resources to delete
   reservation_keys: z
-    .array(z.string())
+    .array(resource_key)
     .optional()
     .describe('List of reservation keys to delete.'),
   booking_keys: z
-    .array(z.string())
+    .array(resource_key)
     .optional()
     .describe('List of booking keys to delete.'),
   access_grant_keys: z
-    .array(z.string())
+    .array(resource_key)
     .optional()
     .describe('List of access grant keys to delete.'),
   staff_member_keys: z
-    .array(z.string())
+    .array(resource_key)
     .optional()
     .describe('List of staff member keys to delete.'),
 })

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

@@ -48092,7 +48092,8 @@ const openapi: OpenAPISpec = {
             name: 'user_identity_phone_number',
             schema: {
               description:
-                'Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).',
+                'Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). Specify `null` to retrieve access system users whose user identity has no phone number.',
+              nullable: true,
               type: 'string',
             },
           },
@@ -48101,7 +48102,8 @@ const openapi: OpenAPISpec = {
             name: 'user_identity_email_address',
             schema: {
               description:
-                'Email address of the user identity for which you want to retrieve all access system users.',
+                'Email address of the user identity for which you want to retrieve all access system users. Specify `null` to retrieve access system users whose user identity has no email address.',
+              nullable: true,
               type: 'string',
             },
           },
@@ -48238,7 +48240,8 @@ const openapi: OpenAPISpec = {
                   },
                   user_identity_email_address: {
                     description:
-                      'Email address of the user identity for which you want to retrieve all access system users.',
+                      'Email address of the user identity for which you want to retrieve all access system users. Specify `null` to retrieve access system users whose user identity has no email address.',
+                    nullable: true,
                     type: 'string',
                   },
                   user_identity_id: {
@@ -48249,7 +48252,8 @@ const openapi: OpenAPISpec = {
                   },
                   user_identity_phone_number: {
                     description:
-                      'Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).',
+                      'Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). Specify `null` to retrieve access system users whose user identity has no phone number.',
+                    nullable: true,
                     type: 'string',
                   },
                 },
@@ -48835,7 +48839,8 @@ const openapi: OpenAPISpec = {
             name: 'user_identity_phone_number',
             schema: {
               description:
-                'Phone number of the user identity for which you want to retrieve all unmanaged access system users.',
+                'Phone number of the user identity for which you want to retrieve all unmanaged access system users. Specify `null` to retrieve unmanaged access system users whose user identity has no phone number.',
+              nullable: true,
               type: 'string',
             },
           },
@@ -48844,7 +48849,8 @@ const openapi: OpenAPISpec = {
             name: 'user_identity_email_address',
             schema: {
               description:
-                'Email address of the user identity for which you want to retrieve all unmanaged access system users.',
+                'Email address of the user identity for which you want to retrieve all unmanaged access system users. Specify `null` to retrieve unmanaged access system users whose user identity has no email address.',
+              nullable: true,
               type: 'string',
             },
           },
@@ -48947,7 +48953,8 @@ const openapi: OpenAPISpec = {
                   },
                   user_identity_email_address: {
                     description:
-                      'Email address of the user identity for which you want to retrieve all unmanaged access system users.',
+                      'Email address of the user identity for which you want to retrieve all unmanaged access system users. Specify `null` to retrieve unmanaged access system users whose user identity has no email address.',
+                    nullable: true,
                     type: 'string',
                   },
                   user_identity_id: {
@@ -48958,7 +48965,8 @@ const openapi: OpenAPISpec = {
                   },
                   user_identity_phone_number: {
                     description:
-                      'Phone number of the user identity for which you want to retrieve all unmanaged access system users.',
+                      'Phone number of the user identity for which you want to retrieve all unmanaged access system users. Specify `null` to retrieve unmanaged access system users whose user identity has no phone number.',
+                    nullable: true,
                     type: 'string',
                   },
                 },
@@ -50594,7 +50602,8 @@ const openapi: OpenAPISpec = {
             name: 'connect_webview_id',
             schema: {
               description:
-                'ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) for which you want to retrieve client sessions.',
+                'ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) for which you want to retrieve client sessions. Specify `null` to retrieve client sessions that are not associated with a Connect Webview.',
+              nullable: true,
               type: 'string',
             },
           },
@@ -50612,7 +50621,8 @@ const openapi: OpenAPISpec = {
             name: 'user_identity_id',
             schema: {
               description:
-                'ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions.',
+                'ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions. Specify `null` to retrieve client sessions that are not associated with a user identity.',
+              nullable: true,
               type: 'string',
             },
           },
@@ -50668,7 +50678,8 @@ const openapi: OpenAPISpec = {
                   },
                   connect_webview_id: {
                     description:
-                      'ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) for which you want to retrieve client sessions.',
+                      'ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) for which you want to retrieve client sessions. Specify `null` to retrieve client sessions that are not associated with a Connect Webview.',
+                    nullable: true,
                     type: 'string',
                   },
                   user_identifier_key: {
@@ -50679,7 +50690,8 @@ const openapi: OpenAPISpec = {
                   },
                   user_identity_id: {
                     description:
-                      'ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions.',
+                      'ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions. Specify `null` to retrieve client sessions that are not associated with a user identity.',
+                    nullable: true,
                     type: 'string',
                   },
                   without_user_identifier_key: {
@@ -53601,7 +53613,7 @@ const openapi: OpenAPISpec = {
             name: 'customer_keys',
             schema: {
               description: 'List of customer keys to delete all data for.',
-              items: { type: 'string' },
+              items: { minLength: 1, type: 'string' },
               type: 'array',
             },
           },
@@ -53610,7 +53622,7 @@ const openapi: OpenAPISpec = {
             name: 'space_keys',
             schema: {
               description: 'List of space keys to delete.',
-              items: { type: 'string' },
+              items: { minLength: 1, type: 'string' },
               type: 'array',
             },
           },
@@ -53619,7 +53631,7 @@ const openapi: OpenAPISpec = {
             name: 'property_keys',
             schema: {
               description: 'List of property keys to delete.',
-              items: { type: 'string' },
+              items: { minLength: 1, type: 'string' },
               type: 'array',
             },
           },
@@ -53628,7 +53640,7 @@ const openapi: OpenAPISpec = {
             name: 'room_keys',
             schema: {
               description: 'List of room keys to delete.',
-              items: { type: 'string' },
+              items: { minLength: 1, type: 'string' },
               type: 'array',
             },
           },
@@ -53637,7 +53649,7 @@ const openapi: OpenAPISpec = {
             name: 'common_area_keys',
             schema: {
               description: 'List of common area keys to delete.',
-              items: { type: 'string' },
+              items: { minLength: 1, type: 'string' },
               type: 'array',
             },
           },
@@ -53646,7 +53658,7 @@ const openapi: OpenAPISpec = {
             name: 'unit_keys',
             schema: {
               description: 'List of unit keys to delete.',
-              items: { type: 'string' },
+              items: { minLength: 1, type: 'string' },
               type: 'array',
             },
           },
@@ -53655,7 +53667,7 @@ const openapi: OpenAPISpec = {
             name: 'facility_keys',
             schema: {
               description: 'List of facility keys to delete.',
-              items: { type: 'string' },
+              items: { minLength: 1, type: 'string' },
               type: 'array',
             },
           },
@@ -53664,7 +53676,7 @@ const openapi: OpenAPISpec = {
             name: 'building_keys',
             schema: {
               description: 'List of building keys to delete.',
-              items: { type: 'string' },
+              items: { minLength: 1, type: 'string' },
               type: 'array',
             },
           },
@@ -53673,7 +53685,7 @@ const openapi: OpenAPISpec = {
             name: 'listing_keys',
             schema: {
               description: 'List of listing keys to delete.',
-              items: { type: 'string' },
+              items: { minLength: 1, type: 'string' },
               type: 'array',
             },
           },
@@ -53682,7 +53694,7 @@ const openapi: OpenAPISpec = {
             name: 'property_listing_keys',
             schema: {
               description: 'List of property listing keys to delete.',
-              items: { type: 'string' },
+              items: { minLength: 1, type: 'string' },
               type: 'array',
             },
           },
@@ -53691,7 +53703,7 @@ const openapi: OpenAPISpec = {
             name: 'guest_keys',
             schema: {
               description: 'List of guest keys to delete.',
-              items: { type: 'string' },
+              items: { minLength: 1, type: 'string' },
               type: 'array',
             },
           },
@@ -53700,7 +53712,7 @@ const openapi: OpenAPISpec = {
             name: 'tenant_keys',
             schema: {
               description: 'List of tenant keys to delete.',
-              items: { type: 'string' },
+              items: { minLength: 1, type: 'string' },
               type: 'array',
             },
           },
@@ -53709,7 +53721,7 @@ const openapi: OpenAPISpec = {
             name: 'resident_keys',
             schema: {
               description: 'List of resident keys to delete.',
-              items: { type: 'string' },
+              items: { minLength: 1, type: 'string' },
               type: 'array',
             },
           },
@@ -53718,7 +53730,7 @@ const openapi: OpenAPISpec = {
             name: 'user_keys',
             schema: {
               description: 'List of user keys to delete.',
-              items: { type: 'string' },
+              items: { minLength: 1, type: 'string' },
               type: 'array',
             },
           },
@@ -53727,7 +53739,7 @@ const openapi: OpenAPISpec = {
             name: 'user_identity_keys',
             schema: {
               description: 'List of user identity keys to delete.',
-              items: { type: 'string' },
+              items: { minLength: 1, type: 'string' },
               type: 'array',
             },
           },
@@ -53736,7 +53748,7 @@ const openapi: OpenAPISpec = {
             name: 'reservation_keys',
             schema: {
               description: 'List of reservation keys to delete.',
-              items: { type: 'string' },
+              items: { minLength: 1, type: 'string' },
               type: 'array',
             },
           },
@@ -53745,7 +53757,7 @@ const openapi: OpenAPISpec = {
             name: 'booking_keys',
             schema: {
               description: 'List of booking keys to delete.',
-              items: { type: 'string' },
+              items: { minLength: 1, type: 'string' },
               type: 'array',
             },
           },
@@ -53754,7 +53766,7 @@ const openapi: OpenAPISpec = {
             name: 'access_grant_keys',
             schema: {
               description: 'List of access grant keys to delete.',
-              items: { type: 'string' },
+              items: { minLength: 1, type: 'string' },
               type: 'array',
             },
           },
@@ -53763,7 +53775,7 @@ const openapi: OpenAPISpec = {
             name: 'staff_member_keys',
             schema: {
               description: 'List of staff member keys to delete.',
-              items: { type: 'string' },
+              items: { minLength: 1, type: 'string' },
               type: 'array',
             },
           },
@@ -53808,98 +53820,98 @@ const openapi: OpenAPISpec = {
                 properties: {
                   access_grant_keys: {
                     description: 'List of access grant keys to delete.',
-                    items: { type: 'string' },
+                    items: { minLength: 1, type: 'string' },
                     type: 'array',
                   },
                   booking_keys: {
                     description: 'List of booking keys to delete.',
-                    items: { type: 'string' },
+                    items: { minLength: 1, type: 'string' },
                     type: 'array',
                   },
                   building_keys: {
                     description: 'List of building keys to delete.',
-                    items: { type: 'string' },
+                    items: { minLength: 1, type: 'string' },
                     type: 'array',
                   },
                   common_area_keys: {
                     description: 'List of common area keys to delete.',
-                    items: { type: 'string' },
+                    items: { minLength: 1, type: 'string' },
                     type: 'array',
                   },
                   customer_keys: {
                     description:
                       'List of customer keys to delete all data for.',
-                    items: { type: 'string' },
+                    items: { minLength: 1, type: 'string' },
                     type: 'array',
                   },
                   facility_keys: {
                     description: 'List of facility keys to delete.',
-                    items: { type: 'string' },
+                    items: { minLength: 1, type: 'string' },
                     type: 'array',
                   },
                   guest_keys: {
                     description: 'List of guest keys to delete.',
-                    items: { type: 'string' },
+                    items: { minLength: 1, type: 'string' },
                     type: 'array',
                   },
                   listing_keys: {
                     description: 'List of listing keys to delete.',
-                    items: { type: 'string' },
+                    items: { minLength: 1, type: 'string' },
                     type: 'array',
                   },
                   property_keys: {
                     description: 'List of property keys to delete.',
-                    items: { type: 'string' },
+                    items: { minLength: 1, type: 'string' },
                     type: 'array',
                   },
                   property_listing_keys: {
                     description: 'List of property listing keys to delete.',
-                    items: { type: 'string' },
+                    items: { minLength: 1, type: 'string' },
                     type: 'array',
                   },
                   reservation_keys: {
                     description: 'List of reservation keys to delete.',
-                    items: { type: 'string' },
+                    items: { minLength: 1, type: 'string' },
                     type: 'array',
                   },
                   resident_keys: {
                     description: 'List of resident keys to delete.',
-                    items: { type: 'string' },
+                    items: { minLength: 1, type: 'string' },
                     type: 'array',
                   },
                   room_keys: {
                     description: 'List of room keys to delete.',
-                    items: { type: 'string' },
+                    items: { minLength: 1, type: 'string' },
                     type: 'array',
                   },
                   space_keys: {
                     description: 'List of space keys to delete.',
-                    items: { type: 'string' },
+                    items: { minLength: 1, type: 'string' },
                     type: 'array',
                   },
                   staff_member_keys: {
                     description: 'List of staff member keys to delete.',
-                    items: { type: 'string' },
+                    items: { minLength: 1, type: 'string' },
                     type: 'array',
                   },
                   tenant_keys: {
                     description: 'List of tenant keys to delete.',
-                    items: { type: 'string' },
+                    items: { minLength: 1, type: 'string' },
                     type: 'array',
                   },
                   unit_keys: {
                     description: 'List of unit keys to delete.',
-                    items: { type: 'string' },
+                    items: { minLength: 1, type: 'string' },
                     type: 'array',
                   },
                   user_identity_keys: {
                     description: 'List of user identity keys to delete.',
-                    items: { type: 'string' },
+                    items: { minLength: 1, type: 'string' },
                     type: 'array',
                   },
                   user_keys: {
                     description: 'List of user keys to delete.',
-                    items: { type: 'string' },
+                    items: { minLength: 1, type: 'string' },
                     type: 'array',
                   },
                 },
@@ -66608,7 +66620,9 @@ const openapi: OpenAPISpec = {
             required: false,
             schema: {
               description:
-                "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
+                'Identifies the specific page of results to return. Specify `null` or omit this parameter to return the first page.',
+              minLength: 1,
+              nullable: true,
               type: 'string',
             },
           },
@@ -67004,7 +67018,9 @@ const openapi: OpenAPISpec = {
                   },
                   page_cursor: {
                     description:
-                      "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
+                      'Identifies the specific page of results to return. Specify `null` or omit this parameter to return the first page.',
+                    minLength: 1,
+                    nullable: true,
                     type: 'string',
                   },
                   resource_id: {