@seamapi/types 1.1081.0 → 1.1082.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.
@@ -1438,6 +1438,41 @@ export type Routes = {
1438
1438
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1439
1439
  message: string;
1440
1440
  };
1441
+ } | {
1442
+ /** ID of the action attempt. */
1443
+ action_attempt_id: string;
1444
+ status: 'pending';
1445
+ /** Result of the action attempt. Null for pending action attempts. */
1446
+ result: null;
1447
+ /** Errors associated with the action attempt. Null for pending action attempts. */
1448
+ error: null;
1449
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
1450
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
1451
+ } | {
1452
+ /** ID of the action attempt. */
1453
+ action_attempt_id: string;
1454
+ status: 'success';
1455
+ /** Errors associated with the action attempt. Null for successful action attempts. */
1456
+ error: null;
1457
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
1458
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
1459
+ /** Result of the action. */
1460
+ result: {};
1461
+ } | {
1462
+ /** ID of the action attempt. */
1463
+ action_attempt_id: string;
1464
+ status: 'error';
1465
+ /** Result of the action attempt. Null for failed action attempts. */
1466
+ result: null;
1467
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
1468
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
1469
+ /** Error associated with the action. */
1470
+ error: {
1471
+ /** Type of the error. */
1472
+ type: string;
1473
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1474
+ message: string;
1475
+ };
1441
1476
  } | {
1442
1477
  /** ID of the action attempt. */
1443
1478
  action_attempt_id: string;
@@ -4288,6 +4323,41 @@ export type Routes = {
4288
4323
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4289
4324
  message: string;
4290
4325
  };
4326
+ } | {
4327
+ /** ID of the action attempt. */
4328
+ action_attempt_id: string;
4329
+ status: 'pending';
4330
+ /** Result of the action attempt. Null for pending action attempts. */
4331
+ result: null;
4332
+ /** Errors associated with the action attempt. Null for pending action attempts. */
4333
+ error: null;
4334
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
4335
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
4336
+ } | {
4337
+ /** ID of the action attempt. */
4338
+ action_attempt_id: string;
4339
+ status: 'success';
4340
+ /** Errors associated with the action attempt. Null for successful action attempts. */
4341
+ error: null;
4342
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
4343
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
4344
+ /** Result of the action. */
4345
+ result: {};
4346
+ } | {
4347
+ /** ID of the action attempt. */
4348
+ action_attempt_id: string;
4349
+ status: 'error';
4350
+ /** Result of the action attempt. Null for failed action attempts. */
4351
+ result: null;
4352
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
4353
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
4354
+ /** Error associated with the action. */
4355
+ error: {
4356
+ /** Type of the error. */
4357
+ type: string;
4358
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4359
+ message: string;
4360
+ };
4291
4361
  } | {
4292
4362
  /** ID of the action attempt. */
4293
4363
  action_attempt_id: string;
@@ -8715,6 +8785,41 @@ export type Routes = {
8715
8785
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
8716
8786
  message: string;
8717
8787
  };
8788
+ } | {
8789
+ /** ID of the action attempt. */
8790
+ action_attempt_id: string;
8791
+ status: 'pending';
8792
+ /** Result of the action attempt. Null for pending action attempts. */
8793
+ result: null;
8794
+ /** Errors associated with the action attempt. Null for pending action attempts. */
8795
+ error: null;
8796
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
8797
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
8798
+ } | {
8799
+ /** ID of the action attempt. */
8800
+ action_attempt_id: string;
8801
+ status: 'success';
8802
+ /** Errors associated with the action attempt. Null for successful action attempts. */
8803
+ error: null;
8804
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
8805
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
8806
+ /** Result of the action. */
8807
+ result: {};
8808
+ } | {
8809
+ /** ID of the action attempt. */
8810
+ action_attempt_id: string;
8811
+ status: 'error';
8812
+ /** Result of the action attempt. Null for failed action attempts. */
8813
+ result: null;
8814
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
8815
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
8816
+ /** Error associated with the action. */
8817
+ error: {
8818
+ /** Type of the error. */
8819
+ type: string;
8820
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
8821
+ message: string;
8822
+ };
8718
8823
  } | {
8719
8824
  /** ID of the action attempt. */
8720
8825
  action_attempt_id: string;
@@ -11430,6 +11535,41 @@ export type Routes = {
11430
11535
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
11431
11536
  message: string;
11432
11537
  };
11538
+ } | {
11539
+ /** ID of the action attempt. */
11540
+ action_attempt_id: string;
11541
+ status: 'pending';
11542
+ /** Result of the action attempt. Null for pending action attempts. */
11543
+ result: null;
11544
+ /** Errors associated with the action attempt. Null for pending action attempts. */
11545
+ error: null;
11546
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
11547
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
11548
+ } | {
11549
+ /** ID of the action attempt. */
11550
+ action_attempt_id: string;
11551
+ status: 'success';
11552
+ /** Errors associated with the action attempt. Null for successful action attempts. */
11553
+ error: null;
11554
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
11555
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
11556
+ /** Result of the action. */
11557
+ result: {};
11558
+ } | {
11559
+ /** ID of the action attempt. */
11560
+ action_attempt_id: string;
11561
+ status: 'error';
11562
+ /** Result of the action attempt. Null for failed action attempts. */
11563
+ result: null;
11564
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
11565
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
11566
+ /** Error associated with the action. */
11567
+ error: {
11568
+ /** Type of the error. */
11569
+ type: string;
11570
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
11571
+ message: string;
11572
+ };
11433
11573
  } | {
11434
11574
  /** ID of the action attempt. */
11435
11575
  action_attempt_id: string;
@@ -13892,6 +14032,8 @@ export type Routes = {
13892
14032
  can_hvac_heat_cool?: boolean | undefined;
13893
14033
  /** Indicates whether the thermostat can be turned off. */
13894
14034
  can_turn_off_hvac?: boolean | undefined;
14035
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
14036
+ can_activate_weekly_program?: boolean | undefined;
13895
14037
  /** Indicates whether the device supports simulating removal in a sandbox. */
13896
14038
  can_simulate_removal?: boolean | undefined;
13897
14039
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -17089,6 +17231,41 @@ export type Routes = {
17089
17231
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
17090
17232
  message: string;
17091
17233
  };
17234
+ } | {
17235
+ /** ID of the action attempt. */
17236
+ action_attempt_id: string;
17237
+ status: 'pending';
17238
+ /** Result of the action attempt. Null for pending action attempts. */
17239
+ result: null;
17240
+ /** Errors associated with the action attempt. Null for pending action attempts. */
17241
+ error: null;
17242
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
17243
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
17244
+ } | {
17245
+ /** ID of the action attempt. */
17246
+ action_attempt_id: string;
17247
+ status: 'success';
17248
+ /** Errors associated with the action attempt. Null for successful action attempts. */
17249
+ error: null;
17250
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
17251
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
17252
+ /** Result of the action. */
17253
+ result: {};
17254
+ } | {
17255
+ /** ID of the action attempt. */
17256
+ action_attempt_id: string;
17257
+ status: 'error';
17258
+ /** Result of the action attempt. Null for failed action attempts. */
17259
+ result: null;
17260
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
17261
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
17262
+ /** Error associated with the action. */
17263
+ error: {
17264
+ /** Type of the error. */
17265
+ type: string;
17266
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
17267
+ message: string;
17268
+ };
17092
17269
  } | {
17093
17270
  /** ID of the action attempt. */
17094
17271
  action_attempt_id: string;
@@ -18920,6 +19097,41 @@ export type Routes = {
18920
19097
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
18921
19098
  message: string;
18922
19099
  };
19100
+ } | {
19101
+ /** ID of the action attempt. */
19102
+ action_attempt_id: string;
19103
+ status: 'pending';
19104
+ /** Result of the action attempt. Null for pending action attempts. */
19105
+ result: null;
19106
+ /** Errors associated with the action attempt. Null for pending action attempts. */
19107
+ error: null;
19108
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
19109
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
19110
+ } | {
19111
+ /** ID of the action attempt. */
19112
+ action_attempt_id: string;
19113
+ status: 'success';
19114
+ /** Errors associated with the action attempt. Null for successful action attempts. */
19115
+ error: null;
19116
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
19117
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
19118
+ /** Result of the action. */
19119
+ result: {};
19120
+ } | {
19121
+ /** ID of the action attempt. */
19122
+ action_attempt_id: string;
19123
+ status: 'error';
19124
+ /** Result of the action attempt. Null for failed action attempts. */
19125
+ result: null;
19126
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
19127
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
19128
+ /** Error associated with the action. */
19129
+ error: {
19130
+ /** Type of the error. */
19131
+ type: string;
19132
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
19133
+ message: string;
19134
+ };
18923
19135
  } | {
18924
19136
  /** ID of the action attempt. */
18925
19137
  action_attempt_id: string;
@@ -21052,6 +21264,8 @@ export type Routes = {
21052
21264
  can_hvac_heat_cool?: boolean | undefined;
21053
21265
  /** Indicates whether the thermostat can be turned off. */
21054
21266
  can_turn_off_hvac?: boolean | undefined;
21267
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
21268
+ can_activate_weekly_program?: boolean | undefined;
21055
21269
  /** Indicates whether the device supports simulating removal in a sandbox. */
21056
21270
  can_simulate_removal?: boolean | undefined;
21057
21271
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -23404,6 +23618,41 @@ export type Routes = {
23404
23618
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23405
23619
  message: string;
23406
23620
  };
23621
+ } | {
23622
+ /** ID of the action attempt. */
23623
+ action_attempt_id: string;
23624
+ status: 'pending';
23625
+ /** Result of the action attempt. Null for pending action attempts. */
23626
+ result: null;
23627
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23628
+ error: null;
23629
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
23630
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
23631
+ } | {
23632
+ /** ID of the action attempt. */
23633
+ action_attempt_id: string;
23634
+ status: 'success';
23635
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23636
+ error: null;
23637
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
23638
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
23639
+ /** Result of the action. */
23640
+ result: {};
23641
+ } | {
23642
+ /** ID of the action attempt. */
23643
+ action_attempt_id: string;
23644
+ status: 'error';
23645
+ /** Result of the action attempt. Null for failed action attempts. */
23646
+ result: null;
23647
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
23648
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
23649
+ /** Error associated with the action. */
23650
+ error: {
23651
+ /** Type of the error. */
23652
+ type: string;
23653
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23654
+ message: string;
23655
+ };
23407
23656
  } | {
23408
23657
  /** ID of the action attempt. */
23409
23658
  action_attempt_id: string;
@@ -28724,6 +28973,41 @@ export type Routes = {
28724
28973
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
28725
28974
  message: string;
28726
28975
  };
28976
+ } | {
28977
+ /** ID of the action attempt. */
28978
+ action_attempt_id: string;
28979
+ status: 'pending';
28980
+ /** Result of the action attempt. Null for pending action attempts. */
28981
+ result: null;
28982
+ /** Errors associated with the action attempt. Null for pending action attempts. */
28983
+ error: null;
28984
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
28985
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
28986
+ } | {
28987
+ /** ID of the action attempt. */
28988
+ action_attempt_id: string;
28989
+ status: 'success';
28990
+ /** Errors associated with the action attempt. Null for successful action attempts. */
28991
+ error: null;
28992
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
28993
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
28994
+ /** Result of the action. */
28995
+ result: {};
28996
+ } | {
28997
+ /** ID of the action attempt. */
28998
+ action_attempt_id: string;
28999
+ status: 'error';
29000
+ /** Result of the action attempt. Null for failed action attempts. */
29001
+ result: null;
29002
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
29003
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
29004
+ /** Error associated with the action. */
29005
+ error: {
29006
+ /** Type of the error. */
29007
+ type: string;
29008
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
29009
+ message: string;
29010
+ };
28727
29011
  } | {
28728
29012
  /** ID of the action attempt. */
28729
29013
  action_attempt_id: string;
@@ -30644,6 +30928,41 @@ export type Routes = {
30644
30928
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
30645
30929
  message: string;
30646
30930
  };
30931
+ } | {
30932
+ /** ID of the action attempt. */
30933
+ action_attempt_id: string;
30934
+ status: 'pending';
30935
+ /** Result of the action attempt. Null for pending action attempts. */
30936
+ result: null;
30937
+ /** Errors associated with the action attempt. Null for pending action attempts. */
30938
+ error: null;
30939
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
30940
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
30941
+ } | {
30942
+ /** ID of the action attempt. */
30943
+ action_attempt_id: string;
30944
+ status: 'success';
30945
+ /** Errors associated with the action attempt. Null for successful action attempts. */
30946
+ error: null;
30947
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
30948
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
30949
+ /** Result of the action. */
30950
+ result: {};
30951
+ } | {
30952
+ /** ID of the action attempt. */
30953
+ action_attempt_id: string;
30954
+ status: 'error';
30955
+ /** Result of the action attempt. Null for failed action attempts. */
30956
+ result: null;
30957
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
30958
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
30959
+ /** Error associated with the action. */
30960
+ error: {
30961
+ /** Type of the error. */
30962
+ type: string;
30963
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
30964
+ message: string;
30965
+ };
30647
30966
  } | {
30648
30967
  /** ID of the action attempt. */
30649
30968
  action_attempt_id: string;
@@ -32463,6 +32782,41 @@ export type Routes = {
32463
32782
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
32464
32783
  message: string;
32465
32784
  };
32785
+ } | {
32786
+ /** ID of the action attempt. */
32787
+ action_attempt_id: string;
32788
+ status: 'pending';
32789
+ /** Result of the action attempt. Null for pending action attempts. */
32790
+ result: null;
32791
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32792
+ error: null;
32793
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
32794
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
32795
+ } | {
32796
+ /** ID of the action attempt. */
32797
+ action_attempt_id: string;
32798
+ status: 'success';
32799
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32800
+ error: null;
32801
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
32802
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
32803
+ /** Result of the action. */
32804
+ result: {};
32805
+ } | {
32806
+ /** ID of the action attempt. */
32807
+ action_attempt_id: string;
32808
+ status: 'error';
32809
+ /** Result of the action attempt. Null for failed action attempts. */
32810
+ result: null;
32811
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
32812
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
32813
+ /** Error associated with the action. */
32814
+ error: {
32815
+ /** Type of the error. */
32816
+ type: string;
32817
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
32818
+ message: string;
32819
+ };
32466
32820
  } | {
32467
32821
  /** ID of the action attempt. */
32468
32822
  action_attempt_id: string;
@@ -35013,6 +35367,41 @@ export type Routes = {
35013
35367
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
35014
35368
  message: string;
35015
35369
  };
35370
+ } | {
35371
+ /** ID of the action attempt. */
35372
+ action_attempt_id: string;
35373
+ status: 'pending';
35374
+ /** Result of the action attempt. Null for pending action attempts. */
35375
+ result: null;
35376
+ /** Errors associated with the action attempt. Null for pending action attempts. */
35377
+ error: null;
35378
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
35379
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
35380
+ } | {
35381
+ /** ID of the action attempt. */
35382
+ action_attempt_id: string;
35383
+ status: 'success';
35384
+ /** Errors associated with the action attempt. Null for successful action attempts. */
35385
+ error: null;
35386
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
35387
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
35388
+ /** Result of the action. */
35389
+ result: {};
35390
+ } | {
35391
+ /** ID of the action attempt. */
35392
+ action_attempt_id: string;
35393
+ status: 'error';
35394
+ /** Result of the action attempt. Null for failed action attempts. */
35395
+ result: null;
35396
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
35397
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
35398
+ /** Error associated with the action. */
35399
+ error: {
35400
+ /** Type of the error. */
35401
+ type: string;
35402
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
35403
+ message: string;
35404
+ };
35016
35405
  } | {
35017
35406
  /** ID of the action attempt. */
35018
35407
  action_attempt_id: string;
@@ -39182,6 +39571,41 @@ export type Routes = {
39182
39571
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
39183
39572
  message: string;
39184
39573
  };
39574
+ } | {
39575
+ /** ID of the action attempt. */
39576
+ action_attempt_id: string;
39577
+ status: 'pending';
39578
+ /** Result of the action attempt. Null for pending action attempts. */
39579
+ result: null;
39580
+ /** Errors associated with the action attempt. Null for pending action attempts. */
39581
+ error: null;
39582
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
39583
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
39584
+ } | {
39585
+ /** ID of the action attempt. */
39586
+ action_attempt_id: string;
39587
+ status: 'success';
39588
+ /** Errors associated with the action attempt. Null for successful action attempts. */
39589
+ error: null;
39590
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
39591
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
39592
+ /** Result of the action. */
39593
+ result: {};
39594
+ } | {
39595
+ /** ID of the action attempt. */
39596
+ action_attempt_id: string;
39597
+ status: 'error';
39598
+ /** Result of the action attempt. Null for failed action attempts. */
39599
+ result: null;
39600
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
39601
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
39602
+ /** Error associated with the action. */
39603
+ error: {
39604
+ /** Type of the error. */
39605
+ type: string;
39606
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
39607
+ message: string;
39608
+ };
39185
39609
  } | {
39186
39610
  /** ID of the action attempt. */
39187
39611
  action_attempt_id: string;
@@ -40993,6 +41417,41 @@ export type Routes = {
40993
41417
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
40994
41418
  message: string;
40995
41419
  };
41420
+ } | {
41421
+ /** ID of the action attempt. */
41422
+ action_attempt_id: string;
41423
+ status: 'pending';
41424
+ /** Result of the action attempt. Null for pending action attempts. */
41425
+ result: null;
41426
+ /** Errors associated with the action attempt. Null for pending action attempts. */
41427
+ error: null;
41428
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
41429
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
41430
+ } | {
41431
+ /** ID of the action attempt. */
41432
+ action_attempt_id: string;
41433
+ status: 'success';
41434
+ /** Errors associated with the action attempt. Null for successful action attempts. */
41435
+ error: null;
41436
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
41437
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
41438
+ /** Result of the action. */
41439
+ result: {};
41440
+ } | {
41441
+ /** ID of the action attempt. */
41442
+ action_attempt_id: string;
41443
+ status: 'error';
41444
+ /** Result of the action attempt. Null for failed action attempts. */
41445
+ result: null;
41446
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
41447
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
41448
+ /** Error associated with the action. */
41449
+ error: {
41450
+ /** Type of the error. */
41451
+ type: string;
41452
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41453
+ message: string;
41454
+ };
40996
41455
  } | {
40997
41456
  /** ID of the action attempt. */
40998
41457
  action_attempt_id: string;
@@ -45166,6 +45625,8 @@ export type Routes = {
45166
45625
  can_hvac_heat_cool?: boolean | undefined;
45167
45626
  /** Indicates whether the thermostat can be turned off. */
45168
45627
  can_turn_off_hvac?: boolean | undefined;
45628
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
45629
+ can_activate_weekly_program?: boolean | undefined;
45169
45630
  /** Indicates whether the device supports simulating removal in a sandbox. */
45170
45631
  can_simulate_removal?: boolean | undefined;
45171
45632
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -45229,9 +45690,9 @@ export type Routes = {
45229
45690
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
45230
45691
  page_cursor?: (string | undefined) | null;
45231
45692
  /** */
45232
- include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
45693
+ include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_activate_weekly_program' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
45233
45694
  /** */
45234
- exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
45695
+ exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_activate_weekly_program' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
45235
45696
  /**
45236
45697
  * @deprecated Use `space_id`.*/
45237
45698
  unstable_location_id?: (string | null) | undefined;
@@ -46747,6 +47208,8 @@ export type Routes = {
46747
47208
  can_hvac_heat_cool?: boolean | undefined;
46748
47209
  /** Indicates whether the thermostat can be turned off. */
46749
47210
  can_turn_off_hvac?: boolean | undefined;
47211
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
47212
+ can_activate_weekly_program?: boolean | undefined;
46750
47213
  /** Indicates whether the device supports simulating removal in a sandbox. */
46751
47214
  can_simulate_removal?: boolean | undefined;
46752
47215
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -46820,6 +47283,8 @@ export type Routes = {
46820
47283
  can_hvac_heat_cool?: boolean | undefined;
46821
47284
  /** Indicates whether the thermostat can be turned off. */
46822
47285
  can_turn_off_hvac?: boolean | undefined;
47286
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
47287
+ can_activate_weekly_program?: boolean | undefined;
46823
47288
  /** Indicates whether the device supports simulating removal in a sandbox. */
46824
47289
  can_simulate_removal?: boolean | undefined;
46825
47290
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -47435,6 +47900,8 @@ export type Routes = {
47435
47900
  can_hvac_heat_cool?: boolean | undefined;
47436
47901
  /** Indicates whether the thermostat can be turned off. */
47437
47902
  can_turn_off_hvac?: boolean | undefined;
47903
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
47904
+ can_activate_weekly_program?: boolean | undefined;
47438
47905
  /** Indicates whether the device supports simulating removal in a sandbox. */
47439
47906
  can_simulate_removal?: boolean | undefined;
47440
47907
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -47490,9 +47957,9 @@ export type Routes = {
47490
47957
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
47491
47958
  page_cursor?: (string | undefined) | null;
47492
47959
  /** */
47493
- include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
47960
+ include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_activate_weekly_program' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
47494
47961
  /** */
47495
- exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
47962
+ exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_activate_weekly_program' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
47496
47963
  /** String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`. */
47497
47964
  search?: string | undefined;
47498
47965
  /** Numerical limit on the number of devices to return. */
@@ -47964,6 +48431,8 @@ export type Routes = {
47964
48431
  can_hvac_heat_cool?: boolean | undefined;
47965
48432
  /** Indicates whether the thermostat can be turned off. */
47966
48433
  can_turn_off_hvac?: boolean | undefined;
48434
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
48435
+ can_activate_weekly_program?: boolean | undefined;
47967
48436
  /** Indicates whether the device supports simulating removal in a sandbox. */
47968
48437
  can_simulate_removal?: boolean | undefined;
47969
48438
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -56766,6 +57235,41 @@ export type Routes = {
56766
57235
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
56767
57236
  message: string;
56768
57237
  };
57238
+ } | {
57239
+ /** ID of the action attempt. */
57240
+ action_attempt_id: string;
57241
+ status: 'pending';
57242
+ /** Result of the action attempt. Null for pending action attempts. */
57243
+ result: null;
57244
+ /** Errors associated with the action attempt. Null for pending action attempts. */
57245
+ error: null;
57246
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
57247
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
57248
+ } | {
57249
+ /** ID of the action attempt. */
57250
+ action_attempt_id: string;
57251
+ status: 'success';
57252
+ /** Errors associated with the action attempt. Null for successful action attempts. */
57253
+ error: null;
57254
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
57255
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
57256
+ /** Result of the action. */
57257
+ result: {};
57258
+ } | {
57259
+ /** ID of the action attempt. */
57260
+ action_attempt_id: string;
57261
+ status: 'error';
57262
+ /** Result of the action attempt. Null for failed action attempts. */
57263
+ result: null;
57264
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
57265
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
57266
+ /** Error associated with the action. */
57267
+ error: {
57268
+ /** Type of the error. */
57269
+ type: string;
57270
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
57271
+ message: string;
57272
+ };
56769
57273
  } | {
56770
57274
  /** ID of the action attempt. */
56771
57275
  action_attempt_id: string;
@@ -58694,6 +59198,8 @@ export type Routes = {
58694
59198
  can_hvac_heat_cool?: boolean | undefined;
58695
59199
  /** Indicates whether the thermostat can be turned off. */
58696
59200
  can_turn_off_hvac?: boolean | undefined;
59201
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
59202
+ can_activate_weekly_program?: boolean | undefined;
58697
59203
  /** Indicates whether the device supports simulating removal in a sandbox. */
58698
59204
  can_simulate_removal?: boolean | undefined;
58699
59205
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -60225,6 +60731,8 @@ export type Routes = {
60225
60731
  can_hvac_heat_cool?: boolean | undefined;
60226
60732
  /** Indicates whether the thermostat can be turned off. */
60227
60733
  can_turn_off_hvac?: boolean | undefined;
60734
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
60735
+ can_activate_weekly_program?: boolean | undefined;
60228
60736
  /** Indicates whether the device supports simulating removal in a sandbox. */
60229
60737
  can_simulate_removal?: boolean | undefined;
60230
60738
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -61779,6 +62287,8 @@ export type Routes = {
61779
62287
  can_hvac_heat_cool?: boolean | undefined;
61780
62288
  /** Indicates whether the thermostat can be turned off. */
61781
62289
  can_turn_off_hvac?: boolean | undefined;
62290
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
62291
+ can_activate_weekly_program?: boolean | undefined;
61782
62292
  /** Indicates whether the device supports simulating removal in a sandbox. */
61783
62293
  can_simulate_removal?: boolean | undefined;
61784
62294
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -63309,6 +63819,8 @@ export type Routes = {
63309
63819
  can_hvac_heat_cool?: boolean | undefined;
63310
63820
  /** Indicates whether the thermostat can be turned off. */
63311
63821
  can_turn_off_hvac?: boolean | undefined;
63822
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
63823
+ can_activate_weekly_program?: boolean | undefined;
63312
63824
  /** Indicates whether the device supports simulating removal in a sandbox. */
63313
63825
  can_simulate_removal?: boolean | undefined;
63314
63826
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -64740,6 +65252,41 @@ export type Routes = {
64740
65252
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
64741
65253
  message: string;
64742
65254
  };
65255
+ } | {
65256
+ /** ID of the action attempt. */
65257
+ action_attempt_id: string;
65258
+ status: 'pending';
65259
+ /** Result of the action attempt. Null for pending action attempts. */
65260
+ result: null;
65261
+ /** Errors associated with the action attempt. Null for pending action attempts. */
65262
+ error: null;
65263
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
65264
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
65265
+ } | {
65266
+ /** ID of the action attempt. */
65267
+ action_attempt_id: string;
65268
+ status: 'success';
65269
+ /** Errors associated with the action attempt. Null for successful action attempts. */
65270
+ error: null;
65271
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
65272
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
65273
+ /** Result of the action. */
65274
+ result: {};
65275
+ } | {
65276
+ /** ID of the action attempt. */
65277
+ action_attempt_id: string;
65278
+ status: 'error';
65279
+ /** Result of the action attempt. Null for failed action attempts. */
65280
+ result: null;
65281
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
65282
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
65283
+ /** Error associated with the action. */
65284
+ error: {
65285
+ /** Type of the error. */
65286
+ type: string;
65287
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
65288
+ message: string;
65289
+ };
64743
65290
  } | {
64744
65291
  /** ID of the action attempt. */
64745
65292
  action_attempt_id: string;
@@ -66552,6 +67099,41 @@ export type Routes = {
66552
67099
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
66553
67100
  message: string;
66554
67101
  };
67102
+ } | {
67103
+ /** ID of the action attempt. */
67104
+ action_attempt_id: string;
67105
+ status: 'pending';
67106
+ /** Result of the action attempt. Null for pending action attempts. */
67107
+ result: null;
67108
+ /** Errors associated with the action attempt. Null for pending action attempts. */
67109
+ error: null;
67110
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
67111
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
67112
+ } | {
67113
+ /** ID of the action attempt. */
67114
+ action_attempt_id: string;
67115
+ status: 'success';
67116
+ /** Errors associated with the action attempt. Null for successful action attempts. */
67117
+ error: null;
67118
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
67119
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
67120
+ /** Result of the action. */
67121
+ result: {};
67122
+ } | {
67123
+ /** ID of the action attempt. */
67124
+ action_attempt_id: string;
67125
+ status: 'error';
67126
+ /** Result of the action attempt. Null for failed action attempts. */
67127
+ result: null;
67128
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
67129
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
67130
+ /** Error associated with the action. */
67131
+ error: {
67132
+ /** Type of the error. */
67133
+ type: string;
67134
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
67135
+ message: string;
67136
+ };
66555
67137
  } | {
66556
67138
  /** ID of the action attempt. */
66557
67139
  action_attempt_id: string;
@@ -68362,6 +68944,41 @@ export type Routes = {
68362
68944
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
68363
68945
  message: string;
68364
68946
  };
68947
+ } | {
68948
+ /** ID of the action attempt. */
68949
+ action_attempt_id: string;
68950
+ status: 'pending';
68951
+ /** Result of the action attempt. Null for pending action attempts. */
68952
+ result: null;
68953
+ /** Errors associated with the action attempt. Null for pending action attempts. */
68954
+ error: null;
68955
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
68956
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
68957
+ } | {
68958
+ /** ID of the action attempt. */
68959
+ action_attempt_id: string;
68960
+ status: 'success';
68961
+ /** Errors associated with the action attempt. Null for successful action attempts. */
68962
+ error: null;
68963
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
68964
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
68965
+ /** Result of the action. */
68966
+ result: {};
68967
+ } | {
68968
+ /** ID of the action attempt. */
68969
+ action_attempt_id: string;
68970
+ status: 'error';
68971
+ /** Result of the action attempt. Null for failed action attempts. */
68972
+ result: null;
68973
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
68974
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
68975
+ /** Error associated with the action. */
68976
+ error: {
68977
+ /** Type of the error. */
68978
+ type: string;
68979
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
68980
+ message: string;
68981
+ };
68365
68982
  } | {
68366
68983
  /** ID of the action attempt. */
68367
68984
  action_attempt_id: string;
@@ -70174,6 +70791,41 @@ export type Routes = {
70174
70791
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
70175
70792
  message: string;
70176
70793
  };
70794
+ } | {
70795
+ /** ID of the action attempt. */
70796
+ action_attempt_id: string;
70797
+ status: 'pending';
70798
+ /** Result of the action attempt. Null for pending action attempts. */
70799
+ result: null;
70800
+ /** Errors associated with the action attempt. Null for pending action attempts. */
70801
+ error: null;
70802
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
70803
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
70804
+ } | {
70805
+ /** ID of the action attempt. */
70806
+ action_attempt_id: string;
70807
+ status: 'success';
70808
+ /** Errors associated with the action attempt. Null for successful action attempts. */
70809
+ error: null;
70810
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
70811
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
70812
+ /** Result of the action. */
70813
+ result: {};
70814
+ } | {
70815
+ /** ID of the action attempt. */
70816
+ action_attempt_id: string;
70817
+ status: 'error';
70818
+ /** Result of the action attempt. Null for failed action attempts. */
70819
+ result: null;
70820
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
70821
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
70822
+ /** Error associated with the action. */
70823
+ error: {
70824
+ /** Type of the error. */
70825
+ type: string;
70826
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
70827
+ message: string;
70828
+ };
70177
70829
  } | {
70178
70830
  /** ID of the action attempt. */
70179
70831
  action_attempt_id: string;
@@ -72109,6 +72761,8 @@ export type Routes = {
72109
72761
  can_hvac_heat_cool?: boolean | undefined;
72110
72762
  /** Indicates whether the thermostat can be turned off. */
72111
72763
  can_turn_off_hvac?: boolean | undefined;
72764
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
72765
+ can_activate_weekly_program?: boolean | undefined;
72112
72766
  /** Indicates whether the device supports simulating removal in a sandbox. */
72113
72767
  can_simulate_removal?: boolean | undefined;
72114
72768
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -73639,6 +74293,8 @@ export type Routes = {
73639
74293
  can_hvac_heat_cool?: boolean | undefined;
73640
74294
  /** Indicates whether the thermostat can be turned off. */
73641
74295
  can_turn_off_hvac?: boolean | undefined;
74296
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
74297
+ can_activate_weekly_program?: boolean | undefined;
73642
74298
  /** Indicates whether the device supports simulating removal in a sandbox. */
73643
74299
  can_simulate_removal?: boolean | undefined;
73644
74300
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -75080,6 +75736,41 @@ export type Routes = {
75080
75736
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
75081
75737
  message: string;
75082
75738
  };
75739
+ } | {
75740
+ /** ID of the action attempt. */
75741
+ action_attempt_id: string;
75742
+ status: 'pending';
75743
+ /** Result of the action attempt. Null for pending action attempts. */
75744
+ result: null;
75745
+ /** Errors associated with the action attempt. Null for pending action attempts. */
75746
+ error: null;
75747
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
75748
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
75749
+ } | {
75750
+ /** ID of the action attempt. */
75751
+ action_attempt_id: string;
75752
+ status: 'success';
75753
+ /** Errors associated with the action attempt. Null for successful action attempts. */
75754
+ error: null;
75755
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
75756
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
75757
+ /** Result of the action. */
75758
+ result: {};
75759
+ } | {
75760
+ /** ID of the action attempt. */
75761
+ action_attempt_id: string;
75762
+ status: 'error';
75763
+ /** Result of the action attempt. Null for failed action attempts. */
75764
+ result: null;
75765
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
75766
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
75767
+ /** Error associated with the action. */
75768
+ error: {
75769
+ /** Type of the error. */
75770
+ type: string;
75771
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
75772
+ message: string;
75773
+ };
75083
75774
  } | {
75084
75775
  /** ID of the action attempt. */
75085
75776
  action_attempt_id: string;
@@ -76911,6 +77602,41 @@ export type Routes = {
76911
77602
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
76912
77603
  message: string;
76913
77604
  };
77605
+ } | {
77606
+ /** ID of the action attempt. */
77607
+ action_attempt_id: string;
77608
+ status: 'pending';
77609
+ /** Result of the action attempt. Null for pending action attempts. */
77610
+ result: null;
77611
+ /** Errors associated with the action attempt. Null for pending action attempts. */
77612
+ error: null;
77613
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
77614
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
77615
+ } | {
77616
+ /** ID of the action attempt. */
77617
+ action_attempt_id: string;
77618
+ status: 'success';
77619
+ /** Errors associated with the action attempt. Null for successful action attempts. */
77620
+ error: null;
77621
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
77622
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
77623
+ /** Result of the action. */
77624
+ result: {};
77625
+ } | {
77626
+ /** ID of the action attempt. */
77627
+ action_attempt_id: string;
77628
+ status: 'error';
77629
+ /** Result of the action attempt. Null for failed action attempts. */
77630
+ result: null;
77631
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
77632
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
77633
+ /** Error associated with the action. */
77634
+ error: {
77635
+ /** Type of the error. */
77636
+ type: string;
77637
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
77638
+ message: string;
77639
+ };
76914
77640
  } | {
76915
77641
  /** ID of the action attempt. */
76916
77642
  action_attempt_id: string;
@@ -78798,6 +79524,41 @@ export type Routes = {
78798
79524
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
78799
79525
  message: string;
78800
79526
  };
79527
+ } | {
79528
+ /** ID of the action attempt. */
79529
+ action_attempt_id: string;
79530
+ status: 'pending';
79531
+ /** Result of the action attempt. Null for pending action attempts. */
79532
+ result: null;
79533
+ /** Errors associated with the action attempt. Null for pending action attempts. */
79534
+ error: null;
79535
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
79536
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
79537
+ } | {
79538
+ /** ID of the action attempt. */
79539
+ action_attempt_id: string;
79540
+ status: 'success';
79541
+ /** Errors associated with the action attempt. Null for successful action attempts. */
79542
+ error: null;
79543
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
79544
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
79545
+ /** Result of the action. */
79546
+ result: {};
79547
+ } | {
79548
+ /** ID of the action attempt. */
79549
+ action_attempt_id: string;
79550
+ status: 'error';
79551
+ /** Result of the action attempt. Null for failed action attempts. */
79552
+ result: null;
79553
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
79554
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
79555
+ /** Error associated with the action. */
79556
+ error: {
79557
+ /** Type of the error. */
79558
+ type: string;
79559
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
79560
+ message: string;
79561
+ };
78801
79562
  } | {
78802
79563
  /** ID of the action attempt. */
78803
79564
  action_attempt_id: string;
@@ -82468,6 +83229,41 @@ export type Routes = {
82468
83229
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
82469
83230
  message: string;
82470
83231
  };
83232
+ } | {
83233
+ /** ID of the action attempt. */
83234
+ action_attempt_id: string;
83235
+ status: 'pending';
83236
+ /** Result of the action attempt. Null for pending action attempts. */
83237
+ result: null;
83238
+ /** Errors associated with the action attempt. Null for pending action attempts. */
83239
+ error: null;
83240
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
83241
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
83242
+ } | {
83243
+ /** ID of the action attempt. */
83244
+ action_attempt_id: string;
83245
+ status: 'success';
83246
+ /** Errors associated with the action attempt. Null for successful action attempts. */
83247
+ error: null;
83248
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
83249
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
83250
+ /** Result of the action. */
83251
+ result: {};
83252
+ } | {
83253
+ /** ID of the action attempt. */
83254
+ action_attempt_id: string;
83255
+ status: 'error';
83256
+ /** Result of the action attempt. Null for failed action attempts. */
83257
+ result: null;
83258
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
83259
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
83260
+ /** Error associated with the action. */
83261
+ error: {
83262
+ /** Type of the error. */
83263
+ type: string;
83264
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
83265
+ message: string;
83266
+ };
82471
83267
  } | {
82472
83268
  /** ID of the action attempt. */
82473
83269
  action_attempt_id: string;
@@ -94738,6 +95534,8 @@ export type Routes = {
94738
95534
  can_hvac_heat_cool?: boolean | undefined;
94739
95535
  /** Indicates whether the thermostat can be turned off. */
94740
95536
  can_turn_off_hvac?: boolean | undefined;
95537
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
95538
+ can_activate_weekly_program?: boolean | undefined;
94741
95539
  /** Indicates whether the device supports simulating removal in a sandbox. */
94742
95540
  can_simulate_removal?: boolean | undefined;
94743
95541
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -95444,224 +96242,2071 @@ export type Routes = {
95444
96242
  })[];
95445
96243
  /** ID of the customization profile associated with the access method. */
95446
96244
  customization_profile_id?: string | undefined;
95447
- }[] | undefined;
95448
- };
95449
- };
95450
- maxDuration: undefined;
95451
- };
95452
- '/spaces/list': {
95453
- route: '/spaces/list';
95454
- method: 'GET' | 'POST';
95455
- queryParams: {};
95456
- jsonBody: {};
95457
- commonParams: {
95458
- /** Customer key for which you want to list spaces. */
95459
- customer_key?: string | undefined;
95460
- /** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`. */
95461
- search?: string | undefined;
95462
- /** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
95463
- connected_account_id?: string | undefined;
95464
- /** Filter spaces by space_key. */
95465
- space_key?: string | undefined;
95466
- /** Filter spaces to only include those whose parent space has the specified `parent_space_id`. */
95467
- parent_space_id?: string | undefined;
95468
- /** Filter spaces to only include those whose parent space has the specified `parent_space_key`. */
95469
- parent_space_key?: string | undefined;
95470
- /** Maximum number of records to return per page. */
95471
- limit?: number;
95472
- /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
95473
- page_cursor?: (string | undefined) | null;
95474
- };
95475
- formData: {};
95476
- jsonResponse: {
95477
- spaces: {
95478
- /** ID of the space. */
95479
- space_id: string;
95480
- /** ID of the workspace associated with the space. */
95481
- workspace_id: string;
95482
- /** Unique key for the space within the workspace. */
95483
- space_key?: string | undefined;
95484
- /** Name of the space. */
95485
- name: string;
95486
- /** Display name for the space. */
95487
- display_name: string;
95488
- /** Date and time at which the space was created. */
95489
- created_at: string;
95490
- /** Number of devices in the space. */
95491
- device_count: number;
95492
- /** Number of entrances in the space. */
95493
- acs_entrance_count: number;
95494
- /** Customer key associated with the space. */
95495
- customer_key?: string | undefined;
95496
- /** Reservation/stay-related defaults for the space. Also carries the provider/PMS-supplied name under a `<connector_type>_name` key (e.g. `guesty_name`), which Seam preserves when you rename the space (read-only — managed by Seam). */
95497
- customer_data?: {
95498
- /** IANA time zone for the space, e.g. America/Los_Angeles. */
95499
- time_zone?: (string | null) | undefined;
95500
- /** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
95501
- default_checkin_time?: (string | null) | undefined;
95502
- /** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
95503
- default_checkout_time?: (string | null) | undefined;
95504
- /** Postal address for the space. */
95505
- address?: (string | null) | undefined;
95506
- } | undefined;
95507
- /** Geographic coordinates (latitude and longitude) of the space. */
95508
- geolocation?: ({
95509
- /** Latitude of the space, in decimal degrees. */
95510
- latitude: number;
95511
- /** Longitude of the space, in decimal degrees. */
95512
- longitude: number;
95513
- } | null) | undefined;
95514
- /** */
95515
- parent_space_id?: string | undefined;
95516
- /** */
95517
- parent_space_key?: string | undefined;
95518
- }[];
95519
- /** Information about the current page of results. */
95520
- pagination: {
95521
- /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
95522
- next_page_cursor: string | null;
95523
- /** Indicates whether there is another page of results after this one. */
95524
- has_next_page: boolean;
95525
- /** URL to get the next page of results. */
95526
- next_page_url: string | null;
95527
- };
95528
- };
95529
- maxDuration: undefined;
95530
- };
95531
- '/spaces/remove_acs_entrances': {
95532
- route: '/spaces/remove_acs_entrances';
95533
- method: 'POST' | 'DELETE';
95534
- queryParams: {};
95535
- jsonBody: {};
95536
- commonParams: {
95537
- /** ID of the space from which you want to remove entrances. */
95538
- space_id: string;
95539
- /** IDs of the entrances that you want to remove from the space. */
95540
- acs_entrance_ids: string[];
95541
- };
95542
- formData: {};
95543
- jsonResponse: {};
95544
- maxDuration: undefined;
95545
- };
95546
- '/spaces/remove_connected_account': {
95547
- route: '/spaces/remove_connected_account';
95548
- method: 'POST' | 'DELETE';
95549
- queryParams: {};
95550
- jsonBody: {};
95551
- commonParams: {
95552
- /** ID of the space from which you want to remove the connected account. */
95553
- space_id: string;
95554
- /** ID of the connected account that you want to remove from the space. */
95555
- connected_account_id: string;
95556
- };
95557
- formData: {};
95558
- jsonResponse: {};
95559
- maxDuration: undefined;
95560
- };
95561
- '/spaces/remove_devices': {
95562
- route: '/spaces/remove_devices';
95563
- method: 'POST' | 'DELETE';
95564
- queryParams: {};
95565
- jsonBody: {};
95566
- commonParams: {
95567
- /** ID of the space from which you want to remove devices. */
95568
- space_id: string;
95569
- /** IDs of the devices that you want to remove from the space. */
95570
- device_ids: string[];
95571
- };
95572
- formData: {};
95573
- jsonResponse: {};
95574
- maxDuration: undefined;
95575
- };
95576
- '/spaces/update': {
95577
- route: '/spaces/update';
95578
- method: 'POST' | 'PATCH';
95579
- queryParams: {};
95580
- jsonBody: {
95581
- /** Name of the space. */
95582
- name?: string | undefined;
95583
- /** ID of the space that you want to update. */
95584
- space_id?: string | undefined;
95585
- /** Unique key of the space that you want to update. */
95586
- space_key?: string | undefined;
95587
- /** IDs of the devices that you want to set for the space. If specified, this will replace all existing devices. */
95588
- device_ids?: string[] | undefined;
95589
- /** IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances. */
95590
- acs_entrance_ids?: string[] | undefined;
95591
- /** Reservation/stay-related defaults for the space. Only the keys you provide are updated; omit a key to leave it unchanged. Pass null on a key to clear it. */
95592
- customer_data?: {
95593
- /** IANA time zone for the space, e.g. America/Los_Angeles. */
95594
- time_zone?: (string | null) | undefined;
95595
- /** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
95596
- default_checkin_time?: (string | null) | undefined;
95597
- /** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
95598
- default_checkout_time?: (string | null) | undefined;
95599
- /** Postal address for the space. */
95600
- address?: (string | null) | undefined;
95601
- } | undefined;
95602
- /** Reassign this space to the parent space (site) with this `parent_space_id`. */
95603
- parent_space_id?: string | undefined;
95604
- /** Reassign this space to the parent space (site) with this `parent_space_key`. */
95605
- parent_space_key?: string | undefined;
95606
- };
95607
- commonParams: {};
95608
- formData: {};
95609
- jsonResponse: {
95610
- /** Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient. */
95611
- space: {
95612
- /** ID of the space. */
95613
- space_id: string;
95614
- /** ID of the workspace associated with the space. */
95615
- workspace_id: string;
95616
- /** Unique key for the space within the workspace. */
95617
- space_key?: string | undefined;
95618
- /** Name of the space. */
95619
- name: string;
95620
- /** Display name for the space. */
95621
- display_name: string;
95622
- /** Date and time at which the space was created. */
95623
- created_at: string;
95624
- /** Number of devices in the space. */
95625
- device_count: number;
95626
- /** Number of entrances in the space. */
95627
- acs_entrance_count: number;
95628
- /** Customer key associated with the space. */
95629
- customer_key?: string | undefined;
95630
- /** Reservation/stay-related defaults for the space. Also carries the provider/PMS-supplied name under a `<connector_type>_name` key (e.g. `guesty_name`), which Seam preserves when you rename the space (read-only — managed by Seam). */
95631
- customer_data?: {
95632
- /** IANA time zone for the space, e.g. America/Los_Angeles. */
95633
- time_zone?: (string | null) | undefined;
95634
- /** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
95635
- default_checkin_time?: (string | null) | undefined;
95636
- /** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
95637
- default_checkout_time?: (string | null) | undefined;
95638
- /** Postal address for the space. */
95639
- address?: (string | null) | undefined;
95640
- } | undefined;
95641
- /** Geographic coordinates (latitude and longitude) of the space. */
95642
- geolocation?: ({
95643
- /** Latitude of the space, in decimal degrees. */
95644
- latitude: number;
95645
- /** Longitude of the space, in decimal degrees. */
95646
- longitude: number;
95647
- } | null) | undefined;
95648
- /** */
95649
- parent_space_id?: string | undefined;
95650
- /** */
95651
- parent_space_key?: string | undefined;
96245
+ }[] | undefined;
96246
+ };
96247
+ };
96248
+ maxDuration: undefined;
96249
+ };
96250
+ '/spaces/list': {
96251
+ route: '/spaces/list';
96252
+ method: 'GET' | 'POST';
96253
+ queryParams: {};
96254
+ jsonBody: {};
96255
+ commonParams: {
96256
+ /** Customer key for which you want to list spaces. */
96257
+ customer_key?: string | undefined;
96258
+ /** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`. */
96259
+ search?: string | undefined;
96260
+ /** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
96261
+ connected_account_id?: string | undefined;
96262
+ /** Filter spaces by space_key. */
96263
+ space_key?: string | undefined;
96264
+ /** Filter spaces to only include those whose parent space has the specified `parent_space_id`. */
96265
+ parent_space_id?: string | undefined;
96266
+ /** Filter spaces to only include those whose parent space has the specified `parent_space_key`. */
96267
+ parent_space_key?: string | undefined;
96268
+ /** Maximum number of records to return per page. */
96269
+ limit?: number;
96270
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
96271
+ page_cursor?: (string | undefined) | null;
96272
+ };
96273
+ formData: {};
96274
+ jsonResponse: {
96275
+ spaces: {
96276
+ /** ID of the space. */
96277
+ space_id: string;
96278
+ /** ID of the workspace associated with the space. */
96279
+ workspace_id: string;
96280
+ /** Unique key for the space within the workspace. */
96281
+ space_key?: string | undefined;
96282
+ /** Name of the space. */
96283
+ name: string;
96284
+ /** Display name for the space. */
96285
+ display_name: string;
96286
+ /** Date and time at which the space was created. */
96287
+ created_at: string;
96288
+ /** Number of devices in the space. */
96289
+ device_count: number;
96290
+ /** Number of entrances in the space. */
96291
+ acs_entrance_count: number;
96292
+ /** Customer key associated with the space. */
96293
+ customer_key?: string | undefined;
96294
+ /** Reservation/stay-related defaults for the space. Also carries the provider/PMS-supplied name under a `<connector_type>_name` key (e.g. `guesty_name`), which Seam preserves when you rename the space (read-only — managed by Seam). */
96295
+ customer_data?: {
96296
+ /** IANA time zone for the space, e.g. America/Los_Angeles. */
96297
+ time_zone?: (string | null) | undefined;
96298
+ /** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
96299
+ default_checkin_time?: (string | null) | undefined;
96300
+ /** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
96301
+ default_checkout_time?: (string | null) | undefined;
96302
+ /** Postal address for the space. */
96303
+ address?: (string | null) | undefined;
96304
+ } | undefined;
96305
+ /** Geographic coordinates (latitude and longitude) of the space. */
96306
+ geolocation?: ({
96307
+ /** Latitude of the space, in decimal degrees. */
96308
+ latitude: number;
96309
+ /** Longitude of the space, in decimal degrees. */
96310
+ longitude: number;
96311
+ } | null) | undefined;
96312
+ /** */
96313
+ parent_space_id?: string | undefined;
96314
+ /** */
96315
+ parent_space_key?: string | undefined;
96316
+ }[];
96317
+ /** Information about the current page of results. */
96318
+ pagination: {
96319
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
96320
+ next_page_cursor: string | null;
96321
+ /** Indicates whether there is another page of results after this one. */
96322
+ has_next_page: boolean;
96323
+ /** URL to get the next page of results. */
96324
+ next_page_url: string | null;
96325
+ };
96326
+ };
96327
+ maxDuration: undefined;
96328
+ };
96329
+ '/spaces/remove_acs_entrances': {
96330
+ route: '/spaces/remove_acs_entrances';
96331
+ method: 'POST' | 'DELETE';
96332
+ queryParams: {};
96333
+ jsonBody: {};
96334
+ commonParams: {
96335
+ /** ID of the space from which you want to remove entrances. */
96336
+ space_id: string;
96337
+ /** IDs of the entrances that you want to remove from the space. */
96338
+ acs_entrance_ids: string[];
96339
+ };
96340
+ formData: {};
96341
+ jsonResponse: {};
96342
+ maxDuration: undefined;
96343
+ };
96344
+ '/spaces/remove_connected_account': {
96345
+ route: '/spaces/remove_connected_account';
96346
+ method: 'POST' | 'DELETE';
96347
+ queryParams: {};
96348
+ jsonBody: {};
96349
+ commonParams: {
96350
+ /** ID of the space from which you want to remove the connected account. */
96351
+ space_id: string;
96352
+ /** ID of the connected account that you want to remove from the space. */
96353
+ connected_account_id: string;
96354
+ };
96355
+ formData: {};
96356
+ jsonResponse: {};
96357
+ maxDuration: undefined;
96358
+ };
96359
+ '/spaces/remove_devices': {
96360
+ route: '/spaces/remove_devices';
96361
+ method: 'POST' | 'DELETE';
96362
+ queryParams: {};
96363
+ jsonBody: {};
96364
+ commonParams: {
96365
+ /** ID of the space from which you want to remove devices. */
96366
+ space_id: string;
96367
+ /** IDs of the devices that you want to remove from the space. */
96368
+ device_ids: string[];
96369
+ };
96370
+ formData: {};
96371
+ jsonResponse: {};
96372
+ maxDuration: undefined;
96373
+ };
96374
+ '/spaces/update': {
96375
+ route: '/spaces/update';
96376
+ method: 'POST' | 'PATCH';
96377
+ queryParams: {};
96378
+ jsonBody: {
96379
+ /** Name of the space. */
96380
+ name?: string | undefined;
96381
+ /** ID of the space that you want to update. */
96382
+ space_id?: string | undefined;
96383
+ /** Unique key of the space that you want to update. */
96384
+ space_key?: string | undefined;
96385
+ /** IDs of the devices that you want to set for the space. If specified, this will replace all existing devices. */
96386
+ device_ids?: string[] | undefined;
96387
+ /** IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances. */
96388
+ acs_entrance_ids?: string[] | undefined;
96389
+ /** Reservation/stay-related defaults for the space. Only the keys you provide are updated; omit a key to leave it unchanged. Pass null on a key to clear it. */
96390
+ customer_data?: {
96391
+ /** IANA time zone for the space, e.g. America/Los_Angeles. */
96392
+ time_zone?: (string | null) | undefined;
96393
+ /** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
96394
+ default_checkin_time?: (string | null) | undefined;
96395
+ /** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
96396
+ default_checkout_time?: (string | null) | undefined;
96397
+ /** Postal address for the space. */
96398
+ address?: (string | null) | undefined;
96399
+ } | undefined;
96400
+ /** Reassign this space to the parent space (site) with this `parent_space_id`. */
96401
+ parent_space_id?: string | undefined;
96402
+ /** Reassign this space to the parent space (site) with this `parent_space_key`. */
96403
+ parent_space_key?: string | undefined;
96404
+ };
96405
+ commonParams: {};
96406
+ formData: {};
96407
+ jsonResponse: {
96408
+ /** Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient. */
96409
+ space: {
96410
+ /** ID of the space. */
96411
+ space_id: string;
96412
+ /** ID of the workspace associated with the space. */
96413
+ workspace_id: string;
96414
+ /** Unique key for the space within the workspace. */
96415
+ space_key?: string | undefined;
96416
+ /** Name of the space. */
96417
+ name: string;
96418
+ /** Display name for the space. */
96419
+ display_name: string;
96420
+ /** Date and time at which the space was created. */
96421
+ created_at: string;
96422
+ /** Number of devices in the space. */
96423
+ device_count: number;
96424
+ /** Number of entrances in the space. */
96425
+ acs_entrance_count: number;
96426
+ /** Customer key associated with the space. */
96427
+ customer_key?: string | undefined;
96428
+ /** Reservation/stay-related defaults for the space. Also carries the provider/PMS-supplied name under a `<connector_type>_name` key (e.g. `guesty_name`), which Seam preserves when you rename the space (read-only — managed by Seam). */
96429
+ customer_data?: {
96430
+ /** IANA time zone for the space, e.g. America/Los_Angeles. */
96431
+ time_zone?: (string | null) | undefined;
96432
+ /** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
96433
+ default_checkin_time?: (string | null) | undefined;
96434
+ /** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
96435
+ default_checkout_time?: (string | null) | undefined;
96436
+ /** Postal address for the space. */
96437
+ address?: (string | null) | undefined;
96438
+ } | undefined;
96439
+ /** Geographic coordinates (latitude and longitude) of the space. */
96440
+ geolocation?: ({
96441
+ /** Latitude of the space, in decimal degrees. */
96442
+ latitude: number;
96443
+ /** Longitude of the space, in decimal degrees. */
96444
+ longitude: number;
96445
+ } | null) | undefined;
96446
+ /** */
96447
+ parent_space_id?: string | undefined;
96448
+ /** */
96449
+ parent_space_key?: string | undefined;
96450
+ };
96451
+ };
96452
+ maxDuration: undefined;
96453
+ };
96454
+ '/thermostats/activate_climate_preset': {
96455
+ route: '/thermostats/activate_climate_preset';
96456
+ method: 'POST';
96457
+ queryParams: {};
96458
+ jsonBody: {
96459
+ /** ID of the thermostat device for which you want to activate a climate preset. */
96460
+ device_id: string;
96461
+ /** Climate preset key of the climate preset that you want to activate. */
96462
+ climate_preset_key: string;
96463
+ };
96464
+ commonParams: {};
96465
+ formData: {};
96466
+ jsonResponse: {
96467
+ /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
96468
+
96469
+ When you request for a device to perform an action, the Seam API immediately returns an action attempt object. In the background, the Seam API performs the action.
96470
+
96471
+ See also [Action Attempts](https://www.seam.co/docs/core-concepts/action-attempts). */
96472
+ action_attempt: {
96473
+ /** ID of the action attempt. */
96474
+ action_attempt_id: string;
96475
+ status: 'pending';
96476
+ /** Result of the action attempt. Null for pending action attempts. */
96477
+ result: null;
96478
+ /** Errors associated with the action attempt. Null for pending action attempts. */
96479
+ error: null;
96480
+ /** Action attempt to track the status of locking a door. */
96481
+ action_type: 'LOCK_DOOR';
96482
+ } | {
96483
+ /** ID of the action attempt. */
96484
+ action_attempt_id: string;
96485
+ status: 'success';
96486
+ /** Errors associated with the action attempt. Null for successful action attempts. */
96487
+ error: null;
96488
+ /** Action attempt to track the status of locking a door. */
96489
+ action_type: 'LOCK_DOOR';
96490
+ /** Result of the action. */
96491
+ result: {
96492
+ /** Indicates whether the device confirmed that the lock action occurred. */
96493
+ was_confirmed_by_device?: boolean | undefined;
96494
+ };
96495
+ } | {
96496
+ /** ID of the action attempt. */
96497
+ action_attempt_id: string;
96498
+ status: 'error';
96499
+ /** Result of the action attempt. Null for failed action attempts. */
96500
+ result: null;
96501
+ /** Action attempt to track the status of locking a door. */
96502
+ action_type: 'LOCK_DOOR';
96503
+ /** Error associated with the action. */
96504
+ error: {
96505
+ /** Type of the error. */
96506
+ type: string;
96507
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
96508
+ message: string;
96509
+ };
96510
+ } | {
96511
+ /** ID of the action attempt. */
96512
+ action_attempt_id: string;
96513
+ status: 'pending';
96514
+ /** Result of the action attempt. Null for pending action attempts. */
96515
+ result: null;
96516
+ /** Errors associated with the action attempt. Null for pending action attempts. */
96517
+ error: null;
96518
+ /** Action attempt to track the status of unlocking a door. */
96519
+ action_type: 'UNLOCK_DOOR';
96520
+ } | {
96521
+ /** ID of the action attempt. */
96522
+ action_attempt_id: string;
96523
+ status: 'success';
96524
+ /** Errors associated with the action attempt. Null for successful action attempts. */
96525
+ error: null;
96526
+ /** Action attempt to track the status of unlocking a door. */
96527
+ action_type: 'UNLOCK_DOOR';
96528
+ /** Result of the action. */
96529
+ result: {
96530
+ /** Indicates whether the device confirmed that the unlock action occurred. */
96531
+ was_confirmed_by_device?: boolean | undefined;
96532
+ };
96533
+ } | {
96534
+ /** ID of the action attempt. */
96535
+ action_attempt_id: string;
96536
+ status: 'error';
96537
+ /** Result of the action attempt. Null for failed action attempts. */
96538
+ result: null;
96539
+ /** Action attempt to track the status of unlocking a door. */
96540
+ action_type: 'UNLOCK_DOOR';
96541
+ /** Error associated with the action. */
96542
+ error: {
96543
+ /** Type of the error. */
96544
+ type: string;
96545
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
96546
+ message: string;
96547
+ };
96548
+ } | {
96549
+ /** ID of the action attempt. */
96550
+ action_attempt_id: string;
96551
+ status: 'pending';
96552
+ /** Result of the action attempt. Null for pending action attempts. */
96553
+ result: null;
96554
+ /** Errors associated with the action attempt. Null for pending action attempts. */
96555
+ error: null;
96556
+ /** Action attempt to track the status of scanning a credential. */
96557
+ action_type: 'SCAN_CREDENTIAL';
96558
+ } | {
96559
+ /** ID of the action attempt. */
96560
+ action_attempt_id: string;
96561
+ status: 'success';
96562
+ /** Errors associated with the action attempt. Null for successful action attempts. */
96563
+ error: null;
96564
+ /** Action attempt to track the status of scanning a credential. */
96565
+ action_type: 'SCAN_CREDENTIAL';
96566
+ /** Result of scanning a card. If the attempt was successful, includes a snapshot of credential data read from the physical encoder, the corresponding data stored on Seam and the access system, and any associated warnings. */
96567
+ result: {
96568
+ /** Snapshot of credential data read from the physical encoder. */
96569
+ acs_credential_on_encoder: {
96570
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
96571
+ created_at: string | null;
96572
+ /** Indicates whether the credential has been issued (encoded onto a card). */
96573
+ is_issued: boolean | null;
96574
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) becomes usable. */
96575
+ starts_at: string | null;
96576
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) will stop being usable. */
96577
+ ends_at: string | null;
96578
+ /** A number or string that physically identifies the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96579
+ card_number: string | null;
96580
+ /** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96581
+ visionline_metadata?: {
96582
+ /** Card ID for the Visionline card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96583
+ card_id?: (string | undefined) | undefined;
96584
+ /** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is cancelled. */
96585
+ cancelled?: (boolean | undefined) | undefined;
96586
+ /** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is discarded. */
96587
+ discarded?: (boolean | undefined) | undefined;
96588
+ /** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is expired. */
96589
+ expired?: (boolean | undefined) | undefined;
96590
+ /** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overwritten. */
96591
+ overwritten?: (boolean | undefined) | undefined;
96592
+ /** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overridden. */
96593
+ overridden?: (boolean | undefined) | undefined;
96594
+ /** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is pending auto-update. */
96595
+ pending_auto_update?: (boolean | undefined) | undefined;
96596
+ /** Format of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96597
+ card_format?: (('TLCode' | 'rfid48') | undefined) | undefined;
96598
+ /** Holder of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96599
+ card_holder?: (string | undefined) | undefined;
96600
+ /** Number of issued cards associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96601
+ number_of_issued_cards?: (number | undefined) | undefined;
96602
+ /** IDs of the guest [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96603
+ guest_acs_entrance_ids?: (string[] | undefined) | undefined;
96604
+ /** IDs of the common [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96605
+ common_acs_entrance_ids?: (string[] | undefined) | undefined;
96606
+ } | undefined;
96607
+ } | null;
96608
+ /** Corresponding credential data as stored on Seam and the access system. */
96609
+ acs_credential_on_seam: ({
96610
+ /** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96611
+ acs_credential_id: string;
96612
+ /** ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
96613
+ acs_user_id?: string | undefined;
96614
+ /** ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
96615
+ user_identity_id?: string | undefined;
96616
+ /** ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
96617
+ connected_account_id: string;
96618
+ /** ID of the credential pool to which the credential belongs. */
96619
+ acs_credential_pool_id?: string | undefined;
96620
+ /** ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96621
+ acs_system_id: string;
96622
+ /** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96623
+ parent_acs_credential_id?: string | undefined;
96624
+ /** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
96625
+ display_name: string;
96626
+ /** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96627
+ code?: (string | undefined) | null;
96628
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
96629
+ is_one_time_use?: boolean | undefined;
96630
+ /** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96631
+ card_number?: (string | undefined) | null;
96632
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
96633
+ is_issued?: boolean | undefined;
96634
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
96635
+ issued_at?: (string | undefined) | null;
96636
+ /** Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
96637
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
96638
+ /** Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
96639
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card' | 'salto_ks_tag' | 'avigilon_alta_credential' | 'kisi_credential' | 'akiles_credential') | undefined;
96640
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
96641
+ external_type_display_name?: string | undefined;
96642
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
96643
+ created_at: string;
96644
+ /** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96645
+ workspace_id: string;
96646
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
96647
+ starts_at?: string | undefined;
96648
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
96649
+ ends_at?: string | undefined;
96650
+ /** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96651
+ errors: {
96652
+ error_code: string;
96653
+ message: string;
96654
+ /** Date and time at which Seam created the error. */
96655
+ created_at: string;
96656
+ }[];
96657
+ /** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96658
+ warnings: ({
96659
+ /** Date and time at which Seam created the warning. */
96660
+ created_at: string;
96661
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
96662
+ message: string;
96663
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
96664
+ warning_code: 'waiting_to_be_issued';
96665
+ } | {
96666
+ /** Date and time at which Seam created the warning. */
96667
+ created_at: string;
96668
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
96669
+ message: string;
96670
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
96671
+ warning_code: 'schedule_externally_modified';
96672
+ } | {
96673
+ /** Date and time at which Seam created the warning. */
96674
+ created_at: string;
96675
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
96676
+ message: string;
96677
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
96678
+ warning_code: 'schedule_modified';
96679
+ } | {
96680
+ /** Date and time at which Seam created the warning. */
96681
+ created_at: string;
96682
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
96683
+ message: string;
96684
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
96685
+ warning_code: 'being_deleted';
96686
+ } | {
96687
+ /** Date and time at which Seam created the warning. */
96688
+ created_at: string;
96689
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
96690
+ message: string;
96691
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
96692
+ warning_code: 'unknown_issue_with_acs_credential';
96693
+ } | {
96694
+ /** Date and time at which Seam created the warning. */
96695
+ created_at: string;
96696
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
96697
+ message: string;
96698
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
96699
+ warning_code: 'needs_to_be_reissued';
96700
+ } | {
96701
+ /** Date and time at which Seam created the warning. */
96702
+ created_at: string;
96703
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
96704
+ message: string;
96705
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
96706
+ warning_code: 'requested_code_unavailable';
96707
+ /** The originally requested PIN code that could not be used. */
96708
+ original_code: string;
96709
+ /** The PIN code that was assigned instead. */
96710
+ new_code: string;
96711
+ })[];
96712
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
96713
+ is_multi_phone_sync_credential?: boolean | undefined;
96714
+ /** Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. */
96715
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
96716
+ /** Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
96717
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
96718
+ /** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96719
+ visionline_metadata?: {
96720
+ /** Card function type in the Visionline access system. */
96721
+ card_function_type?: (('guest' | 'staff') | undefined) | undefined;
96722
+ /** IDs of the credentials to which you want to join. */
96723
+ joiner_acs_credential_ids?: (string[] | undefined) | undefined;
96724
+ /** Guest entrance IDs in the Visionline access system. */
96725
+ guest_acs_entrance_ids?: (string[] | undefined) | undefined;
96726
+ /** Common entrance IDs in the Visionline access system. */
96727
+ common_acs_entrance_ids?: (string[] | undefined) | undefined;
96728
+ /** Indicates whether the credential is valid. */
96729
+ is_valid?: (boolean | undefined) | undefined;
96730
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
96731
+ auto_join?: (boolean | undefined) | undefined;
96732
+ /** ID of the card in the Visionline access system. */
96733
+ card_id?: (string | undefined) | undefined;
96734
+ /** ID of the credential in the Visionline access system. */
96735
+ credential_id?: (string | undefined) | undefined;
96736
+ } | undefined;
96737
+ /** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96738
+ assa_abloy_vostio_metadata?: {
96739
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
96740
+ auto_join?: (boolean | undefined) | undefined;
96741
+ /** IDs of the guest entrances to override in the Vostio access system. */
96742
+ override_guest_acs_entrance_ids?: (string[] | undefined) | undefined;
96743
+ /** Key ID in the Vostio access system. */
96744
+ key_id?: (string | undefined) | undefined;
96745
+ /** Key issuing request ID in the Vostio access system. */
96746
+ key_issuing_request_id?: (string | undefined) | undefined;
96747
+ /** Names of the doors to which to grant access in the Vostio access system. */
96748
+ door_names?: (string[] | undefined) | undefined;
96749
+ /** Endpoint ID in the Vostio access system. */
96750
+ endpoint_id?: (string | undefined) | undefined;
96751
+ } | undefined;
96752
+ /** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96753
+ akiles_metadata?: {
96754
+ /** ID of the Akiles member PIN. */
96755
+ member_pin_id?: (string | undefined) | undefined;
96756
+ } | undefined;
96757
+ /** Indicates whether Seam manages the credential. */
96758
+ is_managed: true;
96759
+ } | {
96760
+ /** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96761
+ acs_credential_id: string;
96762
+ /** ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
96763
+ acs_user_id?: string | undefined;
96764
+ /** ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
96765
+ user_identity_id?: string | undefined;
96766
+ /** ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
96767
+ connected_account_id: string;
96768
+ /** ID of the credential pool to which the credential belongs. */
96769
+ acs_credential_pool_id?: string | undefined;
96770
+ /** ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96771
+ acs_system_id: string;
96772
+ /** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96773
+ parent_acs_credential_id?: string | undefined;
96774
+ /** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
96775
+ display_name: string;
96776
+ /** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96777
+ code?: (string | undefined) | null;
96778
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
96779
+ is_one_time_use?: boolean | undefined;
96780
+ /** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96781
+ card_number?: (string | undefined) | null;
96782
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
96783
+ is_issued?: boolean | undefined;
96784
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
96785
+ issued_at?: (string | undefined) | null;
96786
+ /** Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
96787
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
96788
+ /** Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
96789
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card' | 'salto_ks_tag' | 'avigilon_alta_credential' | 'kisi_credential' | 'akiles_credential') | undefined;
96790
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
96791
+ external_type_display_name?: string | undefined;
96792
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
96793
+ created_at: string;
96794
+ /** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96795
+ workspace_id: string;
96796
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
96797
+ starts_at?: string | undefined;
96798
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
96799
+ ends_at?: string | undefined;
96800
+ /** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96801
+ errors: {
96802
+ error_code: string;
96803
+ message: string;
96804
+ /** Date and time at which Seam created the error. */
96805
+ created_at: string;
96806
+ }[];
96807
+ /** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96808
+ warnings: ({
96809
+ /** Date and time at which Seam created the warning. */
96810
+ created_at: string;
96811
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
96812
+ message: string;
96813
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
96814
+ warning_code: 'waiting_to_be_issued';
96815
+ } | {
96816
+ /** Date and time at which Seam created the warning. */
96817
+ created_at: string;
96818
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
96819
+ message: string;
96820
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
96821
+ warning_code: 'schedule_externally_modified';
96822
+ } | {
96823
+ /** Date and time at which Seam created the warning. */
96824
+ created_at: string;
96825
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
96826
+ message: string;
96827
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
96828
+ warning_code: 'schedule_modified';
96829
+ } | {
96830
+ /** Date and time at which Seam created the warning. */
96831
+ created_at: string;
96832
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
96833
+ message: string;
96834
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
96835
+ warning_code: 'being_deleted';
96836
+ } | {
96837
+ /** Date and time at which Seam created the warning. */
96838
+ created_at: string;
96839
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
96840
+ message: string;
96841
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
96842
+ warning_code: 'unknown_issue_with_acs_credential';
96843
+ } | {
96844
+ /** Date and time at which Seam created the warning. */
96845
+ created_at: string;
96846
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
96847
+ message: string;
96848
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
96849
+ warning_code: 'needs_to_be_reissued';
96850
+ } | {
96851
+ /** Date and time at which Seam created the warning. */
96852
+ created_at: string;
96853
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
96854
+ message: string;
96855
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
96856
+ warning_code: 'requested_code_unavailable';
96857
+ /** The originally requested PIN code that could not be used. */
96858
+ original_code: string;
96859
+ /** The PIN code that was assigned instead. */
96860
+ new_code: string;
96861
+ })[];
96862
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
96863
+ is_multi_phone_sync_credential?: boolean | undefined;
96864
+ /** Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. */
96865
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
96866
+ /** Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
96867
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
96868
+ /** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96869
+ visionline_metadata?: {
96870
+ /** Card function type in the Visionline access system. */
96871
+ card_function_type?: (('guest' | 'staff') | undefined) | undefined;
96872
+ /** IDs of the credentials to which you want to join. */
96873
+ joiner_acs_credential_ids?: (string[] | undefined) | undefined;
96874
+ /** Guest entrance IDs in the Visionline access system. */
96875
+ guest_acs_entrance_ids?: (string[] | undefined) | undefined;
96876
+ /** Common entrance IDs in the Visionline access system. */
96877
+ common_acs_entrance_ids?: (string[] | undefined) | undefined;
96878
+ /** Indicates whether the credential is valid. */
96879
+ is_valid?: (boolean | undefined) | undefined;
96880
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
96881
+ auto_join?: (boolean | undefined) | undefined;
96882
+ /** ID of the card in the Visionline access system. */
96883
+ card_id?: (string | undefined) | undefined;
96884
+ /** ID of the credential in the Visionline access system. */
96885
+ credential_id?: (string | undefined) | undefined;
96886
+ } | undefined;
96887
+ /** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96888
+ assa_abloy_vostio_metadata?: {
96889
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
96890
+ auto_join?: (boolean | undefined) | undefined;
96891
+ /** IDs of the guest entrances to override in the Vostio access system. */
96892
+ override_guest_acs_entrance_ids?: (string[] | undefined) | undefined;
96893
+ /** Key ID in the Vostio access system. */
96894
+ key_id?: (string | undefined) | undefined;
96895
+ /** Key issuing request ID in the Vostio access system. */
96896
+ key_issuing_request_id?: (string | undefined) | undefined;
96897
+ /** Names of the doors to which to grant access in the Vostio access system. */
96898
+ door_names?: (string[] | undefined) | undefined;
96899
+ /** Endpoint ID in the Vostio access system. */
96900
+ endpoint_id?: (string | undefined) | undefined;
96901
+ } | undefined;
96902
+ /** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96903
+ akiles_metadata?: {
96904
+ /** ID of the Akiles member PIN. */
96905
+ member_pin_id?: (string | undefined) | undefined;
96906
+ } | undefined;
96907
+ is_managed: false;
96908
+ }) | null;
96909
+ /** Warnings related to scanning the credential, such as mismatches between the credential data currently encoded on the card and the corresponding data stored on Seam and the access system. */
96910
+ warnings: {
96911
+ /** Indicates a warning related to scanning a credential. */
96912
+ warning_code: 'acs_credential_on_encoder_out_of_sync' | 'acs_credential_on_seam_not_found';
96913
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
96914
+ warning_message: string;
96915
+ }[];
96916
+ };
96917
+ } | {
96918
+ /** ID of the action attempt. */
96919
+ action_attempt_id: string;
96920
+ status: 'error';
96921
+ /** Result of the action attempt. Null for failed action attempts. */
96922
+ result: null;
96923
+ /** Action attempt to track the status of scanning a credential. */
96924
+ action_type: 'SCAN_CREDENTIAL';
96925
+ error: {
96926
+ /** Type of the error associated with the action attempt. */
96927
+ type: 'uncategorized_error';
96928
+ /** Message for the error associated with the action attempt. */
96929
+ message: string;
96930
+ } | {
96931
+ /** Type of the error associated with the action attempt. */
96932
+ type: 'action_attempt_expired';
96933
+ /** Message for the error associated with the action attempt. */
96934
+ message: string;
96935
+ } | {
96936
+ /** Error type to indicate that there is no credential on the encoder. */
96937
+ type: 'no_credential_on_encoder';
96938
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
96939
+ message: string;
96940
+ } | {
96941
+ /** Error type to indicate that the encoder is not online. */
96942
+ type: 'encoder_not_online';
96943
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
96944
+ message: string;
96945
+ } | {
96946
+ /** Error type to indicate that communication with the encoder timed out. */
96947
+ type: 'encoder_communication_timeout';
96948
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
96949
+ message: string;
96950
+ } | {
96951
+ /** Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system. */
96952
+ type: 'bridge_disconnected';
96953
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
96954
+ message: string;
96955
+ };
96956
+ } | {
96957
+ /** ID of the action attempt. */
96958
+ action_attempt_id: string;
96959
+ status: 'pending';
96960
+ /** Result of the action attempt. Null for pending action attempts. */
96961
+ result: null;
96962
+ /** Errors associated with the action attempt. Null for pending action attempts. */
96963
+ error: null;
96964
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
96965
+ action_type: 'ENCODE_CREDENTIAL';
96966
+ } | {
96967
+ /** ID of the action attempt. */
96968
+ action_attempt_id: string;
96969
+ status: 'success';
96970
+ /** Errors associated with the action attempt. Null for successful action attempts. */
96971
+ error: null;
96972
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
96973
+ action_type: 'ENCODE_CREDENTIAL';
96974
+ /** Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card. */
96975
+ result: {
96976
+ /** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96977
+ acs_credential_id: string;
96978
+ /** ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
96979
+ acs_user_id?: string | undefined;
96980
+ /** ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
96981
+ user_identity_id?: string | undefined;
96982
+ /** ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
96983
+ connected_account_id: string;
96984
+ /** ID of the credential pool to which the credential belongs. */
96985
+ acs_credential_pool_id?: string | undefined;
96986
+ /** ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96987
+ acs_system_id: string;
96988
+ /** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96989
+ parent_acs_credential_id?: string | undefined;
96990
+ /** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
96991
+ display_name: string;
96992
+ /** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96993
+ code?: (string | undefined) | null;
96994
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
96995
+ is_one_time_use?: boolean | undefined;
96996
+ /** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
96997
+ card_number?: (string | undefined) | null;
96998
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
96999
+ is_issued?: boolean | undefined;
97000
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
97001
+ issued_at?: (string | undefined) | null;
97002
+ /** Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
97003
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
97004
+ /** Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
97005
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card' | 'salto_ks_tag' | 'avigilon_alta_credential' | 'kisi_credential' | 'akiles_credential') | undefined;
97006
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
97007
+ external_type_display_name?: string | undefined;
97008
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
97009
+ created_at: string;
97010
+ /** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97011
+ workspace_id: string;
97012
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
97013
+ starts_at?: string | undefined;
97014
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
97015
+ ends_at?: string | undefined;
97016
+ /** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97017
+ errors: {
97018
+ error_code: string;
97019
+ message: string;
97020
+ /** Date and time at which Seam created the error. */
97021
+ created_at: string;
97022
+ }[];
97023
+ /** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97024
+ warnings: ({
97025
+ /** Date and time at which Seam created the warning. */
97026
+ created_at: string;
97027
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97028
+ message: string;
97029
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97030
+ warning_code: 'waiting_to_be_issued';
97031
+ } | {
97032
+ /** Date and time at which Seam created the warning. */
97033
+ created_at: string;
97034
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97035
+ message: string;
97036
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97037
+ warning_code: 'schedule_externally_modified';
97038
+ } | {
97039
+ /** Date and time at which Seam created the warning. */
97040
+ created_at: string;
97041
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97042
+ message: string;
97043
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97044
+ warning_code: 'schedule_modified';
97045
+ } | {
97046
+ /** Date and time at which Seam created the warning. */
97047
+ created_at: string;
97048
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97049
+ message: string;
97050
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97051
+ warning_code: 'being_deleted';
97052
+ } | {
97053
+ /** Date and time at which Seam created the warning. */
97054
+ created_at: string;
97055
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97056
+ message: string;
97057
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97058
+ warning_code: 'unknown_issue_with_acs_credential';
97059
+ } | {
97060
+ /** Date and time at which Seam created the warning. */
97061
+ created_at: string;
97062
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97063
+ message: string;
97064
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97065
+ warning_code: 'needs_to_be_reissued';
97066
+ } | {
97067
+ /** Date and time at which Seam created the warning. */
97068
+ created_at: string;
97069
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97070
+ message: string;
97071
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97072
+ warning_code: 'requested_code_unavailable';
97073
+ /** The originally requested PIN code that could not be used. */
97074
+ original_code: string;
97075
+ /** The PIN code that was assigned instead. */
97076
+ new_code: string;
97077
+ })[];
97078
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
97079
+ is_multi_phone_sync_credential?: boolean | undefined;
97080
+ /** Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. */
97081
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
97082
+ /** Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
97083
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
97084
+ /** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97085
+ visionline_metadata?: {
97086
+ /** Card function type in the Visionline access system. */
97087
+ card_function_type?: (('guest' | 'staff') | undefined) | undefined;
97088
+ /** IDs of the credentials to which you want to join. */
97089
+ joiner_acs_credential_ids?: (string[] | undefined) | undefined;
97090
+ /** Guest entrance IDs in the Visionline access system. */
97091
+ guest_acs_entrance_ids?: (string[] | undefined) | undefined;
97092
+ /** Common entrance IDs in the Visionline access system. */
97093
+ common_acs_entrance_ids?: (string[] | undefined) | undefined;
97094
+ /** Indicates whether the credential is valid. */
97095
+ is_valid?: (boolean | undefined) | undefined;
97096
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
97097
+ auto_join?: (boolean | undefined) | undefined;
97098
+ /** ID of the card in the Visionline access system. */
97099
+ card_id?: (string | undefined) | undefined;
97100
+ /** ID of the credential in the Visionline access system. */
97101
+ credential_id?: (string | undefined) | undefined;
97102
+ } | undefined;
97103
+ /** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97104
+ assa_abloy_vostio_metadata?: {
97105
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
97106
+ auto_join?: (boolean | undefined) | undefined;
97107
+ /** IDs of the guest entrances to override in the Vostio access system. */
97108
+ override_guest_acs_entrance_ids?: (string[] | undefined) | undefined;
97109
+ /** Key ID in the Vostio access system. */
97110
+ key_id?: (string | undefined) | undefined;
97111
+ /** Key issuing request ID in the Vostio access system. */
97112
+ key_issuing_request_id?: (string | undefined) | undefined;
97113
+ /** Names of the doors to which to grant access in the Vostio access system. */
97114
+ door_names?: (string[] | undefined) | undefined;
97115
+ /** Endpoint ID in the Vostio access system. */
97116
+ endpoint_id?: (string | undefined) | undefined;
97117
+ } | undefined;
97118
+ /** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97119
+ akiles_metadata?: {
97120
+ /** ID of the Akiles member PIN. */
97121
+ member_pin_id?: (string | undefined) | undefined;
97122
+ } | undefined;
97123
+ /** Indicates whether Seam manages the credential. */
97124
+ is_managed: true;
97125
+ } | {
97126
+ /** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97127
+ acs_credential_id: string;
97128
+ /** ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
97129
+ acs_user_id?: string | undefined;
97130
+ /** ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
97131
+ user_identity_id?: string | undefined;
97132
+ /** ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
97133
+ connected_account_id: string;
97134
+ /** ID of the credential pool to which the credential belongs. */
97135
+ acs_credential_pool_id?: string | undefined;
97136
+ /** ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97137
+ acs_system_id: string;
97138
+ /** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97139
+ parent_acs_credential_id?: string | undefined;
97140
+ /** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
97141
+ display_name: string;
97142
+ /** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97143
+ code?: (string | undefined) | null;
97144
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
97145
+ is_one_time_use?: boolean | undefined;
97146
+ /** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97147
+ card_number?: (string | undefined) | null;
97148
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
97149
+ is_issued?: boolean | undefined;
97150
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
97151
+ issued_at?: (string | undefined) | null;
97152
+ /** Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
97153
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
97154
+ /** Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
97155
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card' | 'salto_ks_tag' | 'avigilon_alta_credential' | 'kisi_credential' | 'akiles_credential') | undefined;
97156
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
97157
+ external_type_display_name?: string | undefined;
97158
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
97159
+ created_at: string;
97160
+ /** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97161
+ workspace_id: string;
97162
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
97163
+ starts_at?: string | undefined;
97164
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
97165
+ ends_at?: string | undefined;
97166
+ /** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97167
+ errors: {
97168
+ error_code: string;
97169
+ message: string;
97170
+ /** Date and time at which Seam created the error. */
97171
+ created_at: string;
97172
+ }[];
97173
+ /** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97174
+ warnings: ({
97175
+ /** Date and time at which Seam created the warning. */
97176
+ created_at: string;
97177
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97178
+ message: string;
97179
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97180
+ warning_code: 'waiting_to_be_issued';
97181
+ } | {
97182
+ /** Date and time at which Seam created the warning. */
97183
+ created_at: string;
97184
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97185
+ message: string;
97186
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97187
+ warning_code: 'schedule_externally_modified';
97188
+ } | {
97189
+ /** Date and time at which Seam created the warning. */
97190
+ created_at: string;
97191
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97192
+ message: string;
97193
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97194
+ warning_code: 'schedule_modified';
97195
+ } | {
97196
+ /** Date and time at which Seam created the warning. */
97197
+ created_at: string;
97198
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97199
+ message: string;
97200
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97201
+ warning_code: 'being_deleted';
97202
+ } | {
97203
+ /** Date and time at which Seam created the warning. */
97204
+ created_at: string;
97205
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97206
+ message: string;
97207
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97208
+ warning_code: 'unknown_issue_with_acs_credential';
97209
+ } | {
97210
+ /** Date and time at which Seam created the warning. */
97211
+ created_at: string;
97212
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97213
+ message: string;
97214
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97215
+ warning_code: 'needs_to_be_reissued';
97216
+ } | {
97217
+ /** Date and time at which Seam created the warning. */
97218
+ created_at: string;
97219
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97220
+ message: string;
97221
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97222
+ warning_code: 'requested_code_unavailable';
97223
+ /** The originally requested PIN code that could not be used. */
97224
+ original_code: string;
97225
+ /** The PIN code that was assigned instead. */
97226
+ new_code: string;
97227
+ })[];
97228
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
97229
+ is_multi_phone_sync_credential?: boolean | undefined;
97230
+ /** Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. */
97231
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
97232
+ /** Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
97233
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
97234
+ /** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97235
+ visionline_metadata?: {
97236
+ /** Card function type in the Visionline access system. */
97237
+ card_function_type?: (('guest' | 'staff') | undefined) | undefined;
97238
+ /** IDs of the credentials to which you want to join. */
97239
+ joiner_acs_credential_ids?: (string[] | undefined) | undefined;
97240
+ /** Guest entrance IDs in the Visionline access system. */
97241
+ guest_acs_entrance_ids?: (string[] | undefined) | undefined;
97242
+ /** Common entrance IDs in the Visionline access system. */
97243
+ common_acs_entrance_ids?: (string[] | undefined) | undefined;
97244
+ /** Indicates whether the credential is valid. */
97245
+ is_valid?: (boolean | undefined) | undefined;
97246
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
97247
+ auto_join?: (boolean | undefined) | undefined;
97248
+ /** ID of the card in the Visionline access system. */
97249
+ card_id?: (string | undefined) | undefined;
97250
+ /** ID of the credential in the Visionline access system. */
97251
+ credential_id?: (string | undefined) | undefined;
97252
+ } | undefined;
97253
+ /** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97254
+ assa_abloy_vostio_metadata?: {
97255
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
97256
+ auto_join?: (boolean | undefined) | undefined;
97257
+ /** IDs of the guest entrances to override in the Vostio access system. */
97258
+ override_guest_acs_entrance_ids?: (string[] | undefined) | undefined;
97259
+ /** Key ID in the Vostio access system. */
97260
+ key_id?: (string | undefined) | undefined;
97261
+ /** Key issuing request ID in the Vostio access system. */
97262
+ key_issuing_request_id?: (string | undefined) | undefined;
97263
+ /** Names of the doors to which to grant access in the Vostio access system. */
97264
+ door_names?: (string[] | undefined) | undefined;
97265
+ /** Endpoint ID in the Vostio access system. */
97266
+ endpoint_id?: (string | undefined) | undefined;
97267
+ } | undefined;
97268
+ /** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97269
+ akiles_metadata?: {
97270
+ /** ID of the Akiles member PIN. */
97271
+ member_pin_id?: (string | undefined) | undefined;
97272
+ } | undefined;
97273
+ is_managed: false;
97274
+ };
97275
+ } | {
97276
+ /** ID of the action attempt. */
97277
+ action_attempt_id: string;
97278
+ status: 'error';
97279
+ /** Result of the action attempt. Null for failed action attempts. */
97280
+ result: null;
97281
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
97282
+ action_type: 'ENCODE_CREDENTIAL';
97283
+ error: {
97284
+ /** Type of the error associated with the action attempt. */
97285
+ type: 'uncategorized_error';
97286
+ /** Message for the error associated with the action attempt. */
97287
+ message: string;
97288
+ } | {
97289
+ /** Type of the error associated with the action attempt. */
97290
+ type: 'action_attempt_expired';
97291
+ /** Message for the error associated with the action attempt. */
97292
+ message: string;
97293
+ } | {
97294
+ /** Error type to indicate that there is no credential on the encoder. */
97295
+ type: 'no_credential_on_encoder';
97296
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97297
+ message: string;
97298
+ } | {
97299
+ /** Error type to indicate an incompatible card format. */
97300
+ type: 'incompatible_card_format';
97301
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97302
+ message: string;
97303
+ } | {
97304
+ /** Error type to indicate that the affected credential cannot be reissued. */
97305
+ type: 'credential_cannot_be_reissued';
97306
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97307
+ message: string;
97308
+ } | {
97309
+ /** Error type to indicate that the encoder is not online. */
97310
+ type: 'encoder_not_online';
97311
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97312
+ message: string;
97313
+ } | {
97314
+ /** Error type to indicate that communication with the encoder timed out. */
97315
+ type: 'encoder_communication_timeout';
97316
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97317
+ message: string;
97318
+ } | {
97319
+ /** Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system. */
97320
+ type: 'bridge_disconnected';
97321
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97322
+ message: string;
97323
+ } | {
97324
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
97325
+ type: 'encoding_interrupted';
97326
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97327
+ message: string;
97328
+ } | {
97329
+ /** Error type to indicate that the credential was deleted and can no longer be encoded. */
97330
+ type: 'credential_deleted';
97331
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97332
+ message: string;
97333
+ };
97334
+ } | {
97335
+ /** ID of the action attempt. */
97336
+ action_attempt_id: string;
97337
+ status: 'pending';
97338
+ /** Result of the action attempt. Null for pending action attempts. */
97339
+ result: null;
97340
+ /** Errors associated with the action attempt. Null for pending action attempts. */
97341
+ error: null;
97342
+ /** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
97343
+ action_type: 'SCAN_TO_ASSIGN_CREDENTIAL';
97344
+ } | {
97345
+ /** ID of the action attempt. */
97346
+ action_attempt_id: string;
97347
+ status: 'success';
97348
+ /** Errors associated with the action attempt. Null for successful action attempts. */
97349
+ error: null;
97350
+ /** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
97351
+ action_type: 'SCAN_TO_ASSIGN_CREDENTIAL';
97352
+ /** Result of a scan to assign attempt. If the attempt was successful, includes the credential data that was scanned and assigned. */
97353
+ result: {
97354
+ /** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97355
+ acs_credential_id: string;
97356
+ /** ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
97357
+ acs_user_id?: string | undefined;
97358
+ /** ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
97359
+ user_identity_id?: string | undefined;
97360
+ /** ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
97361
+ connected_account_id: string;
97362
+ /** ID of the credential pool to which the credential belongs. */
97363
+ acs_credential_pool_id?: string | undefined;
97364
+ /** ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97365
+ acs_system_id: string;
97366
+ /** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97367
+ parent_acs_credential_id?: string | undefined;
97368
+ /** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
97369
+ display_name: string;
97370
+ /** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97371
+ code?: (string | undefined) | null;
97372
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
97373
+ is_one_time_use?: boolean | undefined;
97374
+ /** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97375
+ card_number?: (string | undefined) | null;
97376
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
97377
+ is_issued?: boolean | undefined;
97378
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
97379
+ issued_at?: (string | undefined) | null;
97380
+ /** Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
97381
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
97382
+ /** Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
97383
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card' | 'salto_ks_tag' | 'avigilon_alta_credential' | 'kisi_credential' | 'akiles_credential') | undefined;
97384
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
97385
+ external_type_display_name?: string | undefined;
97386
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
97387
+ created_at: string;
97388
+ /** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97389
+ workspace_id: string;
97390
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
97391
+ starts_at?: string | undefined;
97392
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
97393
+ ends_at?: string | undefined;
97394
+ /** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97395
+ errors: {
97396
+ error_code: string;
97397
+ message: string;
97398
+ /** Date and time at which Seam created the error. */
97399
+ created_at: string;
97400
+ }[];
97401
+ /** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97402
+ warnings: ({
97403
+ /** Date and time at which Seam created the warning. */
97404
+ created_at: string;
97405
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97406
+ message: string;
97407
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97408
+ warning_code: 'waiting_to_be_issued';
97409
+ } | {
97410
+ /** Date and time at which Seam created the warning. */
97411
+ created_at: string;
97412
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97413
+ message: string;
97414
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97415
+ warning_code: 'schedule_externally_modified';
97416
+ } | {
97417
+ /** Date and time at which Seam created the warning. */
97418
+ created_at: string;
97419
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97420
+ message: string;
97421
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97422
+ warning_code: 'schedule_modified';
97423
+ } | {
97424
+ /** Date and time at which Seam created the warning. */
97425
+ created_at: string;
97426
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97427
+ message: string;
97428
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97429
+ warning_code: 'being_deleted';
97430
+ } | {
97431
+ /** Date and time at which Seam created the warning. */
97432
+ created_at: string;
97433
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97434
+ message: string;
97435
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97436
+ warning_code: 'unknown_issue_with_acs_credential';
97437
+ } | {
97438
+ /** Date and time at which Seam created the warning. */
97439
+ created_at: string;
97440
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97441
+ message: string;
97442
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97443
+ warning_code: 'needs_to_be_reissued';
97444
+ } | {
97445
+ /** Date and time at which Seam created the warning. */
97446
+ created_at: string;
97447
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97448
+ message: string;
97449
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97450
+ warning_code: 'requested_code_unavailable';
97451
+ /** The originally requested PIN code that could not be used. */
97452
+ original_code: string;
97453
+ /** The PIN code that was assigned instead. */
97454
+ new_code: string;
97455
+ })[];
97456
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
97457
+ is_multi_phone_sync_credential?: boolean | undefined;
97458
+ /** Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. */
97459
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
97460
+ /** Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
97461
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
97462
+ /** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97463
+ visionline_metadata?: {
97464
+ /** Card function type in the Visionline access system. */
97465
+ card_function_type?: (('guest' | 'staff') | undefined) | undefined;
97466
+ /** IDs of the credentials to which you want to join. */
97467
+ joiner_acs_credential_ids?: (string[] | undefined) | undefined;
97468
+ /** Guest entrance IDs in the Visionline access system. */
97469
+ guest_acs_entrance_ids?: (string[] | undefined) | undefined;
97470
+ /** Common entrance IDs in the Visionline access system. */
97471
+ common_acs_entrance_ids?: (string[] | undefined) | undefined;
97472
+ /** Indicates whether the credential is valid. */
97473
+ is_valid?: (boolean | undefined) | undefined;
97474
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
97475
+ auto_join?: (boolean | undefined) | undefined;
97476
+ /** ID of the card in the Visionline access system. */
97477
+ card_id?: (string | undefined) | undefined;
97478
+ /** ID of the credential in the Visionline access system. */
97479
+ credential_id?: (string | undefined) | undefined;
97480
+ } | undefined;
97481
+ /** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97482
+ assa_abloy_vostio_metadata?: {
97483
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
97484
+ auto_join?: (boolean | undefined) | undefined;
97485
+ /** IDs of the guest entrances to override in the Vostio access system. */
97486
+ override_guest_acs_entrance_ids?: (string[] | undefined) | undefined;
97487
+ /** Key ID in the Vostio access system. */
97488
+ key_id?: (string | undefined) | undefined;
97489
+ /** Key issuing request ID in the Vostio access system. */
97490
+ key_issuing_request_id?: (string | undefined) | undefined;
97491
+ /** Names of the doors to which to grant access in the Vostio access system. */
97492
+ door_names?: (string[] | undefined) | undefined;
97493
+ /** Endpoint ID in the Vostio access system. */
97494
+ endpoint_id?: (string | undefined) | undefined;
97495
+ } | undefined;
97496
+ /** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
97497
+ akiles_metadata?: {
97498
+ /** ID of the Akiles member PIN. */
97499
+ member_pin_id?: (string | undefined) | undefined;
97500
+ } | undefined;
97501
+ /** Indicates whether Seam manages the credential. */
97502
+ is_managed: true;
97503
+ };
97504
+ } | {
97505
+ /** ID of the action attempt. */
97506
+ action_attempt_id: string;
97507
+ status: 'error';
97508
+ /** Result of the action attempt. Null for failed action attempts. */
97509
+ result: null;
97510
+ /** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
97511
+ action_type: 'SCAN_TO_ASSIGN_CREDENTIAL';
97512
+ error: {
97513
+ /** Type of the error associated with the action attempt. */
97514
+ type: 'uncategorized_error';
97515
+ /** Message for the error associated with the action attempt. */
97516
+ message: string;
97517
+ } | {
97518
+ /** Type of the error associated with the action attempt. */
97519
+ type: 'action_attempt_expired';
97520
+ /** Message for the error associated with the action attempt. */
97521
+ message: string;
97522
+ } | {
97523
+ /** Error type to indicate that there is no credential on the encoder. */
97524
+ type: 'no_credential_on_encoder';
97525
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97526
+ message: string;
97527
+ };
97528
+ } | {
97529
+ /** ID of the action attempt. */
97530
+ action_attempt_id: string;
97531
+ status: 'pending';
97532
+ /** Result of the action attempt. Null for pending action attempts. */
97533
+ result: null;
97534
+ /** Errors associated with the action attempt. Null for pending action attempts. */
97535
+ error: null;
97536
+ /** Action attempt to track the status of assigning a pre-registered card credential to an access method. */
97537
+ action_type: 'ASSIGN_CREDENTIAL';
97538
+ } | {
97539
+ /** ID of the action attempt. */
97540
+ action_attempt_id: string;
97541
+ status: 'success';
97542
+ /** Errors associated with the action attempt. Null for successful action attempts. */
97543
+ error: null;
97544
+ /** Action attempt to track the status of assigning a pre-registered card credential to an access method. */
97545
+ action_type: 'ASSIGN_CREDENTIAL';
97546
+ /** Result of assigning a credential. If successful, includes the updated access method with the assigned credential. */
97547
+ result: {
97548
+ /** ID of the Seam workspace associated with the access method. */
97549
+ workspace_id: string;
97550
+ /** ID of the access method. */
97551
+ access_method_id: string;
97552
+ /** Display name of the access method. */
97553
+ display_name: string;
97554
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
97555
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
97556
+ /** Date and time at which the access method was created. */
97557
+ created_at: string;
97558
+ /** Date and time at which the access method was issued. */
97559
+ issued_at: string | null;
97560
+ /** Indicates whether the access method has been issued. */
97561
+ is_issued: boolean;
97562
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
97563
+ display_status: string;
97564
+ /** URL of the Instant Key for mobile key access methods. */
97565
+ instant_key_url?: string | undefined;
97566
+ /** Token of the client session associated with the access method. */
97567
+ client_session_token?: string | undefined;
97568
+ /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
97569
+ is_encoding_required?: boolean | undefined;
97570
+ /** Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued. */
97571
+ is_ready_for_encoding?: boolean | undefined;
97572
+ /** Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment. */
97573
+ is_assignment_required?: boolean | undefined;
97574
+ /** Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment. */
97575
+ is_ready_for_assignment?: boolean | undefined;
97576
+ /** The actual PIN code for code access methods. */
97577
+ code?: (string | null) | undefined;
97578
+ /** Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */
97579
+ warnings: ({
97580
+ /** Date and time at which Seam created the warning. */
97581
+ created_at: string;
97582
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97583
+ message: string;
97584
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97585
+ warning_code: 'being_deleted';
97586
+ } | {
97587
+ /** Date and time at which Seam created the warning. */
97588
+ created_at: string;
97589
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97590
+ message: string;
97591
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97592
+ warning_code: 'updating_access_times';
97593
+ } | {
97594
+ /** Date and time at which Seam created the warning. */
97595
+ created_at: string;
97596
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97597
+ message: string;
97598
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97599
+ warning_code: 'pulled_backup_access_code';
97600
+ /** ID of the original access method from which this backup access method was split, if applicable. */
97601
+ original_access_method_id?: string | undefined;
97602
+ } | {
97603
+ /** Date and time at which Seam created the warning. */
97604
+ created_at: string;
97605
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97606
+ message: string;
97607
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97608
+ warning_code: 'delay_in_issuing';
97609
+ } | {
97610
+ /** Date and time at which Seam created the warning. */
97611
+ created_at: string;
97612
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97613
+ message: string;
97614
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97615
+ warning_code: 'user_identity_missing_email_address';
97616
+ } | {
97617
+ /** Date and time at which Seam created the warning. */
97618
+ created_at: string;
97619
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97620
+ message: string;
97621
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97622
+ warning_code: 'user_identity_missing_phone_number';
97623
+ })[];
97624
+ /** Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */
97625
+ errors: {
97626
+ /** Date and time at which Seam created the error. */
97627
+ created_at: string;
97628
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97629
+ message: string;
97630
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
97631
+ error_code: 'failed_to_issue';
97632
+ }[];
97633
+ /** Pending mutations for the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress. */
97634
+ pending_mutations: ({
97635
+ /** Date and time at which the mutation was created. */
97636
+ created_at: string;
97637
+ /** Detailed description of the mutation. */
97638
+ message: string;
97639
+ /** Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices. */
97640
+ mutation_code: 'provisioning_access';
97641
+ /** Previous device configuration. */
97642
+ from: {
97643
+ /** Previous device IDs where access was provisioned. */
97644
+ device_ids: string[];
97645
+ };
97646
+ /** New device configuration. */
97647
+ to: {
97648
+ /** New device IDs where access is being provisioned. */
97649
+ device_ids: string[];
97650
+ };
97651
+ } | {
97652
+ /** Date and time at which the mutation was created. */
97653
+ created_at: string;
97654
+ /** Detailed description of the mutation. */
97655
+ message: string;
97656
+ /** Mutation code to indicate that Seam is in the process of revoking access for this access method from devices. */
97657
+ mutation_code: 'revoking_access';
97658
+ /** Previous device configuration. */
97659
+ from: {
97660
+ /** Previous device IDs where access existed. */
97661
+ device_ids: string[];
97662
+ };
97663
+ /** New device configuration. */
97664
+ to: {
97665
+ /** New device IDs where access should remain. */
97666
+ device_ids: string[];
97667
+ };
97668
+ } | {
97669
+ /** Date and time at which the mutation was created. */
97670
+ created_at: string;
97671
+ /** Detailed description of the mutation. */
97672
+ message: string;
97673
+ /** Mutation code to indicate that Seam is in the process of updating the access times for this access method. */
97674
+ mutation_code: 'updating_access_times';
97675
+ /** Previous access time configuration. */
97676
+ from: {
97677
+ /** Previous start time for access. */
97678
+ starts_at: string | null;
97679
+ /** Previous end time for access. */
97680
+ ends_at: string | null;
97681
+ };
97682
+ /** New access time configuration. */
97683
+ to: {
97684
+ /** New start time for access. */
97685
+ starts_at: string | null;
97686
+ /** New end time for access. */
97687
+ ends_at: string | null;
97688
+ };
97689
+ })[];
97690
+ /** ID of the customization profile associated with the access method. */
97691
+ customization_profile_id?: string | undefined;
97692
+ };
97693
+ } | {
97694
+ /** ID of the action attempt. */
97695
+ action_attempt_id: string;
97696
+ status: 'error';
97697
+ /** Result of the action attempt. Null for failed action attempts. */
97698
+ result: null;
97699
+ /** Action attempt to track the status of assigning a pre-registered card credential to an access method. */
97700
+ action_type: 'ASSIGN_CREDENTIAL';
97701
+ error: {
97702
+ /** Type of the error associated with the action attempt. */
97703
+ type: 'uncategorized_error';
97704
+ /** Message for the error associated with the action attempt. */
97705
+ message: string;
97706
+ } | {
97707
+ /** Type of the error associated with the action attempt. */
97708
+ type: 'action_attempt_expired';
97709
+ /** Message for the error associated with the action attempt. */
97710
+ message: string;
97711
+ } | {
97712
+ /** Error type to indicate that no matching credential was found. */
97713
+ type: 'credential_not_found';
97714
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97715
+ message: string;
97716
+ };
97717
+ } | {
97718
+ /** ID of the action attempt. */
97719
+ action_attempt_id: string;
97720
+ status: 'pending';
97721
+ /** Result of the action attempt. Null for pending action attempts. */
97722
+ result: null;
97723
+ /** Errors associated with the action attempt. Null for pending action attempts. */
97724
+ error: null;
97725
+ /** Action attempt to track the status of resetting a sandbox workspace. */
97726
+ action_type: 'RESET_SANDBOX_WORKSPACE';
97727
+ } | {
97728
+ /** ID of the action attempt. */
97729
+ action_attempt_id: string;
97730
+ status: 'success';
97731
+ /** Errors associated with the action attempt. Null for successful action attempts. */
97732
+ error: null;
97733
+ /** Action attempt to track the status of resetting a sandbox workspace. */
97734
+ action_type: 'RESET_SANDBOX_WORKSPACE';
97735
+ /** Result of the action. */
97736
+ result: {};
97737
+ } | {
97738
+ /** ID of the action attempt. */
97739
+ action_attempt_id: string;
97740
+ status: 'error';
97741
+ /** Result of the action attempt. Null for failed action attempts. */
97742
+ result: null;
97743
+ /** Action attempt to track the status of resetting a sandbox workspace. */
97744
+ action_type: 'RESET_SANDBOX_WORKSPACE';
97745
+ /** Error associated with the action. */
97746
+ error: {
97747
+ /** Type of the error. */
97748
+ type: string;
97749
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97750
+ message: string;
97751
+ };
97752
+ } | {
97753
+ /** ID of the action attempt. */
97754
+ action_attempt_id: string;
97755
+ status: 'pending';
97756
+ /** Result of the action attempt. Null for pending action attempts. */
97757
+ result: null;
97758
+ /** Errors associated with the action attempt. Null for pending action attempts. */
97759
+ error: null;
97760
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
97761
+ action_type: 'SET_FAN_MODE';
97762
+ } | {
97763
+ /** ID of the action attempt. */
97764
+ action_attempt_id: string;
97765
+ status: 'success';
97766
+ /** Errors associated with the action attempt. Null for successful action attempts. */
97767
+ error: null;
97768
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
97769
+ action_type: 'SET_FAN_MODE';
97770
+ /** Result of the action. */
97771
+ result: {};
97772
+ } | {
97773
+ /** ID of the action attempt. */
97774
+ action_attempt_id: string;
97775
+ status: 'error';
97776
+ /** Result of the action attempt. Null for failed action attempts. */
97777
+ result: null;
97778
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
97779
+ action_type: 'SET_FAN_MODE';
97780
+ /** Error associated with the action. */
97781
+ error: {
97782
+ /** Type of the error. */
97783
+ type: string;
97784
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97785
+ message: string;
97786
+ };
97787
+ } | {
97788
+ /** ID of the action attempt. */
97789
+ action_attempt_id: string;
97790
+ status: 'pending';
97791
+ /** Result of the action attempt. Null for pending action attempts. */
97792
+ result: null;
97793
+ /** Errors associated with the action attempt. Null for pending action attempts. */
97794
+ error: null;
97795
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
97796
+ action_type: 'SET_HVAC_MODE';
97797
+ } | {
97798
+ /** ID of the action attempt. */
97799
+ action_attempt_id: string;
97800
+ status: 'success';
97801
+ /** Errors associated with the action attempt. Null for successful action attempts. */
97802
+ error: null;
97803
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
97804
+ action_type: 'SET_HVAC_MODE';
97805
+ /** Result of the action. */
97806
+ result: {};
97807
+ } | {
97808
+ /** ID of the action attempt. */
97809
+ action_attempt_id: string;
97810
+ status: 'error';
97811
+ /** Result of the action attempt. Null for failed action attempts. */
97812
+ result: null;
97813
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
97814
+ action_type: 'SET_HVAC_MODE';
97815
+ /** Error associated with the action. */
97816
+ error: {
97817
+ /** Type of the error. */
97818
+ type: string;
97819
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97820
+ message: string;
97821
+ };
97822
+ } | {
97823
+ /** ID of the action attempt. */
97824
+ action_attempt_id: string;
97825
+ status: 'pending';
97826
+ /** Result of the action attempt. Null for pending action attempts. */
97827
+ result: null;
97828
+ /** Errors associated with the action attempt. Null for pending action attempts. */
97829
+ error: null;
97830
+ /** Action attempt to track the status of a climate preset activation. */
97831
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
97832
+ } | {
97833
+ /** ID of the action attempt. */
97834
+ action_attempt_id: string;
97835
+ status: 'success';
97836
+ /** Errors associated with the action attempt. Null for successful action attempts. */
97837
+ error: null;
97838
+ /** Action attempt to track the status of a climate preset activation. */
97839
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
97840
+ /** Result of the action. */
97841
+ result: {};
97842
+ } | {
97843
+ /** ID of the action attempt. */
97844
+ action_attempt_id: string;
97845
+ status: 'error';
97846
+ /** Result of the action attempt. Null for failed action attempts. */
97847
+ result: null;
97848
+ /** Action attempt to track the status of a climate preset activation. */
97849
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
97850
+ /** Error associated with the action. */
97851
+ error: {
97852
+ /** Type of the error. */
97853
+ type: string;
97854
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97855
+ message: string;
97856
+ };
97857
+ } | {
97858
+ /** ID of the action attempt. */
97859
+ action_attempt_id: string;
97860
+ status: 'pending';
97861
+ /** Result of the action attempt. Null for pending action attempts. */
97862
+ result: null;
97863
+ /** Errors associated with the action attempt. Null for pending action attempts. */
97864
+ error: null;
97865
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
97866
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
97867
+ } | {
97868
+ /** ID of the action attempt. */
97869
+ action_attempt_id: string;
97870
+ status: 'success';
97871
+ /** Errors associated with the action attempt. Null for successful action attempts. */
97872
+ error: null;
97873
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
97874
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
97875
+ /** Result of the action. */
97876
+ result: {};
97877
+ } | {
97878
+ /** ID of the action attempt. */
97879
+ action_attempt_id: string;
97880
+ status: 'error';
97881
+ /** Result of the action attempt. Null for failed action attempts. */
97882
+ result: null;
97883
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
97884
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
97885
+ /** Error associated with the action. */
97886
+ error: {
97887
+ /** Type of the error. */
97888
+ type: string;
97889
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97890
+ message: string;
97891
+ };
97892
+ } | {
97893
+ /** ID of the action attempt. */
97894
+ action_attempt_id: string;
97895
+ status: 'pending';
97896
+ /** Result of the action attempt. Null for pending action attempts. */
97897
+ result: null;
97898
+ /** Errors associated with the action attempt. Null for pending action attempts. */
97899
+ error: null;
97900
+ /** Action attempt to track the status of simulating a keypad code entry. */
97901
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
97902
+ } | {
97903
+ /** ID of the action attempt. */
97904
+ action_attempt_id: string;
97905
+ status: 'success';
97906
+ /** Errors associated with the action attempt. Null for successful action attempts. */
97907
+ error: null;
97908
+ /** Action attempt to track the status of simulating a keypad code entry. */
97909
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
97910
+ /** Result of the action. */
97911
+ result: {};
97912
+ } | {
97913
+ /** ID of the action attempt. */
97914
+ action_attempt_id: string;
97915
+ status: 'error';
97916
+ /** Result of the action attempt. Null for failed action attempts. */
97917
+ result: null;
97918
+ /** Action attempt to track the status of simulating a keypad code entry. */
97919
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
97920
+ /** Error associated with the action. */
97921
+ error: {
97922
+ /** Type of the error. */
97923
+ type: string;
97924
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97925
+ message: string;
97926
+ };
97927
+ } | {
97928
+ /** ID of the action attempt. */
97929
+ action_attempt_id: string;
97930
+ status: 'pending';
97931
+ /** Result of the action attempt. Null for pending action attempts. */
97932
+ result: null;
97933
+ /** Errors associated with the action attempt. Null for pending action attempts. */
97934
+ error: null;
97935
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
97936
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
97937
+ } | {
97938
+ /** ID of the action attempt. */
97939
+ action_attempt_id: string;
97940
+ status: 'success';
97941
+ /** Errors associated with the action attempt. Null for successful action attempts. */
97942
+ error: null;
97943
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
97944
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
97945
+ /** Result of the action. */
97946
+ result: {};
97947
+ } | {
97948
+ /** ID of the action attempt. */
97949
+ action_attempt_id: string;
97950
+ status: 'error';
97951
+ /** Result of the action attempt. Null for failed action attempts. */
97952
+ result: null;
97953
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
97954
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
97955
+ /** Error associated with the action. */
97956
+ error: {
97957
+ /** Type of the error. */
97958
+ type: string;
97959
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97960
+ message: string;
97961
+ };
97962
+ } | {
97963
+ /** ID of the action attempt. */
97964
+ action_attempt_id: string;
97965
+ status: 'pending';
97966
+ /** Result of the action attempt. Null for pending action attempts. */
97967
+ result: null;
97968
+ /** Errors associated with the action attempt. Null for pending action attempts. */
97969
+ error: null;
97970
+ /** Action attempt to track the status of pushing thermostat programs. */
97971
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS';
97972
+ } | {
97973
+ /** ID of the action attempt. */
97974
+ action_attempt_id: string;
97975
+ status: 'success';
97976
+ /** Errors associated with the action attempt. Null for successful action attempts. */
97977
+ error: null;
97978
+ /** Action attempt to track the status of pushing thermostat programs. */
97979
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS';
97980
+ /** Result of the action. */
97981
+ result: {};
97982
+ } | {
97983
+ /** ID of the action attempt. */
97984
+ action_attempt_id: string;
97985
+ status: 'error';
97986
+ /** Result of the action attempt. Null for failed action attempts. */
97987
+ result: null;
97988
+ /** Action attempt to track the status of pushing thermostat programs. */
97989
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS';
97990
+ /** Error associated with the action. */
97991
+ error: {
97992
+ /** Type of the error. */
97993
+ type: string;
97994
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97995
+ message: string;
97996
+ };
97997
+ } | {
97998
+ /** ID of the action attempt. */
97999
+ action_attempt_id: string;
98000
+ status: 'pending';
98001
+ /** Result of the action attempt. Null for pending action attempts. */
98002
+ result: null;
98003
+ /** Errors associated with the action attempt. Null for pending action attempts. */
98004
+ error: null;
98005
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
98006
+ action_type: 'CONFIGURE_AUTO_LOCK';
98007
+ } | {
98008
+ /** ID of the action attempt. */
98009
+ action_attempt_id: string;
98010
+ status: 'success';
98011
+ /** Errors associated with the action attempt. Null for successful action attempts. */
98012
+ error: null;
98013
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
98014
+ action_type: 'CONFIGURE_AUTO_LOCK';
98015
+ /** Result of the action. */
98016
+ result: {};
98017
+ } | {
98018
+ /** ID of the action attempt. */
98019
+ action_attempt_id: string;
98020
+ status: 'error';
98021
+ /** Result of the action attempt. Null for failed action attempts. */
98022
+ result: null;
98023
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
98024
+ action_type: 'CONFIGURE_AUTO_LOCK';
98025
+ /** Error associated with the action. */
98026
+ error: {
98027
+ /** Type of the error. */
98028
+ type: string;
98029
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98030
+ message: string;
98031
+ };
98032
+ } | {
98033
+ /** ID of the action attempt. */
98034
+ action_attempt_id: string;
98035
+ status: 'pending';
98036
+ /** Result of the action attempt. Null for pending action attempts. */
98037
+ result: null;
98038
+ /** Errors associated with the action attempt. Null for pending action attempts. */
98039
+ error: null;
98040
+ /** Syncing access codes is pending. */
98041
+ action_type: 'SYNC_ACCESS_CODES';
98042
+ } | {
98043
+ /** ID of the action attempt. */
98044
+ action_attempt_id: string;
98045
+ status: 'success';
98046
+ /** Errors associated with the action attempt. Null for successful action attempts. */
98047
+ error: null;
98048
+ /** Syncing access codes succeeded. */
98049
+ action_type: 'SYNC_ACCESS_CODES';
98050
+ /** Result of the action. */
98051
+ result: {};
98052
+ } | {
98053
+ /** ID of the action attempt. */
98054
+ action_attempt_id: string;
98055
+ status: 'error';
98056
+ /** Result of the action attempt. Null for failed action attempts. */
98057
+ result: null;
98058
+ /** Syncing access codes failed. */
98059
+ action_type: 'SYNC_ACCESS_CODES';
98060
+ /** Error associated with the action. */
98061
+ error: {
98062
+ /** Type of the error. */
98063
+ type: string;
98064
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98065
+ message: string;
98066
+ };
98067
+ } | {
98068
+ /** ID of the action attempt. */
98069
+ action_attempt_id: string;
98070
+ status: 'pending';
98071
+ /** Result of the action attempt. Null for pending action attempts. */
98072
+ result: null;
98073
+ /** Errors associated with the action attempt. Null for pending action attempts. */
98074
+ error: null;
98075
+ /** Creating an access code is pending. */
98076
+ action_type: 'CREATE_ACCESS_CODE';
98077
+ } | {
98078
+ /** ID of the action attempt. */
98079
+ action_attempt_id: string;
98080
+ status: 'success';
98081
+ /** Errors associated with the action attempt. Null for successful action attempts. */
98082
+ error: null;
98083
+ /** Creating an access code succeeded. */
98084
+ action_type: 'CREATE_ACCESS_CODE';
98085
+ /** Result of the action. */
98086
+ result: {
98087
+ /** Created access code. */
98088
+ access_code: {
98089
+ [x: string]: any;
98090
+ };
98091
+ };
98092
+ } | {
98093
+ /** ID of the action attempt. */
98094
+ action_attempt_id: string;
98095
+ status: 'error';
98096
+ /** Result of the action attempt. Null for failed action attempts. */
98097
+ result: null;
98098
+ /** Creating an access code failed. */
98099
+ action_type: 'CREATE_ACCESS_CODE';
98100
+ /** Error associated with the action. */
98101
+ error: {
98102
+ /** Type of the error. */
98103
+ type: string;
98104
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98105
+ message: string;
98106
+ };
98107
+ } | {
98108
+ /** ID of the action attempt. */
98109
+ action_attempt_id: string;
98110
+ status: 'pending';
98111
+ /** Result of the action attempt. Null for pending action attempts. */
98112
+ result: null;
98113
+ /** Errors associated with the action attempt. Null for pending action attempts. */
98114
+ error: null;
98115
+ /** Deleting an access code is pending. */
98116
+ action_type: 'DELETE_ACCESS_CODE';
98117
+ } | {
98118
+ /** ID of the action attempt. */
98119
+ action_attempt_id: string;
98120
+ status: 'success';
98121
+ /** Errors associated with the action attempt. Null for successful action attempts. */
98122
+ error: null;
98123
+ /** Deleting an access code succeeded. */
98124
+ action_type: 'DELETE_ACCESS_CODE';
98125
+ /** Result of the action. */
98126
+ result: {};
98127
+ } | {
98128
+ /** ID of the action attempt. */
98129
+ action_attempt_id: string;
98130
+ status: 'error';
98131
+ /** Result of the action attempt. Null for failed action attempts. */
98132
+ result: null;
98133
+ /** Deleting an access code failed. */
98134
+ action_type: 'DELETE_ACCESS_CODE';
98135
+ /** Error associated with the action. */
98136
+ error: {
98137
+ /** Type of the error. */
98138
+ type: string;
98139
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98140
+ message: string;
98141
+ };
98142
+ } | {
98143
+ /** ID of the action attempt. */
98144
+ action_attempt_id: string;
98145
+ status: 'pending';
98146
+ /** Result of the action attempt. Null for pending action attempts. */
98147
+ result: null;
98148
+ /** Errors associated with the action attempt. Null for pending action attempts. */
98149
+ error: null;
98150
+ /** Updating an access code is pending. */
98151
+ action_type: 'UPDATE_ACCESS_CODE';
98152
+ } | {
98153
+ /** ID of the action attempt. */
98154
+ action_attempt_id: string;
98155
+ status: 'success';
98156
+ /** Errors associated with the action attempt. Null for successful action attempts. */
98157
+ error: null;
98158
+ /** Updating an access code succeeded. */
98159
+ action_type: 'UPDATE_ACCESS_CODE';
98160
+ /** Result of the action. */
98161
+ result: {
98162
+ /** Updated access code. */
98163
+ access_code?: {
98164
+ [x: string]: any;
98165
+ } | undefined;
98166
+ };
98167
+ } | {
98168
+ /** ID of the action attempt. */
98169
+ action_attempt_id: string;
98170
+ status: 'error';
98171
+ /** Result of the action attempt. Null for failed action attempts. */
98172
+ result: null;
98173
+ /** Updating an access code failed. */
98174
+ action_type: 'UPDATE_ACCESS_CODE';
98175
+ /** Error associated with the action. */
98176
+ error: {
98177
+ /** Type of the error. */
98178
+ type: string;
98179
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98180
+ message: string;
98181
+ };
98182
+ } | {
98183
+ /** ID of the action attempt. */
98184
+ action_attempt_id: string;
98185
+ status: 'pending';
98186
+ /** Result of the action attempt. Null for pending action attempts. */
98187
+ result: null;
98188
+ /** Errors associated with the action attempt. Null for pending action attempts. */
98189
+ error: null;
98190
+ /** Creating a noise threshold is pending. */
98191
+ action_type: 'CREATE_NOISE_THRESHOLD';
98192
+ } | {
98193
+ /** ID of the action attempt. */
98194
+ action_attempt_id: string;
98195
+ status: 'success';
98196
+ /** Errors associated with the action attempt. Null for successful action attempts. */
98197
+ error: null;
98198
+ /** Creating a noise threshold succeeded. */
98199
+ action_type: 'CREATE_NOISE_THRESHOLD';
98200
+ /** Result of the action. */
98201
+ result: {
98202
+ /** Created noise threshold. */
98203
+ noise_threshold: {
98204
+ [x: string]: any;
98205
+ };
98206
+ };
98207
+ } | {
98208
+ /** ID of the action attempt. */
98209
+ action_attempt_id: string;
98210
+ status: 'error';
98211
+ /** Result of the action attempt. Null for failed action attempts. */
98212
+ result: null;
98213
+ /** Creating a noise threshold failed. */
98214
+ action_type: 'CREATE_NOISE_THRESHOLD';
98215
+ /** Error associated with the action. */
98216
+ error: {
98217
+ /** Type of the error. */
98218
+ type: string;
98219
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98220
+ message: string;
98221
+ };
98222
+ } | {
98223
+ /** ID of the action attempt. */
98224
+ action_attempt_id: string;
98225
+ status: 'pending';
98226
+ /** Result of the action attempt. Null for pending action attempts. */
98227
+ result: null;
98228
+ /** Errors associated with the action attempt. Null for pending action attempts. */
98229
+ error: null;
98230
+ /** Deleting a noise threshold is pending. */
98231
+ action_type: 'DELETE_NOISE_THRESHOLD';
98232
+ } | {
98233
+ /** ID of the action attempt. */
98234
+ action_attempt_id: string;
98235
+ status: 'success';
98236
+ /** Errors associated with the action attempt. Null for successful action attempts. */
98237
+ error: null;
98238
+ /** Deleting a noise threshold succeeded. */
98239
+ action_type: 'DELETE_NOISE_THRESHOLD';
98240
+ /** Result of the action. */
98241
+ result: {};
98242
+ } | {
98243
+ /** ID of the action attempt. */
98244
+ action_attempt_id: string;
98245
+ status: 'error';
98246
+ /** Result of the action attempt. Null for failed action attempts. */
98247
+ result: null;
98248
+ /** Deleting a noise threshold failed. */
98249
+ action_type: 'DELETE_NOISE_THRESHOLD';
98250
+ /** Error associated with the action. */
98251
+ error: {
98252
+ /** Type of the error. */
98253
+ type: string;
98254
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98255
+ message: string;
98256
+ };
98257
+ } | {
98258
+ /** ID of the action attempt. */
98259
+ action_attempt_id: string;
98260
+ status: 'pending';
98261
+ /** Result of the action attempt. Null for pending action attempts. */
98262
+ result: null;
98263
+ /** Errors associated with the action attempt. Null for pending action attempts. */
98264
+ error: null;
98265
+ /** Updating a noise threshold is pending. */
98266
+ action_type: 'UPDATE_NOISE_THRESHOLD';
98267
+ } | {
98268
+ /** ID of the action attempt. */
98269
+ action_attempt_id: string;
98270
+ status: 'success';
98271
+ /** Errors associated with the action attempt. Null for successful action attempts. */
98272
+ error: null;
98273
+ /** Updating a noise threshold succeeded. */
98274
+ action_type: 'UPDATE_NOISE_THRESHOLD';
98275
+ /** Result of the action. */
98276
+ result: {
98277
+ /** Updated noise threshold. */
98278
+ noise_threshold: {
98279
+ [x: string]: any;
98280
+ };
98281
+ };
98282
+ } | {
98283
+ /** ID of the action attempt. */
98284
+ action_attempt_id: string;
98285
+ status: 'error';
98286
+ /** Result of the action attempt. Null for failed action attempts. */
98287
+ result: null;
98288
+ /** Updating a noise threshold failed. */
98289
+ action_type: 'UPDATE_NOISE_THRESHOLD';
98290
+ /** Error associated with the action. */
98291
+ error: {
98292
+ /** Type of the error. */
98293
+ type: string;
98294
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98295
+ message: string;
98296
+ };
95652
98297
  };
95653
98298
  };
95654
98299
  maxDuration: undefined;
95655
98300
  };
95656
- '/thermostats/activate_climate_preset': {
95657
- route: '/thermostats/activate_climate_preset';
98301
+ '/thermostats/activate_weekly_program': {
98302
+ route: '/thermostats/activate_weekly_program';
95658
98303
  method: 'POST';
95659
98304
  queryParams: {};
95660
98305
  jsonBody: {
95661
- /** ID of the thermostat device for which you want to activate a climate preset. */
98306
+ /** ID of the thermostat device that you want to return to its weekly program. */
95662
98307
  device_id: string;
95663
- /** Climate preset key of the climate preset that you want to activate. */
95664
- climate_preset_key: string;
98308
+ /** */
98309
+ sync?: boolean;
95665
98310
  };
95666
98311
  commonParams: {};
95667
98312
  formData: {};
@@ -97056,6 +99701,41 @@ export type Routes = {
97056
99701
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
97057
99702
  message: string;
97058
99703
  };
99704
+ } | {
99705
+ /** ID of the action attempt. */
99706
+ action_attempt_id: string;
99707
+ status: 'pending';
99708
+ /** Result of the action attempt. Null for pending action attempts. */
99709
+ result: null;
99710
+ /** Errors associated with the action attempt. Null for pending action attempts. */
99711
+ error: null;
99712
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
99713
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
99714
+ } | {
99715
+ /** ID of the action attempt. */
99716
+ action_attempt_id: string;
99717
+ status: 'success';
99718
+ /** Errors associated with the action attempt. Null for successful action attempts. */
99719
+ error: null;
99720
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
99721
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
99722
+ /** Result of the action. */
99723
+ result: {};
99724
+ } | {
99725
+ /** ID of the action attempt. */
99726
+ action_attempt_id: string;
99727
+ status: 'error';
99728
+ /** Result of the action attempt. Null for failed action attempts. */
99729
+ result: null;
99730
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
99731
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
99732
+ /** Error associated with the action. */
99733
+ error: {
99734
+ /** Type of the error. */
99735
+ type: string;
99736
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
99737
+ message: string;
99738
+ };
97059
99739
  } | {
97060
99740
  /** ID of the action attempt. */
97061
99741
  action_attempt_id: string;
@@ -98872,6 +101552,41 @@ export type Routes = {
98872
101552
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
98873
101553
  message: string;
98874
101554
  };
101555
+ } | {
101556
+ /** ID of the action attempt. */
101557
+ action_attempt_id: string;
101558
+ status: 'pending';
101559
+ /** Result of the action attempt. Null for pending action attempts. */
101560
+ result: null;
101561
+ /** Errors associated with the action attempt. Null for pending action attempts. */
101562
+ error: null;
101563
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
101564
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
101565
+ } | {
101566
+ /** ID of the action attempt. */
101567
+ action_attempt_id: string;
101568
+ status: 'success';
101569
+ /** Errors associated with the action attempt. Null for successful action attempts. */
101570
+ error: null;
101571
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
101572
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
101573
+ /** Result of the action. */
101574
+ result: {};
101575
+ } | {
101576
+ /** ID of the action attempt. */
101577
+ action_attempt_id: string;
101578
+ status: 'error';
101579
+ /** Result of the action attempt. Null for failed action attempts. */
101580
+ result: null;
101581
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
101582
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
101583
+ /** Error associated with the action. */
101584
+ error: {
101585
+ /** Type of the error. */
101586
+ type: string;
101587
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101588
+ message: string;
101589
+ };
98875
101590
  } | {
98876
101591
  /** ID of the action attempt. */
98877
101592
  action_attempt_id: string;
@@ -100794,6 +103509,41 @@ export type Routes = {
100794
103509
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
100795
103510
  message: string;
100796
103511
  };
103512
+ } | {
103513
+ /** ID of the action attempt. */
103514
+ action_attempt_id: string;
103515
+ status: 'pending';
103516
+ /** Result of the action attempt. Null for pending action attempts. */
103517
+ result: null;
103518
+ /** Errors associated with the action attempt. Null for pending action attempts. */
103519
+ error: null;
103520
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
103521
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
103522
+ } | {
103523
+ /** ID of the action attempt. */
103524
+ action_attempt_id: string;
103525
+ status: 'success';
103526
+ /** Errors associated with the action attempt. Null for successful action attempts. */
103527
+ error: null;
103528
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
103529
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
103530
+ /** Result of the action. */
103531
+ result: {};
103532
+ } | {
103533
+ /** ID of the action attempt. */
103534
+ action_attempt_id: string;
103535
+ status: 'error';
103536
+ /** Result of the action attempt. Null for failed action attempts. */
103537
+ result: null;
103538
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
103539
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
103540
+ /** Error associated with the action. */
103541
+ error: {
103542
+ /** Type of the error. */
103543
+ type: string;
103544
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
103545
+ message: string;
103546
+ };
100797
103547
  } | {
100798
103548
  /** ID of the action attempt. */
100799
103549
  action_attempt_id: string;
@@ -102737,6 +105487,8 @@ export type Routes = {
102737
105487
  can_hvac_heat_cool?: boolean | undefined;
102738
105488
  /** Indicates whether the thermostat can be turned off. */
102739
105489
  can_turn_off_hvac?: boolean | undefined;
105490
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
105491
+ can_activate_weekly_program?: boolean | undefined;
102740
105492
  /** Indicates whether the device supports simulating removal in a sandbox. */
102741
105493
  can_simulate_removal?: boolean | undefined;
102742
105494
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -104172,6 +106924,41 @@ export type Routes = {
104172
106924
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
104173
106925
  message: string;
104174
106926
  };
106927
+ } | {
106928
+ /** ID of the action attempt. */
106929
+ action_attempt_id: string;
106930
+ status: 'pending';
106931
+ /** Result of the action attempt. Null for pending action attempts. */
106932
+ result: null;
106933
+ /** Errors associated with the action attempt. Null for pending action attempts. */
106934
+ error: null;
106935
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
106936
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
106937
+ } | {
106938
+ /** ID of the action attempt. */
106939
+ action_attempt_id: string;
106940
+ status: 'success';
106941
+ /** Errors associated with the action attempt. Null for successful action attempts. */
106942
+ error: null;
106943
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
106944
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
106945
+ /** Result of the action. */
106946
+ result: {};
106947
+ } | {
106948
+ /** ID of the action attempt. */
106949
+ action_attempt_id: string;
106950
+ status: 'error';
106951
+ /** Result of the action attempt. Null for failed action attempts. */
106952
+ result: null;
106953
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
106954
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
106955
+ /** Error associated with the action. */
106956
+ error: {
106957
+ /** Type of the error. */
106958
+ type: string;
106959
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
106960
+ message: string;
106961
+ };
104175
106962
  } | {
104176
106963
  /** ID of the action attempt. */
104177
106964
  action_attempt_id: string;
@@ -105992,6 +108779,41 @@ export type Routes = {
105992
108779
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
105993
108780
  message: string;
105994
108781
  };
108782
+ } | {
108783
+ /** ID of the action attempt. */
108784
+ action_attempt_id: string;
108785
+ status: 'pending';
108786
+ /** Result of the action attempt. Null for pending action attempts. */
108787
+ result: null;
108788
+ /** Errors associated with the action attempt. Null for pending action attempts. */
108789
+ error: null;
108790
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
108791
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
108792
+ } | {
108793
+ /** ID of the action attempt. */
108794
+ action_attempt_id: string;
108795
+ status: 'success';
108796
+ /** Errors associated with the action attempt. Null for successful action attempts. */
108797
+ error: null;
108798
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
108799
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
108800
+ /** Result of the action. */
108801
+ result: {};
108802
+ } | {
108803
+ /** ID of the action attempt. */
108804
+ action_attempt_id: string;
108805
+ status: 'error';
108806
+ /** Result of the action attempt. Null for failed action attempts. */
108807
+ result: null;
108808
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
108809
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
108810
+ /** Error associated with the action. */
108811
+ error: {
108812
+ /** Type of the error. */
108813
+ type: string;
108814
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
108815
+ message: string;
108816
+ };
105995
108817
  } | {
105996
108818
  /** ID of the action attempt. */
105997
108819
  action_attempt_id: string;
@@ -107927,6 +110749,8 @@ export type Routes = {
107927
110749
  can_hvac_heat_cool?: boolean | undefined;
107928
110750
  /** Indicates whether the thermostat can be turned off. */
107929
110751
  can_turn_off_hvac?: boolean | undefined;
110752
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
110753
+ can_activate_weekly_program?: boolean | undefined;
107930
110754
  /** Indicates whether the device supports simulating removal in a sandbox. */
107931
110755
  can_simulate_removal?: boolean | undefined;
107932
110756
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -109457,6 +112281,8 @@ export type Routes = {
109457
112281
  can_hvac_heat_cool?: boolean | undefined;
109458
112282
  /** Indicates whether the thermostat can be turned off. */
109459
112283
  can_turn_off_hvac?: boolean | undefined;
112284
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
112285
+ can_activate_weekly_program?: boolean | undefined;
109460
112286
  /** Indicates whether the device supports simulating removal in a sandbox. */
109461
112287
  can_simulate_removal?: boolean | undefined;
109462
112288
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -110888,6 +113714,41 @@ export type Routes = {
110888
113714
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
110889
113715
  message: string;
110890
113716
  };
113717
+ } | {
113718
+ /** ID of the action attempt. */
113719
+ action_attempt_id: string;
113720
+ status: 'pending';
113721
+ /** Result of the action attempt. Null for pending action attempts. */
113722
+ result: null;
113723
+ /** Errors associated with the action attempt. Null for pending action attempts. */
113724
+ error: null;
113725
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
113726
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
113727
+ } | {
113728
+ /** ID of the action attempt. */
113729
+ action_attempt_id: string;
113730
+ status: 'success';
113731
+ /** Errors associated with the action attempt. Null for successful action attempts. */
113732
+ error: null;
113733
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
113734
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
113735
+ /** Result of the action. */
113736
+ result: {};
113737
+ } | {
113738
+ /** ID of the action attempt. */
113739
+ action_attempt_id: string;
113740
+ status: 'error';
113741
+ /** Result of the action attempt. Null for failed action attempts. */
113742
+ result: null;
113743
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
113744
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
113745
+ /** Error associated with the action. */
113746
+ error: {
113747
+ /** Type of the error. */
113748
+ type: string;
113749
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
113750
+ message: string;
113751
+ };
110891
113752
  } | {
110892
113753
  /** ID of the action attempt. */
110893
113754
  action_attempt_id: string;
@@ -112909,6 +115770,41 @@ export type Routes = {
112909
115770
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
112910
115771
  message: string;
112911
115772
  };
115773
+ } | {
115774
+ /** ID of the action attempt. */
115775
+ action_attempt_id: string;
115776
+ status: 'pending';
115777
+ /** Result of the action attempt. Null for pending action attempts. */
115778
+ result: null;
115779
+ /** Errors associated with the action attempt. Null for pending action attempts. */
115780
+ error: null;
115781
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
115782
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
115783
+ } | {
115784
+ /** ID of the action attempt. */
115785
+ action_attempt_id: string;
115786
+ status: 'success';
115787
+ /** Errors associated with the action attempt. Null for successful action attempts. */
115788
+ error: null;
115789
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
115790
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
115791
+ /** Result of the action. */
115792
+ result: {};
115793
+ } | {
115794
+ /** ID of the action attempt. */
115795
+ action_attempt_id: string;
115796
+ status: 'error';
115797
+ /** Result of the action attempt. Null for failed action attempts. */
115798
+ result: null;
115799
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
115800
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
115801
+ /** Error associated with the action. */
115802
+ error: {
115803
+ /** Type of the error. */
115804
+ type: string;
115805
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
115806
+ message: string;
115807
+ };
112912
115808
  } | {
112913
115809
  /** ID of the action attempt. */
112914
115810
  action_attempt_id: string;
@@ -114752,6 +117648,41 @@ export type Routes = {
114752
117648
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
114753
117649
  message: string;
114754
117650
  };
117651
+ } | {
117652
+ /** ID of the action attempt. */
117653
+ action_attempt_id: string;
117654
+ status: 'pending';
117655
+ /** Result of the action attempt. Null for pending action attempts. */
117656
+ result: null;
117657
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117658
+ error: null;
117659
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
117660
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
117661
+ } | {
117662
+ /** ID of the action attempt. */
117663
+ action_attempt_id: string;
117664
+ status: 'success';
117665
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117666
+ error: null;
117667
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
117668
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
117669
+ /** Result of the action. */
117670
+ result: {};
117671
+ } | {
117672
+ /** ID of the action attempt. */
117673
+ action_attempt_id: string;
117674
+ status: 'error';
117675
+ /** Result of the action attempt. Null for failed action attempts. */
117676
+ result: null;
117677
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
117678
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
117679
+ /** Error associated with the action. */
117680
+ error: {
117681
+ /** Type of the error. */
117682
+ type: string;
117683
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117684
+ message: string;
117685
+ };
114755
117686
  } | {
114756
117687
  /** ID of the action attempt. */
114757
117688
  action_attempt_id: string;
@@ -116707,6 +119638,41 @@ export type Routes = {
116707
119638
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
116708
119639
  message: string;
116709
119640
  };
119641
+ } | {
119642
+ /** ID of the action attempt. */
119643
+ action_attempt_id: string;
119644
+ status: 'pending';
119645
+ /** Result of the action attempt. Null for pending action attempts. */
119646
+ result: null;
119647
+ /** Errors associated with the action attempt. Null for pending action attempts. */
119648
+ error: null;
119649
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
119650
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
119651
+ } | {
119652
+ /** ID of the action attempt. */
119653
+ action_attempt_id: string;
119654
+ status: 'success';
119655
+ /** Errors associated with the action attempt. Null for successful action attempts. */
119656
+ error: null;
119657
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
119658
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
119659
+ /** Result of the action. */
119660
+ result: {};
119661
+ } | {
119662
+ /** ID of the action attempt. */
119663
+ action_attempt_id: string;
119664
+ status: 'error';
119665
+ /** Result of the action attempt. Null for failed action attempts. */
119666
+ result: null;
119667
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
119668
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
119669
+ /** Error associated with the action. */
119670
+ error: {
119671
+ /** Type of the error. */
119672
+ type: string;
119673
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
119674
+ message: string;
119675
+ };
116710
119676
  } | {
116711
119677
  /** ID of the action attempt. */
116712
119678
  action_attempt_id: string;
@@ -119241,6 +122207,8 @@ export type Routes = {
119241
122207
  can_hvac_heat_cool?: boolean | undefined;
119242
122208
  /** Indicates whether the thermostat can be turned off. */
119243
122209
  can_turn_off_hvac?: boolean | undefined;
122210
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
122211
+ can_activate_weekly_program?: boolean | undefined;
119244
122212
  /** Indicates whether the device supports simulating removal in a sandbox. */
119245
122213
  can_simulate_removal?: boolean | undefined;
119246
122214
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -120773,6 +123741,8 @@ export type Routes = {
120773
123741
  can_hvac_heat_cool?: boolean | undefined;
120774
123742
  /** Indicates whether the thermostat can be turned off. */
120775
123743
  can_turn_off_hvac?: boolean | undefined;
123744
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
123745
+ can_activate_weekly_program?: boolean | undefined;
120776
123746
  /** Indicates whether the device supports simulating removal in a sandbox. */
120777
123747
  can_simulate_removal?: boolean | undefined;
120778
123748
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -123642,6 +126612,8 @@ export type Routes = {
123642
126612
  can_hvac_heat_cool?: boolean | undefined;
123643
126613
  /** Indicates whether the thermostat can be turned off. */
123644
126614
  can_turn_off_hvac?: boolean | undefined;
126615
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
126616
+ can_activate_weekly_program?: boolean | undefined;
123645
126617
  /** Indicates whether the device supports simulating removal in a sandbox. */
123646
126618
  can_simulate_removal?: boolean | undefined;
123647
126619
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -125862,6 +128834,41 @@ export type Routes = {
125862
128834
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
125863
128835
  message: string;
125864
128836
  };
128837
+ } | {
128838
+ /** ID of the action attempt. */
128839
+ action_attempt_id: string;
128840
+ status: 'pending';
128841
+ /** Result of the action attempt. Null for pending action attempts. */
128842
+ result: null;
128843
+ /** Errors associated with the action attempt. Null for pending action attempts. */
128844
+ error: null;
128845
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
128846
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
128847
+ } | {
128848
+ /** ID of the action attempt. */
128849
+ action_attempt_id: string;
128850
+ status: 'success';
128851
+ /** Errors associated with the action attempt. Null for successful action attempts. */
128852
+ error: null;
128853
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
128854
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
128855
+ /** Result of the action. */
128856
+ result: {};
128857
+ } | {
128858
+ /** ID of the action attempt. */
128859
+ action_attempt_id: string;
128860
+ status: 'error';
128861
+ /** Result of the action attempt. Null for failed action attempts. */
128862
+ result: null;
128863
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
128864
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
128865
+ /** Error associated with the action. */
128866
+ error: {
128867
+ /** Type of the error. */
128868
+ type: string;
128869
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
128870
+ message: string;
128871
+ };
125865
128872
  } | {
125866
128873
  /** ID of the action attempt. */
125867
128874
  action_attempt_id: string;
@@ -127188,6 +130195,8 @@ export type Routes = {
127188
130195
  can_hvac_heat_cool?: boolean | undefined;
127189
130196
  /** Indicates whether the thermostat can be turned off. */
127190
130197
  can_turn_off_hvac?: boolean | undefined;
130198
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
130199
+ can_activate_weekly_program?: boolean | undefined;
127191
130200
  /** Indicates whether the device supports simulating removal in a sandbox. */
127192
130201
  can_simulate_removal?: boolean | undefined;
127193
130202
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -134171,6 +137180,41 @@ export type Routes = {
134171
137180
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
134172
137181
  message: string;
134173
137182
  };
137183
+ } | {
137184
+ /** ID of the action attempt. */
137185
+ action_attempt_id: string;
137186
+ status: 'pending';
137187
+ /** Result of the action attempt. Null for pending action attempts. */
137188
+ result: null;
137189
+ /** Errors associated with the action attempt. Null for pending action attempts. */
137190
+ error: null;
137191
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
137192
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
137193
+ } | {
137194
+ /** ID of the action attempt. */
137195
+ action_attempt_id: string;
137196
+ status: 'success';
137197
+ /** Errors associated with the action attempt. Null for successful action attempts. */
137198
+ error: null;
137199
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
137200
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
137201
+ /** Result of the action. */
137202
+ result: {};
137203
+ } | {
137204
+ /** ID of the action attempt. */
137205
+ action_attempt_id: string;
137206
+ status: 'error';
137207
+ /** Result of the action attempt. Null for failed action attempts. */
137208
+ result: null;
137209
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
137210
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM';
137211
+ /** Error associated with the action. */
137212
+ error: {
137213
+ /** Type of the error. */
137214
+ type: string;
137215
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
137216
+ message: string;
137217
+ };
134174
137218
  } | {
134175
137219
  /** ID of the action attempt. */
134176
137220
  action_attempt_id: string;