@seamapi/types 1.329.0 → 1.330.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.
@@ -4807,6 +4807,10 @@ export interface Routes {
4807
4807
  created_at: string;
4808
4808
  message: string;
4809
4809
  warning_code: 'salto_ks_user_not_subscribed';
4810
+ } | {
4811
+ created_at: string;
4812
+ message: string;
4813
+ warning_code: 'unknown_issue_with_acs_user';
4810
4814
  }>;
4811
4815
  /** Errors associated with the `acs_user`. */
4812
4816
  errors: Array<{
@@ -8733,6 +8737,10 @@ export interface Routes {
8733
8737
  created_at: string;
8734
8738
  message: string;
8735
8739
  warning_code: 'salto_ks_user_not_subscribed';
8740
+ } | {
8741
+ created_at: string;
8742
+ message: string;
8743
+ warning_code: 'unknown_issue_with_acs_user';
8736
8744
  }>;
8737
8745
  /** Errors associated with the `acs_user`. */
8738
8746
  errors: Array<{
@@ -8849,6 +8857,10 @@ export interface Routes {
8849
8857
  created_at: string;
8850
8858
  message: string;
8851
8859
  warning_code: 'salto_ks_user_not_subscribed';
8860
+ } | {
8861
+ created_at: string;
8862
+ message: string;
8863
+ warning_code: 'unknown_issue_with_acs_user';
8852
8864
  }>;
8853
8865
  /** Errors associated with the `acs_user`. */
8854
8866
  errors: Array<{
@@ -8960,6 +8972,10 @@ export interface Routes {
8960
8972
  created_at: string;
8961
8973
  message: string;
8962
8974
  warning_code: 'salto_ks_user_not_subscribed';
8975
+ } | {
8976
+ created_at: string;
8977
+ message: string;
8978
+ warning_code: 'unknown_issue_with_acs_user';
8963
8979
  }>;
8964
8980
  /** Errors associated with the `acs_user`. */
8965
8981
  errors: Array<{
@@ -9167,6 +9183,10 @@ export interface Routes {
9167
9183
  created_at: string;
9168
9184
  message: string;
9169
9185
  warning_code: 'salto_ks_user_not_subscribed';
9186
+ } | {
9187
+ created_at: string;
9188
+ message: string;
9189
+ warning_code: 'unknown_issue_with_acs_user';
9170
9190
  }>;
9171
9191
  /** Errors associated with the `acs_user`. */
9172
9192
  errors: Array<{
@@ -9273,6 +9293,10 @@ export interface Routes {
9273
9293
  created_at: string;
9274
9294
  message: string;
9275
9295
  warning_code: 'salto_ks_user_not_subscribed';
9296
+ } | {
9297
+ created_at: string;
9298
+ message: string;
9299
+ warning_code: 'unknown_issue_with_acs_user';
9276
9300
  }>;
9277
9301
  /** Errors associated with the `acs_user`. */
9278
9302
  errors: Array<{
@@ -14293,13 +14317,13 @@ export interface Routes {
14293
14317
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
14294
14318
  connected_account_id: string;
14295
14319
  event_type: 'thermostat.temperature_reached_set_point';
14296
- /** Temperature, in °C, reported by the thermostat. */
14320
+ /** Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). */
14297
14321
  temperature_celsius: number;
14298
- /** Temperature, in °F, reported by the thermostat. */
14322
+ /** Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). */
14299
14323
  temperature_fahrenheit: number;
14300
- /** Desired temperature, in °C, set by the thermostat's cooling or heating set point. */
14324
+ /** Desired temperature, in °C, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
14301
14325
  desired_temperature_celsius?: number | undefined;
14302
- /** Desired temperature, in °F, set by the thermostat's cooling or heating set point. */
14326
+ /** Desired temperature, in °F, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
14303
14327
  desired_temperature_fahrenheit?: number | undefined;
14304
14328
  } | {
14305
14329
  /** ID of the event. */
@@ -15486,13 +15510,13 @@ export interface Routes {
15486
15510
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
15487
15511
  connected_account_id: string;
15488
15512
  event_type: 'thermostat.temperature_reached_set_point';
15489
- /** Temperature, in °C, reported by the thermostat. */
15513
+ /** Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). */
15490
15514
  temperature_celsius: number;
15491
- /** Temperature, in °F, reported by the thermostat. */
15515
+ /** Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). */
15492
15516
  temperature_fahrenheit: number;
15493
- /** Desired temperature, in °C, set by the thermostat's cooling or heating set point. */
15517
+ /** Desired temperature, in °C, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
15494
15518
  desired_temperature_celsius?: number | undefined;
15495
- /** Desired temperature, in °F, set by the thermostat's cooling or heating set point. */
15519
+ /** Desired temperature, in °F, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
15496
15520
  desired_temperature_fahrenheit?: number | undefined;
15497
15521
  } | {
15498
15522
  /** ID of the event. */
@@ -33232,6 +33256,10 @@ export interface Routes {
33232
33256
  created_at: string;
33233
33257
  message: string;
33234
33258
  warning_code: 'salto_ks_user_not_subscribed';
33259
+ } | {
33260
+ created_at: string;
33261
+ message: string;
33262
+ warning_code: 'unknown_issue_with_acs_user';
33235
33263
  }>;
33236
33264
  /** Errors associated with the `acs_user`. */
33237
33265
  errors: Array<{
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.329.0",
3
+ "version": "1.330.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -114,15 +114,31 @@ const acs_users_salto_ks_user_not_subscribed = common_acs_user_warning
114
114
  `Indicates that the user is not subscribed on the Salto KS, so they cannot unlock doors or perform any actions. This occur when the their access schedule hasn’t started yet, or if their access schedule has ended, or if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.`,
115
115
  )
116
116
 
117
+ export const unknown_issue_with_acs_user = common_acs_user_warning
118
+ .extend({
119
+ warning_code: z.literal('unknown_issue_with_acs_user'),
120
+ })
121
+ .describe(
122
+ 'An unknown issue occurred while syncing the state of this user with the provider. ' +
123
+ 'This issue may affect the proper functioning of this user.',
124
+ )
125
+
117
126
  export const acs_users_warning_map = z.object({
118
127
  being_deleted: acs_users_being_deleted.optional().nullable(),
119
128
  salto_ks_user_not_subscribed: acs_users_salto_ks_user_not_subscribed
120
129
  .optional()
121
130
  .nullable(),
131
+ unknown_issue_with_acs_user: unknown_issue_with_acs_user
132
+ .optional()
133
+ .nullable(),
122
134
  })
123
135
 
124
136
  export const acs_users_warnings = z
125
- .union([acs_users_being_deleted, acs_users_salto_ks_user_not_subscribed])
137
+ .union([
138
+ acs_users_being_deleted,
139
+ acs_users_salto_ks_user_not_subscribed,
140
+ unknown_issue_with_acs_user,
141
+ ])
126
142
  .describe('Warning associated with the `acs_user`.')
127
143
 
128
144
  export type AcsUsersWarningMap = z.infer<typeof acs_users_warning_map>
@@ -599,26 +599,31 @@ export const temperature_reached_set_point_event = device_event.extend({
599
599
  event_type: z.literal('thermostat.temperature_reached_set_point'),
600
600
  temperature_celsius: z
601
601
  .number()
602
- .describe('Temperature, in °C, reported by the thermostat.'),
602
+ .describe(
603
+ 'Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
604
+ ),
603
605
  temperature_fahrenheit: z
604
606
  .number()
605
- .describe('Temperature, in °F, reported by the thermostat.'),
607
+ .describe(
608
+ 'Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
609
+ ),
606
610
  desired_temperature_celsius: z
607
611
  .number()
608
612
  .optional()
609
613
  .describe(
610
- "Desired temperature, in °C, set by the thermostat's cooling or heating set point.",
614
+ "Desired temperature, in °C, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
611
615
  ),
612
616
  desired_temperature_fahrenheit: z
613
617
  .number()
614
618
  .optional()
615
619
  .describe(
616
- "Desired temperature, in °F, set by the thermostat's cooling or heating set point.",
620
+ "Desired temperature, in °F, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
617
621
  ),
618
622
  }).describe(`
619
623
  ---
620
624
  route_path: /thermostats
621
625
  ---
626
+ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading is within 1 °C of the configured cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
622
627
  `)
623
628
 
624
629
  export type TemperatureReachedSetPointEvent = z.infer<
@@ -1660,6 +1660,20 @@ export default {
1660
1660
  required: ['created_at', 'message', 'warning_code'],
1661
1661
  type: 'object',
1662
1662
  },
1663
+ {
1664
+ description:
1665
+ 'An unknown issue occurred while syncing the state of this user with the provider. This issue may affect the proper functioning of this user.',
1666
+ properties: {
1667
+ created_at: { format: 'date-time', type: 'string' },
1668
+ message: { type: 'string' },
1669
+ warning_code: {
1670
+ enum: ['unknown_issue_with_acs_user'],
1671
+ type: 'string',
1672
+ },
1673
+ },
1674
+ required: ['created_at', 'message', 'warning_code'],
1675
+ type: 'object',
1676
+ },
1663
1677
  ],
1664
1678
  },
1665
1679
  type: 'array',
@@ -10553,6 +10567,8 @@ export default {
10553
10567
  'x-route-path': '/thermostats',
10554
10568
  },
10555
10569
  {
10570
+ description:
10571
+ "A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading is within 1 °C of the configured cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
10556
10572
  properties: {
10557
10573
  connected_account_id: {
10558
10574
  description:
@@ -10567,13 +10583,13 @@ export default {
10567
10583
  },
10568
10584
  desired_temperature_celsius: {
10569
10585
  description:
10570
- "Desired temperature, in °C, set by the thermostat's cooling or heating set point.",
10586
+ "Desired temperature, in °C, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
10571
10587
  format: 'float',
10572
10588
  type: 'number',
10573
10589
  },
10574
10590
  desired_temperature_fahrenheit: {
10575
10591
  description:
10576
- "Desired temperature, in °F, set by the thermostat's cooling or heating set point.",
10592
+ "Desired temperature, in °F, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
10577
10593
  format: 'float',
10578
10594
  type: 'number',
10579
10595
  },
@@ -10597,12 +10613,14 @@ export default {
10597
10613
  type: 'string',
10598
10614
  },
10599
10615
  temperature_celsius: {
10600
- description: 'Temperature, in °C, reported by the thermostat.',
10616
+ description:
10617
+ 'Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
10601
10618
  format: 'float',
10602
10619
  type: 'number',
10603
10620
  },
10604
10621
  temperature_fahrenheit: {
10605
- description: 'Temperature, in °F, reported by the thermostat.',
10622
+ description:
10623
+ 'Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
10606
10624
  format: 'float',
10607
10625
  type: 'number',
10608
10626
  },
@@ -18051,6 +18069,27 @@ export default {
18051
18069
  ],
18052
18070
  type: 'object',
18053
18071
  },
18072
+ {
18073
+ description:
18074
+ 'An unknown issue occurred while syncing the state of this user with the provider. This issue may affect the proper functioning of this user.',
18075
+ properties: {
18076
+ created_at: {
18077
+ format: 'date-time',
18078
+ type: 'string',
18079
+ },
18080
+ message: { type: 'string' },
18081
+ warning_code: {
18082
+ enum: ['unknown_issue_with_acs_user'],
18083
+ type: 'string',
18084
+ },
18085
+ },
18086
+ required: [
18087
+ 'created_at',
18088
+ 'message',
18089
+ 'warning_code',
18090
+ ],
18091
+ type: 'object',
18092
+ },
18054
18093
  ],
18055
18094
  },
18056
18095
  type: 'array',
@@ -18448,6 +18487,27 @@ export default {
18448
18487
  ],
18449
18488
  type: 'object',
18450
18489
  },
18490
+ {
18491
+ description:
18492
+ 'An unknown issue occurred while syncing the state of this user with the provider. This issue may affect the proper functioning of this user.',
18493
+ properties: {
18494
+ created_at: {
18495
+ format: 'date-time',
18496
+ type: 'string',
18497
+ },
18498
+ message: { type: 'string' },
18499
+ warning_code: {
18500
+ enum: ['unknown_issue_with_acs_user'],
18501
+ type: 'string',
18502
+ },
18503
+ },
18504
+ required: [
18505
+ 'created_at',
18506
+ 'message',
18507
+ 'warning_code',
18508
+ ],
18509
+ type: 'object',
18510
+ },
18451
18511
  ],
18452
18512
  },
18453
18513
  type: 'array',
@@ -5622,6 +5622,11 @@ export interface Routes {
5622
5622
  message: string
5623
5623
  warning_code: 'salto_ks_user_not_subscribed'
5624
5624
  }
5625
+ | {
5626
+ created_at: string
5627
+ message: string
5628
+ warning_code: 'unknown_issue_with_acs_user'
5629
+ }
5625
5630
  >
5626
5631
  /** Errors associated with the `acs_user`. */
5627
5632
  errors: Array<
@@ -10332,6 +10337,11 @@ export interface Routes {
10332
10337
  message: string
10333
10338
  warning_code: 'salto_ks_user_not_subscribed'
10334
10339
  }
10340
+ | {
10341
+ created_at: string
10342
+ message: string
10343
+ warning_code: 'unknown_issue_with_acs_user'
10344
+ }
10335
10345
  >
10336
10346
  /** Errors associated with the `acs_user`. */
10337
10347
  errors: Array<
@@ -10472,6 +10482,11 @@ export interface Routes {
10472
10482
  message: string
10473
10483
  warning_code: 'salto_ks_user_not_subscribed'
10474
10484
  }
10485
+ | {
10486
+ created_at: string
10487
+ message: string
10488
+ warning_code: 'unknown_issue_with_acs_user'
10489
+ }
10475
10490
  >
10476
10491
  /** Errors associated with the `acs_user`. */
10477
10492
  errors: Array<
@@ -10607,6 +10622,11 @@ export interface Routes {
10607
10622
  message: string
10608
10623
  warning_code: 'salto_ks_user_not_subscribed'
10609
10624
  }
10625
+ | {
10626
+ created_at: string
10627
+ message: string
10628
+ warning_code: 'unknown_issue_with_acs_user'
10629
+ }
10610
10630
  >
10611
10631
  /** Errors associated with the `acs_user`. */
10612
10632
  errors: Array<
@@ -10861,6 +10881,11 @@ export interface Routes {
10861
10881
  message: string
10862
10882
  warning_code: 'salto_ks_user_not_subscribed'
10863
10883
  }
10884
+ | {
10885
+ created_at: string
10886
+ message: string
10887
+ warning_code: 'unknown_issue_with_acs_user'
10888
+ }
10864
10889
  >
10865
10890
  /** Errors associated with the `acs_user`. */
10866
10891
  errors: Array<
@@ -10991,6 +11016,11 @@ export interface Routes {
10991
11016
  message: string
10992
11017
  warning_code: 'salto_ks_user_not_subscribed'
10993
11018
  }
11019
+ | {
11020
+ created_at: string
11021
+ message: string
11022
+ warning_code: 'unknown_issue_with_acs_user'
11023
+ }
10994
11024
  >
10995
11025
  /** Errors associated with the `acs_user`. */
10996
11026
  errors: Array<
@@ -17371,13 +17401,13 @@ export interface Routes {
17371
17401
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
17372
17402
  connected_account_id: string
17373
17403
  event_type: 'thermostat.temperature_reached_set_point'
17374
- /** Temperature, in °C, reported by the thermostat. */
17404
+ /** Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). */
17375
17405
  temperature_celsius: number
17376
- /** Temperature, in °F, reported by the thermostat. */
17406
+ /** Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). */
17377
17407
  temperature_fahrenheit: number
17378
- /** Desired temperature, in °C, set by the thermostat's cooling or heating set point. */
17408
+ /** Desired temperature, in °C, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
17379
17409
  desired_temperature_celsius?: number | undefined
17380
- /** Desired temperature, in °F, set by the thermostat's cooling or heating set point. */
17410
+ /** Desired temperature, in °F, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
17381
17411
  desired_temperature_fahrenheit?: number | undefined
17382
17412
  }
17383
17413
  | {
@@ -18804,13 +18834,13 @@ export interface Routes {
18804
18834
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
18805
18835
  connected_account_id: string
18806
18836
  event_type: 'thermostat.temperature_reached_set_point'
18807
- /** Temperature, in °C, reported by the thermostat. */
18837
+ /** Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). */
18808
18838
  temperature_celsius: number
18809
- /** Temperature, in °F, reported by the thermostat. */
18839
+ /** Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). */
18810
18840
  temperature_fahrenheit: number
18811
- /** Desired temperature, in °C, set by the thermostat's cooling or heating set point. */
18841
+ /** Desired temperature, in °C, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
18812
18842
  desired_temperature_celsius?: number | undefined
18813
- /** Desired temperature, in °F, set by the thermostat's cooling or heating set point. */
18843
+ /** Desired temperature, in °F, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
18814
18844
  desired_temperature_fahrenheit?: number | undefined
18815
18845
  }
18816
18846
  | {
@@ -41067,6 +41097,11 @@ export interface Routes {
41067
41097
  message: string
41068
41098
  warning_code: 'salto_ks_user_not_subscribed'
41069
41099
  }
41100
+ | {
41101
+ created_at: string
41102
+ message: string
41103
+ warning_code: 'unknown_issue_with_acs_user'
41104
+ }
41070
41105
  >
41071
41106
  /** Errors associated with the `acs_user`. */
41072
41107
  errors: Array<