@seamapi/types 1.361.1 → 1.363.0

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

@@ -200,29 +200,31 @@ const many_active_backup_codes = common_device_warning
   })
   .describe('Too many backup codes.')
 
-const salto_unknown_device_type = common_device_warning
+const salto_ks_office_mode = common_device_warning
   .extend({
     warning_code: z
-      .literal('salto_unknown_device_type')
+      .literal('salto_ks_office_mode')
       .describe(warning_code_description),
   })
-  .describe('A Salto Lock displaying an unknown device type.')
+  .describe('Lock is in Office Mode. Access Codes will not unlock doors.')
 
-const salto_office_mode = common_device_warning
+const salto_ks_privacy_mode = common_device_warning
   .extend({
     warning_code: z
-      .literal('salto_office_mode')
+      .literal('salto_ks_privacy_mode')
       .describe(warning_code_description),
   })
-  .describe('Lock is in Office Mode. Access Codes will not unlock doors.')
+  .describe('Lock is in Privacy Mode. Access Codes will not unlock doors.')
 
-const salto_privacy_mode = common_device_warning
+const salto_ks_subscription_limit_almost_reached = common_device_warning
   .extend({
     warning_code: z
-      .literal('salto_privacy_mode')
+      .literal('salto_ks_subscription_limit_almost_reached')
       .describe(warning_code_description),
   })
-  .describe('Lock is in Privacy Mode. Access Codes will not unlock doors.')
+  .describe(
+    'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this.',
+  )
 
 const wyze_device_missing_gateway = common_device_warning
   .extend({
@@ -318,7 +320,6 @@ export const unknown_issue_with_phone = common_device_warning
 const device_warning = z.discriminatedUnion('warning_code', [
   partial_backup_access_code_pool,
   many_active_backup_codes,
-  salto_unknown_device_type,
   wyze_device_missing_gateway,
   functional_offline_device,
   third_party_integration_detected,
@@ -329,8 +330,9 @@ const device_warning = z.discriminatedUnion('warning_code', [
   device_communication_degraded,
   scheduled_maintenance_window,
   device_has_flaky_connection,
-  salto_office_mode,
-  salto_privacy_mode,
+  salto_ks_office_mode,
+  salto_ks_privacy_mode,
+  salto_ks_subscription_limit_almost_reached,
   unknown_issue_with_phone,
 ])
 
@@ -341,7 +343,13 @@ export const device_warning_map = z.object({
     .optional()
     .nullable(),
   many_active_backup_codes: many_active_backup_codes.optional().nullable(),
-  salto_unknown_device_type: salto_unknown_device_type.optional().nullable(),
+  device_has_flaky_connection: device_has_flaky_connection
+    .extend({
+      _event_id: z.string().uuid().optional(),
+      _reason: z.string().optional(),
+    })
+    .optional()
+    .nullable(),
   wyze_device_missing_gateway: wyze_device_missing_gateway
     .optional()
     .nullable(),
@@ -364,14 +372,10 @@ export const device_warning_map = z.object({
   scheduled_maintenance_window: scheduled_maintenance_window
     .optional()
     .nullable(),
-  device_has_flaky_connection: device_has_flaky_connection
-    .extend({
-      _event_id: z.string().uuid().optional(),
-    })
-    .optional()
-    .nullable(),
-  salto_office_mode: salto_office_mode.optional().nullable(),
-  salto_privacy_mode: salto_privacy_mode.optional().nullable(),
+  salto_ks_office_mode: salto_ks_office_mode.optional().nullable(),
+  salto_ks_privacy_mode: salto_ks_privacy_mode.optional().nullable(),
+  salto_ks_subscription_limit_almost_reached:
+    salto_ks_subscription_limit_almost_reached.optional().nullable(),
   unknown_issue_with_phone: unknown_issue_with_phone.optional().nullable(),
 })
 

package/src/lib/seam/connect/models/events/acs/entrances.ts

@@ -0,0 +1,36 @@
+import { z } from 'zod'
+
+import { common_acs_event } from './common.js'
+
+const acs_entrance_event = common_acs_event
+  .extend({
+    acs_entrance_id: z.string().uuid(),
+  })
+  .describe(
+    'ID of the [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).',
+  )
+
+export const acs_entrance_added_event = acs_entrance_event.extend({
+  event_type: z.literal('acs_entrance.added'),
+}).describe(`
+    ---
+    route_path: /acs/entrances
+    ---
+    An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was added.
+  `)
+
+export const acs_entrance_removed_event = acs_entrance_event.extend({
+  event_type: z.literal('acs_entrance.removed'),
+}).describe(`
+    ---
+    route_path: /acs/entrances
+    ---
+    An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was removed.
+  `)
+
+export type AcsUserDeletedEvent = z.infer<typeof acs_entrance_removed_event>
+
+export const acs_entrance_events = [
+  acs_entrance_added_event,
+  acs_entrance_removed_event,
+] as const

package/src/lib/seam/connect/models/events/acs/index.ts

@@ -1,6 +1,7 @@
 import { acs_access_group_events } from './access-groups.js'
 import { acs_credential_events } from './credentials.js'
 import { acs_encoder_events } from './encoders.js'
+import { acs_entrance_events } from './entrances.js'
 import { acs_system_events } from './systems.js'
 import { acs_user_events } from './users.js'
 
@@ -10,4 +11,5 @@ export const acs_events = [
   ...acs_user_events,
   ...acs_encoder_events,
   ...acs_access_group_events,
+  ...acs_entrance_events,
 ] as const

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

@@ -7598,22 +7598,6 @@ export default {
                   required: ['message', 'created_at', 'warning_code'],
                   type: 'object',
                 },
-                {
-                  description:
-                    'A Salto Lock displaying an unknown device type.',
-                  properties: {
-                    created_at: { format: 'date-time', type: 'string' },
-                    message: { type: 'string' },
-                    warning_code: {
-                      description:
-                        'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
-                      enum: ['salto_unknown_device_type'],
-                      type: 'string',
-                    },
-                  },
-                  required: ['message', 'created_at', 'warning_code'],
-                  type: 'object',
-                },
                 {
                   description: 'Wyze Lock is not connected to a gateway.',
                   properties: {
@@ -7774,7 +7758,7 @@ export default {
                     warning_code: {
                       description:
                         'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
-                      enum: ['salto_office_mode'],
+                      enum: ['salto_ks_office_mode'],
                       type: 'string',
                     },
                   },
@@ -7790,7 +7774,23 @@ export default {
                     warning_code: {
                       description:
                         'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
-                      enum: ['salto_privacy_mode'],
+                      enum: ['salto_ks_privacy_mode'],
+                      type: 'string',
+                    },
+                  },
+                  required: ['message', 'created_at', 'warning_code'],
+                  type: 'object',
+                },
+                {
+                  description:
+                    'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this.',
+                  properties: {
+                    created_at: { format: 'date-time', type: 'string' },
+                    message: { type: 'string' },
+                    warning_code: {
+                      description:
+                        'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+                      enum: ['salto_ks_subscription_limit_almost_reached'],
                       type: 'string',
                     },
                   },
@@ -9552,6 +9552,110 @@ export default {
             type: 'object',
             'x-route-path': '/acs/access_groups',
           },
+          {
+            description:
+              'An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was added.',
+            properties: {
+              acs_entrance_id: { format: 'uuid', type: 'string' },
+              acs_system_id: {
+                description:
+                  'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
+                format: 'uuid',
+                type: 'string',
+              },
+              connected_account_id: {
+                description:
+                  'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
+                format: 'uuid',
+                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: ['acs_entrance.added'], 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).',
+                format: 'uuid',
+                type: 'string',
+              },
+            },
+            required: [
+              'event_id',
+              'workspace_id',
+              'created_at',
+              'occurred_at',
+              'acs_system_id',
+              'acs_entrance_id',
+              'event_type',
+            ],
+            type: 'object',
+            'x-route-path': '/acs/entrances',
+          },
+          {
+            description:
+              'An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was removed.',
+            properties: {
+              acs_entrance_id: { format: 'uuid', type: 'string' },
+              acs_system_id: {
+                description:
+                  'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
+                format: 'uuid',
+                type: 'string',
+              },
+              connected_account_id: {
+                description:
+                  'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
+                format: 'uuid',
+                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: ['acs_entrance.removed'], 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).',
+                format: 'uuid',
+                type: 'string',
+              },
+            },
+            required: [
+              'event_id',
+              'workspace_id',
+              'created_at',
+              'occurred_at',
+              'acs_system_id',
+              'acs_entrance_id',
+              'event_type',
+            ],
+            type: 'object',
+            'x-route-path': '/acs/entrances',
+          },
           {
             description:
               'A [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was deleted.',
@@ -14967,22 +15071,6 @@ export default {
                   required: ['message', 'created_at', 'warning_code'],
                   type: 'object',
                 },
-                {
-                  description:
-                    'A Salto Lock displaying an unknown device type.',
-                  properties: {
-                    created_at: { format: 'date-time', type: 'string' },
-                    message: { type: 'string' },
-                    warning_code: {
-                      description:
-                        'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
-                      enum: ['salto_unknown_device_type'],
-                      type: 'string',
-                    },
-                  },
-                  required: ['message', 'created_at', 'warning_code'],
-                  type: 'object',
-                },
                 {
                   description: 'Wyze Lock is not connected to a gateway.',
                   properties: {
@@ -15143,7 +15231,7 @@ export default {
                     warning_code: {
                       description:
                         'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
-                      enum: ['salto_office_mode'],
+                      enum: ['salto_ks_office_mode'],
                       type: 'string',
                     },
                   },
@@ -15159,7 +15247,23 @@ export default {
                     warning_code: {
                       description:
                         'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
-                      enum: ['salto_privacy_mode'],
+                      enum: ['salto_ks_privacy_mode'],
+                      type: 'string',
+                    },
+                  },
+                  required: ['message', 'created_at', 'warning_code'],
+                  type: 'object',
+                },
+                {
+                  description:
+                    'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this.',
+                  properties: {
+                    created_at: { format: 'date-time', type: 'string' },
+                    message: { type: 'string' },
+                    warning_code: {
+                      description:
+                        'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+                      enum: ['salto_ks_subscription_limit_almost_reached'],
                       type: 'string',
                     },
                   },
@@ -22742,6 +22846,8 @@ export default {
                       'acs_encoder.added',
                       'acs_encoder.removed',
                       'acs_access_group.deleted',
+                      'acs_entrance.added',
+                      'acs_entrance.removed',
                       'client_session.deleted',
                       'connected_account.connected',
                       'connected_account.created',
@@ -22824,6 +22930,8 @@ export default {
                         'acs_encoder.added',
                         'acs_encoder.removed',
                         'acs_access_group.deleted',
+                        'acs_entrance.added',
+                        'acs_entrance.removed',
                         'client_session.deleted',
                         'connected_account.connected',
                         'connected_account.created',