@seamapi/types 1.340.1 → 1.342.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/connect.cjs CHANGED
@@ -1694,7 +1694,7 @@ var acs_credential = common_acs_credential.merge(
1694
1694
  ---
1695
1695
  route_path: /acs/credentials
1696
1696
  ---
1697
- ${getAcsCredentialDescription()}
1697
+ Means by which a user gains access at an entrance. The \`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.
1698
1698
  `);
1699
1699
  var unmanaged_acs_credential = common_acs_credential.merge(
1700
1700
  zod.z.object({
@@ -1704,14 +1704,8 @@ var unmanaged_acs_credential = common_acs_credential.merge(
1704
1704
  ---
1705
1705
  route_path: /acs/credentials/unmanaged
1706
1706
  ---
1707
- ${getAcsCredentialDescription(false)}
1707
+ Means by which a user gains access at an entrance. The \`unmanaged_acs_credential\` object, which is not managed by Seam, 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.
1708
1708
  `);
1709
- function getAcsCredentialDescription(is_managed = true) {
1710
- const resource_name = is_managed ? "acs_credential" : "unmanaged_acs_credential";
1711
- const management_clause = is_managed ? "" : ", which is not managed by Seam,";
1712
- return `Means by which a user gains access at an entrance.
1713
- The \`${resource_name}\` object${management_clause} 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.`.trim();
1714
- }
1715
1709
  var acs_credential_on_encoder = zod.z.object({
1716
1710
  created_at: zod.z.string().datetime().nullable().describe("Date and time the credential was created."),
1717
1711
  is_issued: zod.z.boolean().nullable(),
@@ -3413,6 +3407,20 @@ var temperature_reached_set_point_event = device_event.extend({
3413
3407
  ---
3414
3408
  A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading is within 1 \xB0C of the configured cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
3415
3409
  `);
3410
+ var temperature_changed_event = device_event.extend({
3411
+ event_type: zod.z.literal("thermostat.temperature_changed_event"),
3412
+ temperature_celsius: zod.z.number().describe(
3413
+ "Temperature, in \xB0C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats)."
3414
+ ),
3415
+ temperature_fahrenheit: zod.z.number().describe(
3416
+ "Temperature, in \xB0F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats)."
3417
+ )
3418
+ }).describe(`
3419
+ ---
3420
+ route_path: /thermostats
3421
+ ---
3422
+ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) reported temperature changed by at least 1 \xB0C.
3423
+ `);
3416
3424
  var device_events = [
3417
3425
  device_connected_event,
3418
3426
  device_added_event,
@@ -3444,7 +3452,8 @@ var device_events = [
3444
3452
  thermostat_manually_adjusted_event,
3445
3453
  temperature_threshold_exceeded_event,
3446
3454
  temperature_threshold_no_longer_exceeded_event,
3447
- temperature_reached_set_point_event
3455
+ temperature_reached_set_point_event,
3456
+ temperature_changed_event
3448
3457
  ];
3449
3458
  var enrollment_automation_event = common_event.extend({
3450
3459
  enrollment_automation_id: zod.z.string().uuid().describe(
@@ -4512,7 +4521,7 @@ var openapi_default = {
4512
4521
  "x-route-path": "/acs/access_groups"
4513
4522
  },
4514
4523
  acs_credential: {
4515
- 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.",
4524
+ description: "Means by which a user gains access at an entrance. The `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.",
4516
4525
  properties: {
4517
4526
  access_method: {
4518
4527
  description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
@@ -5960,7 +5969,7 @@ var openapi_default = {
5960
5969
  nullable: true,
5961
5970
  oneOf: [
5962
5971
  {
5963
- 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.",
5972
+ description: "Means by which a user gains access at an entrance. The `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.",
5964
5973
  properties: {
5965
5974
  access_method: {
5966
5975
  description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
@@ -6296,7 +6305,7 @@ var openapi_default = {
6296
6305
  "x-route-path": "/acs/credentials"
6297
6306
  },
6298
6307
  {
6299
- description: "Means by which a user gains access at an entrance.\nThe `unmanaged_acs_credential` object, which is not managed by Seam, 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.",
6308
+ description: "Means by which a user gains access at an entrance. The `unmanaged_acs_credential` object, which is not managed by Seam, 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.",
6300
6309
  properties: {
6301
6310
  access_method: {
6302
6311
  description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
@@ -6761,10 +6770,10 @@ var openapi_default = {
6761
6770
  action_type: { enum: ["ENCODE_CREDENTIAL"], type: "string" },
6762
6771
  error: { nullable: true },
6763
6772
  result: {
6764
- 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.",
6773
+ description: "Means by which a user gains access at an entrance. The `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.",
6765
6774
  oneOf: [
6766
6775
  {
6767
- 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.",
6776
+ description: "Means by which a user gains access at an entrance. The `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.",
6768
6777
  properties: {
6769
6778
  access_method: {
6770
6779
  description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
@@ -7098,7 +7107,7 @@ var openapi_default = {
7098
7107
  "x-route-path": "/acs/credentials"
7099
7108
  },
7100
7109
  {
7101
- description: "Means by which a user gains access at an entrance.\nThe `unmanaged_acs_credential` object, which is not managed by Seam, 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.",
7110
+ description: "Means by which a user gains access at an entrance. The `unmanaged_acs_credential` object, which is not managed by Seam, 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.",
7102
7111
  properties: {
7103
7112
  access_method: {
7104
7113
  description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
@@ -14418,6 +14427,68 @@ var openapi_default = {
14418
14427
  type: "object",
14419
14428
  "x-route-path": "/thermostats"
14420
14429
  },
14430
+ {
14431
+ description: "A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) reported temperature changed by at least 1 \xB0C.",
14432
+ properties: {
14433
+ connected_account_id: {
14434
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
14435
+ format: "uuid",
14436
+ type: "string"
14437
+ },
14438
+ created_at: {
14439
+ description: "Date and time at which the event was created.",
14440
+ format: "date-time",
14441
+ type: "string"
14442
+ },
14443
+ device_id: {
14444
+ description: "ID of the device.",
14445
+ format: "uuid",
14446
+ type: "string"
14447
+ },
14448
+ event_id: {
14449
+ description: "ID of the event.",
14450
+ format: "uuid",
14451
+ type: "string"
14452
+ },
14453
+ event_type: {
14454
+ enum: ["thermostat.temperature_changed_event"],
14455
+ type: "string"
14456
+ },
14457
+ occurred_at: {
14458
+ description: "Date and time at which the event occurred.",
14459
+ format: "date-time",
14460
+ type: "string"
14461
+ },
14462
+ temperature_celsius: {
14463
+ description: "Temperature, in \xB0C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
14464
+ format: "float",
14465
+ type: "number"
14466
+ },
14467
+ temperature_fahrenheit: {
14468
+ description: "Temperature, in \xB0F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
14469
+ format: "float",
14470
+ type: "number"
14471
+ },
14472
+ workspace_id: {
14473
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).",
14474
+ format: "uuid",
14475
+ type: "string"
14476
+ }
14477
+ },
14478
+ required: [
14479
+ "event_id",
14480
+ "workspace_id",
14481
+ "created_at",
14482
+ "occurred_at",
14483
+ "device_id",
14484
+ "connected_account_id",
14485
+ "event_type",
14486
+ "temperature_celsius",
14487
+ "temperature_fahrenheit"
14488
+ ],
14489
+ type: "object",
14490
+ "x-route-path": "/thermostats"
14491
+ },
14421
14492
  {
14422
14493
  description: "An [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) was deleted.",
14423
14494
  properties: {
@@ -16095,7 +16166,7 @@ var openapi_default = {
16095
16166
  "x-route-path": "/acs/access_groups/unmanaged"
16096
16167
  },
16097
16168
  unmanaged_acs_credential: {
16098
- description: "Means by which a user gains access at an entrance.\nThe `unmanaged_acs_credential` object, which is not managed by Seam, 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.",
16169
+ description: "Means by which a user gains access at an entrance. The `unmanaged_acs_credential` object, which is not managed by Seam, 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.",
16099
16170
  properties: {
16100
16171
  access_method: {
16101
16172
  description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
@@ -24640,6 +24711,7 @@ var openapi_default = {
24640
24711
  "thermostat.temperature_threshold_exceeded",
24641
24712
  "thermostat.temperature_threshold_no_longer_exceeded",
24642
24713
  "thermostat.temperature_reached_set_point",
24714
+ "thermostat.temperature_changed_event",
24643
24715
  "enrollment_automation.deleted",
24644
24716
  "phone.deactivated"
24645
24717
  ],
@@ -24720,6 +24792,7 @@ var openapi_default = {
24720
24792
  "thermostat.temperature_threshold_exceeded",
24721
24793
  "thermostat.temperature_threshold_no_longer_exceeded",
24722
24794
  "thermostat.temperature_reached_set_point",
24795
+ "thermostat.temperature_changed_event",
24723
24796
  "enrollment_automation.deleted",
24724
24797
  "phone.deactivated"
24725
24798
  ],
@@ -27872,6 +27945,158 @@ var openapi_default = {
27872
27945
  "x-title": "Set a Temperature Threshold"
27873
27946
  }
27874
27947
  },
27948
+ "/thermostats/simulate/hvac_mode_adjusted": {
27949
+ post: {
27950
+ operationId: "thermostatsSimulateHvacModeAdjustedPost",
27951
+ requestBody: {
27952
+ content: {
27953
+ "application/json": {
27954
+ schema: {
27955
+ discriminator: { propertyName: "hvac_mode" },
27956
+ oneOf: [
27957
+ {
27958
+ properties: {
27959
+ device_id: { format: "uuid", type: "string" },
27960
+ hvac_mode: { enum: ["off"], type: "string" }
27961
+ },
27962
+ required: ["hvac_mode", "device_id"],
27963
+ type: "object"
27964
+ },
27965
+ {
27966
+ properties: {
27967
+ cooling_set_point_celsius: {
27968
+ format: "float",
27969
+ type: "number"
27970
+ },
27971
+ cooling_set_point_fahrenheit: {
27972
+ format: "float",
27973
+ type: "number"
27974
+ },
27975
+ device_id: { format: "uuid", type: "string" },
27976
+ hvac_mode: { enum: ["cool"], type: "string" }
27977
+ },
27978
+ required: ["hvac_mode", "device_id"],
27979
+ type: "object"
27980
+ },
27981
+ {
27982
+ properties: {
27983
+ device_id: { format: "uuid", type: "string" },
27984
+ heating_set_point_celsius: {
27985
+ format: "float",
27986
+ type: "number"
27987
+ },
27988
+ heating_set_point_fahrenheit: {
27989
+ format: "float",
27990
+ type: "number"
27991
+ },
27992
+ hvac_mode: { enum: ["heat"], type: "string" }
27993
+ },
27994
+ required: ["hvac_mode", "device_id"],
27995
+ type: "object"
27996
+ },
27997
+ {
27998
+ properties: {
27999
+ cooling_set_point_celsius: {
28000
+ format: "float",
28001
+ type: "number"
28002
+ },
28003
+ cooling_set_point_fahrenheit: {
28004
+ format: "float",
28005
+ type: "number"
28006
+ },
28007
+ device_id: { format: "uuid", type: "string" },
28008
+ heating_set_point_celsius: {
28009
+ format: "float",
28010
+ type: "number"
28011
+ },
28012
+ heating_set_point_fahrenheit: {
28013
+ format: "float",
28014
+ type: "number"
28015
+ },
28016
+ hvac_mode: { enum: ["heat_cool"], type: "string" }
28017
+ },
28018
+ required: ["hvac_mode", "device_id"],
28019
+ type: "object"
28020
+ }
28021
+ ]
28022
+ }
28023
+ }
28024
+ }
28025
+ },
28026
+ responses: {
28027
+ 200: {
28028
+ content: {
28029
+ "application/json": {
28030
+ schema: {
28031
+ properties: { ok: { type: "boolean" } },
28032
+ required: ["ok"],
28033
+ type: "object"
28034
+ }
28035
+ }
28036
+ },
28037
+ description: "OK"
28038
+ },
28039
+ 400: { description: "Bad Request" },
28040
+ 401: { description: "Unauthorized" }
28041
+ },
28042
+ security: [
28043
+ { api_key: [] },
28044
+ { pat_with_workspace: [] },
28045
+ { console_session_with_workspace: [] }
28046
+ ],
28047
+ summary: "/thermostats/simulate/hvac_mode_adjusted",
28048
+ tags: ["/thermostats"],
28049
+ "x-fern-sdk-group-name": ["thermostats", "simulate"],
28050
+ "x-fern-sdk-method-name": "hvac_mode_adjusted",
28051
+ "x-response-key": null
28052
+ }
28053
+ },
28054
+ "/thermostats/simulate/temperature_reached": {
28055
+ post: {
28056
+ operationId: "thermostatsSimulateTemperatureReachedPost",
28057
+ requestBody: {
28058
+ content: {
28059
+ "application/json": {
28060
+ schema: {
28061
+ properties: {
28062
+ device_id: { format: "uuid", type: "string" },
28063
+ temperature_celsius: { format: "float", type: "number" },
28064
+ temperature_fahrenheit: { format: "float", type: "number" }
28065
+ },
28066
+ required: ["device_id"],
28067
+ type: "object"
28068
+ }
28069
+ }
28070
+ }
28071
+ },
28072
+ responses: {
28073
+ 200: {
28074
+ content: {
28075
+ "application/json": {
28076
+ schema: {
28077
+ properties: { ok: { type: "boolean" } },
28078
+ required: ["ok"],
28079
+ type: "object"
28080
+ }
28081
+ }
28082
+ },
28083
+ description: "OK"
28084
+ },
28085
+ 400: { description: "Bad Request" },
28086
+ 401: { description: "Unauthorized" }
28087
+ },
28088
+ security: [
28089
+ { api_key: [] },
28090
+ { pat_with_workspace: [] },
28091
+ { console_session_with_workspace: [] }
28092
+ ],
28093
+ summary: "/thermostats/simulate/temperature_reached",
28094
+ tags: ["/thermostats"],
28095
+ "x-fern-sdk-group-name": ["thermostats", "simulate"],
28096
+ "x-fern-sdk-method-name": "temperature_reached",
28097
+ "x-response-key": null
28098
+ }
28099
+ },
27875
28100
  "/thermostats/update_climate_preset": {
27876
28101
  patch: {
27877
28102
  description: "Updates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",