@seamapi/types 1.287.3 → 1.288.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.287.3",
+  "version": "1.288.0",
   "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_credential_action_attempt } from './encode-credential.js'
+import { encode_card_action_attempt } from './encode-card.js'
 import { lock_door_action_attempt } from './lock-door.js'
 import { reset_sandbox_workspace_action_attempt } from './reset-sandbox-workspace.js'
-import { scan_credential_action_attempt } from './scan-credential.js'
+import { scan_card_action_attempt } from './scan-card.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_credential_action_attempt.options,
-  ...encode_credential_action_attempt.options,
+  ...scan_card_action_attempt.options,
+  ...encode_card_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-credential.ts → encode-card.ts}

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

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

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

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

@@ -1359,7 +1359,7 @@ export default {
             type: 'object',
           },
           {
-            description: 'Reading credential data from physical encoder.',
+            description: 'Reading card data from physical encoder.',
             properties: {
               action_attempt_id: {
                 description: 'The ID of the action attempt.',
@@ -1367,7 +1367,7 @@ export default {
                 type: 'string',
                 'x-title': 'Action Attempt ID',
               },
-              action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
+              action_type: { enum: ['SCAN_CARD'], type: 'string' },
               error: { nullable: true },
               result: { nullable: true },
               status: { enum: ['pending'], type: 'string' },
@@ -1382,8 +1382,7 @@ export default {
             type: 'object',
           },
           {
-            description:
-              'Reading credential data from physical encoder succeeded.',
+            description: 'Reading card data from physical encoder succeeded.',
             properties: {
               action_attempt_id: {
                 description: 'The ID of the action attempt.',
@@ -1391,13 +1390,13 @@ export default {
                 type: 'string',
                 'x-title': 'Action Attempt ID',
               },
-              action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
+              action_type: { enum: ['SCAN_CARD'], type: 'string' },
               error: { nullable: true },
               result: {
                 properties: {
                   acs_credential_on_encoder: {
                     description:
-                      'Snapshot of credential data read from physical encoder.',
+                      'Snapshot of the card data read from the physical encoder.',
                     properties: {
                       card_number: {
                         description:
@@ -1869,8 +1868,7 @@ export default {
             type: 'object',
           },
           {
-            description:
-              'Reading credential data from physical encoder failed.',
+            description: 'Reading card data from physical encoder failed.',
             properties: {
               action_attempt_id: {
                 description: 'The ID of the action attempt.',
@@ -1878,7 +1876,7 @@ export default {
                 type: 'string',
                 'x-title': 'Action Attempt ID',
               },
-              action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
+              action_type: { enum: ['SCAN_CARD'], type: 'string' },
               error: {
                 oneOf: [
                   {
@@ -1923,7 +1921,7 @@ export default {
             type: 'object',
           },
           {
-            description: 'Encoding credential data from physical encoder.',
+            description: 'Encoding card data from physical encoder.',
             properties: {
               action_attempt_id: {
                 description: 'The ID of the action attempt.',
@@ -1931,7 +1929,7 @@ export default {
                 type: 'string',
                 'x-title': 'Action Attempt ID',
               },
-              action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
+              action_type: { enum: ['ENCODE_CARD'], type: 'string' },
               error: { nullable: true },
               result: { nullable: true },
               status: { enum: ['pending'], type: 'string' },
@@ -1946,8 +1944,7 @@ export default {
             type: 'object',
           },
           {
-            description:
-              'Encoding credential data from physical encoder succeeded.',
+            description: 'Encoding card data from physical encoder succeeded.',
             properties: {
               action_attempt_id: {
                 description: 'The ID of the action attempt.',
@@ -1955,7 +1952,7 @@ export default {
                 type: 'string',
                 'x-title': 'Action Attempt ID',
               },
-              action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
+              action_type: { enum: ['ENCODE_CARD'], type: 'string' },
               error: { nullable: true },
               result: {
                 description:
@@ -2323,8 +2320,7 @@ export default {
             type: 'object',
           },
           {
-            description:
-              'Encoding credential data from physical encoder failed.',
+            description: 'Encoding card data from physical encoder failed.',
             properties: {
               action_attempt_id: {
                 description: 'The ID of the action attempt.',
@@ -2332,7 +2328,7 @@ export default {
                 type: 'string',
                 'x-title': 'Action Attempt ID',
               },
-              action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
+              action_type: { enum: ['ENCODE_CARD'], type: 'string' },
               error: {
                 oneOf: [
                   {
@@ -8034,6 +8030,19 @@ export default {
                     items: { format: 'uuid', type: 'string' },
                     type: 'array',
                   },
+                  assa_abloy_vostio_metadata: {
+                    description:
+                      'Vostio-specific metadata for the new credential.',
+                    properties: {
+                      join_all_guest_acs_entrances: { type: 'boolean' },
+                      override_all_guest_acs_entrances: { type: 'boolean' },
+                      override_guest_acs_entrance_ids: {
+                        items: { format: 'uuid', type: 'string' },
+                        type: 'array',
+                      },
+                    },
+                    type: 'object',
+                  },
                   code: {
                     description:
                       'Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview).',
@@ -9196,25 +9205,16 @@ export default {
         'x-title': 'Update a Credential',
       },
     },
-    '/acs/encoders/encode_credential': {
+    '/acs/encoders/encode_card': {
       post: {
-        operationId: 'acsEncodersEncodeCredentialPost',
+        operationId: 'acsEncodersEncodeCardPost',
         requestBody: {
           content: {
             'application/json': {
               schema: {
                 properties: {
-                  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',
-                  },
+                  acs_credential_id: { format: 'uuid', type: 'string' },
+                  device_id: { format: 'uuid', type: 'string' },
                 },
                 required: ['device_id', 'acs_credential_id'],
                 type: 'object',
@@ -9248,10 +9248,10 @@ export default {
           { console_session: [] },
           { api_key: [] },
         ],
-        summary: '/acs/encoders/encode_credential',
+        summary: '/acs/encoders/encode_card',
         tags: ['/acs'],
         'x-fern-sdk-group-name': ['acs', 'encoders'],
-        'x-fern-sdk-method-name': 'encode_credential',
+        'x-fern-sdk-method-name': 'encode_card',
         'x-fern-sdk-return-value': 'action_attempt',
         'x-response-key': 'action_attempt',
         'x-undocumented': 'Encoding a card is currently unimplemented.',
@@ -9343,24 +9343,16 @@ export default {
         'x-undocumented': 'Encoders are in alpha.',
       },
     },
-    '/acs/encoders/scan_credential': {
+    '/acs/encoders/scan_card': {
       post: {
-        operationId: 'acsEncodersScanCredentialPost',
+        operationId: 'acsEncodersScanCardPost',
         requestBody: {
           content: {
             'application/json': {
               schema: {
                 properties: {
-                  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',
-                  },
+                  acs_system_id: { format: 'uuid', type: 'string' },
+                  device_id: { format: 'uuid', type: 'string' },
                 },
                 required: ['acs_system_id', 'device_id'],
                 type: 'object',
@@ -9394,10 +9386,10 @@ export default {
           { console_session: [] },
           { api_key: [] },
         ],
-        summary: '/acs/encoders/scan_credential',
+        summary: '/acs/encoders/scan_card',
         tags: ['/acs'],
         'x-fern-sdk-group-name': ['acs', 'encoders'],
-        'x-fern-sdk-method-name': 'scan_credential',
+        'x-fern-sdk-method-name': 'scan_card',
         'x-fern-sdk-return-value': 'action_attempt',
         'x-response-key': 'action_attempt',
         'x-undocumented': 'Reading a card is currently unimplemented.',