@seamapi/types 1.286.1 → 1.286.3

package/package.json

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

package/src/lib/seam/connect/models/action-attempts/action-attempt.ts

@@ -2,10 +2,10 @@ import { z } from 'zod'
 
 import { activate_climate_preset_action_attempt } from './activate-climate-preset.js'
 import { deprecated_action_attempts } from './deprecated.js'
-import { encode_card_action_attempt } from './encode-card.js'
+import { encode_credential_action_attempt } from './encode-credential.js'
 import { lock_door_action_attempt } from './lock-door.js'
 import { reset_sandbox_workspace_action_attempt } from './reset-sandbox-workspace.js'
-import { scan_card_action_attempt } from './scan-card.js'
+import { scan_credential_action_attempt } from './scan-credential.js'
 import { set_cool_action_attempt } from './set-cool.js'
 import { set_fan_mode_action_attempt } from './set-fan-mode.js'
 import { set_heat_action_attempt } from './set-heat.js'
@@ -16,8 +16,8 @@ import { unlock_door_action_attempt } from './unlock-door.js'
 export const action_attempt = z.union([
   ...lock_door_action_attempt.options,
   ...unlock_door_action_attempt.options,
-  ...scan_card_action_attempt.options,
-  ...encode_card_action_attempt.options,
+  ...scan_credential_action_attempt.options,
+  ...encode_credential_action_attempt.options,
   ...reset_sandbox_workspace_action_attempt.options,
   ...set_cool_action_attempt.options,
   ...set_heat_action_attempt.options,

package/src/lib/seam/connect/models/action-attempts/{encode-card.ts → encode-credential.ts}

@@ -11,7 +11,7 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z.literal('ENCODE_CARD')
+const action_type = z.literal('ENCODE_CREDENTIAL')
 
 const no_card_on_encoder_error = z.object({
   type: z.literal('no_card_on_encoder'),
@@ -31,21 +31,23 @@ const error = z.union([
 
 const result = acs_credential.or(unmanaged_acs_credential)
 
-export const encode_card_action_attempt = z.discriminatedUnion('status', [
+export const encode_credential_action_attempt = z.discriminatedUnion('status', [
   common_pending_action_attempt
     .extend({
       action_type,
     })
-    .describe('Encoding card data from physical encoder.'),
+    .describe('Encoding credential data from physical encoder.'),
   common_succeeded_action_attempt
     .extend({
       action_type,
       result,
     })
-    .describe('Encoding card data from physical encoder succeeded.'),
+    .describe('Encoding credential data from physical encoder succeeded.'),
   common_failed_action_attempt
     .extend({ action_type, error })
-    .describe('Encoding card data from physical encoder failed.'),
+    .describe('Encoding credential data from physical encoder failed.'),
 ])
 
-export type EncodeCardActionAttempt = z.infer<typeof encode_card_action_attempt>
+export type EncodeCredentialActionAttempt = z.infer<
+  typeof encode_credential_action_attempt
+>

package/src/lib/seam/connect/models/action-attempts/{scan-card.ts → scan-credential.ts}

@@ -12,7 +12,7 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z.literal('SCAN_CARD')
+const action_type = z.literal('SCAN_CREDENTIAL')
 
 const no_card_on_encoder_error = z.object({
   type: z.literal('no_card_on_encoder'),
@@ -33,7 +33,7 @@ const acs_credential_on_seam = acs_credential.or(unmanaged_acs_credential)
 
 const result = z.object({
   acs_credential_on_encoder: acs_credential_on_encoder.describe(
-    'Snapshot of the card data read from the physical encoder.',
+    'Snapshot of credential data read from physical encoder.',
   ),
   acs_credential_on_seam: acs_credential_on_seam
     .nullable()
@@ -41,21 +41,23 @@ const result = z.object({
   warnings: z.array(warning),
 })
 
-export const scan_card_action_attempt = z.discriminatedUnion('status', [
+export const scan_credential_action_attempt = z.discriminatedUnion('status', [
   common_pending_action_attempt
     .extend({
       action_type,
     })
-    .describe('Reading card data from physical encoder.'),
+    .describe('Reading credential data from physical encoder.'),
   common_succeeded_action_attempt
     .extend({
       action_type,
       result,
     })
-    .describe('Reading card data from physical encoder succeeded.'),
+    .describe('Reading credential data from physical encoder succeeded.'),
   common_failed_action_attempt
     .extend({ action_type, error })
-    .describe('Reading card data from physical encoder failed.'),
+    .describe('Reading credential data from physical encoder failed.'),
 ])
 
-export type ScanCardActionAttempt = z.infer<typeof scan_card_action_attempt>
+export type ScanCredentialActionAttempt = z.infer<
+  typeof scan_credential_action_attempt
+>

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

@@ -262,6 +262,9 @@ export const device_metadata = z
        */
       _member_group_id: z.string().optional(),
     }),
+    assa_abloy_vostio_metadata: z.object({
+      encoder_id: z.string(),
+    }),
   })
   .partial()
 

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

@@ -105,6 +105,7 @@ export type PhoneDeviceType = z.infer<typeof phone_device_type>
 /** Encoders */
 export const ENCODER_DEVICE_TYPE = {
   VISIONLINE_ENCODER: 'visionline_encoder',
+  ASSA_ABLOY_VOSTIO_ENCODER: 'assa_abloy_vostio_encoder',
 } as const
 
 type EncoderDeviceTypeFromMapping =

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

@@ -16,4 +16,13 @@ export type AcsCredentialDeletedEvent = z.infer<
   typeof acs_credential_deleted_event
 >
 
-export const acs_credential_events = [acs_credential_deleted_event] as const
+export const acs_credential_issued = acs_credential_event
+  .extend({
+    event_type: z.literal('acs_credential.issued'),
+  })
+  .describe('An ACS credential was issued.')
+
+export const acs_credential_events = [
+  acs_credential_deleted_event,
+  acs_credential_issued,
+] as const

package/src/lib/seam/connect/models/events/action-attempts.ts

@@ -34,3 +34,22 @@ export const action_attempt_lock_door_failed_event = action_attempt_event
     event_type: z.literal('action_attempt.lock_door.failed'),
   })
   .describe('A lock door action attempt failed.')
+
+export const action_attempt_unlock_door_succeeded_event = action_attempt_event
+  .extend({
+    event_type: z.literal('action_attempt.unlock_door.succeeded'),
+  })
+  .describe('An unlock door action attempt succeeded.')
+
+export const action_attempt_unlock_door_failed_event = action_attempt_event
+  .extend({
+    event_type: z.literal('action_attempt.unlock_door.failed'),
+  })
+  .describe('An unlock door action attempt failed.')
+
+export const action_attempt_events = [
+  action_attempt_lock_door_succeeded_event,
+  action_attempt_lock_door_failed_event,
+  action_attempt_unlock_door_succeeded_event,
+  action_attempt_unlock_door_failed_event,
+]

package/src/lib/seam/connect/models/events/seam-event.ts

@@ -2,6 +2,7 @@ import { z } from 'zod'
 
 import { access_code_events } from './access-codes.js'
 import { acs_events } from './acs/index.js'
+import { action_attempt_events } from './action-attempts.js'
 import { client_session_events } from './client-sessions.js'
 import { connect_webview_events } from './connect-webviews.js'
 import { connected_account_events } from './connected-accounts.js'
@@ -14,6 +15,7 @@ export const seam_event = z.discriminatedUnion('event_type', [
   ...acs_events,
   ...client_session_events,
   ...connected_account_events,
+  ...action_attempt_events,
   ...connect_webview_events,
   ...device_events,
   ...enrollment_automation_events,

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

@@ -1347,7 +1347,7 @@ export default {
             type: 'object',
           },
           {
-            description: 'Reading card data from physical encoder.',
+            description: 'Reading credential data from physical encoder.',
             properties: {
               action_attempt_id: {
                 description: 'The ID of the action attempt.',
@@ -1355,7 +1355,7 @@ export default {
                 type: 'string',
                 'x-title': 'Action Attempt ID',
               },
-              action_type: { enum: ['SCAN_CARD'], type: 'string' },
+              action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
               error: { nullable: true },
               result: { nullable: true },
               status: { enum: ['pending'], type: 'string' },
@@ -1370,7 +1370,8 @@ export default {
             type: 'object',
           },
           {
-            description: 'Reading card data from physical encoder succeeded.',
+            description:
+              'Reading credential data from physical encoder succeeded.',
             properties: {
               action_attempt_id: {
                 description: 'The ID of the action attempt.',
@@ -1378,13 +1379,13 @@ export default {
                 type: 'string',
                 'x-title': 'Action Attempt ID',
               },
-              action_type: { enum: ['SCAN_CARD'], type: 'string' },
+              action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
               error: { nullable: true },
               result: {
                 properties: {
                   acs_credential_on_encoder: {
                     description:
-                      'Snapshot of the card data read from the physical encoder.',
+                      'Snapshot of credential data read from physical encoder.',
                     properties: {
                       card_number: {
                         description:
@@ -1856,7 +1857,8 @@ export default {
             type: 'object',
           },
           {
-            description: 'Reading card data from physical encoder failed.',
+            description:
+              'Reading credential data from physical encoder failed.',
             properties: {
               action_attempt_id: {
                 description: 'The ID of the action attempt.',
@@ -1864,7 +1866,7 @@ export default {
                 type: 'string',
                 'x-title': 'Action Attempt ID',
               },
-              action_type: { enum: ['SCAN_CARD'], type: 'string' },
+              action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
               error: {
                 oneOf: [
                   {
@@ -1909,7 +1911,7 @@ export default {
             type: 'object',
           },
           {
-            description: 'Encoding card data from physical encoder.',
+            description: 'Encoding credential data from physical encoder.',
             properties: {
               action_attempt_id: {
                 description: 'The ID of the action attempt.',
@@ -1917,7 +1919,7 @@ export default {
                 type: 'string',
                 'x-title': 'Action Attempt ID',
               },
-              action_type: { enum: ['ENCODE_CARD'], type: 'string' },
+              action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
               error: { nullable: true },
               result: { nullable: true },
               status: { enum: ['pending'], type: 'string' },
@@ -1932,7 +1934,8 @@ export default {
             type: 'object',
           },
           {
-            description: 'Encoding card data from physical encoder succeeded.',
+            description:
+              'Encoding credential data from physical encoder succeeded.',
             properties: {
               action_attempt_id: {
                 description: 'The ID of the action attempt.',
@@ -1940,7 +1943,7 @@ export default {
                 type: 'string',
                 'x-title': 'Action Attempt ID',
               },
-              action_type: { enum: ['ENCODE_CARD'], type: 'string' },
+              action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
               error: { nullable: true },
               result: {
                 description:
@@ -2308,7 +2311,8 @@ export default {
             type: 'object',
           },
           {
-            description: 'Encoding card data from physical encoder failed.',
+            description:
+              'Encoding credential data from physical encoder failed.',
             properties: {
               action_attempt_id: {
                 description: 'The ID of the action attempt.',
@@ -2316,7 +2320,7 @@ export default {
                 type: 'string',
                 'x-title': 'Action Attempt ID',
               },
-              action_type: { enum: ['ENCODE_CARD'], type: 'string' },
+              action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
               error: {
                 oneOf: [
                   {
@@ -3702,7 +3706,10 @@ export default {
                 type: 'string',
               },
               { enum: ['ios_phone', 'android_phone'], type: 'string' },
-              { enum: ['visionline_encoder'], type: 'string' },
+              {
+                enum: ['visionline_encoder', 'assa_abloy_vostio_encoder'],
+                type: 'string',
+              },
             ],
           },
           display_name: {
@@ -3992,6 +3999,11 @@ export default {
                         required: ['gadget_name', 'gadget_id'],
                         type: 'object',
                       },
+                      assa_abloy_vostio_metadata: {
+                        properties: { encoder_id: { type: 'string' } },
+                        required: ['encoder_id'],
+                        type: 'object',
+                      },
                       august_metadata: {
                         properties: {
                           has_keypad: { type: 'boolean' },
@@ -5490,7 +5502,10 @@ export default {
                 type: 'string',
               },
               { enum: ['ios_phone', 'android_phone'], type: 'string' },
-              { enum: ['visionline_encoder'], type: 'string' },
+              {
+                enum: ['visionline_encoder', 'assa_abloy_vostio_encoder'],
+                type: 'string',
+              },
             ],
           },
           errors: {
@@ -7126,6 +7141,7 @@ export default {
         'x-fern-sdk-group-name': ['acs', 'access_groups'],
         'x-fern-sdk-method-name': 'add_user',
         'x-response-key': null,
+        'x-title': 'Add an ACS User to an Access Group',
       },
       put: {
         description:
@@ -7178,6 +7194,7 @@ export default {
         tags: ['/acs'],
         'x-fern-ignore': true,
         'x-response-key': null,
+        'x-title': 'Add an ACS User to an Access Group',
       },
     },
     '/acs/access_groups/get': {
@@ -7234,6 +7251,7 @@ export default {
         'x-fern-sdk-method-name': 'get',
         'x-fern-sdk-return-value': 'acs_access_group',
         'x-response-key': 'acs_access_group',
+        'x-title': 'Get an Access Group',
       },
     },
     '/acs/access_groups/list': {
@@ -7297,6 +7315,7 @@ export default {
         'x-fern-sdk-method-name': 'list',
         'x-fern-sdk-return-value': 'acs_access_groups',
         'x-response-key': 'acs_access_groups',
+        'x-title': 'List Access Groups',
       },
     },
     '/acs/access_groups/list_accessible_entrances': {
@@ -7355,6 +7374,7 @@ export default {
         'x-fern-sdk-method-name': 'list_accessible_entrances',
         'x-fern-sdk-return-value': 'acs_entrances',
         'x-response-key': 'acs_entrances',
+        'x-title': 'List Entrances Accessible to an Access Group',
       },
     },
     '/acs/access_groups/list_users': {
@@ -7413,6 +7433,7 @@ export default {
         'x-fern-sdk-method-name': 'list_users',
         'x-fern-sdk-return-value': 'acs_users',
         'x-response-key': 'acs_users',
+        'x-title': 'List ACS Users in an Access Group',
       },
     },
     '/acs/access_groups/remove_user': {
@@ -7468,6 +7489,7 @@ export default {
         'x-fern-sdk-group-name': ['acs', 'access_groups'],
         'x-fern-sdk-method-name': 'remove_user',
         'x-response-key': null,
+        'x-title': 'Remove an ACS User from an Access Group',
       },
     },
     '/acs/access_groups/unmanaged/get': {
@@ -8052,6 +8074,7 @@ export default {
                       'Visionline-specific metadata for the new credential.',
                     properties: {
                       assa_abloy_credential_service_mobile_endpoint_id: {
+                        description: 'DEPRECATED: DO NOT USE',
                         format: 'uuid',
                         type: 'string',
                       },
@@ -9178,16 +9201,25 @@ export default {
         'x-title': 'Update a Credential',
       },
     },
-    '/acs/encoders/encode_card': {
+    '/acs/encoders/encode_credential': {
       post: {
-        operationId: 'acsEncodersEncodeCardPost',
+        operationId: 'acsEncodersEncodeCredentialPost',
         requestBody: {
           content: {
             'application/json': {
               schema: {
                 properties: {
-                  acs_credential_id: { format: 'uuid', type: 'string' },
-                  device_id: { format: 'uuid', type: 'string' },
+                  acs_credential_id: {
+                    description:
+                      'ID of the acs_credential to encode on a physical card.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  device_id: {
+                    description: 'ID of the encoder to use for the encoding.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
                 },
                 required: ['device_id', 'acs_credential_id'],
                 type: 'object',
@@ -9221,10 +9253,10 @@ export default {
           { console_session: [] },
           { api_key: [] },
         ],
-        summary: '/acs/encoders/encode_card',
+        summary: '/acs/encoders/encode_credential',
         tags: ['/acs'],
         'x-fern-sdk-group-name': ['acs', 'encoders'],
-        'x-fern-sdk-method-name': 'encode_card',
+        'x-fern-sdk-method-name': 'encode_credential',
         'x-fern-sdk-return-value': 'action_attempt',
         'x-response-key': 'action_attempt',
         'x-undocumented': 'Encoding a card is currently unimplemented.',
@@ -9316,16 +9348,24 @@ export default {
         'x-undocumented': 'Encoders are in alpha.',
       },
     },
-    '/acs/encoders/scan_card': {
+    '/acs/encoders/scan_credential': {
       post: {
-        operationId: 'acsEncodersScanCardPost',
+        operationId: 'acsEncodersScanCredentialPost',
         requestBody: {
           content: {
             'application/json': {
               schema: {
                 properties: {
-                  acs_system_id: { format: 'uuid', type: 'string' },
-                  device_id: { format: 'uuid', type: 'string' },
+                  acs_system_id: {
+                    description: 'ID of the acs_system the encoder belongs to.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  device_id: {
+                    description: 'ID of the encoder to use for the scan.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
                 },
                 required: ['acs_system_id', 'device_id'],
                 type: 'object',
@@ -9359,10 +9399,10 @@ export default {
           { console_session: [] },
           { api_key: [] },
         ],
-        summary: '/acs/encoders/scan_card',
+        summary: '/acs/encoders/scan_credential',
         tags: ['/acs'],
         'x-fern-sdk-group-name': ['acs', 'encoders'],
-        'x-fern-sdk-method-name': 'scan_card',
+        'x-fern-sdk-method-name': 'scan_credential',
         'x-fern-sdk-return-value': 'action_attempt',
         'x-response-key': 'action_attempt',
         'x-undocumented': 'Reading a card is currently unimplemented.',
@@ -9463,6 +9503,7 @@ export default {
         'x-fern-sdk-group-name': ['acs', 'entrances'],
         'x-fern-sdk-method-name': 'grant_access',
         'x-response-key': null,
+        'x-title': 'Grant an ACS User Access to an Entrance',
       },
     },
     '/acs/entrances/list': {
@@ -12667,7 +12708,13 @@ export default {
                         type: 'string',
                       },
                       { enum: ['ios_phone', 'android_phone'], type: 'string' },
-                      { enum: ['visionline_encoder'], type: 'string' },
+                      {
+                        enum: [
+                          'visionline_encoder',
+                          'assa_abloy_vostio_encoder',
+                        ],
+                        type: 'string',
+                      },
                     ],
                   },
                   device_types: {
@@ -12721,7 +12768,13 @@ export default {
                           enum: ['ios_phone', 'android_phone'],
                           type: 'string',
                         },
-                        { enum: ['visionline_encoder'], type: 'string' },
+                        {
+                          enum: [
+                            'visionline_encoder',
+                            'assa_abloy_vostio_encoder',
+                          ],
+                          type: 'string',
+                        },
                       ],
                     },
                     type: 'array',
@@ -13160,7 +13213,13 @@ export default {
                         type: 'string',
                       },
                       { enum: ['ios_phone', 'android_phone'], type: 'string' },
-                      { enum: ['visionline_encoder'], type: 'string' },
+                      {
+                        enum: [
+                          'visionline_encoder',
+                          'assa_abloy_vostio_encoder',
+                        ],
+                        type: 'string',
+                      },
                     ],
                   },
                   device_types: {
@@ -13214,7 +13273,13 @@ export default {
                           enum: ['ios_phone', 'android_phone'],
                           type: 'string',
                         },
-                        { enum: ['visionline_encoder'], type: 'string' },
+                        {
+                          enum: [
+                            'visionline_encoder',
+                            'assa_abloy_vostio_encoder',
+                          ],
+                          type: 'string',
+                        },
                       ],
                     },
                     type: 'array',
@@ -13953,7 +14018,13 @@ export default {
                         type: 'string',
                       },
                       { enum: ['ios_phone', 'android_phone'], type: 'string' },
-                      { enum: ['visionline_encoder'], type: 'string' },
+                      {
+                        enum: [
+                          'visionline_encoder',
+                          'assa_abloy_vostio_encoder',
+                        ],
+                        type: 'string',
+                      },
                     ],
                   },
                   device_types: {
@@ -14007,7 +14078,13 @@ export default {
                           enum: ['ios_phone', 'android_phone'],
                           type: 'string',
                         },
-                        { enum: ['visionline_encoder'], type: 'string' },
+                        {
+                          enum: [
+                            'visionline_encoder',
+                            'assa_abloy_vostio_encoder',
+                          ],
+                          type: 'string',
+                        },
                       ],
                     },
                     type: 'array',
@@ -14408,7 +14485,13 @@ export default {
                         type: 'string',
                       },
                       { enum: ['ios_phone', 'android_phone'], type: 'string' },
-                      { enum: ['visionline_encoder'], type: 'string' },
+                      {
+                        enum: [
+                          'visionline_encoder',
+                          'assa_abloy_vostio_encoder',
+                        ],
+                        type: 'string',
+                      },
                     ],
                   },
                   device_types: {
@@ -14462,7 +14545,13 @@ export default {
                           enum: ['ios_phone', 'android_phone'],
                           type: 'string',
                         },
-                        { enum: ['visionline_encoder'], type: 'string' },
+                        {
+                          enum: [
+                            'visionline_encoder',
+                            'assa_abloy_vostio_encoder',
+                          ],
+                          type: 'string',
+                        },
                       ],
                     },
                     type: 'array',
@@ -15675,7 +15764,13 @@ export default {
                         type: 'string',
                       },
                       { enum: ['ios_phone', 'android_phone'], type: 'string' },
-                      { enum: ['visionline_encoder'], type: 'string' },
+                      {
+                        enum: [
+                          'visionline_encoder',
+                          'assa_abloy_vostio_encoder',
+                        ],
+                        type: 'string',
+                      },
                     ],
                   },
                   device_types: {
@@ -15729,7 +15824,13 @@ export default {
                           enum: ['ios_phone', 'android_phone'],
                           type: 'string',
                         },
-                        { enum: ['visionline_encoder'], type: 'string' },
+                        {
+                          enum: [
+                            'visionline_encoder',
+                            'assa_abloy_vostio_encoder',
+                          ],
+                          type: 'string',
+                        },
                       ],
                     },
                     type: 'array',