@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.
@@ -13476,14 +13476,19 @@ export type Routes = {
13476
13476
  | undefined
13477
13477
  })
13478
13478
  /** Location information for the device. */
13479
- location: {
13480
- /** Name of the device location.
13481
- */
13482
- location_name?: string | undefined
13483
- /** Time zone of the device location.
13484
- */
13485
- timezone?: string | undefined
13486
- } | null
13479
+ location?:
13480
+ | {
13481
+ /** Name of the device location.
13482
+ */
13483
+ location_name?: string | undefined
13484
+ /** Time zone of the device location.
13485
+ */
13486
+ time_zone?: string | undefined
13487
+ /** Time zone of the device location.
13488
+ * @deprecated Use `time_zone` instead.*/
13489
+ timezone?: string | undefined
13490
+ }
13491
+ | undefined
13487
13492
  /** Unique identifier for the account associated with the device. */
13488
13493
  connected_account_id: string
13489
13494
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -18567,14 +18572,19 @@ export type Routes = {
18567
18572
  | undefined
18568
18573
  })
18569
18574
  /** Location information for the device. */
18570
- location: {
18571
- /** Name of the device location.
18572
- */
18573
- location_name?: string | undefined
18574
- /** Time zone of the device location.
18575
- */
18576
- timezone?: string | undefined
18577
- } | null
18575
+ location?:
18576
+ | {
18577
+ /** Name of the device location.
18578
+ */
18579
+ location_name?: string | undefined
18580
+ /** Time zone of the device location.
18581
+ */
18582
+ time_zone?: string | undefined
18583
+ /** Time zone of the device location.
18584
+ * @deprecated Use `time_zone` instead.*/
18585
+ timezone?: string | undefined
18586
+ }
18587
+ | undefined
18578
18588
  /** Unique identifier for the account associated with the device. */
18579
18589
  connected_account_id: string
18580
18590
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -37766,14 +37776,19 @@ export type Routes = {
37766
37776
  | undefined
37767
37777
  })
37768
37778
  /** Location information for the device. */
37769
- location: {
37770
- /** Name of the device location.
37771
- */
37772
- location_name?: string | undefined
37773
- /** Time zone of the device location.
37774
- */
37775
- timezone?: string | undefined
37776
- } | null
37779
+ location?:
37780
+ | {
37781
+ /** Name of the device location.
37782
+ */
37783
+ location_name?: string | undefined
37784
+ /** Time zone of the device location.
37785
+ */
37786
+ time_zone?: string | undefined
37787
+ /** Time zone of the device location.
37788
+ * @deprecated Use `time_zone` instead.*/
37789
+ timezone?: string | undefined
37790
+ }
37791
+ | undefined
37777
37792
  /** Unique identifier for the account associated with the device. */
37778
37793
  connected_account_id: string
37779
37794
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -39640,14 +39655,19 @@ export type Routes = {
39640
39655
  | undefined
39641
39656
  })
39642
39657
  /** Location information for the device. */
39643
- location: {
39644
- /** Name of the device location.
39645
- */
39646
- location_name?: string | undefined
39647
- /** Time zone of the device location.
39648
- */
39649
- timezone?: string | undefined
39650
- } | null
39658
+ location?:
39659
+ | {
39660
+ /** Name of the device location.
39661
+ */
39662
+ location_name?: string | undefined
39663
+ /** Time zone of the device location.
39664
+ */
39665
+ time_zone?: string | undefined
39666
+ /** Time zone of the device location.
39667
+ * @deprecated Use `time_zone` instead.*/
39668
+ timezone?: string | undefined
39669
+ }
39670
+ | undefined
39651
39671
  /** Unique identifier for the account associated with the device. */
39652
39672
  connected_account_id: string
39653
39673
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -40771,14 +40791,19 @@ export type Routes = {
40771
40791
  /** Unique identifier for the account associated with the device. */
40772
40792
  connected_account_id: string
40773
40793
  /** Location information for the device. */
40774
- location: {
40775
- /** Name of the device location.
40776
- */
40777
- location_name?: string | undefined
40778
- /** Time zone of the device location.
40779
- */
40780
- timezone?: string | undefined
40781
- } | null
40794
+ location?:
40795
+ | {
40796
+ /** Name of the device location.
40797
+ */
40798
+ location_name?: string | undefined
40799
+ /** Time zone of the device location.
40800
+ */
40801
+ time_zone?: string | undefined
40802
+ /** Time zone of the device location.
40803
+ * @deprecated Use `time_zone` instead.*/
40804
+ timezone?: string | undefined
40805
+ }
40806
+ | undefined
40782
40807
  /**
40783
40808
  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).
40784
40809
  */
@@ -41529,14 +41554,19 @@ export type Routes = {
41529
41554
  /** Unique identifier for the account associated with the device. */
41530
41555
  connected_account_id: string
41531
41556
  /** Location information for the device. */
41532
- location: {
41533
- /** Name of the device location.
41534
- */
41535
- location_name?: string | undefined
41536
- /** Time zone of the device location.
41537
- */
41538
- timezone?: string | undefined
41539
- } | null
41557
+ location?:
41558
+ | {
41559
+ /** Name of the device location.
41560
+ */
41561
+ location_name?: string | undefined
41562
+ /** Time zone of the device location.
41563
+ */
41564
+ time_zone?: string | undefined
41565
+ /** Time zone of the device location.
41566
+ * @deprecated Use `time_zone` instead.*/
41567
+ timezone?: string | undefined
41568
+ }
41569
+ | undefined
41540
41570
  /**
41541
41571
  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).
41542
41572
  */
@@ -51492,14 +51522,19 @@ export type Routes = {
51492
51522
  | undefined
51493
51523
  })
51494
51524
  /** Location information for the device. */
51495
- location: {
51496
- /** Name of the device location.
51497
- */
51498
- location_name?: string | undefined
51499
- /** Time zone of the device location.
51500
- */
51501
- timezone?: string | undefined
51502
- } | null
51525
+ location?:
51526
+ | {
51527
+ /** Name of the device location.
51528
+ */
51529
+ location_name?: string | undefined
51530
+ /** Time zone of the device location.
51531
+ */
51532
+ time_zone?: string | undefined
51533
+ /** Time zone of the device location.
51534
+ * @deprecated Use `time_zone` instead.*/
51535
+ timezone?: string | undefined
51536
+ }
51537
+ | undefined
51503
51538
  /** Unique identifier for the account associated with the device. */
51504
51539
  connected_account_id: string
51505
51540
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -53135,14 +53170,19 @@ export type Routes = {
53135
53170
  | undefined
53136
53171
  })
53137
53172
  /** Location information for the device. */
53138
- location: {
53139
- /** Name of the device location.
53140
- */
53141
- location_name?: string | undefined
53142
- /** Time zone of the device location.
53143
- */
53144
- timezone?: string | undefined
53145
- } | null
53173
+ location?:
53174
+ | {
53175
+ /** Name of the device location.
53176
+ */
53177
+ location_name?: string | undefined
53178
+ /** Time zone of the device location.
53179
+ */
53180
+ time_zone?: string | undefined
53181
+ /** Time zone of the device location.
53182
+ * @deprecated Use `time_zone` instead.*/
53183
+ timezone?: string | undefined
53184
+ }
53185
+ | undefined
53146
53186
  /** Unique identifier for the account associated with the device. */
53147
53187
  connected_account_id: string
53148
53188
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -54968,14 +55008,19 @@ export type Routes = {
54968
55008
  | undefined
54969
55009
  })
54970
55010
  /** Location information for the device. */
54971
- location: {
54972
- /** Name of the device location.
54973
- */
54974
- location_name?: string | undefined
54975
- /** Time zone of the device location.
54976
- */
54977
- timezone?: string | undefined
54978
- } | null
55011
+ location?:
55012
+ | {
55013
+ /** Name of the device location.
55014
+ */
55015
+ location_name?: string | undefined
55016
+ /** Time zone of the device location.
55017
+ */
55018
+ time_zone?: string | undefined
55019
+ /** Time zone of the device location.
55020
+ * @deprecated Use `time_zone` instead.*/
55021
+ timezone?: string | undefined
55022
+ }
55023
+ | undefined
54979
55024
  /** Unique identifier for the account associated with the device. */
54980
55025
  connected_account_id: string
54981
55026
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -56610,14 +56655,19 @@ export type Routes = {
56610
56655
  | undefined
56611
56656
  })
56612
56657
  /** Location information for the device. */
56613
- location: {
56614
- /** Name of the device location.
56615
- */
56616
- location_name?: string | undefined
56617
- /** Time zone of the device location.
56618
- */
56619
- timezone?: string | undefined
56620
- } | null
56658
+ location?:
56659
+ | {
56660
+ /** Name of the device location.
56661
+ */
56662
+ location_name?: string | undefined
56663
+ /** Time zone of the device location.
56664
+ */
56665
+ time_zone?: string | undefined
56666
+ /** Time zone of the device location.
56667
+ * @deprecated Use `time_zone` instead.*/
56668
+ timezone?: string | undefined
56669
+ }
56670
+ | undefined
56621
56671
  /** Unique identifier for the account associated with the device. */
56622
56672
  connected_account_id: string
56623
56673
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -64541,14 +64591,19 @@ export type Routes = {
64541
64591
  | undefined
64542
64592
  })
64543
64593
  /** Location information for the device. */
64544
- location: {
64545
- /** Name of the device location.
64546
- */
64547
- location_name?: string | undefined
64548
- /** Time zone of the device location.
64549
- */
64550
- timezone?: string | undefined
64551
- } | null
64594
+ location?:
64595
+ | {
64596
+ /** Name of the device location.
64597
+ */
64598
+ location_name?: string | undefined
64599
+ /** Time zone of the device location.
64600
+ */
64601
+ time_zone?: string | undefined
64602
+ /** Time zone of the device location.
64603
+ * @deprecated Use `time_zone` instead.*/
64604
+ timezone?: string | undefined
64605
+ }
64606
+ | undefined
64552
64607
  /** Unique identifier for the account associated with the device. */
64553
64608
  connected_account_id: string
64554
64609
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -66183,14 +66238,19 @@ export type Routes = {
66183
66238
  | undefined
66184
66239
  })
66185
66240
  /** Location information for the device. */
66186
- location: {
66187
- /** Name of the device location.
66188
- */
66189
- location_name?: string | undefined
66190
- /** Time zone of the device location.
66191
- */
66192
- timezone?: string | undefined
66193
- } | null
66241
+ location?:
66242
+ | {
66243
+ /** Name of the device location.
66244
+ */
66245
+ location_name?: string | undefined
66246
+ /** Time zone of the device location.
66247
+ */
66248
+ time_zone?: string | undefined
66249
+ /** Time zone of the device location.
66250
+ * @deprecated Use `time_zone` instead.*/
66251
+ timezone?: string | undefined
66252
+ }
66253
+ | undefined
66194
66254
  /** Unique identifier for the account associated with the device. */
66195
66255
  connected_account_id: string
66196
66256
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -74327,7 +74387,14 @@ export type Routes = {
74327
74387
  queryParams: {}
74328
74388
  jsonBody: {
74329
74389
  /** Type of connector to create */
74330
- connector_type: 'mock' | 'mews' | 'rms' | 'cloudbeds' | 'smoobu' | 'zonal'
74390
+ connector_type:
74391
+ | 'mock'
74392
+ | 'mews'
74393
+ | 'rms'
74394
+ | 'cloudbeds'
74395
+ | 'smoobu'
74396
+ | 'zonal'
74397
+ | 'ical'
74331
74398
  /** Key identifying the customer */
74332
74399
  customer_key?: string | undefined
74333
74400
  /** Instance-specific configuration for the connector */
@@ -81720,14 +81787,19 @@ export type Routes = {
81720
81787
  | undefined
81721
81788
  })
81722
81789
  /** Location information for the device. */
81723
- location: {
81724
- /** Name of the device location.
81725
- */
81726
- location_name?: string | undefined
81727
- /** Time zone of the device location.
81728
- */
81729
- timezone?: string | undefined
81730
- } | null
81790
+ location?:
81791
+ | {
81792
+ /** Name of the device location.
81793
+ */
81794
+ location_name?: string | undefined
81795
+ /** Time zone of the device location.
81796
+ */
81797
+ time_zone?: string | undefined
81798
+ /** Time zone of the device location.
81799
+ * @deprecated Use `time_zone` instead.*/
81800
+ timezone?: string | undefined
81801
+ }
81802
+ | undefined
81731
81803
  /** Unique identifier for the account associated with the device. */
81732
81804
  connected_account_id: string
81733
81805
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -88897,14 +88969,19 @@ export type Routes = {
88897
88969
  | undefined
88898
88970
  })
88899
88971
  /** Location information for the device. */
88900
- location: {
88901
- /** Name of the device location.
88902
- */
88903
- location_name?: string | undefined
88904
- /** Time zone of the device location.
88905
- */
88906
- timezone?: string | undefined
88907
- } | null
88972
+ location?:
88973
+ | {
88974
+ /** Name of the device location.
88975
+ */
88976
+ location_name?: string | undefined
88977
+ /** Time zone of the device location.
88978
+ */
88979
+ time_zone?: string | undefined
88980
+ /** Time zone of the device location.
88981
+ * @deprecated Use `time_zone` instead.*/
88982
+ timezone?: string | undefined
88983
+ }
88984
+ | undefined
88908
88985
  /** Unique identifier for the account associated with the device. */
88909
88986
  connected_account_id: string
88910
88987
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -93773,14 +93850,19 @@ export type Routes = {
93773
93850
  | undefined
93774
93851
  })
93775
93852
  /** Location information for the device. */
93776
- location: {
93777
- /** Name of the device location.
93778
- */
93779
- location_name?: string | undefined
93780
- /** Time zone of the device location.
93781
- */
93782
- timezone?: string | undefined
93783
- } | null
93853
+ location?:
93854
+ | {
93855
+ /** Name of the device location.
93856
+ */
93857
+ location_name?: string | undefined
93858
+ /** Time zone of the device location.
93859
+ */
93860
+ time_zone?: string | undefined
93861
+ /** Time zone of the device location.
93862
+ * @deprecated Use `time_zone` instead.*/
93863
+ timezone?: string | undefined
93864
+ }
93865
+ | undefined
93784
93866
  /** Unique identifier for the account associated with the device. */
93785
93867
  connected_account_id: string
93786
93868
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -95415,14 +95497,19 @@ export type Routes = {
95415
95497
  | undefined
95416
95498
  })
95417
95499
  /** Location information for the device. */
95418
- location: {
95419
- /** Name of the device location.
95420
- */
95421
- location_name?: string | undefined
95422
- /** Time zone of the device location.
95423
- */
95424
- timezone?: string | undefined
95425
- } | null
95500
+ location?:
95501
+ | {
95502
+ /** Name of the device location.
95503
+ */
95504
+ location_name?: string | undefined
95505
+ /** Time zone of the device location.
95506
+ */
95507
+ time_zone?: string | undefined
95508
+ /** Time zone of the device location.
95509
+ * @deprecated Use `time_zone` instead.*/
95510
+ timezone?: string | undefined
95511
+ }
95512
+ | undefined
95426
95513
  /** Unique identifier for the account associated with the device. */
95427
95514
  connected_account_id: string
95428
95515
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -104223,14 +104310,19 @@ export type Routes = {
104223
104310
  | undefined
104224
104311
  })
104225
104312
  /** Location information for the device. */
104226
- location: {
104227
- /** Name of the device location.
104228
- */
104229
- location_name?: string | undefined
104230
- /** Time zone of the device location.
104231
- */
104232
- timezone?: string | undefined
104233
- } | null
104313
+ location?:
104314
+ | {
104315
+ /** Name of the device location.
104316
+ */
104317
+ location_name?: string | undefined
104318
+ /** Time zone of the device location.
104319
+ */
104320
+ time_zone?: string | undefined
104321
+ /** Time zone of the device location.
104322
+ * @deprecated Use `time_zone` instead.*/
104323
+ timezone?: string | undefined
104324
+ }
104325
+ | undefined
104234
104326
  /** Unique identifier for the account associated with the device. */
104235
104327
  connected_account_id: string
104236
104328
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -105867,14 +105959,19 @@ export type Routes = {
105867
105959
  | undefined
105868
105960
  })
105869
105961
  /** Location information for the device. */
105870
- location: {
105871
- /** Name of the device location.
105872
- */
105873
- location_name?: string | undefined
105874
- /** Time zone of the device location.
105875
- */
105876
- timezone?: string | undefined
105877
- } | null
105962
+ location?:
105963
+ | {
105964
+ /** Name of the device location.
105965
+ */
105966
+ location_name?: string | undefined
105967
+ /** Time zone of the device location.
105968
+ */
105969
+ time_zone?: string | undefined
105970
+ /** Time zone of the device location.
105971
+ * @deprecated Use `time_zone` instead.*/
105972
+ timezone?: string | undefined
105973
+ }
105974
+ | undefined
105878
105975
  /** Unique identifier for the account associated with the device. */
105879
105976
  connected_account_id: string
105880
105977
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -108624,14 +108721,19 @@ export type Routes = {
108624
108721
  | undefined
108625
108722
  })
108626
108723
  /** Location information for the device. */
108627
- location: {
108628
- /** Name of the device location.
108629
- */
108630
- location_name?: string | undefined
108631
- /** Time zone of the device location.
108632
- */
108633
- timezone?: string | undefined
108634
- } | null
108724
+ location?:
108725
+ | {
108726
+ /** Name of the device location.
108727
+ */
108728
+ location_name?: string | undefined
108729
+ /** Time zone of the device location.
108730
+ */
108731
+ time_zone?: string | undefined
108732
+ /** Time zone of the device location.
108733
+ * @deprecated Use `time_zone` instead.*/
108734
+ timezone?: string | undefined
108735
+ }
108736
+ | undefined
108635
108737
  /** Unique identifier for the account associated with the device. */
108636
108738
  connected_account_id: string
108637
108739
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -111970,14 +112072,19 @@ export type Routes = {
111970
112072
  /** Unique identifier for the account associated with the device. */
111971
112073
  connected_account_id: string
111972
112074
  /** Location information for the device. */
111973
- location: {
111974
- /** Name of the device location.
111975
- */
111976
- location_name?: string | undefined
111977
- /** Time zone of the device location.
111978
- */
111979
- timezone?: string | undefined
111980
- } | null
112075
+ location?:
112076
+ | {
112077
+ /** Name of the device location.
112078
+ */
112079
+ location_name?: string | undefined
112080
+ /** Time zone of the device location.
112081
+ */
112082
+ time_zone?: string | undefined
112083
+ /** Time zone of the device location.
112084
+ * @deprecated Use `time_zone` instead.*/
112085
+ timezone?: string | undefined
112086
+ }
112087
+ | undefined
111981
112088
  /**
111982
112089
  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).
111983
112090
  */