@seamapi/types 1.1128.0 → 1.1130.0

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

@@ -13452,6 +13452,15 @@ export type Routes = {
                     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';
+                } | {
+                    /** 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: 'access_revoked';
+                    /** ID of the access method whose access was revoked. */
+                    access_method_id: string;
                 })[];
                 /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
                 errors: ({
@@ -13673,6 +13682,15 @@ export type Routes = {
                     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';
+                } | {
+                    /** 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: 'access_revoked';
+                    /** ID of the access method whose access was revoked. */
+                    access_method_id: string;
                 })[];
                 /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
                 errors: ({
@@ -16517,6 +16535,15 @@ export type Routes = {
                     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';
+                } | {
+                    /** 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: 'access_revoked';
+                    /** ID of the access method whose access was revoked. */
+                    access_method_id: string;
                 })[];
                 /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
                 errors: ({
@@ -16740,6 +16767,15 @@ export type Routes = {
                     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';
+                } | {
+                    /** 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: 'access_revoked';
+                    /** ID of the access method whose access was revoked. */
+                    access_method_id: string;
                 })[];
                 /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
                 errors: ({
@@ -16935,6 +16971,15 @@ export type Routes = {
                     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';
+                } | {
+                    /** 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: 'access_revoked';
+                    /** ID of the access method whose access was revoked. */
+                    access_method_id: string;
                 })[];
                 /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
                 errors: ({
@@ -17139,6 +17184,15 @@ export type Routes = {
                     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';
+                } | {
+                    /** 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: 'access_revoked';
+                    /** ID of the access method whose access was revoked. */
+                    access_method_id: string;
                 })[];
                 /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
                 errors: ({
@@ -23785,6 +23839,15 @@ export type Routes = {
                         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';
+                    } | {
+                        /** 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: 'access_revoked';
+                        /** ID of the access method whose access was revoked. */
+                        access_method_id: string;
                     })[];
                     /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
                     errors: ({
@@ -91039,6 +91102,15 @@ export type Routes = {
                     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';
+                } | {
+                    /** 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: 'access_revoked';
+                    /** ID of the access method whose access was revoked. */
+                    access_method_id: string;
                 })[];
                 /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
                 errors: ({
@@ -98673,6 +98745,15 @@ export type Routes = {
                     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';
+                } | {
+                    /** 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: 'access_revoked';
+                    /** ID of the access method whose access was revoked. */
+                    access_method_id: string;
                 })[];
                 /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
                 errors: ({
@@ -99203,6 +99284,15 @@ export type Routes = {
                     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';
+                } | {
+                    /** 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: 'access_revoked';
+                    /** ID of the access method whose access was revoked. */
+                    access_method_id: string;
                 })[];
                 /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
                 errors: ({
@@ -151146,6 +151236,8 @@ export type Routes = {
             phone_number?: (string | null) | undefined;
             /** Full name of the user associated with the new user identity. */
             full_name?: (string | null) | undefined;
+            /** Customer key of the customer that owns the new user identity. Set it when the user identity will be used in access grants created through that customer's client session or Customer Portal. */
+            customer_key?: string | undefined;
             /** List of access system IDs to associate with the new user identity through access system users. If there's no user with the same email address or phone number in the specified access systems, a new access system user is created. If there is an existing user with the same email or phone number in the specified access systems, the user is linked to the user identity. */
             acs_system_ids?: string[] | undefined;
         };
@@ -163155,6 +163247,15 @@ export type Routes = {
                         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';
+                    } | {
+                        /** 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: 'access_revoked';
+                        /** ID of the access method whose access was revoked. */
+                        access_method_id: string;
                     })[];
                     /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
                     errors: ({

package/package.json

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

package/src/lib/seam/connect/models/access-grants/access-grant.ts

@@ -215,6 +215,20 @@ const device_time_constraints_violated = common_access_grant_warning
     "Indicates that a device in the access grant cannot program an access code for the grant's time range because of device-specific time constraints.",
   )
 
+const access_revoked = common_access_grant_warning
+  .extend({
+    warning_code: z
+      .literal('access_revoked')
+      .describe(warning_code_description),
+    access_method_id: z
+      .string()
+      .uuid()
+      .describe('ID of the access method whose access was revoked.'),
+  })
+  .describe(
+    "Indicates that one of this access grant's access methods no longer grants access because of a change outside Seam, for example its card was encoded again for another credential. Seam does not replace the access method; issue a new one if the user still needs it.",
+  )
+
 const access_grant_warning = z
   .discriminatedUnion('warning_code', [
     being_deleted,
@@ -224,6 +238,7 @@ const access_grant_warning = z
     requested_code_unavailable,
     device_does_not_support_access_codes,
     device_time_constraints_violated,
+    access_revoked,
   ])
   .describe(
     'Warning associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access).',
@@ -250,6 +265,10 @@ const _access_grant_warning_map = z.object({
     .record(z.string().uuid(), device_time_constraints_violated)
     .optional()
     .nullable(),
+  access_revoked_by_access_method: z
+    .record(z.string().uuid(), access_revoked)
+    .optional()
+    .nullable(),
 })
 
 export type AccessGrantWarningMap = z.infer<typeof _access_grant_warning_map>

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

@@ -2421,6 +2421,42 @@ const openapi: OpenAPISpec = {
                   ],
                   type: 'object',
                 },
+                {
+                  description:
+                    "Indicates that one of this access grant's access methods no longer grants access because of a change outside Seam, for example its card was encoded again for another credential. Seam does not replace the access method; issue a new one if the user still needs it.",
+                  properties: {
+                    access_method_id: {
+                      description:
+                        'ID of the access method whose access was revoked.',
+                      format: 'uuid',
+                      type: 'string',
+                    },
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the warning.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    message: {
+                      description:
+                        'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                    warning_code: {
+                      description:
+                        'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+                      enum: ['access_revoked'],
+                      type: 'string',
+                    },
+                  },
+                  required: [
+                    'created_at',
+                    'message',
+                    'warning_code',
+                    'access_method_id',
+                  ],
+                  type: 'object',
+                },
               ],
             },
             type: 'array',
@@ -37613,6 +37649,42 @@ const openapi: OpenAPISpec = {
                   ],
                   type: 'object',
                 },
+                {
+                  description:
+                    "Indicates that one of this access grant's access methods no longer grants access because of a change outside Seam, for example its card was encoded again for another credential. Seam does not replace the access method; issue a new one if the user still needs it.",
+                  properties: {
+                    access_method_id: {
+                      description:
+                        'ID of the access method whose access was revoked.',
+                      format: 'uuid',
+                      type: 'string',
+                    },
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the warning.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    message: {
+                      description:
+                        'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                    warning_code: {
+                      description:
+                        'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+                      enum: ['access_revoked'],
+                      type: 'string',
+                    },
+                  },
+                  required: [
+                    'created_at',
+                    'message',
+                    'warning_code',
+                    'access_method_id',
+                  ],
+                  type: 'object',
+                },
               ],
             },
             type: 'array',
@@ -75434,6 +75506,12 @@ const openapi: OpenAPISpec = {
                     items: { format: 'uuid', type: 'string' },
                     type: 'array',
                   },
+                  customer_key: {
+                    description:
+                      "Customer key of the customer that owns the new user identity. Set it when the user identity will be used in access grants created through that customer's client session or Customer Portal.",
+                    minLength: 1,
+                    type: 'string',
+                  },
                   email_address: {
                     description:
                       'Unique email address for the new user identity.',

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

@@ -15332,6 +15332,16 @@ export type Routes = {
                 | 'times_do_not_match_slots'
                 | 'ongoing_not_supported'
             }
+          | {
+              /** 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: 'access_revoked'
+              /** ID of the access method whose access was revoked. */
+              access_method_id: string
+            }
         )[]
         /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
         errors: (
@@ -15574,6 +15584,16 @@ export type Routes = {
                 | 'times_do_not_match_slots'
                 | 'ongoing_not_supported'
             }
+          | {
+              /** 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: 'access_revoked'
+              /** ID of the access method whose access was revoked. */
+              access_method_id: string
+            }
         )[]
         /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
         errors: (
@@ -19158,6 +19178,16 @@ export type Routes = {
                 | 'times_do_not_match_slots'
                 | 'ongoing_not_supported'
             }
+          | {
+              /** 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: 'access_revoked'
+              /** ID of the access method whose access was revoked. */
+              access_method_id: string
+            }
         )[]
         /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
         errors: (
@@ -19400,6 +19430,16 @@ export type Routes = {
                 | 'times_do_not_match_slots'
                 | 'ongoing_not_supported'
             }
+          | {
+              /** 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: 'access_revoked'
+              /** ID of the access method whose access was revoked. */
+              access_method_id: string
+            }
         )[]
         /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
         errors: (
@@ -19614,6 +19654,16 @@ export type Routes = {
                 | 'times_do_not_match_slots'
                 | 'ongoing_not_supported'
             }
+          | {
+              /** 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: 'access_revoked'
+              /** ID of the access method whose access was revoked. */
+              access_method_id: string
+            }
         )[]
         /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
         errors: (
@@ -19837,6 +19887,16 @@ export type Routes = {
                 | 'times_do_not_match_slots'
                 | 'ongoing_not_supported'
             }
+          | {
+              /** 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: 'access_revoked'
+              /** ID of the access method whose access was revoked. */
+              access_method_id: string
+            }
         )[]
         /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
         errors: (
@@ -27760,6 +27820,16 @@ export type Routes = {
                       | 'times_do_not_match_slots'
                       | 'ongoing_not_supported'
                   }
+                | {
+                    /** 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: 'access_revoked'
+                    /** ID of the access method whose access was revoked. */
+                    access_method_id: string
+                  }
               )[]
               /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
               errors: (
@@ -108622,6 +108692,16 @@ export type Routes = {
                 | 'times_do_not_match_slots'
                 | 'ongoing_not_supported'
             }
+          | {
+              /** 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: 'access_revoked'
+              /** ID of the access method whose access was revoked. */
+              access_method_id: string
+            }
         )[]
         /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
         errors: (
@@ -117673,6 +117753,16 @@ export type Routes = {
                 | 'times_do_not_match_slots'
                 | 'ongoing_not_supported'
             }
+          | {
+              /** 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: 'access_revoked'
+              /** ID of the access method whose access was revoked. */
+              access_method_id: string
+            }
         )[]
         /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
         errors: (
@@ -118262,6 +118352,16 @@ export type Routes = {
                     | 'times_do_not_match_slots'
                     | 'ongoing_not_supported'
                 }
+              | {
+                  /** 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: 'access_revoked'
+                  /** ID of the access method whose access was revoked. */
+                  access_method_id: string
+                }
             )[]
             /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
             errors: (
@@ -179061,6 +179161,8 @@ export type Routes = {
       phone_number?: (string | null) | undefined
       /** Full name of the user associated with the new user identity. */
       full_name?: (string | null) | undefined
+      /** Customer key of the customer that owns the new user identity. Set it when the user identity will be used in access grants created through that customer's client session or Customer Portal. */
+      customer_key?: string | undefined
       /** List of access system IDs to associate with the new user identity through access system users. If there's no user with the same email address or phone number in the specified access systems, a new access system user is created. If there is an existing user with the same email or phone number in the specified access systems, the user is linked to the user identity. */
       acs_system_ids?: string[] | undefined
     }
@@ -193553,6 +193655,16 @@ export type Routes = {
                       | 'times_do_not_match_slots'
                       | 'ongoing_not_supported'
                   }
+                | {
+                    /** 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: 'access_revoked'
+                    /** ID of the access method whose access was revoked. */
+                    access_method_id: string
+                  }
               )[]
               /** Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */
               errors: (