@seamapi/types 1.298.0 → 1.300.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.
@@ -218,13 +218,13 @@ export declare const acs_user: z.ZodObject<z.objectUtil.extendShape<z.objectUtil
218
218
  is_suspended: z.ZodBoolean;
219
219
  access_schedule: z.ZodOptional<z.ZodObject<{
220
220
  starts_at: z.ZodString;
221
- ends_at: z.ZodString;
221
+ ends_at: z.ZodNullable<z.ZodString>;
222
222
  }, "strip", z.ZodTypeAny, {
223
223
  starts_at: string;
224
- ends_at: string;
224
+ ends_at: string | null;
225
225
  }, {
226
226
  starts_at: string;
227
- ends_at: string;
227
+ ends_at: string | null;
228
228
  }>>;
229
229
  user_identity_id: z.ZodOptional<z.ZodString>;
230
230
  user_identity_full_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -382,7 +382,7 @@ export declare const acs_user: z.ZodObject<z.objectUtil.extendShape<z.objectUtil
382
382
  hid_acs_system_id?: string | undefined;
383
383
  access_schedule?: {
384
384
  starts_at: string;
385
- ends_at: string;
385
+ ends_at: string | null;
386
386
  } | undefined;
387
387
  user_identity_full_name?: string | null | undefined;
388
388
  user_identity_email_address?: string | null | undefined;
@@ -437,7 +437,7 @@ export declare const acs_user: z.ZodObject<z.objectUtil.extendShape<z.objectUtil
437
437
  hid_acs_system_id?: string | undefined;
438
438
  access_schedule?: {
439
439
  starts_at: string;
440
- ends_at: string;
440
+ ends_at: string | null;
441
441
  } | undefined;
442
442
  user_identity_full_name?: string | null | undefined;
443
443
  user_identity_email_address?: string | null | undefined;
@@ -455,13 +455,13 @@ export declare const unmanaged_acs_user: z.ZodObject<z.objectUtil.extendShape<z.
455
455
  is_suspended: z.ZodBoolean;
456
456
  access_schedule: z.ZodOptional<z.ZodObject<{
457
457
  starts_at: z.ZodString;
458
- ends_at: z.ZodString;
458
+ ends_at: z.ZodNullable<z.ZodString>;
459
459
  }, "strip", z.ZodTypeAny, {
460
460
  starts_at: string;
461
- ends_at: string;
461
+ ends_at: string | null;
462
462
  }, {
463
463
  starts_at: string;
464
- ends_at: string;
464
+ ends_at: string | null;
465
465
  }>>;
466
466
  user_identity_id: z.ZodOptional<z.ZodString>;
467
467
  user_identity_full_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -619,7 +619,7 @@ export declare const unmanaged_acs_user: z.ZodObject<z.objectUtil.extendShape<z.
619
619
  hid_acs_system_id?: string | undefined;
620
620
  access_schedule?: {
621
621
  starts_at: string;
622
- ends_at: string;
622
+ ends_at: string | null;
623
623
  } | undefined;
624
624
  user_identity_full_name?: string | null | undefined;
625
625
  user_identity_email_address?: string | null | undefined;
@@ -674,7 +674,7 @@ export declare const unmanaged_acs_user: z.ZodObject<z.objectUtil.extendShape<z.
674
674
  hid_acs_system_id?: string | undefined;
675
675
  access_schedule?: {
676
676
  starts_at: string;
677
- ends_at: string;
677
+ ends_at: string | null;
678
678
  } | undefined;
679
679
  user_identity_full_name?: string | null | undefined;
680
680
  user_identity_email_address?: string | null | undefined;
@@ -1,21 +1,21 @@
1
1
  import { z } from 'zod';
2
2
  export declare const start_end_schedule: z.ZodObject<{
3
3
  starts_at: z.ZodString;
4
- ends_at: z.ZodString;
4
+ ends_at: z.ZodNullable<z.ZodString>;
5
5
  }, "strip", z.ZodTypeAny, {
6
6
  starts_at: string;
7
- ends_at: string;
7
+ ends_at: string | null;
8
8
  }, {
9
9
  starts_at: string;
10
- ends_at: string;
10
+ ends_at: string | null;
11
11
  }>;
12
12
  export declare const schedule: z.ZodObject<{
13
13
  starts_at: z.ZodString;
14
- ends_at: z.ZodString;
14
+ ends_at: z.ZodNullable<z.ZodString>;
15
15
  }, "strip", z.ZodTypeAny, {
16
16
  starts_at: string;
17
- ends_at: string;
17
+ ends_at: string | null;
18
18
  }, {
19
19
  starts_at: string;
20
- ends_at: string;
20
+ ends_at: string | null;
21
21
  }>;
@@ -7,7 +7,8 @@ export const start_end_schedule = z.object({
7
7
  ends_at: z
8
8
  .string()
9
9
  .datetime()
10
- .describe("Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."),
10
+ .describe("Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.")
11
+ .nullable(),
11
12
  });
12
13
  // export const schedule = z.union([
13
14
  // start_end_schedule,
@@ -1 +1 @@
1
- {"version":3,"file":"schedule.js","sourceRoot":"","sources":["../../../../src/lib/seam/connect/models/schedule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,gIAAgI,CACjI;IACH,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,8HAA8H,CAC/H;CACJ,CAAC,CAAA;AAEF,oCAAoC;AACpC,wBAAwB;AACxB,oBAAoB;AACpB,oBAAoB;AACpB,KAAK;AACL,MAAM,CAAC,MAAM,QAAQ,GAAG,kBAAkB,CAAA"}
1
+ {"version":3,"file":"schedule.js","sourceRoot":"","sources":["../../../../src/lib/seam/connect/models/schedule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,gIAAgI,CACjI;IACH,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,8HAA8H,CAC/H;SACA,QAAQ,EAAE;CACd,CAAC,CAAA;AAEF,oCAAoC;AACpC,wBAAwB;AACxB,oBAAoB;AACpB,oBAAoB;AACpB,KAAK;AACL,MAAM,CAAC,MAAM,QAAQ,GAAG,kBAAkB,CAAA"}
@@ -828,6 +828,7 @@ declare const _default: {
828
828
  ends_at: {
829
829
  description: string;
830
830
  format: string;
831
+ nullable: boolean;
831
832
  type: string;
832
833
  };
833
834
  starts_at: {
@@ -10250,6 +10251,7 @@ declare const _default: {
10250
10251
  properties: {
10251
10252
  ends_at: {
10252
10253
  format: string;
10254
+ nullable: boolean;
10253
10255
  type: string;
10254
10256
  };
10255
10257
  starts_at: {
@@ -10257,7 +10259,6 @@ declare const _default: {
10257
10259
  type: string;
10258
10260
  };
10259
10261
  };
10260
- required: string[];
10261
10262
  type: string;
10262
10263
  };
10263
10264
  acs_access_group_ids: {
@@ -10909,6 +10910,7 @@ declare const _default: {
10909
10910
  ends_at: {
10910
10911
  description: string;
10911
10912
  format: string;
10913
+ nullable: boolean;
10912
10914
  type: string;
10913
10915
  };
10914
10916
  starts_at: {
@@ -11156,6 +11158,7 @@ declare const _default: {
11156
11158
  ends_at: {
11157
11159
  description: string;
11158
11160
  format: string;
11161
+ nullable: boolean;
11159
11162
  type: string;
11160
11163
  };
11161
11164
  starts_at: {
@@ -17713,6 +17716,183 @@ declare const _default: {
17713
17716
  'x-title': string;
17714
17717
  };
17715
17718
  };
17719
+ '/thermostats/set_hvac_mode': {
17720
+ post: {
17721
+ description: string;
17722
+ operationId: string;
17723
+ requestBody: {
17724
+ content: {
17725
+ 'application/json': {
17726
+ schema: {
17727
+ discriminator: {
17728
+ propertyName: string;
17729
+ };
17730
+ oneOf: ({
17731
+ properties: {
17732
+ device_id: {
17733
+ description: string;
17734
+ format: string;
17735
+ type: string;
17736
+ };
17737
+ hvac_mode_setting: {
17738
+ enum: string[];
17739
+ type: string;
17740
+ };
17741
+ cooling_set_point_celsius?: never;
17742
+ cooling_set_point_fahrenheit?: never;
17743
+ heating_set_point_celsius?: never;
17744
+ heating_set_point_fahrenheit?: never;
17745
+ };
17746
+ required: string[];
17747
+ type: string;
17748
+ } | {
17749
+ properties: {
17750
+ cooling_set_point_celsius: {
17751
+ description: string;
17752
+ format: string;
17753
+ type: string;
17754
+ };
17755
+ cooling_set_point_fahrenheit: {
17756
+ description: string;
17757
+ format: string;
17758
+ type: string;
17759
+ };
17760
+ device_id: {
17761
+ description: string;
17762
+ format: string;
17763
+ type: string;
17764
+ };
17765
+ hvac_mode_setting: {
17766
+ enum: string[];
17767
+ type: string;
17768
+ };
17769
+ heating_set_point_celsius?: never;
17770
+ heating_set_point_fahrenheit?: never;
17771
+ };
17772
+ required: string[];
17773
+ type: string;
17774
+ } | {
17775
+ properties: {
17776
+ device_id: {
17777
+ description: string;
17778
+ format: string;
17779
+ type: string;
17780
+ };
17781
+ heating_set_point_celsius: {
17782
+ description: string;
17783
+ format: string;
17784
+ type: string;
17785
+ };
17786
+ heating_set_point_fahrenheit: {
17787
+ description: string;
17788
+ format: string;
17789
+ type: string;
17790
+ };
17791
+ hvac_mode_setting: {
17792
+ enum: string[];
17793
+ type: string;
17794
+ };
17795
+ cooling_set_point_celsius?: never;
17796
+ cooling_set_point_fahrenheit?: never;
17797
+ };
17798
+ required: string[];
17799
+ type: string;
17800
+ } | {
17801
+ properties: {
17802
+ cooling_set_point_celsius: {
17803
+ description: string;
17804
+ format: string;
17805
+ type: string;
17806
+ };
17807
+ cooling_set_point_fahrenheit: {
17808
+ description: string;
17809
+ format: string;
17810
+ type: string;
17811
+ };
17812
+ device_id: {
17813
+ description: string;
17814
+ format: string;
17815
+ type: string;
17816
+ };
17817
+ heating_set_point_celsius: {
17818
+ description: string;
17819
+ format: string;
17820
+ type: string;
17821
+ };
17822
+ heating_set_point_fahrenheit: {
17823
+ description: string;
17824
+ format: string;
17825
+ type: string;
17826
+ };
17827
+ hvac_mode_setting: {
17828
+ enum: string[];
17829
+ type: string;
17830
+ };
17831
+ };
17832
+ required: string[];
17833
+ type: string;
17834
+ })[];
17835
+ };
17836
+ };
17837
+ };
17838
+ };
17839
+ responses: {
17840
+ 200: {
17841
+ content: {
17842
+ 'application/json': {
17843
+ schema: {
17844
+ properties: {
17845
+ action_attempt: {
17846
+ $ref: string;
17847
+ };
17848
+ ok: {
17849
+ type: string;
17850
+ };
17851
+ };
17852
+ required: string[];
17853
+ type: string;
17854
+ };
17855
+ };
17856
+ };
17857
+ description: string;
17858
+ };
17859
+ 400: {
17860
+ description: string;
17861
+ };
17862
+ 401: {
17863
+ description: string;
17864
+ };
17865
+ };
17866
+ security: ({
17867
+ client_session: never[];
17868
+ pat_with_workspace?: never;
17869
+ console_session?: never;
17870
+ api_key?: never;
17871
+ } | {
17872
+ pat_with_workspace: never[];
17873
+ client_session?: never;
17874
+ console_session?: never;
17875
+ api_key?: never;
17876
+ } | {
17877
+ console_session: never[];
17878
+ client_session?: never;
17879
+ pat_with_workspace?: never;
17880
+ api_key?: never;
17881
+ } | {
17882
+ api_key: never[];
17883
+ client_session?: never;
17884
+ pat_with_workspace?: never;
17885
+ console_session?: never;
17886
+ })[];
17887
+ summary: string;
17888
+ tags: string[];
17889
+ 'x-fern-sdk-group-name': string[];
17890
+ 'x-fern-sdk-method-name': string;
17891
+ 'x-fern-sdk-return-value': string;
17892
+ 'x-response-key': string;
17893
+ 'x-title': string;
17894
+ };
17895
+ };
17716
17896
  '/thermostats/set_temperature_threshold': {
17717
17897
  patch: {
17718
17898
  description: string;
@@ -960,6 +960,7 @@ export default {
960
960
  ends_at: {
961
961
  description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
962
962
  format: 'date-time',
963
+ nullable: true,
963
964
  type: 'string',
964
965
  },
965
966
  starts_at: {
@@ -10542,12 +10543,15 @@ export default {
10542
10543
  schema: {
10543
10544
  properties: {
10544
10545
  access_schedule: {
10545
- description: "`starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems.",
10546
+ description: "`starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`.",
10546
10547
  properties: {
10547
- ends_at: { format: 'date-time', type: 'string' },
10548
+ ends_at: {
10549
+ format: 'date-time',
10550
+ nullable: true,
10551
+ type: 'string',
10552
+ },
10548
10553
  starts_at: { format: 'date-time', type: 'string' },
10549
10554
  },
10550
- required: ['starts_at', 'ends_at'],
10551
10555
  type: 'object',
10552
10556
  },
10553
10557
  acs_access_group_ids: {
@@ -11042,6 +11046,7 @@ export default {
11042
11046
  ends_at: {
11043
11047
  description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
11044
11048
  format: 'date-time',
11049
+ nullable: true,
11045
11050
  type: 'string',
11046
11051
  },
11047
11052
  starts_at: {
@@ -11400,6 +11405,7 @@ export default {
11400
11405
  ends_at: {
11401
11406
  description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
11402
11407
  format: 'date-time',
11408
+ nullable: true,
11403
11409
  type: 'string',
11404
11410
  },
11405
11411
  starts_at: {
@@ -11786,7 +11792,7 @@ export default {
11786
11792
  schema: {
11787
11793
  properties: {
11788
11794
  access_schedule: {
11789
- description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems.",
11795
+ description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`.",
11790
11796
  nullable: true,
11791
11797
  properties: {
11792
11798
  ends_at: { format: 'date-time', type: 'string' },
@@ -11863,7 +11869,7 @@ export default {
11863
11869
  schema: {
11864
11870
  properties: {
11865
11871
  access_schedule: {
11866
- description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems.",
11872
+ description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`.",
11867
11873
  nullable: true,
11868
11874
  properties: {
11869
11875
  ends_at: { format: 'date-time', type: 'string' },
@@ -17299,6 +17305,148 @@ export default {
17299
17305
  'x-title': 'Set the Fan Mode Setting',
17300
17306
  },
17301
17307
  },
17308
+ '/thermostats/set_hvac_mode': {
17309
+ post: {
17310
+ description: 'Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
17311
+ operationId: 'thermostatsSetHvacModePost',
17312
+ requestBody: {
17313
+ content: {
17314
+ 'application/json': {
17315
+ schema: {
17316
+ discriminator: { propertyName: 'hvac_mode_setting' },
17317
+ oneOf: [
17318
+ {
17319
+ properties: {
17320
+ device_id: {
17321
+ description: 'ID of the desired thermostat device.',
17322
+ format: 'uuid',
17323
+ type: 'string',
17324
+ },
17325
+ hvac_mode_setting: { enum: ['off'], type: 'string' },
17326
+ },
17327
+ required: ['hvac_mode_setting', 'device_id'],
17328
+ type: 'object',
17329
+ },
17330
+ {
17331
+ properties: {
17332
+ cooling_set_point_celsius: {
17333
+ description: 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters.',
17334
+ format: 'float',
17335
+ type: 'number',
17336
+ },
17337
+ cooling_set_point_fahrenheit: {
17338
+ description: 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters.',
17339
+ format: 'float',
17340
+ type: 'number',
17341
+ },
17342
+ device_id: {
17343
+ description: 'ID of the desired thermostat device.',
17344
+ format: 'uuid',
17345
+ type: 'string',
17346
+ },
17347
+ hvac_mode_setting: { enum: ['cool'], type: 'string' },
17348
+ },
17349
+ required: ['hvac_mode_setting', 'device_id'],
17350
+ type: 'object',
17351
+ },
17352
+ {
17353
+ properties: {
17354
+ device_id: {
17355
+ description: 'ID of the desired thermostat device.',
17356
+ format: 'uuid',
17357
+ type: 'string',
17358
+ },
17359
+ heating_set_point_celsius: {
17360
+ description: 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters.',
17361
+ format: 'float',
17362
+ type: 'number',
17363
+ },
17364
+ heating_set_point_fahrenheit: {
17365
+ description: 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters.',
17366
+ format: 'float',
17367
+ type: 'number',
17368
+ },
17369
+ hvac_mode_setting: { enum: ['heat'], type: 'string' },
17370
+ },
17371
+ required: ['hvac_mode_setting', 'device_id'],
17372
+ type: 'object',
17373
+ },
17374
+ {
17375
+ properties: {
17376
+ cooling_set_point_celsius: {
17377
+ description: 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters.',
17378
+ format: 'float',
17379
+ type: 'number',
17380
+ },
17381
+ cooling_set_point_fahrenheit: {
17382
+ description: 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters.',
17383
+ format: 'float',
17384
+ type: 'number',
17385
+ },
17386
+ device_id: {
17387
+ description: 'ID of the desired thermostat device.',
17388
+ format: 'uuid',
17389
+ type: 'string',
17390
+ },
17391
+ heating_set_point_celsius: {
17392
+ description: 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters.',
17393
+ format: 'float',
17394
+ type: 'number',
17395
+ },
17396
+ heating_set_point_fahrenheit: {
17397
+ description: 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters.',
17398
+ format: 'float',
17399
+ type: 'number',
17400
+ },
17401
+ hvac_mode_setting: {
17402
+ enum: ['heat_cool'],
17403
+ type: 'string',
17404
+ },
17405
+ },
17406
+ required: ['hvac_mode_setting', 'device_id'],
17407
+ type: 'object',
17408
+ },
17409
+ ],
17410
+ },
17411
+ },
17412
+ },
17413
+ },
17414
+ responses: {
17415
+ 200: {
17416
+ content: {
17417
+ 'application/json': {
17418
+ schema: {
17419
+ properties: {
17420
+ action_attempt: {
17421
+ $ref: '#/components/schemas/action_attempt',
17422
+ },
17423
+ ok: { type: 'boolean' },
17424
+ },
17425
+ required: ['action_attempt', 'ok'],
17426
+ type: 'object',
17427
+ },
17428
+ },
17429
+ },
17430
+ description: 'OK',
17431
+ },
17432
+ 400: { description: 'Bad Request' },
17433
+ 401: { description: 'Unauthorized' },
17434
+ },
17435
+ security: [
17436
+ { client_session: [] },
17437
+ { pat_with_workspace: [] },
17438
+ { console_session: [] },
17439
+ { api_key: [] },
17440
+ ],
17441
+ summary: '/thermostats/set_hvac_mode',
17442
+ tags: ['/thermostats'],
17443
+ 'x-fern-sdk-group-name': ['thermostats'],
17444
+ 'x-fern-sdk-method-name': 'set_hvac_mode',
17445
+ 'x-fern-sdk-return-value': 'action_attempt',
17446
+ 'x-response-key': 'action_attempt',
17447
+ 'x-title': 'Set the HVAC Mode',
17448
+ },
17449
+ },
17302
17450
  '/thermostats/set_temperature_threshold': {
17303
17451
  patch: {
17304
17452
  description: 'Sets a [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range.',