@seamapi/types 1.739.0 → 1.741.0

package/src/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.ts

@@ -135,6 +135,27 @@ const updating_entrance_membership = common_pending_mutation
     'Seam is in the process of pushing an entrance membership update to the integrated access system.',
   )
 
+const deferring_user_membership_update = common_pending_mutation
+  .extend({
+    mutation_code: z
+      .literal('deferring_user_membership_update')
+      .describe(
+        'Mutation code to indicate that a scheduled user membership change is pending for this access group.',
+      ),
+    acs_user_id: z
+      .string()
+      .uuid()
+      .describe('ID of the user involved in the scheduled change.'),
+    variant: z
+      .enum(['adding', 'removing'])
+      .describe(
+        'Whether the user is scheduled to be added to or removed from this access group.',
+      ),
+  })
+  .describe(
+    'A scheduled user membership change is pending for this access group.',
+  )
+
 export const acs_access_group_pending_mutations = z.discriminatedUnion(
   'mutation_code',
   [
@@ -144,6 +165,7 @@ export const acs_access_group_pending_mutations = z.discriminatedUnion(
     updating_access_schedule,
     updating_user_membership,
     updating_entrance_membership,
+    deferring_user_membership_update,
   ],
 )
 
@@ -164,6 +186,10 @@ const _acs_access_group_pending_mutations_map = z.object({
     .record(z.string().uuid(), updating_entrance_membership)
     .optional()
     .nullable(),
+  deferring_user_membership_update: z
+    .record(z.string().uuid(), deferring_user_membership_update)
+    .optional()
+    .nullable(),
 })
 
 export type AcsAccessGroupPendingMutationsMap = z.infer<

package/src/lib/seam/connect/models/acs/acs-users/pending-mutations.ts

@@ -158,6 +158,27 @@ const updating_group_membership_mutation = common_pending_mutation
     'Seam is in the process of pushing an access group membership update to the integrated access system.',
   )
 
+const deferring_group_membership_update_mutation = common_pending_mutation
+  .extend({
+    mutation_code: z
+      .literal('deferring_group_membership_update')
+      .describe(
+        'Mutation code to indicate that a scheduled access group membership change is pending for this user.',
+      ),
+    acs_access_group_id: z
+      .string()
+      .uuid()
+      .describe('ID of the access group involved in the scheduled change.'),
+    variant: z
+      .enum(['adding', 'removing'])
+      .describe(
+        'Whether the user is scheduled to be added to or removed from the access group.',
+      ),
+  })
+  .describe(
+    'A scheduled access group membership change is pending for this user.',
+  )
+
 export const acs_user_pending_mutations = z.discriminatedUnion(
   'mutation_code',
   [
@@ -168,6 +189,7 @@ export const acs_user_pending_mutations = z.discriminatedUnion(
     updating_access_schedule_mutation,
     updating_suspension_state_mutation,
     updating_group_membership_mutation,
+    deferring_group_membership_update_mutation,
   ],
 )
 
@@ -184,6 +206,10 @@ const _acs_user_pending_mutations_map = z.object({
     .record(z.string().uuid(), updating_group_membership_mutation)
     .optional()
     .nullable(),
+  deferring_group_membership_update: z
+    .record(z.string().uuid(), deferring_group_membership_update_mutation)
+    .optional()
+    .nullable(),
   updating_suspension_state: updating_suspension_state_mutation
     .optional()
     .nullable(),

package/src/lib/seam/connect/models/events/devices.ts

@@ -706,6 +706,35 @@ export const device_name_changed_event = device_event.extend({
 
 export type DeviceNameChangedEvent = z.infer<typeof device_name_changed_event>
 
+export const camera_activated_event = device_event.extend({
+  event_type: z.literal('camera.activated'),
+  activation_reason: z
+    .enum(['motion_detected'])
+    .describe('The reason the camera was activated.'),
+  motion_sub_type: z
+    .enum(['human', 'vehicle', 'package', 'other'])
+    .optional()
+    .describe('Sub-type of motion detected, if available.'),
+}).describe(`
+  ---
+  route_path: /devices
+  ---
+  A [camera](https://docs.seam.co/latest/core-concepts/devices) was activated, for example, by motion detection.
+`)
+
+export type CameraActivatedEvent = z.infer<typeof camera_activated_event>
+
+export const device_doorbell_rang_event = device_event.extend({
+  event_type: z.literal('device.doorbell_rang'),
+}).describe(`
+  ---
+  route_path: /devices
+  ---
+  A doorbell button was pressed on a [device](https://docs.seam.co/latest/core-concepts/devices).
+`)
+
+export type DeviceDoorbellRangEvent = z.infer<typeof device_doorbell_rang_event>
+
 export const device_events = [
   device_connected_event,
   device_added_event,
@@ -740,4 +769,6 @@ export const device_events = [
   temperature_reached_set_point_event,
   temperature_changed_event,
   device_name_changed_event,
+  camera_activated_event,
+  device_doorbell_rang_event,
 ] as const

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

@@ -3054,6 +3054,48 @@ export default {
                   ],
                   type: 'object',
                 },
+                {
+                  description:
+                    'A scheduled user membership change is pending for this access group.',
+                  properties: {
+                    acs_user_id: {
+                      description:
+                        'ID of the user involved in the scheduled change.',
+                      format: 'uuid',
+                      type: 'string',
+                    },
+                    created_at: {
+                      description:
+                        'Date and time at which the mutation was created.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    message: {
+                      description: 'Detailed description of the mutation.',
+                      type: 'string',
+                    },
+                    mutation_code: {
+                      description:
+                        'Mutation code to indicate that a scheduled user membership change is pending for this access group.',
+                      enum: ['deferring_user_membership_update'],
+                      type: 'string',
+                    },
+                    variant: {
+                      description:
+                        'Whether the user is scheduled to be added to or removed from this access group.',
+                      enum: ['adding', 'removing'],
+                      type: 'string',
+                    },
+                  },
+                  required: [
+                    'created_at',
+                    'message',
+                    'mutation_code',
+                    'acs_user_id',
+                    'variant',
+                  ],
+                  type: 'object',
+                },
               ],
             },
             type: 'array',
@@ -5060,6 +5102,48 @@ export default {
                   ],
                   type: 'object',
                 },
+                {
+                  description:
+                    'A scheduled access group membership change is pending for this user.',
+                  properties: {
+                    acs_access_group_id: {
+                      description:
+                        'ID of the access group involved in the scheduled change.',
+                      format: 'uuid',
+                      type: 'string',
+                    },
+                    created_at: {
+                      description:
+                        'Date and time at which the mutation was created.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    message: {
+                      description: 'Detailed description of the mutation.',
+                      type: 'string',
+                    },
+                    mutation_code: {
+                      description:
+                        'Mutation code to indicate that a scheduled access group membership change is pending for this user.',
+                      enum: ['deferring_group_membership_update'],
+                      type: 'string',
+                    },
+                    variant: {
+                      description:
+                        'Whether the user is scheduled to be added to or removed from the access group.',
+                      enum: ['adding', 'removing'],
+                      type: 'string',
+                    },
+                  },
+                  required: [
+                    'created_at',
+                    'message',
+                    'mutation_code',
+                    'acs_access_group_id',
+                    'variant',
+                  ],
+                  type: 'object',
+                },
               ],
             },
             type: 'array',
@@ -23002,6 +23086,159 @@ export default {
             type: 'object',
             'x-route-path': '/devices',
           },
+          {
+            description:
+              'A [camera](https://docs.seam.co/latest/core-concepts/devices) was activated, for example, by motion detection.',
+            properties: {
+              activation_reason: {
+                description: 'The reason the camera was activated.',
+                enum: ['motion_detected'],
+                type: 'string',
+              },
+              connected_account_custom_metadata: {
+                additionalProperties: {
+                  oneOf: [{ type: 'string' }, { type: 'boolean' }],
+                },
+                description:
+                  'Custom metadata of the connected account, present when connected_account_id is provided.',
+                type: 'object',
+              },
+              connected_account_id: {
+                description:
+                  'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event.',
+                format: 'uuid',
+                type: 'string',
+              },
+              created_at: {
+                description: 'Date and time at which the event was created.',
+                format: 'date-time',
+                type: 'string',
+              },
+              customer_key: {
+                description:
+                  'The customer key associated with the device, if any.',
+                type: 'string',
+              },
+              device_custom_metadata: {
+                additionalProperties: {
+                  oneOf: [{ type: 'string' }, { type: 'boolean' }],
+                },
+                description:
+                  'Custom metadata of the device, present when device_id is provided.',
+                type: 'object',
+              },
+              device_id: {
+                description: 'ID of the affected device.',
+                format: 'uuid',
+                type: 'string',
+              },
+              event_id: {
+                description: 'ID of the event.',
+                format: 'uuid',
+                type: 'string',
+              },
+              event_type: { enum: ['camera.activated'], type: 'string' },
+              motion_sub_type: {
+                description: 'Sub-type of motion detected, if available.',
+                enum: ['human', 'vehicle', 'package', 'other'],
+                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',
+              'device_id',
+              'connected_account_id',
+              'event_type',
+              'activation_reason',
+            ],
+            type: 'object',
+            'x-route-path': '/devices',
+          },
+          {
+            description:
+              'A doorbell button was pressed on a [device](https://docs.seam.co/latest/core-concepts/devices).',
+            properties: {
+              connected_account_custom_metadata: {
+                additionalProperties: {
+                  oneOf: [{ type: 'string' }, { type: 'boolean' }],
+                },
+                description:
+                  'Custom metadata of the connected account, present when connected_account_id is provided.',
+                type: 'object',
+              },
+              connected_account_id: {
+                description:
+                  'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event.',
+                format: 'uuid',
+                type: 'string',
+              },
+              created_at: {
+                description: 'Date and time at which the event was created.',
+                format: 'date-time',
+                type: 'string',
+              },
+              customer_key: {
+                description:
+                  'The customer key associated with the device, if any.',
+                type: 'string',
+              },
+              device_custom_metadata: {
+                additionalProperties: {
+                  oneOf: [{ type: 'string' }, { type: 'boolean' }],
+                },
+                description:
+                  'Custom metadata of the device, present when device_id is provided.',
+                type: 'object',
+              },
+              device_id: {
+                description: 'ID of the affected device.',
+                format: 'uuid',
+                type: 'string',
+              },
+              event_id: {
+                description: 'ID of the event.',
+                format: 'uuid',
+                type: 'string',
+              },
+              event_type: { enum: ['device.doorbell_rang'], 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',
+              'device_id',
+              'connected_account_id',
+              'event_type',
+            ],
+            type: 'object',
+            'x-route-path': '/devices',
+          },
           {
             description:
               'An [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) was deleted.',
@@ -27151,6 +27388,48 @@ export default {
                   ],
                   type: 'object',
                 },
+                {
+                  description:
+                    'A scheduled user membership change is pending for this access group.',
+                  properties: {
+                    acs_user_id: {
+                      description:
+                        'ID of the user involved in the scheduled change.',
+                      format: 'uuid',
+                      type: 'string',
+                    },
+                    created_at: {
+                      description:
+                        'Date and time at which the mutation was created.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    message: {
+                      description: 'Detailed description of the mutation.',
+                      type: 'string',
+                    },
+                    mutation_code: {
+                      description:
+                        'Mutation code to indicate that a scheduled user membership change is pending for this access group.',
+                      enum: ['deferring_user_membership_update'],
+                      type: 'string',
+                    },
+                    variant: {
+                      description:
+                        'Whether the user is scheduled to be added to or removed from this access group.',
+                      enum: ['adding', 'removing'],
+                      type: 'string',
+                    },
+                  },
+                  required: [
+                    'created_at',
+                    'message',
+                    'mutation_code',
+                    'acs_user_id',
+                    'variant',
+                  ],
+                  type: 'object',
+                },
               ],
             },
             type: 'array',
@@ -28248,6 +28527,48 @@ export default {
                   ],
                   type: 'object',
                 },
+                {
+                  description:
+                    'A scheduled access group membership change is pending for this user.',
+                  properties: {
+                    acs_access_group_id: {
+                      description:
+                        'ID of the access group involved in the scheduled change.',
+                      format: 'uuid',
+                      type: 'string',
+                    },
+                    created_at: {
+                      description:
+                        'Date and time at which the mutation was created.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    message: {
+                      description: 'Detailed description of the mutation.',
+                      type: 'string',
+                    },
+                    mutation_code: {
+                      description:
+                        'Mutation code to indicate that a scheduled access group membership change is pending for this user.',
+                      enum: ['deferring_group_membership_update'],
+                      type: 'string',
+                    },
+                    variant: {
+                      description:
+                        'Whether the user is scheduled to be added to or removed from the access group.',
+                      enum: ['adding', 'removing'],
+                      type: 'string',
+                    },
+                  },
+                  required: [
+                    'created_at',
+                    'message',
+                    'mutation_code',
+                    'acs_access_group_id',
+                    'variant',
+                  ],
+                  type: 'object',
+                },
               ],
             },
             type: 'array',
@@ -54746,6 +55067,8 @@ export default {
                 'thermostat.temperature_reached_set_point',
                 'thermostat.temperature_changed',
                 'device.name_changed',
+                'camera.activated',
+                'device.doorbell_rang',
                 'enrollment_automation.deleted',
                 'phone.deactivated',
                 'space.device_membership_changed',
@@ -54858,6 +55181,8 @@ export default {
                   'thermostat.temperature_reached_set_point',
                   'thermostat.temperature_changed',
                   'device.name_changed',
+                  'camera.activated',
+                  'device.doorbell_rang',
                   'enrollment_automation.deleted',
                   'phone.deactivated',
                   'space.device_membership_changed',
@@ -55303,6 +55628,8 @@ export default {
                       'thermostat.temperature_reached_set_point',
                       'thermostat.temperature_changed',
                       'device.name_changed',
+                      'camera.activated',
+                      'device.doorbell_rang',
                       'enrollment_automation.deleted',
                       'phone.deactivated',
                       'space.device_membership_changed',
@@ -55411,6 +55738,8 @@ export default {
                         'thermostat.temperature_reached_set_point',
                         'thermostat.temperature_changed',
                         'device.name_changed',
+                        'camera.activated',
+                        'device.doorbell_rang',
                         'enrollment_automation.deleted',
                         'phone.deactivated',
                         'space.device_membership_changed',
@@ -64525,6 +64854,8 @@ export default {
                 'thermostat.temperature_reached_set_point',
                 'thermostat.temperature_changed',
                 'device.name_changed',
+                'camera.activated',
+                'device.doorbell_rang',
                 'enrollment_automation.deleted',
                 'phone.deactivated',
                 'space.device_membership_changed',
@@ -64638,6 +64969,8 @@ export default {
                   'thermostat.temperature_reached_set_point',
                   'thermostat.temperature_changed',
                   'device.name_changed',
+                  'camera.activated',
+                  'device.doorbell_rang',
                   'enrollment_automation.deleted',
                   'phone.deactivated',
                   'space.device_membership_changed',
@@ -64814,6 +65147,8 @@ export default {
                       'thermostat.temperature_reached_set_point',
                       'thermostat.temperature_changed',
                       'device.name_changed',
+                      'camera.activated',
+                      'device.doorbell_rang',
                       'enrollment_automation.deleted',
                       'phone.deactivated',
                       'space.device_membership_changed',
@@ -64922,6 +65257,8 @@ export default {
                         'thermostat.temperature_reached_set_point',
                         'thermostat.temperature_changed',
                         'device.name_changed',
+                        'camera.activated',
+                        'device.doorbell_rang',
                         'enrollment_automation.deleted',
                         'phone.deactivated',
                         'space.device_membership_changed',