@seamapi/types 1.288.2 → 1.289.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.288.2",
+  "version": "1.289.1",
   "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/openapi.ts

@@ -1355,7 +1355,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.',
@@ -1363,7 +1363,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' },
@@ -1378,7 +1378,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.',
@@ -1386,13 +1387,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:
@@ -1864,7 +1865,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.',
@@ -1872,7 +1874,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: [
                   {
@@ -1917,7 +1919,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.',
@@ -1925,7 +1927,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' },
@@ -1940,7 +1942,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.',
@@ -1948,7 +1951,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:
@@ -2316,7 +2319,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.',
@@ -2324,7 +2328,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: [
                   {
@@ -9201,16 +9205,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',
@@ -9244,10 +9257,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.',
@@ -9339,16 +9352,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',
@@ -9382,10 +9403,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.',
@@ -15331,6 +15352,8 @@ export default {
     },
     '/thermostats/cool': {
       post: {
+        description:
+          'Sets a thermostat to cooling mode. You must include a cooling set point in Celsius or Fahrenheit. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
         operationId: 'thermostatsCoolPost',
         requestBody: {
           content: {
@@ -15338,14 +15361,22 @@ export default {
               schema: {
                 properties: {
                   cooling_set_point_celsius: {
+                    description:
+                      'Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters.',
                     format: 'float',
                     type: 'number',
                   },
                   cooling_set_point_fahrenheit: {
+                    description:
+                      'Temperature to which the HVAC system connected to the thermostat should cool (in °F). You must set one of the `cooling_set_point` parameters.',
                     format: 'float',
                     type: 'number',
                   },
-                  device_id: { format: 'uuid', type: 'string' },
+                  device_id: {
+                    description: 'ID of the thermostat device.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
                   sync: { default: false, type: 'boolean' },
                 },
                 required: ['device_id'],
@@ -15387,6 +15418,7 @@ export default {
         'x-fern-sdk-method-name': 'cool',
         'x-fern-sdk-return-value': 'action_attempt',
         'x-response-key': 'action_attempt',
+        'x-title': 'Set to Cool Mode',
       },
     },
     '/thermostats/create_climate_preset': {
@@ -15511,14 +15543,22 @@ export default {
     },
     '/thermostats/get': {
       post: {
+        description: 'Returns a specific thermostat.',
         operationId: 'thermostatsGetPost',
         requestBody: {
           content: {
             'application/json': {
               schema: {
                 properties: {
-                  device_id: { format: 'uuid', type: 'string' },
-                  name: { type: 'string' },
+                  device_id: {
+                    description: 'ID of the thermostat device.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  name: {
+                    description: 'Name of the thermostat.',
+                    type: 'string',
+                  },
                 },
                 type: 'object',
               },
@@ -15557,22 +15597,33 @@ export default {
         'x-fern-sdk-method-name': 'get',
         'x-fern-sdk-return-value': 'thermostat',
         'x-response-key': 'thermostat',
+        'x-title': 'Get a Thermostat',
       },
     },
     '/thermostats/heat': {
       post: {
+        description:
+          'Sets a thermostat to heating mode. You must include a heating set point in Celsius or Fahrenheit. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
         operationId: 'thermostatsHeatPost',
         requestBody: {
           content: {
             'application/json': {
               schema: {
                 properties: {
-                  device_id: { format: 'uuid', type: 'string' },
+                  device_id: {
+                    description: 'ID of the thermostat device.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
                   heating_set_point_celsius: {
+                    description:
+                      'Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters.',
                     format: 'float',
                     type: 'number',
                   },
                   heating_set_point_fahrenheit: {
+                    description:
+                      'Temperature to which the HVAC system connected to the thermostat should heat (in °F). You must set one of the `heating_set_point` parameters.',
                     format: 'float',
                     type: 'number',
                   },
@@ -15617,10 +15668,13 @@ export default {
         'x-fern-sdk-method-name': 'heat',
         'x-fern-sdk-return-value': 'action_attempt',
         'x-response-key': 'action_attempt',
+        'x-title': 'Set to Heat Mode',
       },
     },
     '/thermostats/heat_cool': {
       post: {
+        description:
+          'Set a thermostat to heat-cool mode, also known as "auto" mode. To do so, you must include both cooling and heating set points in the payload, either in Celsius or Fahrenheit. For information about verifying the heating and cooling availability of the thermostat and validating the correct set points, see [HVAC Mode Constraints](https://docs.seam.co/latest/capability-guides/thermostats/hvac-mode#hvac-mode-constraints) and [Set Point Constraints](https://docs.seam.co/latest/capability-guides/thermostats/set-points#set-point-constraints).',
         operationId: 'thermostatsHeatCoolPost',
         requestBody: {
           content: {
@@ -15628,19 +15682,31 @@ export default {
               schema: {
                 properties: {
                   cooling_set_point_celsius: {
+                    description:
+                      'Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters.',
                     format: 'float',
                     type: 'number',
                   },
                   cooling_set_point_fahrenheit: {
+                    description:
+                      'Temperature the thermostat should cool to (in °F). You must set one of the cooling_set_point parameters.',
                     format: 'float',
                     type: 'number',
                   },
-                  device_id: { format: 'uuid', type: 'string' },
+                  device_id: {
+                    description: 'ID of the thermostat device.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
                   heating_set_point_celsius: {
+                    description:
+                      'Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters.',
                     format: 'float',
                     type: 'number',
                   },
                   heating_set_point_fahrenheit: {
+                    description:
+                      'Temperature the thermostat should heat to (in °F). You must set one of the heating_set_point parameters.',
                     format: 'float',
                     type: 'number',
                   },
@@ -15685,10 +15751,13 @@ export default {
         'x-fern-sdk-method-name': 'heat_cool',
         'x-fern-sdk-return-value': 'action_attempt',
         'x-response-key': 'action_attempt',
+        'x-title': 'Set to Heat-Cool (Auto) Mode',
       },
     },
     '/thermostats/list': {
       post: {
+        description:
+          'Returns a list of thermostats connected to your workspace. If no thermostats are connected, the list will be empty.',
         operationId: 'thermostatsListPost',
         requestBody: {
           content: {
@@ -15959,17 +16028,24 @@ export default {
         'x-fern-sdk-method-name': 'list',
         'x-fern-sdk-return-value': 'devices',
         'x-response-key': 'devices',
+        'x-title': 'List Thermostats',
       },
     },
     '/thermostats/off': {
       post: {
+        description:
+          'Sets a thermostat to "off" mode. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
         operationId: 'thermostatsOffPost',
         requestBody: {
           content: {
             'application/json': {
               schema: {
                 properties: {
-                  device_id: { format: 'uuid', type: 'string' },
+                  device_id: {
+                    description: 'ID of the thermostat device.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
                   sync: { default: false, type: 'boolean' },
                 },
                 required: ['device_id'],
@@ -16011,6 +16087,7 @@ export default {
         'x-fern-sdk-method-name': 'off',
         'x-fern-sdk-return-value': 'action_attempt',
         'x-response-key': 'action_attempt',
+        'x-title': 'Set to Off Mode',
       },
     },
     '/thermostats/schedules/create': {
@@ -16373,20 +16450,28 @@ export default {
     },
     '/thermostats/set_fan_mode': {
       post: {
+        description:
+          'Sets the fan mode setting for a thermostat. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) and [Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings).',
         operationId: 'thermostatsSetFanModePost',
         requestBody: {
           content: {
             'application/json': {
               schema: {
                 properties: {
-                  device_id: { format: 'uuid', type: 'string' },
+                  device_id: {
+                    description: 'ID of the thermostat device.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
                   fan_mode: {
                     deprecated: true,
                     enum: ['auto', 'on', 'circulate'],
                     type: 'string',
-                    'x-deprecated': 'use fan_mode_setting instead.',
+                    'x-deprecated': 'Use `fan_mode_setting` instead.',
                   },
                   fan_mode_setting: {
+                    description:
+                      'Fan mode setting of the thermostat. See also [Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings).',
                     enum: ['auto', 'on', 'circulate'],
                     type: 'string',
                   },
@@ -16431,6 +16516,7 @@ export default {
         'x-fern-sdk-method-name': 'set_fan_mode',
         'x-fern-sdk-return-value': 'action_attempt',
         'x-response-key': 'action_attempt',
+        'x-title': 'Set Fan Mode Setting',
       },
     },
     '/thermostats/set_temperature_threshold': {