@seamapi/types 1.1020.0 → 1.1022.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.1020.0",
+  "version": "1.1022.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

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: {
@@ -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: {
@@ -85198,6 +85214,7 @@ const openapi: OpenAPISpec = {
             schema: {
               description:
                 'String for which to search. Filters returned user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`.',
+              minLength: 1,
               type: 'string',
             },
           },
@@ -85319,6 +85336,7 @@ const openapi: OpenAPISpec = {
                   search: {
                     description:
                       'String for which to search. Filters returned user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`.',
+                    minLength: 1,
                     type: 'string',
                   },
                   user_identity_ids: {

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

@@ -42189,10 +42189,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`. */
@@ -43187,10 +43187,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. */
@@ -48079,12 +48079,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: {
@@ -94864,8 +94864,8 @@ export type Routes = {
         | 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: {