@seamapi/types 1.1087.0 → 1.1089.0

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

@@ -41992,7 +41992,7 @@ export type Routes = {
             customer_id?: string | undefined;
             /** Customer key that you want to associate with the new client session. */
             customer_key?: string | undefined;
-            /** Your user ID for the user for whom you want to create a client session. */
+            /** Your user ID for the user for whom you want to create a client session. When you authenticate with a publishable key, the `user_identifier_key` must be a high-entropy secret that only the user knows, such as a UUIDv4 or a salted hash. Do not use an email address, name, phone number, or other guessable value, because anyone who knows the `user_identifier_key` can retrieve the client session. */
             user_identifier_key?: string | undefined;
             /** IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) for which you want to create a client session. */
             connect_webview_ids?: string[] | undefined;
@@ -42118,7 +42118,7 @@ export type Routes = {
         method: 'POST';
         queryParams: {};
         jsonBody: {
-            /** Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session). */
+            /** Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session). When you authenticate with a publishable key, the `user_identifier_key` must be a high-entropy secret that only the user knows, such as a UUIDv4 or a salted hash. Do not use an email address, name, phone number, or other guessable value, because anyone who knows the `user_identifier_key` can retrieve the client session. */
             user_identifier_key?: string | undefined;
             /** IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session). */
             connect_webview_ids?: string[] | undefined;
@@ -83761,6 +83761,38 @@ export type Routes = {
         };
         maxDuration: undefined;
     };
+    '/seam/customer/v1/automation_runs/create': {
+        route: '/seam/customer/v1/automation_runs/create';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            /** Key of the customer that owns the reservation. Not allowed with client_session_with_customer auth. */
+            customer_key?: string | undefined;
+            /** Key of the reservation to run automations for. */
+            reservation_key: string;
+            /** Don't use the reservation's preferred code for the new access grant's code. */
+            should_ignore_preferred_code?: boolean;
+            /** Don't use the last four digits of the guest's phone number as the new access grant's code, even when the automation is configured to. */
+            should_ignore_guest_phone_last4_as_code?: boolean;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            automation_run: {
+                status: 'access_grant_created' | 'skipped';
+                reservation_id: string;
+                reservation_key: string;
+                /** ID of the access grant the run created. */
+                access_grant_id: string | null;
+                /** Why the run did not create an access grant. */
+                skip_reason: string | null;
+                message: string | null;
+                /** Set when the new access grant's code is fixed by the reservation instead of generated, so it matches the previous code. `reservation_preferred_code` means the reservation sets a preferred code; `guest_phone_number` means the automation uses the last digits of the guest's phone number. */
+                reused_code_source: ('reservation_preferred_code' | 'guest_phone_number') | null;
+            };
+        };
+        maxDuration: undefined;
+    };
     '/seam/customer/v1/automation_runs/list': {
         route: '/seam/customer/v1/automation_runs/list';
         method: 'GET' | 'POST';

package/package.json

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

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

@@ -46866,7 +46866,7 @@ const openapi: OpenAPISpec = {
                   },
                   user_identifier_key: {
                     description:
-                      'Your user ID for the user for whom you want to create a client session.',
+                      'Your user ID for the user for whom you want to create a client session. When you authenticate with a publishable key, the `user_identifier_key` must be a high-entropy secret that only the user knows, such as a UUIDv4 or a salted hash. Do not use an email address, name, phone number, or other guessable value, because anyone who knows the `user_identifier_key` can retrieve the client session.',
                     minLength: 1,
                     type: 'string',
                   },
@@ -47066,7 +47066,7 @@ const openapi: OpenAPISpec = {
                   },
                   user_identifier_key: {
                     description:
-                      'Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session).',
+                      'Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session). When you authenticate with a publishable key, the `user_identifier_key` must be a high-entropy secret that only the user knows, such as a UUIDv4 or a salted hash. Do not use an email address, name, phone number, or other guessable value, because anyone who knows the `user_identifier_key` can retrieve the client session.',
                     minLength: 1,
                     type: 'string',
                   },
@@ -59391,6 +59391,124 @@ const openapi: OpenAPISpec = {
         'x-undocumented': 'Internal endpoint for customer portals.',
       },
     },
+    '/seam/customer/v1/automation_runs/create': {
+      post: {
+        description:
+          "Runs automations for a reservation now instead of waiting for the next connector sync. Use it after deleting a reservation's access grant to issue a new one.",
+        operationId: 'seamCustomerV1AutomationRunsCreatePost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  customer_key: {
+                    description:
+                      'Key of the customer that owns the reservation. Not allowed with client_session_with_customer auth.',
+                    minLength: 1,
+                    type: 'string',
+                  },
+                  reservation_key: {
+                    description:
+                      'Key of the reservation to run automations for.',
+                    minLength: 1,
+                    type: 'string',
+                  },
+                  should_ignore_guest_phone_last4_as_code: {
+                    default: false,
+                    description:
+                      "Don't use the last four digits of the guest's phone number as the new access grant's code, even when the automation is configured to.",
+                    type: 'boolean',
+                  },
+                  should_ignore_preferred_code: {
+                    default: false,
+                    description:
+                      "Don't use the reservation's preferred code for the new access grant's code.",
+                    type: 'boolean',
+                  },
+                },
+                required: ['reservation_key'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          '200': {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    automation_run: {
+                      properties: {
+                        access_grant_id: {
+                          description:
+                            'ID of the access grant the run created.',
+                          format: 'uuid',
+                          nullable: true,
+                          type: 'string',
+                        },
+                        message: { nullable: true, type: 'string' },
+                        reservation_id: { format: 'uuid', type: 'string' },
+                        reservation_key: { type: 'string' },
+                        reused_code_source: {
+                          description:
+                            "Set when the new access grant's code is fixed by the reservation instead of generated, so it matches the previous code. `reservation_preferred_code` means the reservation sets a preferred code; `guest_phone_number` means the automation uses the last digits of the guest's phone number.",
+                          enum: [
+                            'reservation_preferred_code',
+                            'guest_phone_number',
+                          ],
+                          nullable: true,
+                          type: 'string',
+                        },
+                        skip_reason: {
+                          description:
+                            'Why the run did not create an access grant.',
+                          nullable: true,
+                          type: 'string',
+                        },
+                        status: {
+                          enum: ['access_grant_created', 'skipped'],
+                          type: 'string',
+                        },
+                      },
+                      required: [
+                        'status',
+                        'reservation_id',
+                        'reservation_key',
+                        'access_grant_id',
+                        'skip_reason',
+                        'message',
+                        'reused_code_source',
+                      ],
+                      type: 'object',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['automation_run', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          '400': { description: 'Bad Request' },
+          '401': { description: 'Unauthorized' },
+        },
+        security: [
+          { client_session_with_customer: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/seam/customer/v1/automation_runs/create',
+        tags: [],
+        'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automation_runs'],
+        'x-fern-sdk-method-name': 'create',
+        'x-fern-sdk-return-value': 'automation_run',
+        'x-response-key': 'automation_run',
+        'x-title': 'Create Automation Run',
+        'x-undocumented': 'Internal endpoint for customer portals.',
+      },
+    },
     '/seam/customer/v1/automation_runs/list': {
       get: {
         description:

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

@@ -49188,7 +49188,7 @@ export type Routes = {
       customer_id?: string | undefined
       /** Customer key that you want to associate with the new client session. */
       customer_key?: string | undefined
-      /** Your user ID for the user for whom you want to create a client session. */
+      /** Your user ID for the user for whom you want to create a client session. When you authenticate with a publishable key, the `user_identifier_key` must be a high-entropy secret that only the user knows, such as a UUIDv4 or a salted hash. Do not use an email address, name, phone number, or other guessable value, because anyone who knows the `user_identifier_key` can retrieve the client session. */
       user_identifier_key?: string | undefined
       /** IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) for which you want to create a client session. */
       connect_webview_ids?: string[] | undefined
@@ -49314,7 +49314,7 @@ export type Routes = {
     method: 'POST'
     queryParams: {}
     jsonBody: {
-      /** Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session). */
+      /** Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session). When you authenticate with a publishable key, the `user_identifier_key` must be a high-entropy secret that only the user knows, such as a UUIDv4 or a salted hash. Do not use an email address, name, phone number, or other guessable value, because anyone who knows the `user_identifier_key` can retrieve the client session. */
       user_identifier_key?: string | undefined
       /** IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session). */
       connect_webview_ids?: string[] | undefined
@@ -100521,6 +100521,39 @@ export type Routes = {
     }
     maxDuration: undefined
   }
+  '/seam/customer/v1/automation_runs/create': {
+    route: '/seam/customer/v1/automation_runs/create'
+    method: 'POST'
+    queryParams: {}
+    jsonBody: {
+      /** Key of the customer that owns the reservation. Not allowed with client_session_with_customer auth. */
+      customer_key?: string | undefined
+      /** Key of the reservation to run automations for. */
+      reservation_key: string
+      /** Don't use the reservation's preferred code for the new access grant's code. */
+      should_ignore_preferred_code?: boolean
+      /** Don't use the last four digits of the guest's phone number as the new access grant's code, even when the automation is configured to. */
+      should_ignore_guest_phone_last4_as_code?: boolean
+    }
+    commonParams: {}
+    formData: {}
+    jsonResponse: {
+      automation_run: {
+        status: 'access_grant_created' | 'skipped'
+        reservation_id: string
+        reservation_key: string
+        /** ID of the access grant the run created. */
+        access_grant_id: string | null
+        /** Why the run did not create an access grant. */
+        skip_reason: string | null
+        message: string | null
+        /** Set when the new access grant's code is fixed by the reservation instead of generated, so it matches the previous code. `reservation_preferred_code` means the reservation sets a preferred code; `guest_phone_number` means the automation uses the last digits of the guest's phone number. */
+        reused_code_source:
+          ('reservation_preferred_code' | 'guest_phone_number') | null
+      }
+    }
+    maxDuration: undefined
+  }
   '/seam/customer/v1/automation_runs/list': {
     route: '/seam/customer/v1/automation_runs/list'
     method: 'GET' | 'POST'