@seamapi/types 1.263.0 → 1.264.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.263.0",
+  "version": "1.264.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",
@@ -92,7 +92,7 @@
     "zod": "^3.21.4"
   },
   "devDependencies": {
-    "@seamapi/blueprint": "^0.27.0",
+    "@seamapi/blueprint": "^0.28.0",
     "@types/node": "^20.8.10",
     "concurrently": "^8.2.0",
     "del-cli": "^5.0.0",

package/src/lib/seam/connect/models/acs/acs-credential.ts

@@ -72,5 +72,53 @@ export const unmanaged_acs_credential = common_acs_credential.merge(
   }),
 )
 
+export const acs_credential_on_encoder = z.object({
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time the credential was created.'),
+
+  is_issued: z.boolean().nullable(),
+
+  starts_at: z
+    .string()
+    .datetime()
+    .nullable()
+    .describe('Date and time the credential will become useable.'),
+  ends_at: z
+    .string()
+    .datetime()
+    .nullable()
+    .describe('Date and time the credential will stop being useable.'),
+
+  card_number: z
+    .string()
+    .nullable()
+    .describe('A number or string that physically identifies this card.'),
+
+  visionline_metadata: z
+    .object({
+      card_id: z.string(),
+      card_function_type: z.enum(['guest', 'staff']), // computed, looks at door ops, and checks is guest op is present.
+
+      cancelled: z.boolean(),
+      discarded: z.boolean(),
+      expired: z.boolean(),
+      overwritten: z.boolean(),
+      overridden: z.boolean().optional(),
+      pending_auto_update: z.boolean(),
+
+      card_format: z.enum(['TLCode', 'rfid48']),
+      card_holder: z.string().optional(),
+
+      number_of_issued_cards: z.number(),
+
+      // guest_acs_entrance_ids: z.array(z.string().uuid()).optional(), // computed
+      // common_acs_entrance_ids: z.array(z.string().uuid()).optional(), // computed
+    })
+    .optional(),
+})
+
 export type AcsCredential = z.output<typeof acs_credential>
 export type UnmanagedAcsCredential = z.output<typeof unmanaged_acs_credential>
+export type AcsCredentialOnEncoder = z.output<typeof acs_credential_on_encoder>

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

@@ -4,8 +4,8 @@ import { activate_climate_preset_action_attempt } from './activate-climate-prese
 import { deprecated_action_attempts } from './deprecated.js'
 import { encode_card_action_attempt } from './encode-card.js'
 import { lock_door_action_attempt } from './lock-door.js'
-import { read_card_action_attempt } from './read-card.js'
 import { reset_sandbox_workspace_action_attempt } from './reset-sandbox-workspace.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,7 +16,7 @@ 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,
-  ...read_card_action_attempt.options,
+  ...scan_card_action_attempt.options,
   ...encode_card_action_attempt.options,
   ...reset_sandbox_workspace_action_attempt.options,
   ...set_cool_action_attempt.options,

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

@@ -1,32 +1,35 @@
 import { z } from 'zod'
 
+import {
+  acs_credential,
+  acs_credential_on_encoder,
+  unmanaged_acs_credential,
+} from '../acs/acs-credential.js'
 import {
   common_failed_action_attempt,
   common_pending_action_attempt,
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z.literal('READ_CARD')
+const action_type = z.literal('SCAN_CARD')
 
 const error = z.object({
   type: z.literal('no_card_on_encoder'),
   message: z.string(),
 })
 
+const acs_credential_on_seam = acs_credential.or(unmanaged_acs_credential)
+
 const result = z.object({
-  // TODO acs_credential_id: z
-  //   .string()
-  //   .uuid()
-  //   .nullable()
-  //   .describe("Matching acs_credential currently encoded on this card."),
-  card_number: z
-    .string()
+  acs_credential_on_encoder: acs_credential_on_encoder.describe(
+    'Snapshot of the card data read from the physical encoder.',
+  ),
+  acs_credential_on_seam: acs_credential_on_seam
     .nullable()
-    .describe('A number or string that physically identifies this card.'),
-  // TODO visionline_metadata: visionline_credential_metadata,
+    .describe('Matching acs_credential currently encoded on this card.'),
 })
 
-export const read_card_action_attempt = z.discriminatedUnion('status', [
+export const scan_card_action_attempt = z.discriminatedUnion('status', [
   common_pending_action_attempt
     .extend({
       action_type,
@@ -43,4 +46,4 @@ export const read_card_action_attempt = z.discriminatedUnion('status', [
     .describe('Reading card data from physical encoder failed.'),
 ])
 
-export type ReadCardActionAttempt = z.infer<typeof read_card_action_attempt>
+export type ScanCardActionAttempt = z.infer<typeof scan_card_action_attempt>

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

@@ -1223,7 +1223,7 @@ export default {
                 type: 'string',
                 'x-title': 'Action Attempt ID',
               },
-              action_type: { enum: ['READ_CARD'], type: 'string' },
+              action_type: { enum: ['SCAN_CARD'], type: 'string' },
               error: { nullable: true },
               result: { nullable: true },
               status: { enum: ['pending'], type: 'string' },
@@ -1246,18 +1246,323 @@ export default {
                 type: 'string',
                 'x-title': 'Action Attempt ID',
               },
-              action_type: { enum: ['READ_CARD'], type: 'string' },
+              action_type: { enum: ['SCAN_CARD'], type: 'string' },
               error: { nullable: true },
               result: {
                 properties: {
-                  card_number: {
+                  acs_credential_on_encoder: {
                     description:
-                      'A number or string that physically identifies this card.',
+                      'Snapshot of the card data read from the physical encoder.',
+                    properties: {
+                      card_number: {
+                        description:
+                          'A number or string that physically identifies this card.',
+                        nullable: true,
+                        type: 'string',
+                      },
+                      created_at: {
+                        description:
+                          'Date and time the credential was created.',
+                        format: 'date-time',
+                        type: 'string',
+                      },
+                      ends_at: {
+                        description:
+                          'Date and time the credential will stop being useable.',
+                        format: 'date-time',
+                        nullable: true,
+                        type: 'string',
+                      },
+                      is_issued: { nullable: true, type: 'boolean' },
+                      starts_at: {
+                        description:
+                          'Date and time the credential will become useable.',
+                        format: 'date-time',
+                        nullable: true,
+                        type: 'string',
+                      },
+                      visionline_metadata: {
+                        properties: {
+                          cancelled: { type: 'boolean' },
+                          card_format: {
+                            enum: ['TLCode', 'rfid48'],
+                            type: 'string',
+                          },
+                          card_function_type: {
+                            enum: ['guest', 'staff'],
+                            type: 'string',
+                          },
+                          card_holder: { type: 'string' },
+                          card_id: { type: 'string' },
+                          discarded: { type: 'boolean' },
+                          expired: { type: 'boolean' },
+                          number_of_issued_cards: {
+                            format: 'float',
+                            type: 'number',
+                          },
+                          overridden: { type: 'boolean' },
+                          overwritten: { type: 'boolean' },
+                          pending_auto_update: { type: 'boolean' },
+                        },
+                        required: [
+                          'card_id',
+                          'card_function_type',
+                          'cancelled',
+                          'discarded',
+                          'expired',
+                          'overwritten',
+                          'pending_auto_update',
+                          'card_format',
+                          'number_of_issued_cards',
+                        ],
+                        type: 'object',
+                      },
+                    },
+                    required: [
+                      'created_at',
+                      'is_issued',
+                      'starts_at',
+                      'ends_at',
+                      'card_number',
+                    ],
+                    type: 'object',
+                  },
+                  acs_credential_on_seam: {
+                    description:
+                      'Matching acs_credential currently encoded on this card.',
                     nullable: true,
-                    type: 'string',
+                    oneOf: [
+                      {
+                        properties: {
+                          access_method: {
+                            enum: ['code', 'card', 'mobile_key'],
+                            type: 'string',
+                          },
+                          acs_credential_id: { format: 'uuid', type: 'string' },
+                          acs_credential_pool_id: {
+                            format: 'uuid',
+                            type: 'string',
+                          },
+                          acs_system_id: { format: 'uuid', type: 'string' },
+                          acs_user_id: { format: 'uuid', type: 'string' },
+                          card_number: { nullable: true, type: 'string' },
+                          code: { nullable: true, type: 'string' },
+                          created_at: { format: 'date-time', type: 'string' },
+                          display_name: { minLength: 1, type: 'string' },
+                          ends_at: { type: 'string' },
+                          errors: {
+                            items: {
+                              properties: {
+                                error_code: { type: 'string' },
+                                message: { type: 'string' },
+                              },
+                              required: ['error_code', 'message'],
+                              type: 'object',
+                            },
+                            type: 'array',
+                          },
+                          external_type: {
+                            enum: [
+                              'pti_card',
+                              'brivo_credential',
+                              'hid_credential',
+                              'visionline_card',
+                              'salto_ks_credential',
+                            ],
+                            type: 'string',
+                          },
+                          external_type_display_name: { type: 'string' },
+                          is_issued: { type: 'boolean' },
+                          is_latest_desired_state_synced_with_provider: {
+                            type: 'boolean',
+                          },
+                          is_managed: { enum: [true], type: 'boolean' },
+                          is_multi_phone_sync_credential: { type: 'boolean' },
+                          issued_at: {
+                            format: 'date-time',
+                            nullable: true,
+                            type: 'string',
+                          },
+                          latest_desired_state_synced_with_provider_at: {
+                            format: 'date-time',
+                            type: 'string',
+                          },
+                          parent_acs_credential_id: {
+                            format: 'uuid',
+                            type: 'string',
+                          },
+                          starts_at: { type: 'string' },
+                          visionline_metadata: {
+                            properties: {
+                              auto_join: { type: 'boolean' },
+                              card_function_type: {
+                                enum: ['guest', 'staff'],
+                                type: 'string',
+                              },
+                              card_id: { type: 'string' },
+                              common_acs_entrance_ids: {
+                                items: { format: 'uuid', type: 'string' },
+                                type: 'array',
+                              },
+                              credential_id: { type: 'string' },
+                              guest_acs_entrance_ids: {
+                                items: { format: 'uuid', type: 'string' },
+                                type: 'array',
+                              },
+                              is_valid: { type: 'boolean' },
+                              joiner_acs_credential_ids: {
+                                items: { format: 'uuid', type: 'string' },
+                                type: 'array',
+                              },
+                            },
+                            required: ['card_function_type'],
+                            type: 'object',
+                          },
+                          warnings: {
+                            items: {
+                              properties: {
+                                message: { type: 'string' },
+                                warning_code: { type: 'string' },
+                              },
+                              required: ['warning_code', 'message'],
+                              type: 'object',
+                            },
+                            type: 'array',
+                          },
+                          workspace_id: { format: 'uuid', type: 'string' },
+                        },
+                        required: [
+                          'acs_credential_id',
+                          'acs_system_id',
+                          'display_name',
+                          'access_method',
+                          'created_at',
+                          'workspace_id',
+                          'errors',
+                          'warnings',
+                          'is_managed',
+                        ],
+                        type: 'object',
+                      },
+                      {
+                        properties: {
+                          access_method: {
+                            enum: ['code', 'card', 'mobile_key'],
+                            type: 'string',
+                          },
+                          acs_credential_id: { format: 'uuid', type: 'string' },
+                          acs_credential_pool_id: {
+                            format: 'uuid',
+                            type: 'string',
+                          },
+                          acs_system_id: { format: 'uuid', type: 'string' },
+                          acs_user_id: { format: 'uuid', type: 'string' },
+                          card_number: { nullable: true, type: 'string' },
+                          code: { nullable: true, type: 'string' },
+                          created_at: { format: 'date-time', type: 'string' },
+                          display_name: { minLength: 1, type: 'string' },
+                          ends_at: { type: 'string' },
+                          errors: {
+                            items: {
+                              properties: {
+                                error_code: { type: 'string' },
+                                message: { type: 'string' },
+                              },
+                              required: ['error_code', 'message'],
+                              type: 'object',
+                            },
+                            type: 'array',
+                          },
+                          external_type: {
+                            enum: [
+                              'pti_card',
+                              'brivo_credential',
+                              'hid_credential',
+                              'visionline_card',
+                              'salto_ks_credential',
+                            ],
+                            type: 'string',
+                          },
+                          external_type_display_name: { type: 'string' },
+                          is_issued: { type: 'boolean' },
+                          is_latest_desired_state_synced_with_provider: {
+                            type: 'boolean',
+                          },
+                          is_managed: { enum: [false], type: 'boolean' },
+                          is_multi_phone_sync_credential: { type: 'boolean' },
+                          issued_at: {
+                            format: 'date-time',
+                            nullable: true,
+                            type: 'string',
+                          },
+                          latest_desired_state_synced_with_provider_at: {
+                            format: 'date-time',
+                            type: 'string',
+                          },
+                          parent_acs_credential_id: {
+                            format: 'uuid',
+                            type: 'string',
+                          },
+                          starts_at: { type: 'string' },
+                          visionline_metadata: {
+                            properties: {
+                              auto_join: { type: 'boolean' },
+                              card_function_type: {
+                                enum: ['guest', 'staff'],
+                                type: 'string',
+                              },
+                              card_id: { type: 'string' },
+                              common_acs_entrance_ids: {
+                                items: { format: 'uuid', type: 'string' },
+                                type: 'array',
+                              },
+                              credential_id: { type: 'string' },
+                              guest_acs_entrance_ids: {
+                                items: { format: 'uuid', type: 'string' },
+                                type: 'array',
+                              },
+                              is_valid: { type: 'boolean' },
+                              joiner_acs_credential_ids: {
+                                items: { format: 'uuid', type: 'string' },
+                                type: 'array',
+                              },
+                            },
+                            required: ['card_function_type'],
+                            type: 'object',
+                          },
+                          warnings: {
+                            items: {
+                              properties: {
+                                message: { type: 'string' },
+                                warning_code: { type: 'string' },
+                              },
+                              required: ['warning_code', 'message'],
+                              type: 'object',
+                            },
+                            type: 'array',
+                          },
+                          workspace_id: { format: 'uuid', type: 'string' },
+                        },
+                        required: [
+                          'acs_credential_id',
+                          'acs_system_id',
+                          'display_name',
+                          'access_method',
+                          'created_at',
+                          'workspace_id',
+                          'errors',
+                          'warnings',
+                          'is_managed',
+                        ],
+                        type: 'object',
+                      },
+                    ],
                   },
                 },
-                required: ['card_number'],
+                required: [
+                  'acs_credential_on_encoder',
+                  'acs_credential_on_seam',
+                ],
                 type: 'object',
               },
               status: { enum: ['success'], type: 'string' },
@@ -1280,7 +1585,7 @@ export default {
                 type: 'string',
                 'x-title': 'Action Attempt ID',
               },
-              action_type: { enum: ['READ_CARD'], type: 'string' },
+              action_type: { enum: ['SCAN_CARD'], type: 'string' },
               error: {
                 properties: {
                   message: { type: 'string' },
@@ -7773,9 +8078,9 @@ export default {
         'x-undocumented': 'Encoders are in alpha.',
       },
     },
-    '/acs/encoders/read_card': {
+    '/acs/encoders/scan_card': {
       post: {
-        operationId: 'acsEncodersReadCardPost',
+        operationId: 'acsEncodersScanCardPost',
         requestBody: {
           content: {
             'application/json': {
@@ -7828,10 +8133,10 @@ export default {
           { console_session: [] },
           { api_key: [] },
         ],
-        summary: '/acs/encoders/read_card',
+        summary: '/acs/encoders/scan_card',
         tags: ['/acs'],
         'x-fern-sdk-group-name': ['acs', 'encoders'],
-        'x-fern-sdk-method-name': 'read_card',
+        '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.',
@@ -8100,7 +8405,7 @@ export default {
     '/acs/systems/list': {
       post: {
         description:
-          'Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems).\n\nTo filter the list of returned access control systems by a specific connected account ID, include the \n`connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the \nresponse includes all access control systems connected to your workspace.',
+          'Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems).\n\nTo filter the list of returned access control systems by a specific connected account ID, include the\n`connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the\nresponse includes all access control systems connected to your workspace.',
         operationId: 'acsSystemsListPost',
         requestBody: {
           content: {
@@ -8159,7 +8464,7 @@ export default {
     '/acs/systems/list_compatible_credential_manager_acs_systems': {
       post: {
         description:
-          'Returns a list of all credential manager ACS systems that are compatible with a specified \n[access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSpecify the ACS system for which you want to retrieve all compatible credential manager ACS \nsystems by including the corresponding `acs_system_id` in the request body.',
+          'Returns a list of all credential manager ACS systems that are compatible with a specified\n[access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSpecify the ACS system for which you want to retrieve all compatible credential manager ACS\nsystems by including the corresponding `acs_system_id` in the request body.',
         operationId: 'acsSystemsListCompatibleCredentialManagerAcsSystemsPost',
         requestBody: {
           content: {
@@ -14266,13 +14571,17 @@ export default {
               'application/json': {
                 schema: {
                   properties: {
+                    devices: {
+                      items: { $ref: '#/components/schemas/device' },
+                      type: 'array',
+                    },
                     ok: { type: 'boolean' },
                     thermostats: {
                       items: { $ref: '#/components/schemas/device' },
                       type: 'array',
                     },
                   },
-                  required: ['thermostats', 'ok'],
+                  required: ['thermostats', 'devices', 'ok'],
                   type: 'object',
                 },
               },
@@ -14292,8 +14601,8 @@ export default {
         tags: ['/thermostats'],
         'x-fern-sdk-group-name': ['thermostats'],
         'x-fern-sdk-method-name': 'list',
-        'x-fern-sdk-return-value': 'thermostats',
-        'x-response-key': 'thermostats',
+        'x-fern-sdk-return-value': 'devices',
+        'x-response-key': 'devices',
       },
     },
     '/thermostats/off': {