@seamapi/types 1.553.0 → 1.555.0

package/src/lib/seam/connect/models/events/access-methods.ts

@@ -94,6 +94,20 @@ export const access_method_reissued_event = access_method_event.extend({
     An access method was reissued due to an Access Grant update.
   `)
 
+export const access_method_code_changed_event = access_method_event.extend({
+  event_type: z.literal('access_method.code_changed'),
+  code: z
+    .string()
+    .describe(
+      "The new PIN code for code access methods (only present when mode is 'code').",
+    ),
+}).describe(`
+    ---
+    route_path: /access_methods
+    ---
+    An access method's PIN code was changed.
+  `)
+
 export type AccessMethodRevokedEvent = z.infer<
   typeof access_method_revoked_event
 >
@@ -104,4 +118,5 @@ export const access_method_events = [
   access_method_card_encoding_required_event,
   access_method_deleted_event,
   access_method_reissued_event,
+  access_method_code_changed_event,
 ] as const

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

@@ -1947,6 +1947,43 @@ export default {
             format: 'uuid',
             type: 'string',
           },
+          warnings: {
+            description:
+              'Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
+            items: {
+              description:
+                'Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
+              discriminator: { propertyName: 'warning_code' },
+              oneOf: [
+                {
+                  description:
+                    'Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted.',
+                  properties: {
+                    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: ['being_deleted'],
+                      type: 'string',
+                    },
+                  },
+                  required: ['created_at', 'message', 'warning_code'],
+                  type: 'object',
+                },
+              ],
+            },
+            type: 'array',
+          },
           workspace_id: {
             description:
               'ID of the Seam workspace associated with the Access Grant.',
@@ -1967,6 +2004,7 @@ export default {
           'created_at',
           'starts_at',
           'ends_at',
+          'warnings',
         ],
         type: 'object',
         'x-draft': 'Early access.',
@@ -2034,6 +2072,43 @@ export default {
             enum: ['code', 'card', 'mobile_key'],
             type: 'string',
           },
+          warnings: {
+            description:
+              'Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
+            items: {
+              description:
+                'Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
+              discriminator: { propertyName: 'warning_code' },
+              oneOf: [
+                {
+                  description:
+                    'Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted.',
+                  properties: {
+                    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: ['being_deleted'],
+                      type: 'string',
+                    },
+                  },
+                  required: ['created_at', 'message', 'warning_code'],
+                  type: 'object',
+                },
+              ],
+            },
+            type: 'array',
+          },
           workspace_id: {
             description:
               'ID of the Seam workspace associated with the access method.',
@@ -2049,6 +2124,7 @@ export default {
           'created_at',
           'issued_at',
           'is_issued',
+          'warnings',
         ],
         type: 'object',
         'x-draft': 'Early access.',
@@ -14736,6 +14812,63 @@ export default {
             type: 'object',
             'x-route-path': '/access_grants',
           },
+          {
+            description: "An Access Grant's start or end time was changed.",
+            properties: {
+              access_grant_id: {
+                description: 'ID of the affected Access Grant.',
+                format: 'uuid',
+                type: 'string',
+              },
+              access_grant_key: {
+                description: 'Key of the affected Access Grant (if present).',
+                type: 'string',
+              },
+              created_at: {
+                description: 'Date and time at which the event was created.',
+                format: 'date-time',
+                type: 'string',
+              },
+              ends_at: {
+                description: 'The new end time for the access grant.',
+                type: 'string',
+              },
+              event_id: {
+                description: 'ID of the event.',
+                format: 'uuid',
+                type: 'string',
+              },
+              event_type: {
+                enum: ['access_grant.access_times_changed'],
+                type: 'string',
+              },
+              occurred_at: {
+                description: 'Date and time at which the event occurred.',
+                format: 'date-time',
+                type: 'string',
+              },
+              starts_at: {
+                description: 'The new start time for the access grant.',
+                type: 'string',
+              },
+              workspace_id: {
+                description:
+                  'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event.',
+                format: 'uuid',
+                type: 'string',
+              },
+            },
+            required: [
+              'event_id',
+              'workspace_id',
+              'created_at',
+              'occurred_at',
+              'access_grant_id',
+              'event_type',
+            ],
+            type: 'object',
+            'x-route-path': '/access_grants',
+          },
           {
             description: 'An access method was issued.',
             properties: {
@@ -15036,6 +15169,70 @@ export default {
             type: 'object',
             'x-route-path': '/access_methods',
           },
+          {
+            description: "An access method's PIN code was changed.",
+            properties: {
+              access_grant_ids: {
+                description:
+                  'IDs of the access grants associated with this access method.',
+                items: { format: 'uuid', type: 'string' },
+                type: 'array',
+              },
+              access_grant_keys: {
+                description:
+                  'Keys of the access grants associated with this access method (if present).',
+                items: { type: 'string' },
+                type: 'array',
+              },
+              access_method_id: {
+                description: 'ID of the affected access method.',
+                format: 'uuid',
+                type: 'string',
+              },
+              code: {
+                description:
+                  "The new PIN code for code access methods (only present when mode is 'code').",
+                type: 'string',
+              },
+              created_at: {
+                description: 'Date and time at which the event was created.',
+                format: 'date-time',
+                type: 'string',
+              },
+              event_id: {
+                description: 'ID of the event.',
+                format: 'uuid',
+                type: 'string',
+              },
+              event_type: {
+                enum: ['access_method.code_changed'],
+                type: 'string',
+              },
+              occurred_at: {
+                description: 'Date and time at which the event occurred.',
+                format: 'date-time',
+                type: 'string',
+              },
+              workspace_id: {
+                description:
+                  'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event.',
+                format: 'uuid',
+                type: 'string',
+              },
+            },
+            required: [
+              'event_id',
+              'workspace_id',
+              'created_at',
+              'occurred_at',
+              'access_method_id',
+              'access_grant_ids',
+              'event_type',
+              'code',
+            ],
+            type: 'object',
+            'x-route-path': '/access_methods',
+          },
           {
             description:
               'An [access system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.',
@@ -43418,11 +43615,13 @@ export default {
                 'access_grant.access_granted_to_all_doors',
                 'access_grant.access_granted_to_door',
                 'access_grant.access_to_door_lost',
+                'access_grant.access_times_changed',
                 'access_method.issued',
                 'access_method.revoked',
                 'access_method.card_encoding_required',
                 'access_method.deleted',
                 'access_method.reissued',
+                'access_method.code_changed',
                 'acs_system.connected',
                 'acs_system.added',
                 'acs_system.disconnected',
@@ -43519,11 +43718,13 @@ export default {
                   'access_grant.access_granted_to_all_doors',
                   'access_grant.access_granted_to_door',
                   'access_grant.access_to_door_lost',
+                  'access_grant.access_times_changed',
                   'access_method.issued',
                   'access_method.revoked',
                   'access_method.card_encoding_required',
                   'access_method.deleted',
                   'access_method.reissued',
+                  'access_method.code_changed',
                   'acs_system.connected',
                   'acs_system.added',
                   'acs_system.disconnected',
@@ -43775,11 +43976,13 @@ export default {
                       'access_grant.access_granted_to_all_doors',
                       'access_grant.access_granted_to_door',
                       'access_grant.access_to_door_lost',
+                      'access_grant.access_times_changed',
                       'access_method.issued',
                       'access_method.revoked',
                       'access_method.card_encoding_required',
                       'access_method.deleted',
                       'access_method.reissued',
+                      'access_method.code_changed',
                       'acs_system.connected',
                       'acs_system.added',
                       'acs_system.disconnected',
@@ -43872,11 +44075,13 @@ export default {
                         'access_grant.access_granted_to_all_doors',
                         'access_grant.access_granted_to_door',
                         'access_grant.access_to_door_lost',
+                        'access_grant.access_times_changed',
                         'access_method.issued',
                         'access_method.revoked',
                         'access_method.card_encoding_required',
                         'access_method.deleted',
                         'access_method.reissued',
+                        'access_method.code_changed',
                         'acs_system.connected',
                         'acs_system.added',
                         'acs_system.disconnected',
@@ -49046,11 +49251,13 @@ export default {
                 'access_grant.access_granted_to_all_doors',
                 'access_grant.access_granted_to_door',
                 'access_grant.access_to_door_lost',
+                'access_grant.access_times_changed',
                 'access_method.issued',
                 'access_method.revoked',
                 'access_method.card_encoding_required',
                 'access_method.deleted',
                 'access_method.reissued',
+                'access_method.code_changed',
                 'acs_system.connected',
                 'acs_system.added',
                 'acs_system.disconnected',
@@ -49148,11 +49355,13 @@ export default {
                   'access_grant.access_granted_to_all_doors',
                   'access_grant.access_granted_to_door',
                   'access_grant.access_to_door_lost',
+                  'access_grant.access_times_changed',
                   'access_method.issued',
                   'access_method.revoked',
                   'access_method.card_encoding_required',
                   'access_method.deleted',
                   'access_method.reissued',
+                  'access_method.code_changed',
                   'acs_system.connected',
                   'acs_system.added',
                   'acs_system.disconnected',
@@ -49313,11 +49522,13 @@ export default {
                       'access_grant.access_granted_to_all_doors',
                       'access_grant.access_granted_to_door',
                       'access_grant.access_to_door_lost',
+                      'access_grant.access_times_changed',
                       'access_method.issued',
                       'access_method.revoked',
                       'access_method.card_encoding_required',
                       'access_method.deleted',
                       'access_method.reissued',
+                      'access_method.code_changed',
                       'acs_system.connected',
                       'acs_system.added',
                       'acs_system.disconnected',
@@ -49410,11 +49621,13 @@ export default {
                         'access_grant.access_granted_to_all_doors',
                         'access_grant.access_granted_to_door',
                         'access_grant.access_to_door_lost',
+                        'access_grant.access_times_changed',
                         'access_method.issued',
                         'access_method.revoked',
                         'access_method.card_encoding_required',
                         'access_method.deleted',
                         'access_method.reissued',
+                        'access_method.code_changed',
                         'acs_system.connected',
                         'acs_system.added',
                         'acs_system.disconnected',