@seamapi/types 1.310.0 → 1.311.1

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.
Files changed (30) hide show
  1. package/dist/connect.cjs +37 -396
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +12 -2330
  4. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +0 -312
  5. package/lib/seam/connect/models/action-attempts/action-attempt.js +0 -8
  6. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
  7. package/lib/seam/connect/openapi.d.ts +6 -0
  8. package/lib/seam/connect/openapi.js +23 -311
  9. package/lib/seam/connect/openapi.js.map +1 -1
  10. package/lib/seam/connect/route-types.d.ts +18 -2030
  11. package/package.json +1 -1
  12. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +0 -8
  13. package/src/lib/seam/connect/openapi.ts +28 -311
  14. package/src/lib/seam/connect/route-types.ts +6 -2270
  15. package/lib/seam/connect/models/action-attempts/set-cool.d.ts +0 -80
  16. package/lib/seam/connect/models/action-attempts/set-cool.js +0 -25
  17. package/lib/seam/connect/models/action-attempts/set-cool.js.map +0 -1
  18. package/lib/seam/connect/models/action-attempts/set-heat-cool.d.ts +0 -80
  19. package/lib/seam/connect/models/action-attempts/set-heat-cool.js +0 -25
  20. package/lib/seam/connect/models/action-attempts/set-heat-cool.js.map +0 -1
  21. package/lib/seam/connect/models/action-attempts/set-heat.d.ts +0 -80
  22. package/lib/seam/connect/models/action-attempts/set-heat.js +0 -25
  23. package/lib/seam/connect/models/action-attempts/set-heat.js.map +0 -1
  24. package/lib/seam/connect/models/action-attempts/set-thermostat-off.d.ts +0 -80
  25. package/lib/seam/connect/models/action-attempts/set-thermostat-off.js +0 -25
  26. package/lib/seam/connect/models/action-attempts/set-thermostat-off.js.map +0 -1
  27. package/src/lib/seam/connect/models/action-attempts/set-cool.ts +0 -33
  28. package/src/lib/seam/connect/models/action-attempts/set-heat-cool.ts +0 -33
  29. package/src/lib/seam/connect/models/action-attempts/set-heat.ts +0 -33
  30. package/src/lib/seam/connect/models/action-attempts/set-thermostat-off.ts +0 -36
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.310.0",
3
+ "version": "1.311.1",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -6,12 +6,8 @@ import { encode_credential_action_attempt } from './encode-credential.js'
6
6
  import { lock_door_action_attempt } from './lock-door.js'
7
7
  import { reset_sandbox_workspace_action_attempt } from './reset-sandbox-workspace.js'
8
8
  import { scan_credential_action_attempt } from './scan-credential.js'
9
- import { set_cool_action_attempt } from './set-cool.js'
10
9
  import { set_fan_mode_action_attempt } from './set-fan-mode.js'
11
- import { set_heat_action_attempt } from './set-heat.js'
12
- import { set_heat_cool_action_attempt } from './set-heat-cool.js'
13
10
  import { set_hvac_mode_action_attempt } from './set-hvac-mode.js'
14
- import { set_thermostat_off_action_attempt } from './set-thermostat-off.js'
15
11
  import { unlock_door_action_attempt } from './unlock-door.js'
16
12
 
17
13
  export const action_attempt = z.union([
@@ -20,11 +16,7 @@ export const action_attempt = z.union([
20
16
  ...scan_credential_action_attempt.options,
21
17
  ...encode_credential_action_attempt.options,
22
18
  ...reset_sandbox_workspace_action_attempt.options,
23
- ...set_cool_action_attempt.options,
24
- ...set_heat_action_attempt.options,
25
- ...set_heat_cool_action_attempt.options,
26
19
  ...set_fan_mode_action_attempt.options,
27
- ...set_thermostat_off_action_attempt.options,
28
20
  ...set_hvac_mode_action_attempt.options,
29
21
  ...activate_climate_preset_action_attempt.options,
30
22
  ...deprecated_action_attempts,
@@ -3157,234 +3157,6 @@ export default {
3157
3157
  ],
3158
3158
  type: 'object',
3159
3159
  },
3160
- {
3161
- description: 'Setting HVAC to cool.',
3162
- properties: {
3163
- action_attempt_id: {
3164
- description: 'The ID of the action attempt.',
3165
- format: 'uuid',
3166
- type: 'string',
3167
- 'x-title': 'Action Attempt ID',
3168
- },
3169
- action_type: { enum: ['SET_COOL'], type: 'string' },
3170
- error: { nullable: true },
3171
- result: { nullable: true },
3172
- status: { enum: ['pending'], type: 'string' },
3173
- },
3174
- required: [
3175
- 'action_attempt_id',
3176
- 'status',
3177
- 'result',
3178
- 'error',
3179
- 'action_type',
3180
- ],
3181
- type: 'object',
3182
- },
3183
- {
3184
- description: 'Setting HVAC to cool succeeded.',
3185
- properties: {
3186
- action_attempt_id: {
3187
- description: 'The ID of the action attempt.',
3188
- format: 'uuid',
3189
- type: 'string',
3190
- 'x-title': 'Action Attempt ID',
3191
- },
3192
- action_type: { enum: ['SET_COOL'], type: 'string' },
3193
- error: { nullable: true },
3194
- result: { properties: {}, type: 'object' },
3195
- status: { enum: ['success'], type: 'string' },
3196
- },
3197
- required: [
3198
- 'action_attempt_id',
3199
- 'status',
3200
- 'error',
3201
- 'action_type',
3202
- 'result',
3203
- ],
3204
- type: 'object',
3205
- },
3206
- {
3207
- description: 'Setting HVAC to cool failed.',
3208
- properties: {
3209
- action_attempt_id: {
3210
- description: 'The ID of the action attempt.',
3211
- format: 'uuid',
3212
- type: 'string',
3213
- 'x-title': 'Action Attempt ID',
3214
- },
3215
- action_type: { enum: ['SET_COOL'], type: 'string' },
3216
- error: {
3217
- properties: {
3218
- message: { type: 'string' },
3219
- type: { type: 'string' },
3220
- },
3221
- required: ['type', 'message'],
3222
- type: 'object',
3223
- },
3224
- result: { nullable: true },
3225
- status: { enum: ['error'], type: 'string' },
3226
- },
3227
- required: [
3228
- 'action_attempt_id',
3229
- 'status',
3230
- 'result',
3231
- 'action_type',
3232
- 'error',
3233
- ],
3234
- type: 'object',
3235
- },
3236
- {
3237
- description: 'Setting HVAC to heat mode.',
3238
- properties: {
3239
- action_attempt_id: {
3240
- description: 'The ID of the action attempt.',
3241
- format: 'uuid',
3242
- type: 'string',
3243
- 'x-title': 'Action Attempt ID',
3244
- },
3245
- action_type: { enum: ['SET_HEAT'], type: 'string' },
3246
- error: { nullable: true },
3247
- result: { nullable: true },
3248
- status: { enum: ['pending'], type: 'string' },
3249
- },
3250
- required: [
3251
- 'action_attempt_id',
3252
- 'status',
3253
- 'result',
3254
- 'error',
3255
- 'action_type',
3256
- ],
3257
- type: 'object',
3258
- },
3259
- {
3260
- description: 'Setting HVAC to heat mode succeeded.',
3261
- properties: {
3262
- action_attempt_id: {
3263
- description: 'The ID of the action attempt.',
3264
- format: 'uuid',
3265
- type: 'string',
3266
- 'x-title': 'Action Attempt ID',
3267
- },
3268
- action_type: { enum: ['SET_HEAT'], type: 'string' },
3269
- error: { nullable: true },
3270
- result: { properties: {}, type: 'object' },
3271
- status: { enum: ['success'], type: 'string' },
3272
- },
3273
- required: [
3274
- 'action_attempt_id',
3275
- 'status',
3276
- 'error',
3277
- 'action_type',
3278
- 'result',
3279
- ],
3280
- type: 'object',
3281
- },
3282
- {
3283
- description: 'Setting HVAC to heat mode failed.',
3284
- properties: {
3285
- action_attempt_id: {
3286
- description: 'The ID of the action attempt.',
3287
- format: 'uuid',
3288
- type: 'string',
3289
- 'x-title': 'Action Attempt ID',
3290
- },
3291
- action_type: { enum: ['SET_HEAT'], type: 'string' },
3292
- error: {
3293
- properties: {
3294
- message: { type: 'string' },
3295
- type: { type: 'string' },
3296
- },
3297
- required: ['type', 'message'],
3298
- type: 'object',
3299
- },
3300
- result: { nullable: true },
3301
- status: { enum: ['error'], type: 'string' },
3302
- },
3303
- required: [
3304
- 'action_attempt_id',
3305
- 'status',
3306
- 'result',
3307
- 'action_type',
3308
- 'error',
3309
- ],
3310
- type: 'object',
3311
- },
3312
- {
3313
- description: 'Setting HVAC to heat-cool mode.',
3314
- properties: {
3315
- action_attempt_id: {
3316
- description: 'The ID of the action attempt.',
3317
- format: 'uuid',
3318
- type: 'string',
3319
- 'x-title': 'Action Attempt ID',
3320
- },
3321
- action_type: { enum: ['SET_HEAT_COOL'], type: 'string' },
3322
- error: { nullable: true },
3323
- result: { nullable: true },
3324
- status: { enum: ['pending'], type: 'string' },
3325
- },
3326
- required: [
3327
- 'action_attempt_id',
3328
- 'status',
3329
- 'result',
3330
- 'error',
3331
- 'action_type',
3332
- ],
3333
- type: 'object',
3334
- },
3335
- {
3336
- description: 'Setting HVAC to heat-cool mode succeeded.',
3337
- properties: {
3338
- action_attempt_id: {
3339
- description: 'The ID of the action attempt.',
3340
- format: 'uuid',
3341
- type: 'string',
3342
- 'x-title': 'Action Attempt ID',
3343
- },
3344
- action_type: { enum: ['SET_HEAT_COOL'], type: 'string' },
3345
- error: { nullable: true },
3346
- result: { properties: {}, type: 'object' },
3347
- status: { enum: ['success'], type: 'string' },
3348
- },
3349
- required: [
3350
- 'action_attempt_id',
3351
- 'status',
3352
- 'error',
3353
- 'action_type',
3354
- 'result',
3355
- ],
3356
- type: 'object',
3357
- },
3358
- {
3359
- description: 'Setting heat-cool mode failed.',
3360
- properties: {
3361
- action_attempt_id: {
3362
- description: 'The ID of the action attempt.',
3363
- format: 'uuid',
3364
- type: 'string',
3365
- 'x-title': 'Action Attempt ID',
3366
- },
3367
- action_type: { enum: ['SET_HEAT_COOL'], type: 'string' },
3368
- error: {
3369
- properties: {
3370
- message: { type: 'string' },
3371
- type: { type: 'string' },
3372
- },
3373
- required: ['type', 'message'],
3374
- type: 'object',
3375
- },
3376
- result: { nullable: true },
3377
- status: { enum: ['error'], type: 'string' },
3378
- },
3379
- required: [
3380
- 'action_attempt_id',
3381
- 'status',
3382
- 'result',
3383
- 'action_type',
3384
- 'error',
3385
- ],
3386
- type: 'object',
3387
- },
3388
3160
  {
3389
3161
  description: 'Setting fan mode.',
3390
3162
  properties: {
@@ -3461,82 +3233,6 @@ export default {
3461
3233
  ],
3462
3234
  type: 'object',
3463
3235
  },
3464
- {
3465
- description: 'Turning HVAC off.',
3466
- properties: {
3467
- action_attempt_id: {
3468
- description: 'The ID of the action attempt.',
3469
- format: 'uuid',
3470
- type: 'string',
3471
- 'x-title': 'Action Attempt ID',
3472
- },
3473
- action_type: { enum: ['SET_THERMOSTAT_OFF'], type: 'string' },
3474
- error: { nullable: true },
3475
- result: { nullable: true },
3476
- status: { enum: ['pending'], type: 'string' },
3477
- },
3478
- required: [
3479
- 'action_attempt_id',
3480
- 'status',
3481
- 'result',
3482
- 'error',
3483
- 'action_type',
3484
- ],
3485
- type: 'object',
3486
- },
3487
- {
3488
- description: 'Turning HVAC off succeeded.',
3489
- properties: {
3490
- action_attempt_id: {
3491
- description: 'The ID of the action attempt.',
3492
- format: 'uuid',
3493
- type: 'string',
3494
- 'x-title': 'Action Attempt ID',
3495
- },
3496
- action_type: { enum: ['SET_THERMOSTAT_OFF'], type: 'string' },
3497
- error: { nullable: true },
3498
- result: { properties: {}, type: 'object' },
3499
- status: { enum: ['success'], type: 'string' },
3500
- },
3501
- required: [
3502
- 'action_attempt_id',
3503
- 'status',
3504
- 'error',
3505
- 'action_type',
3506
- 'result',
3507
- ],
3508
- type: 'object',
3509
- },
3510
- {
3511
- description: 'Turning HVAC off failed.',
3512
- properties: {
3513
- action_attempt_id: {
3514
- description: 'The ID of the action attempt.',
3515
- format: 'uuid',
3516
- type: 'string',
3517
- 'x-title': 'Action Attempt ID',
3518
- },
3519
- action_type: { enum: ['SET_THERMOSTAT_OFF'], type: 'string' },
3520
- error: {
3521
- properties: {
3522
- message: { type: 'string' },
3523
- type: { type: 'string' },
3524
- },
3525
- required: ['type', 'message'],
3526
- type: 'object',
3527
- },
3528
- result: { nullable: true },
3529
- status: { enum: ['error'], type: 'string' },
3530
- },
3531
- required: [
3532
- 'action_attempt_id',
3533
- 'status',
3534
- 'result',
3535
- 'action_type',
3536
- 'error',
3537
- ],
3538
- type: 'object',
3539
- },
3540
3236
  {
3541
3237
  description: 'Setting HVAC mode.',
3542
3238
  properties: {
@@ -17033,7 +16729,15 @@ export default {
17033
16729
  enum: ['off', 'heat', 'cool', 'heat_cool'],
17034
16730
  type: 'string',
17035
16731
  },
17036
- manual_override_allowed: { default: true, type: 'boolean' },
16732
+ manual_override_allowed: {
16733
+ default: true,
16734
+ deprecated: true,
16735
+ description:
16736
+ "Indicates whether a person at the thermostat or using the API can change the thermostat's settings.",
16737
+ type: 'boolean',
16738
+ 'x-deprecated':
16739
+ "Use 'thermostat_schedule.is_override_allowed'",
16740
+ },
17037
16741
  name: {
17038
16742
  default: null,
17039
16743
  description:
@@ -17742,11 +17446,16 @@ export default {
17742
17446
  'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
17743
17447
  type: 'string',
17744
17448
  },
17745
- is_override_allowed: { default: false, type: 'boolean' },
17449
+ is_override_allowed: {
17450
+ default: false,
17451
+ description:
17452
+ "Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
17453
+ type: 'boolean',
17454
+ },
17746
17455
  max_override_period_minutes: {
17747
17456
  default: 0,
17748
17457
  description:
17749
- "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
17458
+ "Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
17750
17459
  minimum: 0,
17751
17460
  type: 'integer',
17752
17461
  },
@@ -18004,10 +17713,14 @@ export default {
18004
17713
  'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
18005
17714
  type: 'string',
18006
17715
  },
18007
- is_override_allowed: { type: 'boolean' },
17716
+ is_override_allowed: {
17717
+ description:
17718
+ "Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
17719
+ type: 'boolean',
17720
+ },
18008
17721
  max_override_period_minutes: {
18009
17722
  description:
18010
- "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
17723
+ "Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
18011
17724
  minimum: 0,
18012
17725
  type: 'integer',
18013
17726
  },
@@ -18080,10 +17793,14 @@ export default {
18080
17793
  'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
18081
17794
  type: 'string',
18082
17795
  },
18083
- is_override_allowed: { type: 'boolean' },
17796
+ is_override_allowed: {
17797
+ description:
17798
+ "Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
17799
+ type: 'boolean',
17800
+ },
18084
17801
  max_override_period_minutes: {
18085
17802
  description:
18086
- "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
17803
+ "Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
18087
17804
  minimum: 0,
18088
17805
  type: 'integer',
18089
17806
  },