@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/lib/seam/connect/openapi.js CHANGED
@@ -2877,234 +2877,6 @@ export default {
2877
2877
  ],
2878
2878
  type: 'object',
2879
2879
  },
2880
- {
2881
- description: 'Setting HVAC to cool.',
2882
- properties: {
2883
- action_attempt_id: {
2884
- description: 'The ID of the action attempt.',
2885
- format: 'uuid',
2886
- type: 'string',
2887
- 'x-title': 'Action Attempt ID',
2888
- },
2889
- action_type: { enum: ['SET_COOL'], type: 'string' },
2890
- error: { nullable: true },
2891
- result: { nullable: true },
2892
- status: { enum: ['pending'], type: 'string' },
2893
- },
2894
- required: [
2895
- 'action_attempt_id',
2896
- 'status',
2897
- 'result',
2898
- 'error',
2899
- 'action_type',
2900
- ],
2901
- type: 'object',
2902
- },
2903
- {
2904
- description: 'Setting HVAC to cool succeeded.',
2905
- properties: {
2906
- action_attempt_id: {
2907
- description: 'The ID of the action attempt.',
2908
- format: 'uuid',
2909
- type: 'string',
2910
- 'x-title': 'Action Attempt ID',
2911
- },
2912
- action_type: { enum: ['SET_COOL'], type: 'string' },
2913
- error: { nullable: true },
2914
- result: { properties: {}, type: 'object' },
2915
- status: { enum: ['success'], type: 'string' },
2916
- },
2917
- required: [
2918
- 'action_attempt_id',
2919
- 'status',
2920
- 'error',
2921
- 'action_type',
2922
- 'result',
2923
- ],
2924
- type: 'object',
2925
- },
2926
- {
2927
- description: 'Setting HVAC to cool failed.',
2928
- properties: {
2929
- action_attempt_id: {
2930
- description: 'The ID of the action attempt.',
2931
- format: 'uuid',
2932
- type: 'string',
2933
- 'x-title': 'Action Attempt ID',
2934
- },
2935
- action_type: { enum: ['SET_COOL'], type: 'string' },
2936
- error: {
2937
- properties: {
2938
- message: { type: 'string' },
2939
- type: { type: 'string' },
2940
- },
2941
- required: ['type', 'message'],
2942
- type: 'object',
2943
- },
2944
- result: { nullable: true },
2945
- status: { enum: ['error'], type: 'string' },
2946
- },
2947
- required: [
2948
- 'action_attempt_id',
2949
- 'status',
2950
- 'result',
2951
- 'action_type',
2952
- 'error',
2953
- ],
2954
- type: 'object',
2955
- },
2956
- {
2957
- description: 'Setting HVAC to heat mode.',
2958
- properties: {
2959
- action_attempt_id: {
2960
- description: 'The ID of the action attempt.',
2961
- format: 'uuid',
2962
- type: 'string',
2963
- 'x-title': 'Action Attempt ID',
2964
- },
2965
- action_type: { enum: ['SET_HEAT'], type: 'string' },
2966
- error: { nullable: true },
2967
- result: { nullable: true },
2968
- status: { enum: ['pending'], type: 'string' },
2969
- },
2970
- required: [
2971
- 'action_attempt_id',
2972
- 'status',
2973
- 'result',
2974
- 'error',
2975
- 'action_type',
2976
- ],
2977
- type: 'object',
2978
- },
2979
- {
2980
- description: 'Setting HVAC to heat mode succeeded.',
2981
- properties: {
2982
- action_attempt_id: {
2983
- description: 'The ID of the action attempt.',
2984
- format: 'uuid',
2985
- type: 'string',
2986
- 'x-title': 'Action Attempt ID',
2987
- },
2988
- action_type: { enum: ['SET_HEAT'], type: 'string' },
2989
- error: { nullable: true },
2990
- result: { properties: {}, type: 'object' },
2991
- status: { enum: ['success'], type: 'string' },
2992
- },
2993
- required: [
2994
- 'action_attempt_id',
2995
- 'status',
2996
- 'error',
2997
- 'action_type',
2998
- 'result',
2999
- ],
3000
- type: 'object',
3001
- },
3002
- {
3003
- description: 'Setting HVAC to heat mode failed.',
3004
- properties: {
3005
- action_attempt_id: {
3006
- description: 'The ID of the action attempt.',
3007
- format: 'uuid',
3008
- type: 'string',
3009
- 'x-title': 'Action Attempt ID',
3010
- },
3011
- action_type: { enum: ['SET_HEAT'], type: 'string' },
3012
- error: {
3013
- properties: {
3014
- message: { type: 'string' },
3015
- type: { type: 'string' },
3016
- },
3017
- required: ['type', 'message'],
3018
- type: 'object',
3019
- },
3020
- result: { nullable: true },
3021
- status: { enum: ['error'], type: 'string' },
3022
- },
3023
- required: [
3024
- 'action_attempt_id',
3025
- 'status',
3026
- 'result',
3027
- 'action_type',
3028
- 'error',
3029
- ],
3030
- type: 'object',
3031
- },
3032
- {
3033
- description: 'Setting HVAC to heat-cool mode.',
3034
- properties: {
3035
- action_attempt_id: {
3036
- description: 'The ID of the action attempt.',
3037
- format: 'uuid',
3038
- type: 'string',
3039
- 'x-title': 'Action Attempt ID',
3040
- },
3041
- action_type: { enum: ['SET_HEAT_COOL'], type: 'string' },
3042
- error: { nullable: true },
3043
- result: { nullable: true },
3044
- status: { enum: ['pending'], type: 'string' },
3045
- },
3046
- required: [
3047
- 'action_attempt_id',
3048
- 'status',
3049
- 'result',
3050
- 'error',
3051
- 'action_type',
3052
- ],
3053
- type: 'object',
3054
- },
3055
- {
3056
- description: 'Setting HVAC to heat-cool mode succeeded.',
3057
- properties: {
3058
- action_attempt_id: {
3059
- description: 'The ID of the action attempt.',
3060
- format: 'uuid',
3061
- type: 'string',
3062
- 'x-title': 'Action Attempt ID',
3063
- },
3064
- action_type: { enum: ['SET_HEAT_COOL'], type: 'string' },
3065
- error: { nullable: true },
3066
- result: { properties: {}, type: 'object' },
3067
- status: { enum: ['success'], type: 'string' },
3068
- },
3069
- required: [
3070
- 'action_attempt_id',
3071
- 'status',
3072
- 'error',
3073
- 'action_type',
3074
- 'result',
3075
- ],
3076
- type: 'object',
3077
- },
3078
- {
3079
- description: 'Setting heat-cool mode failed.',
3080
- properties: {
3081
- action_attempt_id: {
3082
- description: 'The ID of the action attempt.',
3083
- format: 'uuid',
3084
- type: 'string',
3085
- 'x-title': 'Action Attempt ID',
3086
- },
3087
- action_type: { enum: ['SET_HEAT_COOL'], type: 'string' },
3088
- error: {
3089
- properties: {
3090
- message: { type: 'string' },
3091
- type: { type: 'string' },
3092
- },
3093
- required: ['type', 'message'],
3094
- type: 'object',
3095
- },
3096
- result: { nullable: true },
3097
- status: { enum: ['error'], type: 'string' },
3098
- },
3099
- required: [
3100
- 'action_attempt_id',
3101
- 'status',
3102
- 'result',
3103
- 'action_type',
3104
- 'error',
3105
- ],
3106
- type: 'object',
3107
- },
3108
2880
  {
3109
2881
  description: 'Setting fan mode.',
3110
2882
  properties: {
@@ -3181,82 +2953,6 @@ export default {
3181
2953
  ],
3182
2954
  type: 'object',
3183
2955
  },
3184
- {
3185
- description: 'Turning HVAC off.',
3186
- properties: {
3187
- action_attempt_id: {
3188
- description: 'The ID of the action attempt.',
3189
- format: 'uuid',
3190
- type: 'string',
3191
- 'x-title': 'Action Attempt ID',
3192
- },
3193
- action_type: { enum: ['SET_THERMOSTAT_OFF'], type: 'string' },
3194
- error: { nullable: true },
3195
- result: { nullable: true },
3196
- status: { enum: ['pending'], type: 'string' },
3197
- },
3198
- required: [
3199
- 'action_attempt_id',
3200
- 'status',
3201
- 'result',
3202
- 'error',
3203
- 'action_type',
3204
- ],
3205
- type: 'object',
3206
- },
3207
- {
3208
- description: 'Turning HVAC off succeeded.',
3209
- properties: {
3210
- action_attempt_id: {
3211
- description: 'The ID of the action attempt.',
3212
- format: 'uuid',
3213
- type: 'string',
3214
- 'x-title': 'Action Attempt ID',
3215
- },
3216
- action_type: { enum: ['SET_THERMOSTAT_OFF'], type: 'string' },
3217
- error: { nullable: true },
3218
- result: { properties: {}, type: 'object' },
3219
- status: { enum: ['success'], type: 'string' },
3220
- },
3221
- required: [
3222
- 'action_attempt_id',
3223
- 'status',
3224
- 'error',
3225
- 'action_type',
3226
- 'result',
3227
- ],
3228
- type: 'object',
3229
- },
3230
- {
3231
- description: 'Turning HVAC off failed.',
3232
- properties: {
3233
- action_attempt_id: {
3234
- description: 'The ID of the action attempt.',
3235
- format: 'uuid',
3236
- type: 'string',
3237
- 'x-title': 'Action Attempt ID',
3238
- },
3239
- action_type: { enum: ['SET_THERMOSTAT_OFF'], type: 'string' },
3240
- error: {
3241
- properties: {
3242
- message: { type: 'string' },
3243
- type: { type: 'string' },
3244
- },
3245
- required: ['type', 'message'],
3246
- type: 'object',
3247
- },
3248
- result: { nullable: true },
3249
- status: { enum: ['error'], type: 'string' },
3250
- },
3251
- required: [
3252
- 'action_attempt_id',
3253
- 'status',
3254
- 'result',
3255
- 'action_type',
3256
- 'error',
3257
- ],
3258
- type: 'object',
3259
- },
3260
2956
  {
3261
2957
  description: 'Setting HVAC mode.',
3262
2958
  properties: {
@@ -16305,7 +16001,13 @@ export default {
16305
16001
  enum: ['off', 'heat', 'cool', 'heat_cool'],
16306
16002
  type: 'string',
16307
16003
  },
16308
- manual_override_allowed: { default: true, type: 'boolean' },
16004
+ manual_override_allowed: {
16005
+ default: true,
16006
+ deprecated: true,
16007
+ description: "Indicates whether a person at the thermostat or using the API can change the thermostat's settings.",
16008
+ type: 'boolean',
16009
+ 'x-deprecated': "Use 'thermostat_schedule.is_override_allowed'",
16010
+ },
16309
16011
  name: {
16310
16012
  default: null,
16311
16013
  description: 'User-friendly name to identify the climate preset.',
@@ -16987,10 +16689,14 @@ export default {
16987
16689
  description: 'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
16988
16690
  type: 'string',
16989
16691
  },
16990
- is_override_allowed: { default: false, type: 'boolean' },
16692
+ is_override_allowed: {
16693
+ default: false,
16694
+ description: "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).",
16695
+ type: 'boolean',
16696
+ },
16991
16697
  max_override_period_minutes: {
16992
16698
  default: 0,
16993
- description: "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).",
16699
+ description: "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).",
16994
16700
  minimum: 0,
16995
16701
  type: 'integer',
16996
16702
  },
@@ -17239,9 +16945,12 @@ export default {
17239
16945
  description: 'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
17240
16946
  type: 'string',
17241
16947
  },
17242
- is_override_allowed: { type: 'boolean' },
16948
+ is_override_allowed: {
16949
+ description: "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).",
16950
+ type: 'boolean',
16951
+ },
17243
16952
  max_override_period_minutes: {
17244
- description: "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).",
16953
+ description: "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).",
17245
16954
  minimum: 0,
17246
16955
  type: 'integer',
17247
16956
  },
@@ -17309,9 +17018,12 @@ export default {
17309
17018
  description: 'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
17310
17019
  type: 'string',
17311
17020
  },
17312
- is_override_allowed: { type: 'boolean' },
17021
+ is_override_allowed: {
17022
+ description: "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).",
17023
+ type: 'boolean',
17024
+ },
17313
17025
  max_override_period_minutes: {
17314
- description: "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).",
17026
+ description: "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).",
17315
17027
  minimum: 0,
17316
17028
  type: 'integer',
17317
17029
  },