@seamapi/types 1.288.2 → 1.289.1

package/dist/connect.cjs

@@ -1804,7 +1804,7 @@ var deprecated_action_attempts = [
   ...delete_noise_threshold_action_attempt.options,
   ...update_noise_threshold_action_attempt.options
 ];
-var action_type2 = zod.z.literal("ENCODE_CARD");
+var action_type2 = zod.z.literal("ENCODE_CREDENTIAL");
 var no_card_on_encoder_error = zod.z.object({
   type: zod.z.literal("no_card_on_encoder"),
   message: zod.z.string()
@@ -1819,15 +1819,15 @@ var error3 = zod.z.union([
   incompatible_card_format_error
 ]);
 var result3 = acs_credential.or(unmanaged_acs_credential);
-var encode_card_action_attempt = zod.z.discriminatedUnion("status", [
+var encode_credential_action_attempt = zod.z.discriminatedUnion("status", [
   common_pending_action_attempt.extend({
     action_type: action_type2
-  }).describe("Encoding card data from physical encoder."),
+  }).describe("Encoding credential data from physical encoder."),
   common_succeeded_action_attempt.extend({
     action_type: action_type2,
     result: result3
-  }).describe("Encoding card data from physical encoder succeeded."),
-  common_failed_action_attempt.extend({ action_type: action_type2, error: error3 }).describe("Encoding card data from physical encoder failed.")
+  }).describe("Encoding credential data from physical encoder succeeded."),
+  common_failed_action_attempt.extend({ action_type: action_type2, error: error3 }).describe("Encoding credential data from physical encoder failed.")
 ]);
 var action_type3 = zod.z.literal("LOCK_DOOR");
 var error4 = zod.z.object({
@@ -1867,7 +1867,7 @@ var reset_sandbox_workspace_action_attempt = zod.z.discriminatedUnion(
     }).describe("Resetting sandbox workspace failed.")
   ]
 );
-var action_type5 = zod.z.literal("SCAN_CARD");
+var action_type5 = zod.z.literal("SCAN_CREDENTIAL");
 var no_card_on_encoder_error2 = zod.z.object({
   type: zod.z.literal("no_card_on_encoder"),
   message: zod.z.string()
@@ -1883,20 +1883,20 @@ var warning = zod.z.object({
 var acs_credential_on_seam = acs_credential.or(unmanaged_acs_credential);
 var result6 = zod.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().describe("Matching acs_credential currently encoded on this card."),
   warnings: zod.z.array(warning)
 });
-var scan_card_action_attempt = zod.z.discriminatedUnion("status", [
+var scan_credential_action_attempt = zod.z.discriminatedUnion("status", [
   common_pending_action_attempt.extend({
     action_type: action_type5
-  }).describe("Reading card data from physical encoder."),
+  }).describe("Reading credential data from physical encoder."),
   common_succeeded_action_attempt.extend({
     action_type: action_type5,
     result: result6
-  }).describe("Reading card data from physical encoder succeeded."),
-  common_failed_action_attempt.extend({ action_type: action_type5, error: error6 }).describe("Reading card data from physical encoder failed.")
+  }).describe("Reading credential data from physical encoder succeeded."),
+  common_failed_action_attempt.extend({ action_type: action_type5, error: error6 }).describe("Reading credential data from physical encoder failed.")
 ]);
 var action_type6 = zod.z.literal("SET_COOL");
 var error7 = zod.z.object({
@@ -2002,8 +2002,8 @@ var unlock_door_action_attempt = zod.z.discriminatedUnion("status", [
 var action_attempt = zod.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,
@@ -3982,7 +3982,7 @@ var openapi_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.",
@@ -3990,7 +3990,7 @@ var openapi_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" }
@@ -4005,7 +4005,7 @@ var openapi_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.",
@@ -4013,12 +4013,12 @@ var openapi_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.",
+                    description: "Snapshot of credential data read from physical encoder.",
                     properties: {
                       card_number: {
                         description: "A number or string that physically identifies this card.",
@@ -4452,7 +4452,7 @@ var openapi_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.",
@@ -4460,7 +4460,7 @@ var openapi_default = {
                 type: "string",
                 "x-title": "Action Attempt ID"
               },
-              action_type: { enum: ["SCAN_CARD"], type: "string" },
+              action_type: { enum: ["SCAN_CREDENTIAL"], type: "string" },
               error: {
                 oneOf: [
                   {
@@ -4505,7 +4505,7 @@ var openapi_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.",
@@ -4513,7 +4513,7 @@ var openapi_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" }
@@ -4528,7 +4528,7 @@ var openapi_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.",
@@ -4536,7 +4536,7 @@ var openapi_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: "Means by which a user gains access at an entrance.\nThe `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
@@ -4873,7 +4873,7 @@ var openapi_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.",
@@ -4881,7 +4881,7 @@ var openapi_default = {
                 type: "string",
                 "x-title": "Action Attempt ID"
               },
-              action_type: { enum: ["ENCODE_CARD"], type: "string" },
+              action_type: { enum: ["ENCODE_CREDENTIAL"], type: "string" },
               error: {
                 oneOf: [
                   {
@@ -11593,16 +11593,24 @@ var openapi_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"
@@ -11636,10 +11644,10 @@ var openapi_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."
@@ -11731,16 +11739,24 @@ var openapi_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"
@@ -11774,10 +11790,10 @@ var openapi_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."
@@ -17611,6 +17627,7 @@ var openapi_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: {
@@ -17618,14 +17635,20 @@ var openapi_default = {
               schema: {
                 properties: {
                   cooling_set_point_celsius: {
+                    description: "Temperature to which the HVAC system connected to the thermostat should cool (in \xB0C). 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 \xB0F). 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"],
@@ -17666,7 +17689,8 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["thermostats"],
         "x-fern-sdk-method-name": "cool",
         "x-fern-sdk-return-value": "action_attempt",
-        "x-response-key": "action_attempt"
+        "x-response-key": "action_attempt",
+        "x-title": "Set to Cool Mode"
       }
     },
     "/thermostats/create_climate_preset": {
@@ -17791,14 +17815,22 @@ var openapi_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"
               }
@@ -17836,23 +17868,31 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["thermostats"],
         "x-fern-sdk-method-name": "get",
         "x-fern-sdk-return-value": "thermostat",
-        "x-response-key": "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 \xB0C). 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 \xB0F). You must set one of the `heating_set_point` parameters.",
                     format: "float",
                     type: "number"
                   },
@@ -17896,11 +17936,13 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["thermostats"],
         "x-fern-sdk-method-name": "heat",
         "x-fern-sdk-return-value": "action_attempt",
-        "x-response-key": "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: {
@@ -17908,19 +17950,27 @@ var openapi_default = {
               schema: {
                 properties: {
                   cooling_set_point_celsius: {
+                    description: "Temperature to which the HVAC system connected to the thermostat should cool (in \xB0C). 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 \xB0F). 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 \xB0C). 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 \xB0F). You must set one of the heating_set_point parameters.",
                     format: "float",
                     type: "number"
                   },
@@ -17964,11 +18014,13 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["thermostats"],
         "x-fern-sdk-method-name": "heat_cool",
         "x-fern-sdk-return-value": "action_attempt",
-        "x-response-key": "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: {
@@ -18237,18 +18289,24 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["thermostats"],
         "x-fern-sdk-method-name": "list",
         "x-fern-sdk-return-value": "devices",
-        "x-response-key": "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"],
@@ -18289,7 +18347,8 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["thermostats"],
         "x-fern-sdk-method-name": "off",
         "x-fern-sdk-return-value": "action_attempt",
-        "x-response-key": "action_attempt"
+        "x-response-key": "action_attempt",
+        "x-title": "Set to Off Mode"
       }
     },
     "/thermostats/schedules/create": {
@@ -18652,20 +18711,26 @@ var openapi_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"
                   },
@@ -18709,7 +18774,8 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["thermostats"],
         "x-fern-sdk-method-name": "set_fan_mode",
         "x-fern-sdk-return-value": "action_attempt",
-        "x-response-key": "action_attempt"
+        "x-response-key": "action_attempt",
+        "x-title": "Set Fan Mode Setting"
       }
     },
     "/thermostats/set_temperature_threshold": {