@seamapi/types 1.693.0 → 1.695.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.
@@ -7521,6 +7521,7 @@ declare const _default: {
7521
7521
  noise_threshold_id?: never;
7522
7522
  noise_threshold_name?: never;
7523
7523
  noiseaware_metadata?: never;
7524
+ access_code_is_managed?: never;
7524
7525
  method?: never;
7525
7526
  user_identity_id?: never;
7526
7527
  climate_preset_key?: never;
@@ -7649,6 +7650,7 @@ declare const _default: {
7649
7650
  noise_threshold_id?: never;
7650
7651
  noise_threshold_name?: never;
7651
7652
  noiseaware_metadata?: never;
7653
+ access_code_is_managed?: never;
7652
7654
  method?: never;
7653
7655
  user_identity_id?: never;
7654
7656
  climate_preset_key?: never;
@@ -7777,6 +7779,7 @@ declare const _default: {
7777
7779
  noise_threshold_id?: never;
7778
7780
  noise_threshold_name?: never;
7779
7781
  noiseaware_metadata?: never;
7782
+ access_code_is_managed?: never;
7780
7783
  method?: never;
7781
7784
  user_identity_id?: never;
7782
7785
  climate_preset_key?: never;
@@ -7903,6 +7906,7 @@ declare const _default: {
7903
7906
  noise_threshold_id?: never;
7904
7907
  noise_threshold_name?: never;
7905
7908
  noiseaware_metadata?: never;
7909
+ access_code_is_managed?: never;
7906
7910
  method?: never;
7907
7911
  user_identity_id?: never;
7908
7912
  climate_preset_key?: never;
@@ -8003,6 +8007,7 @@ declare const _default: {
8003
8007
  noise_threshold_id?: never;
8004
8008
  noise_threshold_name?: never;
8005
8009
  noiseaware_metadata?: never;
8010
+ access_code_is_managed?: never;
8006
8011
  method?: never;
8007
8012
  user_identity_id?: never;
8008
8013
  climate_preset_key?: never;
@@ -8107,6 +8112,7 @@ declare const _default: {
8107
8112
  noise_threshold_id?: never;
8108
8113
  noise_threshold_name?: never;
8109
8114
  noiseaware_metadata?: never;
8115
+ access_code_is_managed?: never;
8110
8116
  method?: never;
8111
8117
  user_identity_id?: never;
8112
8118
  climate_preset_key?: never;
@@ -8216,6 +8222,7 @@ declare const _default: {
8216
8222
  noise_threshold_id?: never;
8217
8223
  noise_threshold_name?: never;
8218
8224
  noiseaware_metadata?: never;
8225
+ access_code_is_managed?: never;
8219
8226
  method?: never;
8220
8227
  user_identity_id?: never;
8221
8228
  climate_preset_key?: never;
@@ -8336,6 +8343,7 @@ declare const _default: {
8336
8343
  noise_threshold_id?: never;
8337
8344
  noise_threshold_name?: never;
8338
8345
  noiseaware_metadata?: never;
8346
+ access_code_is_managed?: never;
8339
8347
  method?: never;
8340
8348
  user_identity_id?: never;
8341
8349
  climate_preset_key?: never;
@@ -8449,6 +8457,7 @@ declare const _default: {
8449
8457
  noise_threshold_id?: never;
8450
8458
  noise_threshold_name?: never;
8451
8459
  noiseaware_metadata?: never;
8460
+ access_code_is_managed?: never;
8452
8461
  method?: never;
8453
8462
  user_identity_id?: never;
8454
8463
  climate_preset_key?: never;
@@ -8553,6 +8562,7 @@ declare const _default: {
8553
8562
  noise_threshold_id?: never;
8554
8563
  noise_threshold_name?: never;
8555
8564
  noiseaware_metadata?: never;
8565
+ access_code_is_managed?: never;
8556
8566
  method?: never;
8557
8567
  user_identity_id?: never;
8558
8568
  climate_preset_key?: never;
@@ -8661,6 +8671,7 @@ declare const _default: {
8661
8671
  noise_threshold_id?: never;
8662
8672
  noise_threshold_name?: never;
8663
8673
  noiseaware_metadata?: never;
8674
+ access_code_is_managed?: never;
8664
8675
  method?: never;
8665
8676
  user_identity_id?: never;
8666
8677
  climate_preset_key?: never;
@@ -8769,6 +8780,7 @@ declare const _default: {
8769
8780
  noise_threshold_id?: never;
8770
8781
  noise_threshold_name?: never;
8771
8782
  noiseaware_metadata?: never;
8783
+ access_code_is_managed?: never;
8772
8784
  method?: never;
8773
8785
  user_identity_id?: never;
8774
8786
  climate_preset_key?: never;
@@ -8877,6 +8889,7 @@ declare const _default: {
8877
8889
  noise_threshold_id?: never;
8878
8890
  noise_threshold_name?: never;
8879
8891
  noiseaware_metadata?: never;
8892
+ access_code_is_managed?: never;
8880
8893
  method?: never;
8881
8894
  user_identity_id?: never;
8882
8895
  climate_preset_key?: never;
@@ -8985,6 +8998,7 @@ declare const _default: {
8985
8998
  noise_threshold_id?: never;
8986
8999
  noise_threshold_name?: never;
8987
9000
  noiseaware_metadata?: never;
9001
+ access_code_is_managed?: never;
8988
9002
  method?: never;
8989
9003
  user_identity_id?: never;
8990
9004
  climate_preset_key?: never;
@@ -9093,6 +9107,7 @@ declare const _default: {
9093
9107
  noise_threshold_id?: never;
9094
9108
  noise_threshold_name?: never;
9095
9109
  noiseaware_metadata?: never;
9110
+ access_code_is_managed?: never;
9096
9111
  method?: never;
9097
9112
  user_identity_id?: never;
9098
9113
  climate_preset_key?: never;
@@ -9193,6 +9208,7 @@ declare const _default: {
9193
9208
  noise_threshold_id?: never;
9194
9209
  noise_threshold_name?: never;
9195
9210
  noiseaware_metadata?: never;
9211
+ access_code_is_managed?: never;
9196
9212
  method?: never;
9197
9213
  user_identity_id?: never;
9198
9214
  climate_preset_key?: never;
@@ -9308,6 +9324,7 @@ declare const _default: {
9308
9324
  noise_threshold_id?: never;
9309
9325
  noise_threshold_name?: never;
9310
9326
  noiseaware_metadata?: never;
9327
+ access_code_is_managed?: never;
9311
9328
  method?: never;
9312
9329
  user_identity_id?: never;
9313
9330
  climate_preset_key?: never;
@@ -9420,6 +9437,7 @@ declare const _default: {
9420
9437
  noise_threshold_id?: never;
9421
9438
  noise_threshold_name?: never;
9422
9439
  noiseaware_metadata?: never;
9440
+ access_code_is_managed?: never;
9423
9441
  method?: never;
9424
9442
  user_identity_id?: never;
9425
9443
  climate_preset_key?: never;
@@ -9533,6 +9551,7 @@ declare const _default: {
9533
9551
  noise_threshold_id?: never;
9534
9552
  noise_threshold_name?: never;
9535
9553
  noiseaware_metadata?: never;
9554
+ access_code_is_managed?: never;
9536
9555
  method?: never;
9537
9556
  user_identity_id?: never;
9538
9557
  climate_preset_key?: never;
@@ -9640,6 +9659,7 @@ declare const _default: {
9640
9659
  noise_threshold_id?: never;
9641
9660
  noise_threshold_name?: never;
9642
9661
  noiseaware_metadata?: never;
9662
+ access_code_is_managed?: never;
9643
9663
  method?: never;
9644
9664
  user_identity_id?: never;
9645
9665
  climate_preset_key?: never;
@@ -9754,6 +9774,7 @@ declare const _default: {
9754
9774
  noise_threshold_id?: never;
9755
9775
  noise_threshold_name?: never;
9756
9776
  noiseaware_metadata?: never;
9777
+ access_code_is_managed?: never;
9757
9778
  method?: never;
9758
9779
  user_identity_id?: never;
9759
9780
  climate_preset_key?: never;
@@ -9860,6 +9881,7 @@ declare const _default: {
9860
9881
  noise_threshold_id?: never;
9861
9882
  noise_threshold_name?: never;
9862
9883
  noiseaware_metadata?: never;
9884
+ access_code_is_managed?: never;
9863
9885
  method?: never;
9864
9886
  user_identity_id?: never;
9865
9887
  climate_preset_key?: never;
@@ -9960,6 +9982,7 @@ declare const _default: {
9960
9982
  noise_threshold_id?: never;
9961
9983
  noise_threshold_name?: never;
9962
9984
  noiseaware_metadata?: never;
9985
+ access_code_is_managed?: never;
9963
9986
  method?: never;
9964
9987
  user_identity_id?: never;
9965
9988
  climate_preset_key?: never;
@@ -10080,6 +10103,7 @@ declare const _default: {
10080
10103
  noise_threshold_id?: never;
10081
10104
  noise_threshold_name?: never;
10082
10105
  noiseaware_metadata?: never;
10106
+ access_code_is_managed?: never;
10083
10107
  method?: never;
10084
10108
  user_identity_id?: never;
10085
10109
  climate_preset_key?: never;
@@ -10204,6 +10228,7 @@ declare const _default: {
10204
10228
  noise_threshold_id?: never;
10205
10229
  noise_threshold_name?: never;
10206
10230
  noiseaware_metadata?: never;
10231
+ access_code_is_managed?: never;
10207
10232
  method?: never;
10208
10233
  user_identity_id?: never;
10209
10234
  climate_preset_key?: never;
@@ -10330,6 +10355,7 @@ declare const _default: {
10330
10355
  noise_threshold_id?: never;
10331
10356
  noise_threshold_name?: never;
10332
10357
  noiseaware_metadata?: never;
10358
+ access_code_is_managed?: never;
10333
10359
  method?: never;
10334
10360
  user_identity_id?: never;
10335
10361
  climate_preset_key?: never;
@@ -10460,6 +10486,7 @@ declare const _default: {
10460
10486
  noise_threshold_id?: never;
10461
10487
  noise_threshold_name?: never;
10462
10488
  noiseaware_metadata?: never;
10489
+ access_code_is_managed?: never;
10463
10490
  method?: never;
10464
10491
  user_identity_id?: never;
10465
10492
  climate_preset_key?: never;
@@ -10603,6 +10630,7 @@ declare const _default: {
10603
10630
  error_code?: never;
10604
10631
  battery_level?: never;
10605
10632
  battery_status?: never;
10633
+ access_code_is_managed?: never;
10606
10634
  method?: never;
10607
10635
  user_identity_id?: never;
10608
10636
  climate_preset_key?: never;
@@ -10642,6 +10670,10 @@ declare const _default: {
10642
10670
  format: string;
10643
10671
  type: string;
10644
10672
  };
10673
+ access_code_is_managed: {
10674
+ description: string;
10675
+ type: string;
10676
+ };
10645
10677
  action_attempt_id: {
10646
10678
  description: string;
10647
10679
  format: string;
@@ -10774,6 +10806,10 @@ declare const _default: {
10774
10806
  format: string;
10775
10807
  type: string;
10776
10808
  };
10809
+ access_code_is_managed: {
10810
+ description: string;
10811
+ type: string;
10812
+ };
10777
10813
  acs_entrance_id: {
10778
10814
  description: string;
10779
10815
  format: string;
@@ -11017,6 +11053,7 @@ declare const _default: {
11017
11053
  noise_threshold_id?: never;
11018
11054
  noise_threshold_name?: never;
11019
11055
  noiseaware_metadata?: never;
11056
+ access_code_is_managed?: never;
11020
11057
  method?: never;
11021
11058
  user_identity_id?: never;
11022
11059
  cooling_set_point_celsius?: never;
@@ -11169,6 +11206,7 @@ declare const _default: {
11169
11206
  noise_threshold_id?: never;
11170
11207
  noise_threshold_name?: never;
11171
11208
  noiseaware_metadata?: never;
11209
+ access_code_is_managed?: never;
11172
11210
  user_identity_id?: never;
11173
11211
  climate_preset_key?: never;
11174
11212
  is_fallback_climate_preset?: never;
@@ -11316,6 +11354,7 @@ declare const _default: {
11316
11354
  noise_threshold_id?: never;
11317
11355
  noise_threshold_name?: never;
11318
11356
  noiseaware_metadata?: never;
11357
+ access_code_is_managed?: never;
11319
11358
  method?: never;
11320
11359
  user_identity_id?: never;
11321
11360
  climate_preset_key?: never;
@@ -11450,6 +11489,7 @@ declare const _default: {
11450
11489
  noise_threshold_id?: never;
11451
11490
  noise_threshold_name?: never;
11452
11491
  noiseaware_metadata?: never;
11492
+ access_code_is_managed?: never;
11453
11493
  method?: never;
11454
11494
  user_identity_id?: never;
11455
11495
  climate_preset_key?: never;
@@ -11576,6 +11616,7 @@ declare const _default: {
11576
11616
  noise_threshold_id?: never;
11577
11617
  noise_threshold_name?: never;
11578
11618
  noiseaware_metadata?: never;
11619
+ access_code_is_managed?: never;
11579
11620
  method?: never;
11580
11621
  user_identity_id?: never;
11581
11622
  climate_preset_key?: never;
@@ -11698,6 +11739,7 @@ declare const _default: {
11698
11739
  noise_threshold_id?: never;
11699
11740
  noise_threshold_name?: never;
11700
11741
  noiseaware_metadata?: never;
11742
+ access_code_is_managed?: never;
11701
11743
  method?: never;
11702
11744
  user_identity_id?: never;
11703
11745
  climate_preset_key?: never;
@@ -11798,6 +11840,7 @@ declare const _default: {
11798
11840
  noise_threshold_id?: never;
11799
11841
  noise_threshold_name?: never;
11800
11842
  noiseaware_metadata?: never;
11843
+ access_code_is_managed?: never;
11801
11844
  method?: never;
11802
11845
  user_identity_id?: never;
11803
11846
  climate_preset_key?: never;
@@ -11905,6 +11948,7 @@ declare const _default: {
11905
11948
  noise_threshold_id?: never;
11906
11949
  noise_threshold_name?: never;
11907
11950
  noiseaware_metadata?: never;
11951
+ access_code_is_managed?: never;
11908
11952
  method?: never;
11909
11953
  user_identity_id?: never;
11910
11954
  climate_preset_key?: never;
@@ -12026,6 +12070,7 @@ declare const _default: {
12026
12070
  noise_threshold_id?: never;
12027
12071
  noise_threshold_name?: never;
12028
12072
  noiseaware_metadata?: never;
12073
+ access_code_is_managed?: never;
12029
12074
  method?: never;
12030
12075
  user_identity_id?: never;
12031
12076
  climate_preset_key?: never;
@@ -45817,6 +45862,76 @@ declare const _default: {
45817
45862
  'x-undocumented': string;
45818
45863
  };
45819
45864
  };
45865
+ '/seam/customer/v1/customers/open_portal': {
45866
+ post: {
45867
+ description: string;
45868
+ operationId: string;
45869
+ requestBody: {
45870
+ content: {
45871
+ 'application/json': {
45872
+ schema: {
45873
+ properties: {
45874
+ customer_key: {
45875
+ description: string;
45876
+ type: string;
45877
+ };
45878
+ };
45879
+ required: string[];
45880
+ type: string;
45881
+ };
45882
+ };
45883
+ };
45884
+ };
45885
+ responses: {
45886
+ 200: {
45887
+ content: {
45888
+ 'application/json': {
45889
+ schema: {
45890
+ properties: {
45891
+ magic_link: {
45892
+ $ref: string;
45893
+ };
45894
+ ok: {
45895
+ type: string;
45896
+ };
45897
+ };
45898
+ required: string[];
45899
+ type: string;
45900
+ };
45901
+ };
45902
+ };
45903
+ description: string;
45904
+ };
45905
+ 400: {
45906
+ description: string;
45907
+ };
45908
+ 401: {
45909
+ description: string;
45910
+ };
45911
+ };
45912
+ security: ({
45913
+ pat_with_workspace: never[];
45914
+ console_session_with_workspace?: never;
45915
+ api_key?: never;
45916
+ } | {
45917
+ console_session_with_workspace: never[];
45918
+ pat_with_workspace?: never;
45919
+ api_key?: never;
45920
+ } | {
45921
+ api_key: never[];
45922
+ pat_with_workspace?: never;
45923
+ console_session_with_workspace?: never;
45924
+ })[];
45925
+ summary: string;
45926
+ tags: never[];
45927
+ 'x-fern-sdk-group-name': string[];
45928
+ 'x-fern-sdk-method-name': string;
45929
+ 'x-fern-sdk-return-value': string;
45930
+ 'x-response-key': string;
45931
+ 'x-title': string;
45932
+ 'x-undocumented': string;
45933
+ };
45934
+ };
45820
45935
  '/seam/customer/v1/events/list': {
45821
45936
  get: {
45822
45937
  description: string;
@@ -16923,6 +16923,10 @@ export default {
16923
16923
  format: 'uuid',
16924
16924
  type: 'string',
16925
16925
  },
16926
+ access_code_is_managed: {
16927
+ description: 'Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set.',
16928
+ type: 'boolean',
16929
+ },
16926
16930
  action_attempt_id: {
16927
16931
  description: 'ID of the action attempt associated with the lock action.',
16928
16932
  format: 'uuid',
@@ -17000,6 +17004,10 @@ export default {
17000
17004
  format: 'uuid',
17001
17005
  type: 'string',
17002
17006
  },
17007
+ access_code_is_managed: {
17008
+ description: 'Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set.',
17009
+ type: 'boolean',
17010
+ },
17003
17011
  acs_entrance_id: {
17004
17012
  description: '\n undocumented: Unreleased.\n ---\n ID of the ACS entrance associated with the unlock event.\n ',
17005
17013
  format: 'uuid',
@@ -50632,6 +50640,60 @@ export default {
50632
50640
  'x-undocumented': 'Internal endpoint for Console.',
50633
50641
  },
50634
50642
  },
50643
+ '/seam/customer/v1/customers/open_portal': {
50644
+ post: {
50645
+ description: 'Opens an existing customer portal or creates a new one if the previous portal has expired.\nReturns an error if no portal was ever created for this customer.',
50646
+ operationId: 'seamCustomerV1CustomersOpenPortalPost',
50647
+ requestBody: {
50648
+ content: {
50649
+ 'application/json': {
50650
+ schema: {
50651
+ properties: {
50652
+ customer_key: {
50653
+ description: 'The customer key to open a portal for.',
50654
+ type: 'string',
50655
+ },
50656
+ },
50657
+ required: ['customer_key'],
50658
+ type: 'object',
50659
+ },
50660
+ },
50661
+ },
50662
+ },
50663
+ responses: {
50664
+ 200: {
50665
+ content: {
50666
+ 'application/json': {
50667
+ schema: {
50668
+ properties: {
50669
+ magic_link: { $ref: '#/components/schemas/magic_link' },
50670
+ ok: { type: 'boolean' },
50671
+ },
50672
+ required: ['magic_link', 'ok'],
50673
+ type: 'object',
50674
+ },
50675
+ },
50676
+ },
50677
+ description: 'OK',
50678
+ },
50679
+ 400: { description: 'Bad Request' },
50680
+ 401: { description: 'Unauthorized' },
50681
+ },
50682
+ security: [
50683
+ { pat_with_workspace: [] },
50684
+ { console_session_with_workspace: [] },
50685
+ { api_key: [] },
50686
+ ],
50687
+ summary: '/seam/customer/v1/customers/open_portal',
50688
+ tags: [],
50689
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'customers'],
50690
+ 'x-fern-sdk-method-name': 'open_portal',
50691
+ 'x-fern-sdk-return-value': 'magic_link',
50692
+ 'x-response-key': 'magic_link',
50693
+ 'x-title': 'Open Customer Portal',
50694
+ 'x-undocumented': 'Internal endpoint for Console.',
50695
+ },
50696
+ },
50635
50697
  '/seam/customer/v1/events/list': {
50636
50698
  get: {
50637
50699
  description: 'Returns a list of events for devices in a specific space. This endpoint is designed for customer portals and only supports filtering by space_id.',