@seamapi/types 1.773.0 → 1.775.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.
@@ -11738,14 +11738,17 @@ export type Routes = {
11738
11738
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
11739
11739
  });
11740
11740
  /** Location information for the device. */
11741
- location: {
11741
+ location?: {
11742
11742
  /** Name of the device location.
11743
11743
  */
11744
11744
  location_name?: string | undefined;
11745
11745
  /** Time zone of the device location.
11746
11746
  */
11747
+ time_zone?: string | undefined;
11748
+ /** Time zone of the device location.
11749
+ * @deprecated Use `time_zone` instead.*/
11747
11750
  timezone?: string | undefined;
11748
- } | null;
11751
+ } | undefined;
11749
11752
  /** Unique identifier for the account associated with the device. */
11750
11753
  connected_account_id: string;
11751
11754
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -16042,14 +16045,17 @@ export type Routes = {
16042
16045
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
16043
16046
  });
16044
16047
  /** Location information for the device. */
16045
- location: {
16048
+ location?: {
16046
16049
  /** Name of the device location.
16047
16050
  */
16048
16051
  location_name?: string | undefined;
16049
16052
  /** Time zone of the device location.
16050
16053
  */
16054
+ time_zone?: string | undefined;
16055
+ /** Time zone of the device location.
16056
+ * @deprecated Use `time_zone` instead.*/
16051
16057
  timezone?: string | undefined;
16052
- } | null;
16058
+ } | undefined;
16053
16059
  /** Unique identifier for the account associated with the device. */
16054
16060
  connected_account_id: string;
16055
16061
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -32504,14 +32510,17 @@ export type Routes = {
32504
32510
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
32505
32511
  });
32506
32512
  /** Location information for the device. */
32507
- location: {
32513
+ location?: {
32508
32514
  /** Name of the device location.
32509
32515
  */
32510
32516
  location_name?: string | undefined;
32511
32517
  /** Time zone of the device location.
32512
32518
  */
32519
+ time_zone?: string | undefined;
32520
+ /** Time zone of the device location.
32521
+ * @deprecated Use `time_zone` instead.*/
32513
32522
  timezone?: string | undefined;
32514
- } | null;
32523
+ } | undefined;
32515
32524
  /** Unique identifier for the account associated with the device. */
32516
32525
  connected_account_id: string;
32517
32526
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -33874,14 +33883,17 @@ export type Routes = {
33874
33883
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
33875
33884
  });
33876
33885
  /** Location information for the device. */
33877
- location: {
33886
+ location?: {
33878
33887
  /** Name of the device location.
33879
33888
  */
33880
33889
  location_name?: string | undefined;
33881
33890
  /** Time zone of the device location.
33882
33891
  */
33892
+ time_zone?: string | undefined;
33893
+ /** Time zone of the device location.
33894
+ * @deprecated Use `time_zone` instead.*/
33883
33895
  timezone?: string | undefined;
33884
- } | null;
33896
+ } | undefined;
33885
33897
  /** Unique identifier for the account associated with the device. */
33886
33898
  connected_account_id: string;
33887
33899
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -34418,14 +34430,17 @@ export type Routes = {
34418
34430
  /** Unique identifier for the account associated with the device. */
34419
34431
  connected_account_id: string;
34420
34432
  /** Location information for the device. */
34421
- location: {
34433
+ location?: {
34422
34434
  /** Name of the device location.
34423
34435
  */
34424
34436
  location_name?: string | undefined;
34425
34437
  /** Time zone of the device location.
34426
34438
  */
34439
+ time_zone?: string | undefined;
34440
+ /** Time zone of the device location.
34441
+ * @deprecated Use `time_zone` instead.*/
34427
34442
  timezone?: string | undefined;
34428
- } | null;
34443
+ } | undefined;
34429
34444
  /**
34430
34445
  Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).
34431
34446
  */
@@ -34899,14 +34914,17 @@ export type Routes = {
34899
34914
  /** Unique identifier for the account associated with the device. */
34900
34915
  connected_account_id: string;
34901
34916
  /** Location information for the device. */
34902
- location: {
34917
+ location?: {
34903
34918
  /** Name of the device location.
34904
34919
  */
34905
34920
  location_name?: string | undefined;
34906
34921
  /** Time zone of the device location.
34907
34922
  */
34923
+ time_zone?: string | undefined;
34924
+ /** Time zone of the device location.
34925
+ * @deprecated Use `time_zone` instead.*/
34908
34926
  timezone?: string | undefined;
34909
- } | null;
34927
+ } | undefined;
34910
34928
  /**
34911
34929
  Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).
34912
34930
  */
@@ -43386,14 +43404,17 @@ export type Routes = {
43386
43404
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
43387
43405
  });
43388
43406
  /** Location information for the device. */
43389
- location: {
43407
+ location?: {
43390
43408
  /** Name of the device location.
43391
43409
  */
43392
43410
  location_name?: string | undefined;
43393
43411
  /** Time zone of the device location.
43394
43412
  */
43413
+ time_zone?: string | undefined;
43414
+ /** Time zone of the device location.
43415
+ * @deprecated Use `time_zone` instead.*/
43395
43416
  timezone?: string | undefined;
43396
- } | null;
43417
+ } | undefined;
43397
43418
  /** Unique identifier for the account associated with the device. */
43398
43419
  connected_account_id: string;
43399
43420
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -44706,14 +44727,17 @@ export type Routes = {
44706
44727
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
44707
44728
  });
44708
44729
  /** Location information for the device. */
44709
- location: {
44730
+ location?: {
44710
44731
  /** Name of the device location.
44711
44732
  */
44712
44733
  location_name?: string | undefined;
44713
44734
  /** Time zone of the device location.
44714
44735
  */
44736
+ time_zone?: string | undefined;
44737
+ /** Time zone of the device location.
44738
+ * @deprecated Use `time_zone` instead.*/
44715
44739
  timezone?: string | undefined;
44716
- } | null;
44740
+ } | undefined;
44717
44741
  /** Unique identifier for the account associated with the device. */
44718
44742
  connected_account_id: string;
44719
44743
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -46076,14 +46100,17 @@ export type Routes = {
46076
46100
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
46077
46101
  });
46078
46102
  /** Location information for the device. */
46079
- location: {
46103
+ location?: {
46080
46104
  /** Name of the device location.
46081
46105
  */
46082
46106
  location_name?: string | undefined;
46083
46107
  /** Time zone of the device location.
46084
46108
  */
46109
+ time_zone?: string | undefined;
46110
+ /** Time zone of the device location.
46111
+ * @deprecated Use `time_zone` instead.*/
46085
46112
  timezone?: string | undefined;
46086
- } | null;
46113
+ } | undefined;
46087
46114
  /** Unique identifier for the account associated with the device. */
46088
46115
  connected_account_id: string;
46089
46116
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -47395,14 +47422,17 @@ export type Routes = {
47395
47422
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
47396
47423
  });
47397
47424
  /** Location information for the device. */
47398
- location: {
47425
+ location?: {
47399
47426
  /** Name of the device location.
47400
47427
  */
47401
47428
  location_name?: string | undefined;
47402
47429
  /** Time zone of the device location.
47403
47430
  */
47431
+ time_zone?: string | undefined;
47432
+ /** Time zone of the device location.
47433
+ * @deprecated Use `time_zone` instead.*/
47404
47434
  timezone?: string | undefined;
47405
- } | null;
47435
+ } | undefined;
47406
47436
  /** Unique identifier for the account associated with the device. */
47407
47437
  connected_account_id: string;
47408
47438
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -54111,14 +54141,17 @@ export type Routes = {
54111
54141
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
54112
54142
  });
54113
54143
  /** Location information for the device. */
54114
- location: {
54144
+ location?: {
54115
54145
  /** Name of the device location.
54116
54146
  */
54117
54147
  location_name?: string | undefined;
54118
54148
  /** Time zone of the device location.
54119
54149
  */
54150
+ time_zone?: string | undefined;
54151
+ /** Time zone of the device location.
54152
+ * @deprecated Use `time_zone` instead.*/
54120
54153
  timezone?: string | undefined;
54121
- } | null;
54154
+ } | undefined;
54122
54155
  /** Unique identifier for the account associated with the device. */
54123
54156
  connected_account_id: string;
54124
54157
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -55430,14 +55463,17 @@ export type Routes = {
55430
55463
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
55431
55464
  });
55432
55465
  /** Location information for the device. */
55433
- location: {
55466
+ location?: {
55434
55467
  /** Name of the device location.
55435
55468
  */
55436
55469
  location_name?: string | undefined;
55437
55470
  /** Time zone of the device location.
55438
55471
  */
55472
+ time_zone?: string | undefined;
55473
+ /** Time zone of the device location.
55474
+ * @deprecated Use `time_zone` instead.*/
55439
55475
  timezone?: string | undefined;
55440
- } | null;
55476
+ } | undefined;
55441
55477
  /** Unique identifier for the account associated with the device. */
55442
55478
  connected_account_id: string;
55443
55479
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -62540,7 +62576,7 @@ export type Routes = {
62540
62576
  queryParams: {};
62541
62577
  jsonBody: {
62542
62578
  /** Type of connector to create */
62543
- connector_type: 'mock' | 'mews' | 'rms' | 'cloudbeds' | 'smoobu' | 'zonal';
62579
+ connector_type: 'mock' | 'mews' | 'rms' | 'cloudbeds' | 'smoobu' | 'zonal' | 'ical';
62544
62580
  /** Key identifying the customer */
62545
62581
  customer_key?: string | undefined;
62546
62582
  /** Instance-specific configuration for the connector */
@@ -68737,14 +68773,17 @@ export type Routes = {
68737
68773
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
68738
68774
  });
68739
68775
  /** Location information for the device. */
68740
- location: {
68776
+ location?: {
68741
68777
  /** Name of the device location.
68742
68778
  */
68743
68779
  location_name?: string | undefined;
68744
68780
  /** Time zone of the device location.
68745
68781
  */
68782
+ time_zone?: string | undefined;
68783
+ /** Time zone of the device location.
68784
+ * @deprecated Use `time_zone` instead.*/
68746
68785
  timezone?: string | undefined;
68747
- } | null;
68786
+ } | undefined;
68748
68787
  /** Unique identifier for the account associated with the device. */
68749
68788
  connected_account_id: string;
68750
68789
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -74830,14 +74869,17 @@ export type Routes = {
74830
74869
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
74831
74870
  });
74832
74871
  /** Location information for the device. */
74833
- location: {
74872
+ location?: {
74834
74873
  /** Name of the device location.
74835
74874
  */
74836
74875
  location_name?: string | undefined;
74837
74876
  /** Time zone of the device location.
74838
74877
  */
74878
+ time_zone?: string | undefined;
74879
+ /** Time zone of the device location.
74880
+ * @deprecated Use `time_zone` instead.*/
74839
74881
  timezone?: string | undefined;
74840
- } | null;
74882
+ } | undefined;
74841
74883
  /** Unique identifier for the account associated with the device. */
74842
74884
  connected_account_id: string;
74843
74885
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -78886,14 +78928,17 @@ export type Routes = {
78886
78928
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
78887
78929
  });
78888
78930
  /** Location information for the device. */
78889
- location: {
78931
+ location?: {
78890
78932
  /** Name of the device location.
78891
78933
  */
78892
78934
  location_name?: string | undefined;
78893
78935
  /** Time zone of the device location.
78894
78936
  */
78937
+ time_zone?: string | undefined;
78938
+ /** Time zone of the device location.
78939
+ * @deprecated Use `time_zone` instead.*/
78895
78940
  timezone?: string | undefined;
78896
- } | null;
78941
+ } | undefined;
78897
78942
  /** Unique identifier for the account associated with the device. */
78898
78943
  connected_account_id: string;
78899
78944
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -80205,14 +80250,17 @@ export type Routes = {
80205
80250
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
80206
80251
  });
80207
80252
  /** Location information for the device. */
80208
- location: {
80253
+ location?: {
80209
80254
  /** Name of the device location.
80210
80255
  */
80211
80256
  location_name?: string | undefined;
80212
80257
  /** Time zone of the device location.
80213
80258
  */
80259
+ time_zone?: string | undefined;
80260
+ /** Time zone of the device location.
80261
+ * @deprecated Use `time_zone` instead.*/
80214
80262
  timezone?: string | undefined;
80215
- } | null;
80263
+ } | undefined;
80216
80264
  /** Unique identifier for the account associated with the device. */
80217
80265
  connected_account_id: string;
80218
80266
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -87810,14 +87858,17 @@ export type Routes = {
87810
87858
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
87811
87859
  });
87812
87860
  /** Location information for the device. */
87813
- location: {
87861
+ location?: {
87814
87862
  /** Name of the device location.
87815
87863
  */
87816
87864
  location_name?: string | undefined;
87817
87865
  /** Time zone of the device location.
87818
87866
  */
87867
+ time_zone?: string | undefined;
87868
+ /** Time zone of the device location.
87869
+ * @deprecated Use `time_zone` instead.*/
87819
87870
  timezone?: string | undefined;
87820
- } | null;
87871
+ } | undefined;
87821
87872
  /** Unique identifier for the account associated with the device. */
87822
87873
  connected_account_id: string;
87823
87874
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -89131,14 +89182,17 @@ export type Routes = {
89131
89182
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
89132
89183
  });
89133
89184
  /** Location information for the device. */
89134
- location: {
89185
+ location?: {
89135
89186
  /** Name of the device location.
89136
89187
  */
89137
89188
  location_name?: string | undefined;
89138
89189
  /** Time zone of the device location.
89139
89190
  */
89191
+ time_zone?: string | undefined;
89192
+ /** Time zone of the device location.
89193
+ * @deprecated Use `time_zone` instead.*/
89140
89194
  timezone?: string | undefined;
89141
- } | null;
89195
+ } | undefined;
89142
89196
  /** Unique identifier for the account associated with the device. */
89143
89197
  connected_account_id: string;
89144
89198
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -91430,14 +91484,17 @@ export type Routes = {
91430
91484
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
91431
91485
  });
91432
91486
  /** Location information for the device. */
91433
- location: {
91487
+ location?: {
91434
91488
  /** Name of the device location.
91435
91489
  */
91436
91490
  location_name?: string | undefined;
91437
91491
  /** Time zone of the device location.
91438
91492
  */
91493
+ time_zone?: string | undefined;
91494
+ /** Time zone of the device location.
91495
+ * @deprecated Use `time_zone` instead.*/
91439
91496
  timezone?: string | undefined;
91440
- } | null;
91497
+ } | undefined;
91441
91498
  /** Unique identifier for the account associated with the device. */
91442
91499
  connected_account_id: string;
91443
91500
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -94204,14 +94261,17 @@ export type Routes = {
94204
94261
  /** Unique identifier for the account associated with the device. */
94205
94262
  connected_account_id: string;
94206
94263
  /** Location information for the device. */
94207
- location: {
94264
+ location?: {
94208
94265
  /** Name of the device location.
94209
94266
  */
94210
94267
  location_name?: string | undefined;
94211
94268
  /** Time zone of the device location.
94212
94269
  */
94270
+ time_zone?: string | undefined;
94271
+ /** Time zone of the device location.
94272
+ * @deprecated Use `time_zone` instead.*/
94213
94273
  timezone?: string | undefined;
94214
- } | null;
94274
+ } | undefined;
94215
94275
  /**
94216
94276
  Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).
94217
94277
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.773.0",
3
+ "version": "1.775.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -879,16 +879,21 @@ export const device = z
879
879
  Properties of the device.
880
880
  `),
881
881
  location: z
882
- // todo: optional instead of nullable
883
882
  .object({
884
883
  location_name: z.string().optional()
885
884
  .describe(`Name of the device location.
886
885
  `),
887
- timezone: z.string().optional()
886
+ time_zone: z.string().optional()
888
887
  .describe(`Time zone of the device location.
889
888
  `),
889
+ timezone: z.string().optional().describe(`
890
+ ---
891
+ deprecated: Use \`time_zone\` instead.
892
+ ---
893
+ Time zone of the device location.
894
+ `),
890
895
  })
891
- .nullable().describe(`
896
+ .optional().describe(`
892
897
  ---
893
898
  property_group_key: hardware
894
899
  ---
@@ -11739,16 +11739,21 @@ export default {
11739
11739
  },
11740
11740
  location: {
11741
11741
  description: 'Location information for the device.',
11742
- nullable: true,
11743
11742
  properties: {
11744
11743
  location_name: {
11745
11744
  description: 'Name of the device location.\n ',
11746
11745
  type: 'string',
11747
11746
  },
11748
- timezone: {
11747
+ time_zone: {
11749
11748
  description: 'Time zone of the device location.\n ',
11750
11749
  type: 'string',
11751
11750
  },
11751
+ timezone: {
11752
+ deprecated: true,
11753
+ description: 'Time zone of the device location.',
11754
+ type: 'string',
11755
+ 'x-deprecated': 'Use `time_zone` instead.',
11756
+ },
11752
11757
  },
11753
11758
  type: 'object',
11754
11759
  'x-property-group-key': 'hardware',
@@ -15042,7 +15047,6 @@ export default {
15042
15047
  'display_name',
15043
15048
  'capabilities_supported',
15044
15049
  'properties',
15045
- 'location',
15046
15050
  'connected_account_id',
15047
15051
  'workspace_id',
15048
15052
  'errors',
@@ -29885,16 +29889,21 @@ export default {
29885
29889
  is_managed: { enum: [false], type: 'boolean' },
29886
29890
  location: {
29887
29891
  description: 'Location information for the device.',
29888
- nullable: true,
29889
29892
  properties: {
29890
29893
  location_name: {
29891
29894
  description: 'Name of the device location.\n ',
29892
29895
  type: 'string',
29893
29896
  },
29894
- timezone: {
29897
+ time_zone: {
29895
29898
  description: 'Time zone of the device location.\n ',
29896
29899
  type: 'string',
29897
29900
  },
29901
+ timezone: {
29902
+ deprecated: true,
29903
+ description: 'Time zone of the device location.',
29904
+ type: 'string',
29905
+ 'x-deprecated': 'Use `time_zone` instead.',
29906
+ },
29898
29907
  },
29899
29908
  type: 'object',
29900
29909
  'x-property-group-key': 'hardware',
@@ -30695,7 +30704,6 @@ export default {
30695
30704
  'device_id',
30696
30705
  'device_type',
30697
30706
  'connected_account_id',
30698
- 'location',
30699
30707
  'capabilities_supported',
30700
30708
  'workspace_id',
30701
30709
  'errors',
@@ -63556,6 +63564,7 @@ export default {
63556
63564
  'cloudbeds',
63557
63565
  'smoobu',
63558
63566
  'zonal',
63567
+ 'ical',
63559
63568
  ],
63560
63569
  type: 'string',
63561
63570
  },