@seamapi/types 1.963.0 → 1.965.0

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

@@ -82911,7 +82911,7 @@ export type Routes = {
         formData: {};
         jsonResponse: {
             /** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
-            access_grant: {
+            access_grant?: {
                 /** ID of the Seam workspace associated with the Access Grant. */
                 workspace_id: string;
                 /** ID of the Access Grant. */
@@ -83089,7 +83089,7 @@ export type Routes = {
                         ends_at: string | null;
                     };
                 })[];
-            };
+            } | undefined;
             spaces: {
                 space_key: string;
                 child_space_keys?: string[] | undefined;
@@ -83142,6 +83142,11 @@ export type Routes = {
                 /** List of unique identifiers for the spaces the staff member is associated with. */
                 space_keys?: string[] | undefined;
                 user_identity_id?: string | undefined;
+                access_grant?: {
+                    starts_at: string;
+                    ends_at: string | null;
+                    created_at: string;
+                } | undefined;
             }[];
             /** Information about the current page of results. */
             pagination: {
@@ -83867,6 +83872,16 @@ export type Routes = {
         };
         maxDuration: undefined;
     };
+    '/seam/webhooks/[provider]/[subscription_id]': {
+        route: '/seam/webhooks/[provider]/[subscription_id]';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: any;
+        commonParams: {};
+        formData: {};
+        jsonResponse: {};
+        maxDuration: undefined;
+    };
     '/spaces/add_acs_entrances': {
         route: '/spaces/add_acs_entrances';
         method: 'POST' | 'PUT';

package/package.json

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

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

@@ -79851,7 +79851,7 @@ const openapi: OpenAPISpec = {
                         'Internal resource for customer portals.',
                     },
                   },
-                  required: ['access_grant', 'spaces', 'staff_member', 'ok'],
+                  required: ['spaces', 'staff_member', 'ok'],
                   type: 'object',
                 },
               },
@@ -79950,7 +79950,7 @@ const openapi: OpenAPISpec = {
                         'Internal resource for customer portals.',
                     },
                   },
-                  required: ['access_grant', 'spaces', 'staff_member', 'ok'],
+                  required: ['spaces', 'staff_member', 'ok'],
                   type: 'object',
                 },
               },
@@ -80039,6 +80039,9 @@ const openapi: OpenAPISpec = {
                         description:
                           'Represents a staff member for a specific customer.',
                         properties: {
+                          access_grant: {
+                            $ref: '#/components/schemas/access_grant',
+                          },
                           email_address: {
                             description:
                               'Email address associated with the user identity.',
@@ -80153,6 +80156,9 @@ const openapi: OpenAPISpec = {
                         description:
                           'Represents a staff member for a specific customer.',
                         properties: {
+                          access_grant: {
+                            $ref: '#/components/schemas/access_grant',
+                          },
                           email_address: {
                             description:
                               'Email address associated with the user identity.',
@@ -81034,6 +81040,51 @@ const openapi: OpenAPISpec = {
         'x-undocumented': 'Partner building blocks/UI only.',
       },
     },
+    '/seam/webhooks/[provider]/[subscription_id]': {
+      post: {
+        description:
+          'Receives an inbound webhook delivery for a provider subscription.',
+        operationId: 'seamWebhooksByProviderBySubscriptionIdPost',
+        parameters: [
+          {
+            in: 'query',
+            name: 'provider',
+            required: true,
+            schema: { type: 'string' },
+          },
+          {
+            in: 'query',
+            name: 'subscription_id',
+            required: true,
+            schema: { type: 'string' },
+          },
+        ],
+        requestBody: { content: { 'application/json': { schema: {} } } },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: { ok: { type: 'boolean' } },
+                  required: ['ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        summary: '/seam/webhooks/[provider]/[subscription_id]',
+        tags: ['/webhooks'],
+        'x-fern-sdk-group-name': ['seam', 'webhooks', '[provider]'],
+        'x-fern-sdk-method-name': 'by_subscription_id',
+        'x-response-key': null,
+        'x-title': 'Receive a Provider Webhook',
+        'x-undocumented': 'Internal endpoint for inbound provider webhooks',
+      },
+    },
     '/spaces/add_acs_entrances': {
       post: {
         description:

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

@@ -101051,201 +101051,203 @@ export type Routes = {
     formData: {}
     jsonResponse: {
       /** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
-      access_grant: {
-        /** ID of the Seam workspace associated with the Access Grant. */
-        workspace_id: string
-        /** ID of the Access Grant. */
-        access_grant_id: string
-        /** Unique key for the access grant within the workspace. */
-        access_grant_key?: string | undefined
-        /** Reservation key for the access grant. */
-        reservation_key?: string | undefined
-        /** ID of user identity to which the Access Grant gives access. */
-        user_identity_id: string
-        /**
-         * @deprecated Use `space_ids`.*/
-        location_ids: string[]
-        /** IDs of the spaces to which the Access Grant gives access. */
-        space_ids: string[]
-        /** Access methods that the user requested for the Access Grant. */
-        requested_access_methods: {
-          /** Display name of the access method. */
-          display_name: string
-          /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
-          mode: 'code' | 'card' | 'mobile_key' | 'cloud_key'
-          /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
-          code?: string | undefined
-          /** Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified. */
-          instant_key_max_use_count?: number | undefined
-          /** Date and time at which the requested access method was added to the Access Grant. */
-          created_at: string
-          /** IDs of the access methods created for the requested access method. */
-          created_access_method_ids: string[]
-        }[]
-        /** IDs of the access methods created for the Access Grant. */
-        access_method_ids: string[]
-        /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
-        client_session_token?: string | undefined
-        /** Name of the Access Grant. If not provided, the display name will be computed. */
-        name: string | null
-        /** Display name of the Access Grant. */
-        display_name: string
-        /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
-        instant_key_url?: string | undefined
-        /** Date and time at which the Access Grant was created. */
-        created_at: string
-        /** Date and time at which the Access Grant starts. */
-        starts_at: string
-        /** Date and time at which the Access Grant ends. */
-        ends_at: string | null
-        /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
-        warnings: (
-          | {
-              /** Date and time at which Seam created the warning. */
-              created_at: string
-              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
-              message: string
-              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
-              warning_code: 'being_deleted'
-            }
-          | {
-              /** Date and time at which Seam created the warning. */
-              created_at: string
-              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
-              message: string
-              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
-              warning_code: 'underprovisioned_access'
-            }
-          | {
-              /** Date and time at which Seam created the warning. */
-              created_at: string
-              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
-              message: string
-              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
-              warning_code: 'overprovisioned_access'
-              /** Devices whose access codes could not be revoked during reconciliation. Present when the provider does not support revoking an offline access code (e.g. Dormakaba oracode with exhausted override budget). */
-              failed_devices?:
-                | {
-                    /** Device whose access code could not be revoked. */
-                    device_id: string
-                    /** Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`). */
-                    error_code: string
-                    /** Human-readable description of why revocation failed. */
-                    message: string
-                  }[]
-                | undefined
-            }
-          | {
-              /** Date and time at which Seam created the warning. */
-              created_at: string
-              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
-              message: string
-              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
-              warning_code: 'updating_access_times'
-              /** IDs of the access methods being updated. */
-              access_method_ids: string[]
-            }
-          | {
-              /** Date and time at which Seam created the warning. */
-              created_at: string
-              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
-              message: string
-              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
-              warning_code: 'requested_code_unavailable'
-              /** ID of the device where the requested code was unavailable. */
-              device_id: string
-              /** The originally requested PIN code that was unavailable. */
-              original_code: string
-              /** The new PIN code that was assigned instead. */
-              new_code: string
-            }
-          | {
-              /** Date and time at which Seam created the warning. */
-              created_at: string
-              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
-              message: string
-              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
-              warning_code: 'device_does_not_support_access_codes'
-              /** ID of the device that does not support access codes. */
-              device_id: string
-            }
-          | {
-              /** Date and time at which Seam created the warning. */
-              created_at: string
-              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
-              message: string
-              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
-              warning_code: 'device_time_constraints_violated'
-              /** ID of the device whose time constraints the access grant violates. */
-              device_id: string
-              /** Specific reason why the grant's times are not programmable on the device. */
-              reason:
-                | 'duration_exceeds_max'
-                | 'times_do_not_match_slots'
-                | 'ongoing_not_supported'
-            }
-        )[]
-        /** Errors associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
-        errors: {
-          /** Date and time at which Seam created the error. */
-          created_at: string
-          /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
-          message: string
-          /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
-          error_code: 'cannot_create_requested_access_methods'
-          /** IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure. */
-          missing_device_ids?: string[] | undefined
-        }[]
-        /** ID of the customization profile associated with the Access Grant. */
-        customization_profile_id?: string | undefined
-        /** List of pending mutations for the access grant. This shows updates that are in progress. */
-        pending_mutations: (
-          | {
-              /** Date and time at which the mutation was created. */
-              created_at: string
-              /** Detailed description of the mutation. */
-              message: string
-              /** Mutation code to indicate that Seam is in the process of updating the spaces (devices) associated with this access grant. */
-              mutation_code: 'updating_spaces'
-              /** Previous location configuration. */
-              from: {
-                /** Previous device IDs where access codes existed. */
-                device_ids: string[]
-              }
-              /** New location configuration. */
-              to: {
-                /** New device IDs where access codes should be created. */
-                device_ids: string[]
-                /** Common code key to ensure PIN code reuse across devices. */
-                common_code_key?: (string | null) | undefined
-              }
-            }
-          | {
-              /** Date and time at which the mutation was created. */
+      access_grant?:
+        | {
+            /** ID of the Seam workspace associated with the Access Grant. */
+            workspace_id: string
+            /** ID of the Access Grant. */
+            access_grant_id: string
+            /** Unique key for the access grant within the workspace. */
+            access_grant_key?: string | undefined
+            /** Reservation key for the access grant. */
+            reservation_key?: string | undefined
+            /** ID of user identity to which the Access Grant gives access. */
+            user_identity_id: string
+            /**
+             * @deprecated Use `space_ids`.*/
+            location_ids: string[]
+            /** IDs of the spaces to which the Access Grant gives access. */
+            space_ids: string[]
+            /** Access methods that the user requested for the Access Grant. */
+            requested_access_methods: {
+              /** Display name of the access method. */
+              display_name: string
+              /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
+              mode: 'code' | 'card' | 'mobile_key' | 'cloud_key'
+              /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
+              code?: string | undefined
+              /** Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified. */
+              instant_key_max_use_count?: number | undefined
+              /** Date and time at which the requested access method was added to the Access Grant. */
+              created_at: string
+              /** IDs of the access methods created for the requested access method. */
+              created_access_method_ids: string[]
+            }[]
+            /** IDs of the access methods created for the Access Grant. */
+            access_method_ids: string[]
+            /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
+            client_session_token?: string | undefined
+            /** Name of the Access Grant. If not provided, the display name will be computed. */
+            name: string | null
+            /** Display name of the Access Grant. */
+            display_name: string
+            /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
+            instant_key_url?: string | undefined
+            /** Date and time at which the Access Grant was created. */
+            created_at: string
+            /** Date and time at which the Access Grant starts. */
+            starts_at: string
+            /** Date and time at which the Access Grant ends. */
+            ends_at: string | null
+            /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
+            warnings: (
+              | {
+                  /** Date and time at which Seam created the warning. */
+                  created_at: string
+                  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                  message: string
+                  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                  warning_code: 'being_deleted'
+                }
+              | {
+                  /** Date and time at which Seam created the warning. */
+                  created_at: string
+                  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                  message: string
+                  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                  warning_code: 'underprovisioned_access'
+                }
+              | {
+                  /** Date and time at which Seam created the warning. */
+                  created_at: string
+                  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                  message: string
+                  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                  warning_code: 'overprovisioned_access'
+                  /** Devices whose access codes could not be revoked during reconciliation. Present when the provider does not support revoking an offline access code (e.g. Dormakaba oracode with exhausted override budget). */
+                  failed_devices?:
+                    | {
+                        /** Device whose access code could not be revoked. */
+                        device_id: string
+                        /** Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`). */
+                        error_code: string
+                        /** Human-readable description of why revocation failed. */
+                        message: string
+                      }[]
+                    | undefined
+                }
+              | {
+                  /** Date and time at which Seam created the warning. */
+                  created_at: string
+                  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                  message: string
+                  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                  warning_code: 'updating_access_times'
+                  /** IDs of the access methods being updated. */
+                  access_method_ids: string[]
+                }
+              | {
+                  /** Date and time at which Seam created the warning. */
+                  created_at: string
+                  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                  message: string
+                  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                  warning_code: 'requested_code_unavailable'
+                  /** ID of the device where the requested code was unavailable. */
+                  device_id: string
+                  /** The originally requested PIN code that was unavailable. */
+                  original_code: string
+                  /** The new PIN code that was assigned instead. */
+                  new_code: string
+                }
+              | {
+                  /** Date and time at which Seam created the warning. */
+                  created_at: string
+                  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                  message: string
+                  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                  warning_code: 'device_does_not_support_access_codes'
+                  /** ID of the device that does not support access codes. */
+                  device_id: string
+                }
+              | {
+                  /** Date and time at which Seam created the warning. */
+                  created_at: string
+                  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                  message: string
+                  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                  warning_code: 'device_time_constraints_violated'
+                  /** ID of the device whose time constraints the access grant violates. */
+                  device_id: string
+                  /** Specific reason why the grant's times are not programmable on the device. */
+                  reason:
+                    | 'duration_exceeds_max'
+                    | 'times_do_not_match_slots'
+                    | 'ongoing_not_supported'
+                }
+            )[]
+            /** Errors associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
+            errors: {
+              /** Date and time at which Seam created the error. */
               created_at: string
-              /** Detailed description of the mutation. */
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
               message: string
-              /** Mutation code to indicate that Seam is in the process of updating the access times for this access grant. */
-              mutation_code: 'updating_access_times'
-              /** IDs of the access methods being updated. */
-              access_method_ids: string[]
-              /** Previous access time configuration. */
-              from: {
-                /** Previous start time for access. */
-                starts_at: string | null
-                /** Previous end time for access. */
-                ends_at: string | null
-              }
-              /** New access time configuration. */
-              to: {
-                /** New start time for access. */
-                starts_at: string | null
-                /** New end time for access. */
-                ends_at: string | null
-              }
-            }
-        )[]
-      }
+              /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+              error_code: 'cannot_create_requested_access_methods'
+              /** IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure. */
+              missing_device_ids?: string[] | undefined
+            }[]
+            /** ID of the customization profile associated with the Access Grant. */
+            customization_profile_id?: string | undefined
+            /** List of pending mutations for the access grant. This shows updates that are in progress. */
+            pending_mutations: (
+              | {
+                  /** Date and time at which the mutation was created. */
+                  created_at: string
+                  /** Detailed description of the mutation. */
+                  message: string
+                  /** Mutation code to indicate that Seam is in the process of updating the spaces (devices) associated with this access grant. */
+                  mutation_code: 'updating_spaces'
+                  /** Previous location configuration. */
+                  from: {
+                    /** Previous device IDs where access codes existed. */
+                    device_ids: string[]
+                  }
+                  /** New location configuration. */
+                  to: {
+                    /** New device IDs where access codes should be created. */
+                    device_ids: string[]
+                    /** Common code key to ensure PIN code reuse across devices. */
+                    common_code_key?: (string | null) | undefined
+                  }
+                }
+              | {
+                  /** Date and time at which the mutation was created. */
+                  created_at: string
+                  /** Detailed description of the mutation. */
+                  message: string
+                  /** Mutation code to indicate that Seam is in the process of updating the access times for this access grant. */
+                  mutation_code: 'updating_access_times'
+                  /** IDs of the access methods being updated. */
+                  access_method_ids: string[]
+                  /** Previous access time configuration. */
+                  from: {
+                    /** Previous start time for access. */
+                    starts_at: string | null
+                    /** Previous end time for access. */
+                    ends_at: string | null
+                  }
+                  /** New access time configuration. */
+                  to: {
+                    /** New start time for access. */
+                    starts_at: string | null
+                    /** New end time for access. */
+                    ends_at: string | null
+                  }
+                }
+            )[]
+          }
+        | undefined
       spaces: {
         space_key: string
         child_space_keys?: string[] | undefined
@@ -101298,6 +101300,13 @@ export type Routes = {
         /** List of unique identifiers for the spaces the staff member is associated with. */
         space_keys?: string[] | undefined
         user_identity_id?: string | undefined
+        access_grant?:
+          | {
+              starts_at: string
+              ends_at: string | null
+              created_at: string
+            }
+          | undefined
       }[]
       /** Information about the current page of results. */
       pagination: {
@@ -102152,6 +102161,16 @@ export type Routes = {
     }
     maxDuration: undefined
   }
+  '/seam/webhooks/[provider]/[subscription_id]': {
+    route: '/seam/webhooks/[provider]/[subscription_id]'
+    method: 'POST'
+    queryParams: {}
+    jsonBody: any
+    commonParams: {}
+    formData: {}
+    jsonResponse: {}
+    maxDuration: undefined
+  }
   '/spaces/add_acs_entrances': {
     route: '/spaces/add_acs_entrances'
     method: 'POST' | 'PUT'