@seamapi/types 1.1081.0 → 1.1083.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.
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +75 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/activate-weekly-program.d.ts +77 -0
- package/lib/seam/connect/models/action-attempts/activate-weekly-program.js +31 -0
- package/lib/seam/connect/models/action-attempts/activate-weekly-program.js.map +1 -0
- package/lib/seam/connect/models/devices/device-provider.d.ts +3 -0
- package/lib/seam/connect/models/devices/device.d.ts +6 -0
- package/lib/seam/connect/models/devices/device.js +3 -0
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +4 -0
- package/lib/seam/connect/models/events/devices.d.ts +6 -0
- package/lib/seam/connect/models/events/devices.js +4 -0
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +3 -0
- package/lib/seam/connect/models/instant-keys/instant-key-preview.d.ts +6 -6
- package/lib/seam/connect/openapi.js +189 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +3268 -214
- package/package.json +1 -1
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -0
- package/src/lib/seam/connect/models/action-attempts/activate-weekly-program.ts +46 -0
- package/src/lib/seam/connect/models/devices/device.ts +5 -0
- package/src/lib/seam/connect/models/events/devices.ts +6 -0
- package/src/lib/seam/connect/openapi.ts +203 -0
- package/src/lib/seam/connect/route-types.ts +3691 -218
|
@@ -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. */
|
|
@@ -51501,6 +51970,8 @@ export type Routes = {
|
|
|
51501
51970
|
image_url?: string | undefined;
|
|
51502
51971
|
/** URL to a short video clip captured at the time of activation. */
|
|
51503
51972
|
video_url?: string | undefined;
|
|
51973
|
+
/** Status of the recorded clip and thumbnail for this activation, when the camera supports event recordings. `pending` while Seam retrieves the recording, `available` once it is stored, `unavailable` if no recording covers the activation, and `failed` if retrieval failed. */
|
|
51974
|
+
media_status?: ('pending' | 'available' | 'unavailable' | 'failed') | undefined;
|
|
51504
51975
|
} | {
|
|
51505
51976
|
/** ID of the event. */
|
|
51506
51977
|
event_id: string;
|
|
@@ -55132,6 +55603,8 @@ export type Routes = {
|
|
|
55132
55603
|
image_url?: string | undefined;
|
|
55133
55604
|
/** URL to a short video clip captured at the time of activation. */
|
|
55134
55605
|
video_url?: string | undefined;
|
|
55606
|
+
/** Status of the recorded clip and thumbnail for this activation, when the camera supports event recordings. `pending` while Seam retrieves the recording, `available` once it is stored, `unavailable` if no recording covers the activation, and `failed` if retrieval failed. */
|
|
55607
|
+
media_status?: ('pending' | 'available' | 'unavailable' | 'failed') | undefined;
|
|
55135
55608
|
} | {
|
|
55136
55609
|
/** ID of the event. */
|
|
55137
55610
|
event_id: string;
|
|
@@ -56766,6 +57239,41 @@ export type Routes = {
|
|
|
56766
57239
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
56767
57240
|
message: string;
|
|
56768
57241
|
};
|
|
57242
|
+
} | {
|
|
57243
|
+
/** ID of the action attempt. */
|
|
57244
|
+
action_attempt_id: string;
|
|
57245
|
+
status: 'pending';
|
|
57246
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
57247
|
+
result: null;
|
|
57248
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
57249
|
+
error: null;
|
|
57250
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
57251
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
57252
|
+
} | {
|
|
57253
|
+
/** ID of the action attempt. */
|
|
57254
|
+
action_attempt_id: string;
|
|
57255
|
+
status: 'success';
|
|
57256
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
57257
|
+
error: null;
|
|
57258
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
57259
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
57260
|
+
/** Result of the action. */
|
|
57261
|
+
result: {};
|
|
57262
|
+
} | {
|
|
57263
|
+
/** ID of the action attempt. */
|
|
57264
|
+
action_attempt_id: string;
|
|
57265
|
+
status: 'error';
|
|
57266
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
57267
|
+
result: null;
|
|
57268
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
57269
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
57270
|
+
/** Error associated with the action. */
|
|
57271
|
+
error: {
|
|
57272
|
+
/** Type of the error. */
|
|
57273
|
+
type: string;
|
|
57274
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
57275
|
+
message: string;
|
|
57276
|
+
};
|
|
56769
57277
|
} | {
|
|
56770
57278
|
/** ID of the action attempt. */
|
|
56771
57279
|
action_attempt_id: string;
|
|
@@ -58694,6 +59202,8 @@ export type Routes = {
|
|
|
58694
59202
|
can_hvac_heat_cool?: boolean | undefined;
|
|
58695
59203
|
/** Indicates whether the thermostat can be turned off. */
|
|
58696
59204
|
can_turn_off_hvac?: boolean | undefined;
|
|
59205
|
+
/** 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. */
|
|
59206
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
58697
59207
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
58698
59208
|
can_simulate_removal?: boolean | undefined;
|
|
58699
59209
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -60225,6 +60735,8 @@ export type Routes = {
|
|
|
60225
60735
|
can_hvac_heat_cool?: boolean | undefined;
|
|
60226
60736
|
/** Indicates whether the thermostat can be turned off. */
|
|
60227
60737
|
can_turn_off_hvac?: boolean | undefined;
|
|
60738
|
+
/** 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. */
|
|
60739
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
60228
60740
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
60229
60741
|
can_simulate_removal?: boolean | undefined;
|
|
60230
60742
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -61779,6 +62291,8 @@ export type Routes = {
|
|
|
61779
62291
|
can_hvac_heat_cool?: boolean | undefined;
|
|
61780
62292
|
/** Indicates whether the thermostat can be turned off. */
|
|
61781
62293
|
can_turn_off_hvac?: boolean | undefined;
|
|
62294
|
+
/** 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. */
|
|
62295
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
61782
62296
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
61783
62297
|
can_simulate_removal?: boolean | undefined;
|
|
61784
62298
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -63309,6 +63823,8 @@ export type Routes = {
|
|
|
63309
63823
|
can_hvac_heat_cool?: boolean | undefined;
|
|
63310
63824
|
/** Indicates whether the thermostat can be turned off. */
|
|
63311
63825
|
can_turn_off_hvac?: boolean | undefined;
|
|
63826
|
+
/** 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. */
|
|
63827
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
63312
63828
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
63313
63829
|
can_simulate_removal?: boolean | undefined;
|
|
63314
63830
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -64740,6 +65256,41 @@ export type Routes = {
|
|
|
64740
65256
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
64741
65257
|
message: string;
|
|
64742
65258
|
};
|
|
65259
|
+
} | {
|
|
65260
|
+
/** ID of the action attempt. */
|
|
65261
|
+
action_attempt_id: string;
|
|
65262
|
+
status: 'pending';
|
|
65263
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
65264
|
+
result: null;
|
|
65265
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
65266
|
+
error: null;
|
|
65267
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
65268
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
65269
|
+
} | {
|
|
65270
|
+
/** ID of the action attempt. */
|
|
65271
|
+
action_attempt_id: string;
|
|
65272
|
+
status: 'success';
|
|
65273
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
65274
|
+
error: null;
|
|
65275
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
65276
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
65277
|
+
/** Result of the action. */
|
|
65278
|
+
result: {};
|
|
65279
|
+
} | {
|
|
65280
|
+
/** ID of the action attempt. */
|
|
65281
|
+
action_attempt_id: string;
|
|
65282
|
+
status: 'error';
|
|
65283
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
65284
|
+
result: null;
|
|
65285
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
65286
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
65287
|
+
/** Error associated with the action. */
|
|
65288
|
+
error: {
|
|
65289
|
+
/** Type of the error. */
|
|
65290
|
+
type: string;
|
|
65291
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
65292
|
+
message: string;
|
|
65293
|
+
};
|
|
64743
65294
|
} | {
|
|
64744
65295
|
/** ID of the action attempt. */
|
|
64745
65296
|
action_attempt_id: string;
|
|
@@ -66552,6 +67103,41 @@ export type Routes = {
|
|
|
66552
67103
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
66553
67104
|
message: string;
|
|
66554
67105
|
};
|
|
67106
|
+
} | {
|
|
67107
|
+
/** ID of the action attempt. */
|
|
67108
|
+
action_attempt_id: string;
|
|
67109
|
+
status: 'pending';
|
|
67110
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
67111
|
+
result: null;
|
|
67112
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
67113
|
+
error: null;
|
|
67114
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
67115
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
67116
|
+
} | {
|
|
67117
|
+
/** ID of the action attempt. */
|
|
67118
|
+
action_attempt_id: string;
|
|
67119
|
+
status: 'success';
|
|
67120
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
67121
|
+
error: null;
|
|
67122
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
67123
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
67124
|
+
/** Result of the action. */
|
|
67125
|
+
result: {};
|
|
67126
|
+
} | {
|
|
67127
|
+
/** ID of the action attempt. */
|
|
67128
|
+
action_attempt_id: string;
|
|
67129
|
+
status: 'error';
|
|
67130
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
67131
|
+
result: null;
|
|
67132
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
67133
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
67134
|
+
/** Error associated with the action. */
|
|
67135
|
+
error: {
|
|
67136
|
+
/** Type of the error. */
|
|
67137
|
+
type: string;
|
|
67138
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
67139
|
+
message: string;
|
|
67140
|
+
};
|
|
66555
67141
|
} | {
|
|
66556
67142
|
/** ID of the action attempt. */
|
|
66557
67143
|
action_attempt_id: string;
|
|
@@ -68362,6 +68948,41 @@ export type Routes = {
|
|
|
68362
68948
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
68363
68949
|
message: string;
|
|
68364
68950
|
};
|
|
68951
|
+
} | {
|
|
68952
|
+
/** ID of the action attempt. */
|
|
68953
|
+
action_attempt_id: string;
|
|
68954
|
+
status: 'pending';
|
|
68955
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
68956
|
+
result: null;
|
|
68957
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
68958
|
+
error: null;
|
|
68959
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
68960
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
68961
|
+
} | {
|
|
68962
|
+
/** ID of the action attempt. */
|
|
68963
|
+
action_attempt_id: string;
|
|
68964
|
+
status: 'success';
|
|
68965
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
68966
|
+
error: null;
|
|
68967
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
68968
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
68969
|
+
/** Result of the action. */
|
|
68970
|
+
result: {};
|
|
68971
|
+
} | {
|
|
68972
|
+
/** ID of the action attempt. */
|
|
68973
|
+
action_attempt_id: string;
|
|
68974
|
+
status: 'error';
|
|
68975
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
68976
|
+
result: null;
|
|
68977
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
68978
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
68979
|
+
/** Error associated with the action. */
|
|
68980
|
+
error: {
|
|
68981
|
+
/** Type of the error. */
|
|
68982
|
+
type: string;
|
|
68983
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
68984
|
+
message: string;
|
|
68985
|
+
};
|
|
68365
68986
|
} | {
|
|
68366
68987
|
/** ID of the action attempt. */
|
|
68367
68988
|
action_attempt_id: string;
|
|
@@ -70174,6 +70795,41 @@ export type Routes = {
|
|
|
70174
70795
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
70175
70796
|
message: string;
|
|
70176
70797
|
};
|
|
70798
|
+
} | {
|
|
70799
|
+
/** ID of the action attempt. */
|
|
70800
|
+
action_attempt_id: string;
|
|
70801
|
+
status: 'pending';
|
|
70802
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
70803
|
+
result: null;
|
|
70804
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
70805
|
+
error: null;
|
|
70806
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
70807
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
70808
|
+
} | {
|
|
70809
|
+
/** ID of the action attempt. */
|
|
70810
|
+
action_attempt_id: string;
|
|
70811
|
+
status: 'success';
|
|
70812
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
70813
|
+
error: null;
|
|
70814
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
70815
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
70816
|
+
/** Result of the action. */
|
|
70817
|
+
result: {};
|
|
70818
|
+
} | {
|
|
70819
|
+
/** ID of the action attempt. */
|
|
70820
|
+
action_attempt_id: string;
|
|
70821
|
+
status: 'error';
|
|
70822
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
70823
|
+
result: null;
|
|
70824
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
70825
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
70826
|
+
/** Error associated with the action. */
|
|
70827
|
+
error: {
|
|
70828
|
+
/** Type of the error. */
|
|
70829
|
+
type: string;
|
|
70830
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
70831
|
+
message: string;
|
|
70832
|
+
};
|
|
70177
70833
|
} | {
|
|
70178
70834
|
/** ID of the action attempt. */
|
|
70179
70835
|
action_attempt_id: string;
|
|
@@ -72109,6 +72765,8 @@ export type Routes = {
|
|
|
72109
72765
|
can_hvac_heat_cool?: boolean | undefined;
|
|
72110
72766
|
/** Indicates whether the thermostat can be turned off. */
|
|
72111
72767
|
can_turn_off_hvac?: boolean | undefined;
|
|
72768
|
+
/** 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. */
|
|
72769
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
72112
72770
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
72113
72771
|
can_simulate_removal?: boolean | undefined;
|
|
72114
72772
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -73639,6 +74297,8 @@ export type Routes = {
|
|
|
73639
74297
|
can_hvac_heat_cool?: boolean | undefined;
|
|
73640
74298
|
/** Indicates whether the thermostat can be turned off. */
|
|
73641
74299
|
can_turn_off_hvac?: boolean | undefined;
|
|
74300
|
+
/** 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. */
|
|
74301
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
73642
74302
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
73643
74303
|
can_simulate_removal?: boolean | undefined;
|
|
73644
74304
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -75080,6 +75740,41 @@ export type Routes = {
|
|
|
75080
75740
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
75081
75741
|
message: string;
|
|
75082
75742
|
};
|
|
75743
|
+
} | {
|
|
75744
|
+
/** ID of the action attempt. */
|
|
75745
|
+
action_attempt_id: string;
|
|
75746
|
+
status: 'pending';
|
|
75747
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
75748
|
+
result: null;
|
|
75749
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
75750
|
+
error: null;
|
|
75751
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
75752
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
75753
|
+
} | {
|
|
75754
|
+
/** ID of the action attempt. */
|
|
75755
|
+
action_attempt_id: string;
|
|
75756
|
+
status: 'success';
|
|
75757
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
75758
|
+
error: null;
|
|
75759
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
75760
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
75761
|
+
/** Result of the action. */
|
|
75762
|
+
result: {};
|
|
75763
|
+
} | {
|
|
75764
|
+
/** ID of the action attempt. */
|
|
75765
|
+
action_attempt_id: string;
|
|
75766
|
+
status: 'error';
|
|
75767
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
75768
|
+
result: null;
|
|
75769
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
75770
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
75771
|
+
/** Error associated with the action. */
|
|
75772
|
+
error: {
|
|
75773
|
+
/** Type of the error. */
|
|
75774
|
+
type: string;
|
|
75775
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
75776
|
+
message: string;
|
|
75777
|
+
};
|
|
75083
75778
|
} | {
|
|
75084
75779
|
/** ID of the action attempt. */
|
|
75085
75780
|
action_attempt_id: string;
|
|
@@ -76911,6 +77606,41 @@ export type Routes = {
|
|
|
76911
77606
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
76912
77607
|
message: string;
|
|
76913
77608
|
};
|
|
77609
|
+
} | {
|
|
77610
|
+
/** ID of the action attempt. */
|
|
77611
|
+
action_attempt_id: string;
|
|
77612
|
+
status: 'pending';
|
|
77613
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
77614
|
+
result: null;
|
|
77615
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
77616
|
+
error: null;
|
|
77617
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
77618
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
77619
|
+
} | {
|
|
77620
|
+
/** ID of the action attempt. */
|
|
77621
|
+
action_attempt_id: string;
|
|
77622
|
+
status: 'success';
|
|
77623
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
77624
|
+
error: null;
|
|
77625
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
77626
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
77627
|
+
/** Result of the action. */
|
|
77628
|
+
result: {};
|
|
77629
|
+
} | {
|
|
77630
|
+
/** ID of the action attempt. */
|
|
77631
|
+
action_attempt_id: string;
|
|
77632
|
+
status: 'error';
|
|
77633
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
77634
|
+
result: null;
|
|
77635
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
77636
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
77637
|
+
/** Error associated with the action. */
|
|
77638
|
+
error: {
|
|
77639
|
+
/** Type of the error. */
|
|
77640
|
+
type: string;
|
|
77641
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
77642
|
+
message: string;
|
|
77643
|
+
};
|
|
76914
77644
|
} | {
|
|
76915
77645
|
/** ID of the action attempt. */
|
|
76916
77646
|
action_attempt_id: string;
|
|
@@ -78798,6 +79528,41 @@ export type Routes = {
|
|
|
78798
79528
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
78799
79529
|
message: string;
|
|
78800
79530
|
};
|
|
79531
|
+
} | {
|
|
79532
|
+
/** ID of the action attempt. */
|
|
79533
|
+
action_attempt_id: string;
|
|
79534
|
+
status: 'pending';
|
|
79535
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
79536
|
+
result: null;
|
|
79537
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
79538
|
+
error: null;
|
|
79539
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
79540
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
79541
|
+
} | {
|
|
79542
|
+
/** ID of the action attempt. */
|
|
79543
|
+
action_attempt_id: string;
|
|
79544
|
+
status: 'success';
|
|
79545
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
79546
|
+
error: null;
|
|
79547
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
79548
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
79549
|
+
/** Result of the action. */
|
|
79550
|
+
result: {};
|
|
79551
|
+
} | {
|
|
79552
|
+
/** ID of the action attempt. */
|
|
79553
|
+
action_attempt_id: string;
|
|
79554
|
+
status: 'error';
|
|
79555
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
79556
|
+
result: null;
|
|
79557
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
79558
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
79559
|
+
/** Error associated with the action. */
|
|
79560
|
+
error: {
|
|
79561
|
+
/** Type of the error. */
|
|
79562
|
+
type: string;
|
|
79563
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
79564
|
+
message: string;
|
|
79565
|
+
};
|
|
78801
79566
|
} | {
|
|
78802
79567
|
/** ID of the action attempt. */
|
|
78803
79568
|
action_attempt_id: string;
|
|
@@ -82468,6 +83233,41 @@ export type Routes = {
|
|
|
82468
83233
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
82469
83234
|
message: string;
|
|
82470
83235
|
};
|
|
83236
|
+
} | {
|
|
83237
|
+
/** ID of the action attempt. */
|
|
83238
|
+
action_attempt_id: string;
|
|
83239
|
+
status: 'pending';
|
|
83240
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
83241
|
+
result: null;
|
|
83242
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
83243
|
+
error: null;
|
|
83244
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
83245
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
83246
|
+
} | {
|
|
83247
|
+
/** ID of the action attempt. */
|
|
83248
|
+
action_attempt_id: string;
|
|
83249
|
+
status: 'success';
|
|
83250
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
83251
|
+
error: null;
|
|
83252
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
83253
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
83254
|
+
/** Result of the action. */
|
|
83255
|
+
result: {};
|
|
83256
|
+
} | {
|
|
83257
|
+
/** ID of the action attempt. */
|
|
83258
|
+
action_attempt_id: string;
|
|
83259
|
+
status: 'error';
|
|
83260
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
83261
|
+
result: null;
|
|
83262
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
83263
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
83264
|
+
/** Error associated with the action. */
|
|
83265
|
+
error: {
|
|
83266
|
+
/** Type of the error. */
|
|
83267
|
+
type: string;
|
|
83268
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
83269
|
+
message: string;
|
|
83270
|
+
};
|
|
82471
83271
|
} | {
|
|
82472
83272
|
/** ID of the action attempt. */
|
|
82473
83273
|
action_attempt_id: string;
|
|
@@ -87167,6 +87967,8 @@ export type Routes = {
|
|
|
87167
87967
|
image_url?: string | undefined;
|
|
87168
87968
|
/** URL to a short video clip captured at the time of activation. */
|
|
87169
87969
|
video_url?: string | undefined;
|
|
87970
|
+
/** Status of the recorded clip and thumbnail for this activation, when the camera supports event recordings. `pending` while Seam retrieves the recording, `available` once it is stored, `unavailable` if no recording covers the activation, and `failed` if retrieval failed. */
|
|
87971
|
+
media_status?: ('pending' | 'available' | 'unavailable' | 'failed') | undefined;
|
|
87170
87972
|
} | {
|
|
87171
87973
|
/** ID of the event. */
|
|
87172
87974
|
event_id: string;
|
|
@@ -92818,6 +93620,8 @@ export type Routes = {
|
|
|
92818
93620
|
image_url?: string | undefined;
|
|
92819
93621
|
/** URL to a short video clip captured at the time of activation. */
|
|
92820
93622
|
video_url?: string | undefined;
|
|
93623
|
+
/** Status of the recorded clip and thumbnail for this activation, when the camera supports event recordings. `pending` while Seam retrieves the recording, `available` once it is stored, `unavailable` if no recording covers the activation, and `failed` if retrieval failed. */
|
|
93624
|
+
media_status?: ('pending' | 'available' | 'unavailable' | 'failed') | undefined;
|
|
92821
93625
|
} | {
|
|
92822
93626
|
/** ID of the event. */
|
|
92823
93627
|
event_id: string;
|
|
@@ -94738,6 +95542,8 @@ export type Routes = {
|
|
|
94738
95542
|
can_hvac_heat_cool?: boolean | undefined;
|
|
94739
95543
|
/** Indicates whether the thermostat can be turned off. */
|
|
94740
95544
|
can_turn_off_hvac?: boolean | undefined;
|
|
95545
|
+
/** 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. */
|
|
95546
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
94741
95547
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
94742
95548
|
can_simulate_removal?: boolean | undefined;
|
|
94743
95549
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -95444,224 +96250,2071 @@ export type Routes = {
|
|
|
95444
96250
|
})[];
|
|
95445
96251
|
/** ID of the customization profile associated with the access method. */
|
|
95446
96252
|
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;
|
|
96253
|
+
}[] | undefined;
|
|
96254
|
+
};
|
|
96255
|
+
};
|
|
96256
|
+
maxDuration: undefined;
|
|
96257
|
+
};
|
|
96258
|
+
'/spaces/list': {
|
|
96259
|
+
route: '/spaces/list';
|
|
96260
|
+
method: 'GET' | 'POST';
|
|
96261
|
+
queryParams: {};
|
|
96262
|
+
jsonBody: {};
|
|
96263
|
+
commonParams: {
|
|
96264
|
+
/** Customer key for which you want to list spaces. */
|
|
96265
|
+
customer_key?: string | undefined;
|
|
96266
|
+
/** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`. */
|
|
96267
|
+
search?: string | undefined;
|
|
96268
|
+
/** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
|
|
96269
|
+
connected_account_id?: string | undefined;
|
|
96270
|
+
/** Filter spaces by space_key. */
|
|
96271
|
+
space_key?: string | undefined;
|
|
96272
|
+
/** Filter spaces to only include those whose parent space has the specified `parent_space_id`. */
|
|
96273
|
+
parent_space_id?: string | undefined;
|
|
96274
|
+
/** Filter spaces to only include those whose parent space has the specified `parent_space_key`. */
|
|
96275
|
+
parent_space_key?: string | undefined;
|
|
96276
|
+
/** Maximum number of records to return per page. */
|
|
96277
|
+
limit?: number;
|
|
96278
|
+
/** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
|
|
96279
|
+
page_cursor?: (string | undefined) | null;
|
|
96280
|
+
};
|
|
96281
|
+
formData: {};
|
|
96282
|
+
jsonResponse: {
|
|
96283
|
+
spaces: {
|
|
96284
|
+
/** ID of the space. */
|
|
96285
|
+
space_id: string;
|
|
96286
|
+
/** ID of the workspace associated with the space. */
|
|
96287
|
+
workspace_id: string;
|
|
96288
|
+
/** Unique key for the space within the workspace. */
|
|
96289
|
+
space_key?: string | undefined;
|
|
96290
|
+
/** Name of the space. */
|
|
96291
|
+
name: string;
|
|
96292
|
+
/** Display name for the space. */
|
|
96293
|
+
display_name: string;
|
|
96294
|
+
/** Date and time at which the space was created. */
|
|
96295
|
+
created_at: string;
|
|
96296
|
+
/** Number of devices in the space. */
|
|
96297
|
+
device_count: number;
|
|
96298
|
+
/** Number of entrances in the space. */
|
|
96299
|
+
acs_entrance_count: number;
|
|
96300
|
+
/** Customer key associated with the space. */
|
|
96301
|
+
customer_key?: string | undefined;
|
|
96302
|
+
/** 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). */
|
|
96303
|
+
customer_data?: {
|
|
96304
|
+
/** IANA time zone for the space, e.g. America/Los_Angeles. */
|
|
96305
|
+
time_zone?: (string | null) | undefined;
|
|
96306
|
+
/** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
96307
|
+
default_checkin_time?: (string | null) | undefined;
|
|
96308
|
+
/** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
96309
|
+
default_checkout_time?: (string | null) | undefined;
|
|
96310
|
+
/** Postal address for the space. */
|
|
96311
|
+
address?: (string | null) | undefined;
|
|
96312
|
+
} | undefined;
|
|
96313
|
+
/** Geographic coordinates (latitude and longitude) of the space. */
|
|
96314
|
+
geolocation?: ({
|
|
96315
|
+
/** Latitude of the space, in decimal degrees. */
|
|
96316
|
+
latitude: number;
|
|
96317
|
+
/** Longitude of the space, in decimal degrees. */
|
|
96318
|
+
longitude: number;
|
|
96319
|
+
} | null) | undefined;
|
|
96320
|
+
/** */
|
|
96321
|
+
parent_space_id?: string | undefined;
|
|
96322
|
+
/** */
|
|
96323
|
+
parent_space_key?: string | undefined;
|
|
96324
|
+
}[];
|
|
96325
|
+
/** Information about the current page of results. */
|
|
96326
|
+
pagination: {
|
|
96327
|
+
/** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
|
|
96328
|
+
next_page_cursor: string | null;
|
|
96329
|
+
/** Indicates whether there is another page of results after this one. */
|
|
96330
|
+
has_next_page: boolean;
|
|
96331
|
+
/** URL to get the next page of results. */
|
|
96332
|
+
next_page_url: string | null;
|
|
96333
|
+
};
|
|
96334
|
+
};
|
|
96335
|
+
maxDuration: undefined;
|
|
96336
|
+
};
|
|
96337
|
+
'/spaces/remove_acs_entrances': {
|
|
96338
|
+
route: '/spaces/remove_acs_entrances';
|
|
96339
|
+
method: 'POST' | 'DELETE';
|
|
96340
|
+
queryParams: {};
|
|
96341
|
+
jsonBody: {};
|
|
96342
|
+
commonParams: {
|
|
96343
|
+
/** ID of the space from which you want to remove entrances. */
|
|
96344
|
+
space_id: string;
|
|
96345
|
+
/** IDs of the entrances that you want to remove from the space. */
|
|
96346
|
+
acs_entrance_ids: string[];
|
|
96347
|
+
};
|
|
96348
|
+
formData: {};
|
|
96349
|
+
jsonResponse: {};
|
|
96350
|
+
maxDuration: undefined;
|
|
96351
|
+
};
|
|
96352
|
+
'/spaces/remove_connected_account': {
|
|
96353
|
+
route: '/spaces/remove_connected_account';
|
|
96354
|
+
method: 'POST' | 'DELETE';
|
|
96355
|
+
queryParams: {};
|
|
96356
|
+
jsonBody: {};
|
|
96357
|
+
commonParams: {
|
|
96358
|
+
/** ID of the space from which you want to remove the connected account. */
|
|
96359
|
+
space_id: string;
|
|
96360
|
+
/** ID of the connected account that you want to remove from the space. */
|
|
96361
|
+
connected_account_id: string;
|
|
96362
|
+
};
|
|
96363
|
+
formData: {};
|
|
96364
|
+
jsonResponse: {};
|
|
96365
|
+
maxDuration: undefined;
|
|
96366
|
+
};
|
|
96367
|
+
'/spaces/remove_devices': {
|
|
96368
|
+
route: '/spaces/remove_devices';
|
|
96369
|
+
method: 'POST' | 'DELETE';
|
|
96370
|
+
queryParams: {};
|
|
96371
|
+
jsonBody: {};
|
|
96372
|
+
commonParams: {
|
|
96373
|
+
/** ID of the space from which you want to remove devices. */
|
|
96374
|
+
space_id: string;
|
|
96375
|
+
/** IDs of the devices that you want to remove from the space. */
|
|
96376
|
+
device_ids: string[];
|
|
96377
|
+
};
|
|
96378
|
+
formData: {};
|
|
96379
|
+
jsonResponse: {};
|
|
96380
|
+
maxDuration: undefined;
|
|
96381
|
+
};
|
|
96382
|
+
'/spaces/update': {
|
|
96383
|
+
route: '/spaces/update';
|
|
96384
|
+
method: 'POST' | 'PATCH';
|
|
96385
|
+
queryParams: {};
|
|
96386
|
+
jsonBody: {
|
|
96387
|
+
/** Name of the space. */
|
|
96388
|
+
name?: string | undefined;
|
|
96389
|
+
/** ID of the space that you want to update. */
|
|
96390
|
+
space_id?: string | undefined;
|
|
96391
|
+
/** Unique key of the space that you want to update. */
|
|
96392
|
+
space_key?: string | undefined;
|
|
96393
|
+
/** IDs of the devices that you want to set for the space. If specified, this will replace all existing devices. */
|
|
96394
|
+
device_ids?: string[] | undefined;
|
|
96395
|
+
/** IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances. */
|
|
96396
|
+
acs_entrance_ids?: string[] | undefined;
|
|
96397
|
+
/** 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. */
|
|
96398
|
+
customer_data?: {
|
|
96399
|
+
/** IANA time zone for the space, e.g. America/Los_Angeles. */
|
|
96400
|
+
time_zone?: (string | null) | undefined;
|
|
96401
|
+
/** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
96402
|
+
default_checkin_time?: (string | null) | undefined;
|
|
96403
|
+
/** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
96404
|
+
default_checkout_time?: (string | null) | undefined;
|
|
96405
|
+
/** Postal address for the space. */
|
|
96406
|
+
address?: (string | null) | undefined;
|
|
96407
|
+
} | undefined;
|
|
96408
|
+
/** Reassign this space to the parent space (site) with this `parent_space_id`. */
|
|
96409
|
+
parent_space_id?: string | undefined;
|
|
96410
|
+
/** Reassign this space to the parent space (site) with this `parent_space_key`. */
|
|
96411
|
+
parent_space_key?: string | undefined;
|
|
96412
|
+
};
|
|
96413
|
+
commonParams: {};
|
|
96414
|
+
formData: {};
|
|
96415
|
+
jsonResponse: {
|
|
96416
|
+
/** 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. */
|
|
96417
|
+
space: {
|
|
96418
|
+
/** ID of the space. */
|
|
96419
|
+
space_id: string;
|
|
96420
|
+
/** ID of the workspace associated with the space. */
|
|
96421
|
+
workspace_id: string;
|
|
96422
|
+
/** Unique key for the space within the workspace. */
|
|
96423
|
+
space_key?: string | undefined;
|
|
96424
|
+
/** Name of the space. */
|
|
96425
|
+
name: string;
|
|
96426
|
+
/** Display name for the space. */
|
|
96427
|
+
display_name: string;
|
|
96428
|
+
/** Date and time at which the space was created. */
|
|
96429
|
+
created_at: string;
|
|
96430
|
+
/** Number of devices in the space. */
|
|
96431
|
+
device_count: number;
|
|
96432
|
+
/** Number of entrances in the space. */
|
|
96433
|
+
acs_entrance_count: number;
|
|
96434
|
+
/** Customer key associated with the space. */
|
|
96435
|
+
customer_key?: string | undefined;
|
|
96436
|
+
/** 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). */
|
|
96437
|
+
customer_data?: {
|
|
96438
|
+
/** IANA time zone for the space, e.g. America/Los_Angeles. */
|
|
96439
|
+
time_zone?: (string | null) | undefined;
|
|
96440
|
+
/** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
96441
|
+
default_checkin_time?: (string | null) | undefined;
|
|
96442
|
+
/** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
96443
|
+
default_checkout_time?: (string | null) | undefined;
|
|
96444
|
+
/** Postal address for the space. */
|
|
96445
|
+
address?: (string | null) | undefined;
|
|
96446
|
+
} | undefined;
|
|
96447
|
+
/** Geographic coordinates (latitude and longitude) of the space. */
|
|
96448
|
+
geolocation?: ({
|
|
96449
|
+
/** Latitude of the space, in decimal degrees. */
|
|
96450
|
+
latitude: number;
|
|
96451
|
+
/** Longitude of the space, in decimal degrees. */
|
|
96452
|
+
longitude: number;
|
|
96453
|
+
} | null) | undefined;
|
|
96454
|
+
/** */
|
|
96455
|
+
parent_space_id?: string | undefined;
|
|
96456
|
+
/** */
|
|
96457
|
+
parent_space_key?: string | undefined;
|
|
96458
|
+
};
|
|
96459
|
+
};
|
|
96460
|
+
maxDuration: undefined;
|
|
96461
|
+
};
|
|
96462
|
+
'/thermostats/activate_climate_preset': {
|
|
96463
|
+
route: '/thermostats/activate_climate_preset';
|
|
96464
|
+
method: 'POST';
|
|
96465
|
+
queryParams: {};
|
|
96466
|
+
jsonBody: {
|
|
96467
|
+
/** ID of the thermostat device for which you want to activate a climate preset. */
|
|
96468
|
+
device_id: string;
|
|
96469
|
+
/** Climate preset key of the climate preset that you want to activate. */
|
|
96470
|
+
climate_preset_key: string;
|
|
96471
|
+
};
|
|
96472
|
+
commonParams: {};
|
|
96473
|
+
formData: {};
|
|
96474
|
+
jsonResponse: {
|
|
96475
|
+
/** 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.
|
|
96476
|
+
|
|
96477
|
+
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.
|
|
96478
|
+
|
|
96479
|
+
See also [Action Attempts](https://www.seam.co/docs/core-concepts/action-attempts). */
|
|
96480
|
+
action_attempt: {
|
|
96481
|
+
/** ID of the action attempt. */
|
|
96482
|
+
action_attempt_id: string;
|
|
96483
|
+
status: 'pending';
|
|
96484
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
96485
|
+
result: null;
|
|
96486
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
96487
|
+
error: null;
|
|
96488
|
+
/** Action attempt to track the status of locking a door. */
|
|
96489
|
+
action_type: 'LOCK_DOOR';
|
|
96490
|
+
} | {
|
|
96491
|
+
/** ID of the action attempt. */
|
|
96492
|
+
action_attempt_id: string;
|
|
96493
|
+
status: 'success';
|
|
96494
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
96495
|
+
error: null;
|
|
96496
|
+
/** Action attempt to track the status of locking a door. */
|
|
96497
|
+
action_type: 'LOCK_DOOR';
|
|
96498
|
+
/** Result of the action. */
|
|
96499
|
+
result: {
|
|
96500
|
+
/** Indicates whether the device confirmed that the lock action occurred. */
|
|
96501
|
+
was_confirmed_by_device?: boolean | undefined;
|
|
96502
|
+
};
|
|
96503
|
+
} | {
|
|
96504
|
+
/** ID of the action attempt. */
|
|
96505
|
+
action_attempt_id: string;
|
|
96506
|
+
status: 'error';
|
|
96507
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
96508
|
+
result: null;
|
|
96509
|
+
/** Action attempt to track the status of locking a door. */
|
|
96510
|
+
action_type: 'LOCK_DOOR';
|
|
96511
|
+
/** Error associated with the action. */
|
|
96512
|
+
error: {
|
|
96513
|
+
/** Type of the error. */
|
|
96514
|
+
type: string;
|
|
96515
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
96516
|
+
message: string;
|
|
96517
|
+
};
|
|
96518
|
+
} | {
|
|
96519
|
+
/** ID of the action attempt. */
|
|
96520
|
+
action_attempt_id: string;
|
|
96521
|
+
status: 'pending';
|
|
96522
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
96523
|
+
result: null;
|
|
96524
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
96525
|
+
error: null;
|
|
96526
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
96527
|
+
action_type: 'UNLOCK_DOOR';
|
|
96528
|
+
} | {
|
|
96529
|
+
/** ID of the action attempt. */
|
|
96530
|
+
action_attempt_id: string;
|
|
96531
|
+
status: 'success';
|
|
96532
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
96533
|
+
error: null;
|
|
96534
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
96535
|
+
action_type: 'UNLOCK_DOOR';
|
|
96536
|
+
/** Result of the action. */
|
|
96537
|
+
result: {
|
|
96538
|
+
/** Indicates whether the device confirmed that the unlock action occurred. */
|
|
96539
|
+
was_confirmed_by_device?: boolean | undefined;
|
|
96540
|
+
};
|
|
96541
|
+
} | {
|
|
96542
|
+
/** ID of the action attempt. */
|
|
96543
|
+
action_attempt_id: string;
|
|
96544
|
+
status: 'error';
|
|
96545
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
96546
|
+
result: null;
|
|
96547
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
96548
|
+
action_type: 'UNLOCK_DOOR';
|
|
96549
|
+
/** Error associated with the action. */
|
|
96550
|
+
error: {
|
|
96551
|
+
/** Type of the error. */
|
|
96552
|
+
type: string;
|
|
96553
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
96554
|
+
message: string;
|
|
96555
|
+
};
|
|
96556
|
+
} | {
|
|
96557
|
+
/** ID of the action attempt. */
|
|
96558
|
+
action_attempt_id: string;
|
|
96559
|
+
status: 'pending';
|
|
96560
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
96561
|
+
result: null;
|
|
96562
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
96563
|
+
error: null;
|
|
96564
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
96565
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
96566
|
+
} | {
|
|
96567
|
+
/** ID of the action attempt. */
|
|
96568
|
+
action_attempt_id: string;
|
|
96569
|
+
status: 'success';
|
|
96570
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
96571
|
+
error: null;
|
|
96572
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
96573
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
96574
|
+
/** 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. */
|
|
96575
|
+
result: {
|
|
96576
|
+
/** Snapshot of credential data read from the physical encoder. */
|
|
96577
|
+
acs_credential_on_encoder: {
|
|
96578
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
|
|
96579
|
+
created_at: string | null;
|
|
96580
|
+
/** Indicates whether the credential has been issued (encoded onto a card). */
|
|
96581
|
+
is_issued: boolean | null;
|
|
96582
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) becomes usable. */
|
|
96583
|
+
starts_at: string | null;
|
|
96584
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) will stop being usable. */
|
|
96585
|
+
ends_at: string | null;
|
|
96586
|
+
/** 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). */
|
|
96587
|
+
card_number: string | null;
|
|
96588
|
+
/** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96589
|
+
visionline_metadata?: {
|
|
96590
|
+
/** Card ID for the Visionline card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96591
|
+
card_id?: (string | undefined) | undefined;
|
|
96592
|
+
/** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is cancelled. */
|
|
96593
|
+
cancelled?: (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 discarded. */
|
|
96595
|
+
discarded?: (boolean | undefined) | undefined;
|
|
96596
|
+
/** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is expired. */
|
|
96597
|
+
expired?: (boolean | undefined) | undefined;
|
|
96598
|
+
/** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overwritten. */
|
|
96599
|
+
overwritten?: (boolean | undefined) | undefined;
|
|
96600
|
+
/** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overridden. */
|
|
96601
|
+
overridden?: (boolean | undefined) | undefined;
|
|
96602
|
+
/** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is pending auto-update. */
|
|
96603
|
+
pending_auto_update?: (boolean | undefined) | undefined;
|
|
96604
|
+
/** Format of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96605
|
+
card_format?: (('TLCode' | 'rfid48') | undefined) | undefined;
|
|
96606
|
+
/** Holder of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96607
|
+
card_holder?: (string | undefined) | undefined;
|
|
96608
|
+
/** Number of issued cards associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96609
|
+
number_of_issued_cards?: (number | undefined) | undefined;
|
|
96610
|
+
/** 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). */
|
|
96611
|
+
guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
96612
|
+
/** 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). */
|
|
96613
|
+
common_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
96614
|
+
} | undefined;
|
|
96615
|
+
} | null;
|
|
96616
|
+
/** Corresponding credential data as stored on Seam and the access system. */
|
|
96617
|
+
acs_credential_on_seam: ({
|
|
96618
|
+
/** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96619
|
+
acs_credential_id: string;
|
|
96620
|
+
/** 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. */
|
|
96621
|
+
acs_user_id?: string | undefined;
|
|
96622
|
+
/** 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. */
|
|
96623
|
+
user_identity_id?: string | undefined;
|
|
96624
|
+
/** 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. */
|
|
96625
|
+
connected_account_id: string;
|
|
96626
|
+
/** ID of the credential pool to which the credential belongs. */
|
|
96627
|
+
acs_credential_pool_id?: string | undefined;
|
|
96628
|
+
/** 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). */
|
|
96629
|
+
acs_system_id: string;
|
|
96630
|
+
/** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96631
|
+
parent_acs_credential_id?: string | undefined;
|
|
96632
|
+
/** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
96633
|
+
display_name: string;
|
|
96634
|
+
/** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96635
|
+
code?: (string | undefined) | null;
|
|
96636
|
+
/** 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. */
|
|
96637
|
+
is_one_time_use?: boolean | undefined;
|
|
96638
|
+
/** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96639
|
+
card_number?: (string | undefined) | null;
|
|
96640
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
|
|
96641
|
+
is_issued?: boolean | undefined;
|
|
96642
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
|
|
96643
|
+
issued_at?: (string | undefined) | null;
|
|
96644
|
+
/** 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`. */
|
|
96645
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
96646
|
+
/** 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`. */
|
|
96647
|
+
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;
|
|
96648
|
+
/** 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. */
|
|
96649
|
+
external_type_display_name?: string | undefined;
|
|
96650
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
|
|
96651
|
+
created_at: string;
|
|
96652
|
+
/** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96653
|
+
workspace_id: string;
|
|
96654
|
+
/** 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. */
|
|
96655
|
+
starts_at?: string | undefined;
|
|
96656
|
+
/** 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`. */
|
|
96657
|
+
ends_at?: string | undefined;
|
|
96658
|
+
/** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96659
|
+
errors: {
|
|
96660
|
+
error_code: string;
|
|
96661
|
+
message: string;
|
|
96662
|
+
/** Date and time at which Seam created the error. */
|
|
96663
|
+
created_at: string;
|
|
96664
|
+
}[];
|
|
96665
|
+
/** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96666
|
+
warnings: ({
|
|
96667
|
+
/** Date and time at which Seam created the warning. */
|
|
96668
|
+
created_at: string;
|
|
96669
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
96670
|
+
message: string;
|
|
96671
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
96672
|
+
warning_code: 'waiting_to_be_issued';
|
|
96673
|
+
} | {
|
|
96674
|
+
/** Date and time at which Seam created the warning. */
|
|
96675
|
+
created_at: string;
|
|
96676
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
96677
|
+
message: string;
|
|
96678
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
96679
|
+
warning_code: 'schedule_externally_modified';
|
|
96680
|
+
} | {
|
|
96681
|
+
/** Date and time at which Seam created the warning. */
|
|
96682
|
+
created_at: string;
|
|
96683
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
96684
|
+
message: string;
|
|
96685
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
96686
|
+
warning_code: 'schedule_modified';
|
|
96687
|
+
} | {
|
|
96688
|
+
/** Date and time at which Seam created the warning. */
|
|
96689
|
+
created_at: string;
|
|
96690
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
96691
|
+
message: string;
|
|
96692
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
96693
|
+
warning_code: 'being_deleted';
|
|
96694
|
+
} | {
|
|
96695
|
+
/** Date and time at which Seam created the warning. */
|
|
96696
|
+
created_at: string;
|
|
96697
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
96698
|
+
message: string;
|
|
96699
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
96700
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
96701
|
+
} | {
|
|
96702
|
+
/** Date and time at which Seam created the warning. */
|
|
96703
|
+
created_at: string;
|
|
96704
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
96705
|
+
message: string;
|
|
96706
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
96707
|
+
warning_code: 'needs_to_be_reissued';
|
|
96708
|
+
} | {
|
|
96709
|
+
/** Date and time at which Seam created the warning. */
|
|
96710
|
+
created_at: string;
|
|
96711
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
96712
|
+
message: string;
|
|
96713
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
96714
|
+
warning_code: 'requested_code_unavailable';
|
|
96715
|
+
/** The originally requested PIN code that could not be used. */
|
|
96716
|
+
original_code: string;
|
|
96717
|
+
/** The PIN code that was assigned instead. */
|
|
96718
|
+
new_code: string;
|
|
96719
|
+
})[];
|
|
96720
|
+
/** 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). */
|
|
96721
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
96722
|
+
/** 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. */
|
|
96723
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
96724
|
+
/** 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. */
|
|
96725
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
96726
|
+
/** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96727
|
+
visionline_metadata?: {
|
|
96728
|
+
/** Card function type in the Visionline access system. */
|
|
96729
|
+
card_function_type?: (('guest' | 'staff') | undefined) | undefined;
|
|
96730
|
+
/** IDs of the credentials to which you want to join. */
|
|
96731
|
+
joiner_acs_credential_ids?: (string[] | undefined) | undefined;
|
|
96732
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
96733
|
+
guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
96734
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
96735
|
+
common_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
96736
|
+
/** Indicates whether the credential is valid. */
|
|
96737
|
+
is_valid?: (boolean | undefined) | undefined;
|
|
96738
|
+
/** 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. */
|
|
96739
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
96740
|
+
/** ID of the card in the Visionline access system. */
|
|
96741
|
+
card_id?: (string | undefined) | undefined;
|
|
96742
|
+
/** ID of the credential in the Visionline access system. */
|
|
96743
|
+
credential_id?: (string | undefined) | undefined;
|
|
96744
|
+
} | undefined;
|
|
96745
|
+
/** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96746
|
+
assa_abloy_vostio_metadata?: {
|
|
96747
|
+
/** 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. */
|
|
96748
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
96749
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
96750
|
+
override_guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
96751
|
+
/** Key ID in the Vostio access system. */
|
|
96752
|
+
key_id?: (string | undefined) | undefined;
|
|
96753
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
96754
|
+
key_issuing_request_id?: (string | undefined) | undefined;
|
|
96755
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
96756
|
+
door_names?: (string[] | undefined) | undefined;
|
|
96757
|
+
/** Endpoint ID in the Vostio access system. */
|
|
96758
|
+
endpoint_id?: (string | undefined) | undefined;
|
|
96759
|
+
} | undefined;
|
|
96760
|
+
/** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96761
|
+
akiles_metadata?: {
|
|
96762
|
+
/** ID of the Akiles member PIN. */
|
|
96763
|
+
member_pin_id?: (string | undefined) | undefined;
|
|
96764
|
+
} | undefined;
|
|
96765
|
+
/** Indicates whether Seam manages the credential. */
|
|
96766
|
+
is_managed: true;
|
|
96767
|
+
} | {
|
|
96768
|
+
/** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96769
|
+
acs_credential_id: string;
|
|
96770
|
+
/** 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. */
|
|
96771
|
+
acs_user_id?: string | undefined;
|
|
96772
|
+
/** 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. */
|
|
96773
|
+
user_identity_id?: string | undefined;
|
|
96774
|
+
/** 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. */
|
|
96775
|
+
connected_account_id: string;
|
|
96776
|
+
/** ID of the credential pool to which the credential belongs. */
|
|
96777
|
+
acs_credential_pool_id?: string | undefined;
|
|
96778
|
+
/** 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). */
|
|
96779
|
+
acs_system_id: string;
|
|
96780
|
+
/** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96781
|
+
parent_acs_credential_id?: string | undefined;
|
|
96782
|
+
/** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
96783
|
+
display_name: string;
|
|
96784
|
+
/** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96785
|
+
code?: (string | undefined) | null;
|
|
96786
|
+
/** 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. */
|
|
96787
|
+
is_one_time_use?: boolean | undefined;
|
|
96788
|
+
/** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96789
|
+
card_number?: (string | undefined) | null;
|
|
96790
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
|
|
96791
|
+
is_issued?: boolean | undefined;
|
|
96792
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
|
|
96793
|
+
issued_at?: (string | undefined) | null;
|
|
96794
|
+
/** 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`. */
|
|
96795
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
96796
|
+
/** 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`. */
|
|
96797
|
+
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;
|
|
96798
|
+
/** 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. */
|
|
96799
|
+
external_type_display_name?: string | undefined;
|
|
96800
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
|
|
96801
|
+
created_at: string;
|
|
96802
|
+
/** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96803
|
+
workspace_id: string;
|
|
96804
|
+
/** 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. */
|
|
96805
|
+
starts_at?: string | undefined;
|
|
96806
|
+
/** 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`. */
|
|
96807
|
+
ends_at?: string | undefined;
|
|
96808
|
+
/** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96809
|
+
errors: {
|
|
96810
|
+
error_code: string;
|
|
96811
|
+
message: string;
|
|
96812
|
+
/** Date and time at which Seam created the error. */
|
|
96813
|
+
created_at: string;
|
|
96814
|
+
}[];
|
|
96815
|
+
/** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96816
|
+
warnings: ({
|
|
96817
|
+
/** Date and time at which Seam created the warning. */
|
|
96818
|
+
created_at: string;
|
|
96819
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
96820
|
+
message: string;
|
|
96821
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
96822
|
+
warning_code: 'waiting_to_be_issued';
|
|
96823
|
+
} | {
|
|
96824
|
+
/** Date and time at which Seam created the warning. */
|
|
96825
|
+
created_at: string;
|
|
96826
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
96827
|
+
message: string;
|
|
96828
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
96829
|
+
warning_code: 'schedule_externally_modified';
|
|
96830
|
+
} | {
|
|
96831
|
+
/** Date and time at which Seam created the warning. */
|
|
96832
|
+
created_at: string;
|
|
96833
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
96834
|
+
message: string;
|
|
96835
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
96836
|
+
warning_code: 'schedule_modified';
|
|
96837
|
+
} | {
|
|
96838
|
+
/** Date and time at which Seam created the warning. */
|
|
96839
|
+
created_at: string;
|
|
96840
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
96841
|
+
message: string;
|
|
96842
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
96843
|
+
warning_code: 'being_deleted';
|
|
96844
|
+
} | {
|
|
96845
|
+
/** Date and time at which Seam created the warning. */
|
|
96846
|
+
created_at: string;
|
|
96847
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
96848
|
+
message: string;
|
|
96849
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
96850
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
96851
|
+
} | {
|
|
96852
|
+
/** Date and time at which Seam created the warning. */
|
|
96853
|
+
created_at: string;
|
|
96854
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
96855
|
+
message: string;
|
|
96856
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
96857
|
+
warning_code: 'needs_to_be_reissued';
|
|
96858
|
+
} | {
|
|
96859
|
+
/** Date and time at which Seam created the warning. */
|
|
96860
|
+
created_at: string;
|
|
96861
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
96862
|
+
message: string;
|
|
96863
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
96864
|
+
warning_code: 'requested_code_unavailable';
|
|
96865
|
+
/** The originally requested PIN code that could not be used. */
|
|
96866
|
+
original_code: string;
|
|
96867
|
+
/** The PIN code that was assigned instead. */
|
|
96868
|
+
new_code: string;
|
|
96869
|
+
})[];
|
|
96870
|
+
/** 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). */
|
|
96871
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
96872
|
+
/** 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. */
|
|
96873
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
96874
|
+
/** 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. */
|
|
96875
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
96876
|
+
/** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96877
|
+
visionline_metadata?: {
|
|
96878
|
+
/** Card function type in the Visionline access system. */
|
|
96879
|
+
card_function_type?: (('guest' | 'staff') | undefined) | undefined;
|
|
96880
|
+
/** IDs of the credentials to which you want to join. */
|
|
96881
|
+
joiner_acs_credential_ids?: (string[] | undefined) | undefined;
|
|
96882
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
96883
|
+
guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
96884
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
96885
|
+
common_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
96886
|
+
/** Indicates whether the credential is valid. */
|
|
96887
|
+
is_valid?: (boolean | undefined) | undefined;
|
|
96888
|
+
/** 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. */
|
|
96889
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
96890
|
+
/** ID of the card in the Visionline access system. */
|
|
96891
|
+
card_id?: (string | undefined) | undefined;
|
|
96892
|
+
/** ID of the credential in the Visionline access system. */
|
|
96893
|
+
credential_id?: (string | undefined) | undefined;
|
|
96894
|
+
} | undefined;
|
|
96895
|
+
/** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96896
|
+
assa_abloy_vostio_metadata?: {
|
|
96897
|
+
/** 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. */
|
|
96898
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
96899
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
96900
|
+
override_guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
96901
|
+
/** Key ID in the Vostio access system. */
|
|
96902
|
+
key_id?: (string | undefined) | undefined;
|
|
96903
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
96904
|
+
key_issuing_request_id?: (string | undefined) | undefined;
|
|
96905
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
96906
|
+
door_names?: (string[] | undefined) | undefined;
|
|
96907
|
+
/** Endpoint ID in the Vostio access system. */
|
|
96908
|
+
endpoint_id?: (string | undefined) | undefined;
|
|
96909
|
+
} | undefined;
|
|
96910
|
+
/** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96911
|
+
akiles_metadata?: {
|
|
96912
|
+
/** ID of the Akiles member PIN. */
|
|
96913
|
+
member_pin_id?: (string | undefined) | undefined;
|
|
96914
|
+
} | undefined;
|
|
96915
|
+
is_managed: false;
|
|
96916
|
+
}) | null;
|
|
96917
|
+
/** 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. */
|
|
96918
|
+
warnings: {
|
|
96919
|
+
/** Indicates a warning related to scanning a credential. */
|
|
96920
|
+
warning_code: 'acs_credential_on_encoder_out_of_sync' | 'acs_credential_on_seam_not_found';
|
|
96921
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
96922
|
+
warning_message: string;
|
|
96923
|
+
}[];
|
|
96924
|
+
};
|
|
96925
|
+
} | {
|
|
96926
|
+
/** ID of the action attempt. */
|
|
96927
|
+
action_attempt_id: string;
|
|
96928
|
+
status: 'error';
|
|
96929
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
96930
|
+
result: null;
|
|
96931
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
96932
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
96933
|
+
error: {
|
|
96934
|
+
/** Type of the error associated with the action attempt. */
|
|
96935
|
+
type: 'uncategorized_error';
|
|
96936
|
+
/** Message for the error associated with the action attempt. */
|
|
96937
|
+
message: string;
|
|
96938
|
+
} | {
|
|
96939
|
+
/** Type of the error associated with the action attempt. */
|
|
96940
|
+
type: 'action_attempt_expired';
|
|
96941
|
+
/** Message for the error associated with the action attempt. */
|
|
96942
|
+
message: string;
|
|
96943
|
+
} | {
|
|
96944
|
+
/** Error type to indicate that there is no credential on the encoder. */
|
|
96945
|
+
type: 'no_credential_on_encoder';
|
|
96946
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
96947
|
+
message: string;
|
|
96948
|
+
} | {
|
|
96949
|
+
/** Error type to indicate that the encoder is not online. */
|
|
96950
|
+
type: 'encoder_not_online';
|
|
96951
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
96952
|
+
message: string;
|
|
96953
|
+
} | {
|
|
96954
|
+
/** Error type to indicate that communication with the encoder timed out. */
|
|
96955
|
+
type: 'encoder_communication_timeout';
|
|
96956
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
96957
|
+
message: string;
|
|
96958
|
+
} | {
|
|
96959
|
+
/** Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system. */
|
|
96960
|
+
type: 'bridge_disconnected';
|
|
96961
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
96962
|
+
message: string;
|
|
96963
|
+
};
|
|
96964
|
+
} | {
|
|
96965
|
+
/** ID of the action attempt. */
|
|
96966
|
+
action_attempt_id: string;
|
|
96967
|
+
status: 'pending';
|
|
96968
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
96969
|
+
result: null;
|
|
96970
|
+
/** Errors associated with the action attempt. Null for pending 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
|
+
} | {
|
|
96975
|
+
/** ID of the action attempt. */
|
|
96976
|
+
action_attempt_id: string;
|
|
96977
|
+
status: 'success';
|
|
96978
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
96979
|
+
error: null;
|
|
96980
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
96981
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
96982
|
+
/** Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card. */
|
|
96983
|
+
result: {
|
|
96984
|
+
/** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96985
|
+
acs_credential_id: string;
|
|
96986
|
+
/** 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. */
|
|
96987
|
+
acs_user_id?: string | undefined;
|
|
96988
|
+
/** 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. */
|
|
96989
|
+
user_identity_id?: string | undefined;
|
|
96990
|
+
/** 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. */
|
|
96991
|
+
connected_account_id: string;
|
|
96992
|
+
/** ID of the credential pool to which the credential belongs. */
|
|
96993
|
+
acs_credential_pool_id?: string | undefined;
|
|
96994
|
+
/** 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). */
|
|
96995
|
+
acs_system_id: string;
|
|
96996
|
+
/** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
96997
|
+
parent_acs_credential_id?: string | undefined;
|
|
96998
|
+
/** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
96999
|
+
display_name: string;
|
|
97000
|
+
/** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97001
|
+
code?: (string | undefined) | null;
|
|
97002
|
+
/** 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. */
|
|
97003
|
+
is_one_time_use?: boolean | undefined;
|
|
97004
|
+
/** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97005
|
+
card_number?: (string | undefined) | null;
|
|
97006
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
|
|
97007
|
+
is_issued?: boolean | undefined;
|
|
97008
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
|
|
97009
|
+
issued_at?: (string | undefined) | null;
|
|
97010
|
+
/** 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`. */
|
|
97011
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
97012
|
+
/** 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`. */
|
|
97013
|
+
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;
|
|
97014
|
+
/** 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. */
|
|
97015
|
+
external_type_display_name?: string | undefined;
|
|
97016
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
|
|
97017
|
+
created_at: string;
|
|
97018
|
+
/** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97019
|
+
workspace_id: string;
|
|
97020
|
+
/** 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. */
|
|
97021
|
+
starts_at?: string | undefined;
|
|
97022
|
+
/** 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`. */
|
|
97023
|
+
ends_at?: string | undefined;
|
|
97024
|
+
/** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97025
|
+
errors: {
|
|
97026
|
+
error_code: string;
|
|
97027
|
+
message: string;
|
|
97028
|
+
/** Date and time at which Seam created the error. */
|
|
97029
|
+
created_at: string;
|
|
97030
|
+
}[];
|
|
97031
|
+
/** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97032
|
+
warnings: ({
|
|
97033
|
+
/** Date and time at which Seam created the warning. */
|
|
97034
|
+
created_at: string;
|
|
97035
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97036
|
+
message: string;
|
|
97037
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97038
|
+
warning_code: 'waiting_to_be_issued';
|
|
97039
|
+
} | {
|
|
97040
|
+
/** Date and time at which Seam created the warning. */
|
|
97041
|
+
created_at: string;
|
|
97042
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97043
|
+
message: string;
|
|
97044
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97045
|
+
warning_code: 'schedule_externally_modified';
|
|
97046
|
+
} | {
|
|
97047
|
+
/** Date and time at which Seam created the warning. */
|
|
97048
|
+
created_at: string;
|
|
97049
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97050
|
+
message: string;
|
|
97051
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97052
|
+
warning_code: 'schedule_modified';
|
|
97053
|
+
} | {
|
|
97054
|
+
/** Date and time at which Seam created the warning. */
|
|
97055
|
+
created_at: string;
|
|
97056
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97057
|
+
message: string;
|
|
97058
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97059
|
+
warning_code: 'being_deleted';
|
|
97060
|
+
} | {
|
|
97061
|
+
/** Date and time at which Seam created the warning. */
|
|
97062
|
+
created_at: string;
|
|
97063
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97064
|
+
message: string;
|
|
97065
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97066
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
97067
|
+
} | {
|
|
97068
|
+
/** Date and time at which Seam created the warning. */
|
|
97069
|
+
created_at: string;
|
|
97070
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97071
|
+
message: string;
|
|
97072
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97073
|
+
warning_code: 'needs_to_be_reissued';
|
|
97074
|
+
} | {
|
|
97075
|
+
/** Date and time at which Seam created the warning. */
|
|
97076
|
+
created_at: string;
|
|
97077
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97078
|
+
message: string;
|
|
97079
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97080
|
+
warning_code: 'requested_code_unavailable';
|
|
97081
|
+
/** The originally requested PIN code that could not be used. */
|
|
97082
|
+
original_code: string;
|
|
97083
|
+
/** The PIN code that was assigned instead. */
|
|
97084
|
+
new_code: string;
|
|
97085
|
+
})[];
|
|
97086
|
+
/** 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). */
|
|
97087
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
97088
|
+
/** 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. */
|
|
97089
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
97090
|
+
/** 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. */
|
|
97091
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
97092
|
+
/** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97093
|
+
visionline_metadata?: {
|
|
97094
|
+
/** Card function type in the Visionline access system. */
|
|
97095
|
+
card_function_type?: (('guest' | 'staff') | undefined) | undefined;
|
|
97096
|
+
/** IDs of the credentials to which you want to join. */
|
|
97097
|
+
joiner_acs_credential_ids?: (string[] | undefined) | undefined;
|
|
97098
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
97099
|
+
guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
97100
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
97101
|
+
common_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
97102
|
+
/** Indicates whether the credential is valid. */
|
|
97103
|
+
is_valid?: (boolean | undefined) | undefined;
|
|
97104
|
+
/** 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. */
|
|
97105
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
97106
|
+
/** ID of the card in the Visionline access system. */
|
|
97107
|
+
card_id?: (string | undefined) | undefined;
|
|
97108
|
+
/** ID of the credential in the Visionline access system. */
|
|
97109
|
+
credential_id?: (string | undefined) | undefined;
|
|
97110
|
+
} | undefined;
|
|
97111
|
+
/** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97112
|
+
assa_abloy_vostio_metadata?: {
|
|
97113
|
+
/** 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. */
|
|
97114
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
97115
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
97116
|
+
override_guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
97117
|
+
/** Key ID in the Vostio access system. */
|
|
97118
|
+
key_id?: (string | undefined) | undefined;
|
|
97119
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
97120
|
+
key_issuing_request_id?: (string | undefined) | undefined;
|
|
97121
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
97122
|
+
door_names?: (string[] | undefined) | undefined;
|
|
97123
|
+
/** Endpoint ID in the Vostio access system. */
|
|
97124
|
+
endpoint_id?: (string | undefined) | undefined;
|
|
97125
|
+
} | undefined;
|
|
97126
|
+
/** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97127
|
+
akiles_metadata?: {
|
|
97128
|
+
/** ID of the Akiles member PIN. */
|
|
97129
|
+
member_pin_id?: (string | undefined) | undefined;
|
|
97130
|
+
} | undefined;
|
|
97131
|
+
/** Indicates whether Seam manages the credential. */
|
|
97132
|
+
is_managed: true;
|
|
97133
|
+
} | {
|
|
97134
|
+
/** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97135
|
+
acs_credential_id: string;
|
|
97136
|
+
/** 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. */
|
|
97137
|
+
acs_user_id?: string | undefined;
|
|
97138
|
+
/** 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. */
|
|
97139
|
+
user_identity_id?: string | undefined;
|
|
97140
|
+
/** 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. */
|
|
97141
|
+
connected_account_id: string;
|
|
97142
|
+
/** ID of the credential pool to which the credential belongs. */
|
|
97143
|
+
acs_credential_pool_id?: string | undefined;
|
|
97144
|
+
/** 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). */
|
|
97145
|
+
acs_system_id: string;
|
|
97146
|
+
/** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97147
|
+
parent_acs_credential_id?: string | undefined;
|
|
97148
|
+
/** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
97149
|
+
display_name: string;
|
|
97150
|
+
/** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97151
|
+
code?: (string | undefined) | null;
|
|
97152
|
+
/** 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. */
|
|
97153
|
+
is_one_time_use?: boolean | undefined;
|
|
97154
|
+
/** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97155
|
+
card_number?: (string | undefined) | null;
|
|
97156
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
|
|
97157
|
+
is_issued?: boolean | undefined;
|
|
97158
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
|
|
97159
|
+
issued_at?: (string | undefined) | null;
|
|
97160
|
+
/** 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`. */
|
|
97161
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
97162
|
+
/** 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`. */
|
|
97163
|
+
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;
|
|
97164
|
+
/** 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. */
|
|
97165
|
+
external_type_display_name?: string | undefined;
|
|
97166
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
|
|
97167
|
+
created_at: string;
|
|
97168
|
+
/** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97169
|
+
workspace_id: string;
|
|
97170
|
+
/** 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. */
|
|
97171
|
+
starts_at?: string | undefined;
|
|
97172
|
+
/** 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`. */
|
|
97173
|
+
ends_at?: string | undefined;
|
|
97174
|
+
/** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97175
|
+
errors: {
|
|
97176
|
+
error_code: string;
|
|
97177
|
+
message: string;
|
|
97178
|
+
/** Date and time at which Seam created the error. */
|
|
97179
|
+
created_at: string;
|
|
97180
|
+
}[];
|
|
97181
|
+
/** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97182
|
+
warnings: ({
|
|
97183
|
+
/** Date and time at which Seam created the warning. */
|
|
97184
|
+
created_at: string;
|
|
97185
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97186
|
+
message: string;
|
|
97187
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97188
|
+
warning_code: 'waiting_to_be_issued';
|
|
97189
|
+
} | {
|
|
97190
|
+
/** Date and time at which Seam created the warning. */
|
|
97191
|
+
created_at: string;
|
|
97192
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97193
|
+
message: string;
|
|
97194
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97195
|
+
warning_code: 'schedule_externally_modified';
|
|
97196
|
+
} | {
|
|
97197
|
+
/** Date and time at which Seam created the warning. */
|
|
97198
|
+
created_at: string;
|
|
97199
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97200
|
+
message: string;
|
|
97201
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97202
|
+
warning_code: 'schedule_modified';
|
|
97203
|
+
} | {
|
|
97204
|
+
/** Date and time at which Seam created the warning. */
|
|
97205
|
+
created_at: string;
|
|
97206
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97207
|
+
message: string;
|
|
97208
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97209
|
+
warning_code: 'being_deleted';
|
|
97210
|
+
} | {
|
|
97211
|
+
/** Date and time at which Seam created the warning. */
|
|
97212
|
+
created_at: string;
|
|
97213
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97214
|
+
message: string;
|
|
97215
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97216
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
97217
|
+
} | {
|
|
97218
|
+
/** Date and time at which Seam created the warning. */
|
|
97219
|
+
created_at: string;
|
|
97220
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97221
|
+
message: string;
|
|
97222
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97223
|
+
warning_code: 'needs_to_be_reissued';
|
|
97224
|
+
} | {
|
|
97225
|
+
/** Date and time at which Seam created the warning. */
|
|
97226
|
+
created_at: string;
|
|
97227
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97228
|
+
message: string;
|
|
97229
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97230
|
+
warning_code: 'requested_code_unavailable';
|
|
97231
|
+
/** The originally requested PIN code that could not be used. */
|
|
97232
|
+
original_code: string;
|
|
97233
|
+
/** The PIN code that was assigned instead. */
|
|
97234
|
+
new_code: string;
|
|
97235
|
+
})[];
|
|
97236
|
+
/** 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). */
|
|
97237
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
97238
|
+
/** 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. */
|
|
97239
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
97240
|
+
/** 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. */
|
|
97241
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
97242
|
+
/** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97243
|
+
visionline_metadata?: {
|
|
97244
|
+
/** Card function type in the Visionline access system. */
|
|
97245
|
+
card_function_type?: (('guest' | 'staff') | undefined) | undefined;
|
|
97246
|
+
/** IDs of the credentials to which you want to join. */
|
|
97247
|
+
joiner_acs_credential_ids?: (string[] | undefined) | undefined;
|
|
97248
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
97249
|
+
guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
97250
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
97251
|
+
common_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
97252
|
+
/** Indicates whether the credential is valid. */
|
|
97253
|
+
is_valid?: (boolean | undefined) | undefined;
|
|
97254
|
+
/** 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. */
|
|
97255
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
97256
|
+
/** ID of the card in the Visionline access system. */
|
|
97257
|
+
card_id?: (string | undefined) | undefined;
|
|
97258
|
+
/** ID of the credential in the Visionline access system. */
|
|
97259
|
+
credential_id?: (string | undefined) | undefined;
|
|
97260
|
+
} | undefined;
|
|
97261
|
+
/** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97262
|
+
assa_abloy_vostio_metadata?: {
|
|
97263
|
+
/** 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. */
|
|
97264
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
97265
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
97266
|
+
override_guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
97267
|
+
/** Key ID in the Vostio access system. */
|
|
97268
|
+
key_id?: (string | undefined) | undefined;
|
|
97269
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
97270
|
+
key_issuing_request_id?: (string | undefined) | undefined;
|
|
97271
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
97272
|
+
door_names?: (string[] | undefined) | undefined;
|
|
97273
|
+
/** Endpoint ID in the Vostio access system. */
|
|
97274
|
+
endpoint_id?: (string | undefined) | undefined;
|
|
97275
|
+
} | undefined;
|
|
97276
|
+
/** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97277
|
+
akiles_metadata?: {
|
|
97278
|
+
/** ID of the Akiles member PIN. */
|
|
97279
|
+
member_pin_id?: (string | undefined) | undefined;
|
|
97280
|
+
} | undefined;
|
|
97281
|
+
is_managed: false;
|
|
97282
|
+
};
|
|
97283
|
+
} | {
|
|
97284
|
+
/** ID of the action attempt. */
|
|
97285
|
+
action_attempt_id: string;
|
|
97286
|
+
status: 'error';
|
|
97287
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
97288
|
+
result: null;
|
|
97289
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
97290
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
97291
|
+
error: {
|
|
97292
|
+
/** Type of the error associated with the action attempt. */
|
|
97293
|
+
type: 'uncategorized_error';
|
|
97294
|
+
/** Message for the error associated with the action attempt. */
|
|
97295
|
+
message: string;
|
|
97296
|
+
} | {
|
|
97297
|
+
/** Type of the error associated with the action attempt. */
|
|
97298
|
+
type: 'action_attempt_expired';
|
|
97299
|
+
/** Message for the error associated with the action attempt. */
|
|
97300
|
+
message: string;
|
|
97301
|
+
} | {
|
|
97302
|
+
/** Error type to indicate that there is no credential on the encoder. */
|
|
97303
|
+
type: 'no_credential_on_encoder';
|
|
97304
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97305
|
+
message: string;
|
|
97306
|
+
} | {
|
|
97307
|
+
/** Error type to indicate an incompatible card format. */
|
|
97308
|
+
type: 'incompatible_card_format';
|
|
97309
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97310
|
+
message: string;
|
|
97311
|
+
} | {
|
|
97312
|
+
/** Error type to indicate that the affected credential cannot be reissued. */
|
|
97313
|
+
type: 'credential_cannot_be_reissued';
|
|
97314
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97315
|
+
message: string;
|
|
97316
|
+
} | {
|
|
97317
|
+
/** Error type to indicate that the encoder is not online. */
|
|
97318
|
+
type: 'encoder_not_online';
|
|
97319
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97320
|
+
message: string;
|
|
97321
|
+
} | {
|
|
97322
|
+
/** Error type to indicate that communication with the encoder timed out. */
|
|
97323
|
+
type: 'encoder_communication_timeout';
|
|
97324
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97325
|
+
message: string;
|
|
97326
|
+
} | {
|
|
97327
|
+
/** Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system. */
|
|
97328
|
+
type: 'bridge_disconnected';
|
|
97329
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97330
|
+
message: string;
|
|
97331
|
+
} | {
|
|
97332
|
+
/** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
|
|
97333
|
+
type: 'encoding_interrupted';
|
|
97334
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97335
|
+
message: string;
|
|
97336
|
+
} | {
|
|
97337
|
+
/** Error type to indicate that the credential was deleted and can no longer be encoded. */
|
|
97338
|
+
type: 'credential_deleted';
|
|
97339
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97340
|
+
message: string;
|
|
97341
|
+
};
|
|
97342
|
+
} | {
|
|
97343
|
+
/** ID of the action attempt. */
|
|
97344
|
+
action_attempt_id: string;
|
|
97345
|
+
status: 'pending';
|
|
97346
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
97347
|
+
result: null;
|
|
97348
|
+
/** Errors associated with the action attempt. Null for pending 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
|
+
} | {
|
|
97353
|
+
/** ID of the action attempt. */
|
|
97354
|
+
action_attempt_id: string;
|
|
97355
|
+
status: 'success';
|
|
97356
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
97357
|
+
error: null;
|
|
97358
|
+
/** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
|
|
97359
|
+
action_type: 'SCAN_TO_ASSIGN_CREDENTIAL';
|
|
97360
|
+
/** Result of a scan to assign attempt. If the attempt was successful, includes the credential data that was scanned and assigned. */
|
|
97361
|
+
result: {
|
|
97362
|
+
/** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97363
|
+
acs_credential_id: string;
|
|
97364
|
+
/** 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. */
|
|
97365
|
+
acs_user_id?: string | undefined;
|
|
97366
|
+
/** 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. */
|
|
97367
|
+
user_identity_id?: string | undefined;
|
|
97368
|
+
/** 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. */
|
|
97369
|
+
connected_account_id: string;
|
|
97370
|
+
/** ID of the credential pool to which the credential belongs. */
|
|
97371
|
+
acs_credential_pool_id?: string | undefined;
|
|
97372
|
+
/** 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). */
|
|
97373
|
+
acs_system_id: string;
|
|
97374
|
+
/** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97375
|
+
parent_acs_credential_id?: string | undefined;
|
|
97376
|
+
/** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
97377
|
+
display_name: string;
|
|
97378
|
+
/** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97379
|
+
code?: (string | undefined) | null;
|
|
97380
|
+
/** 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. */
|
|
97381
|
+
is_one_time_use?: boolean | undefined;
|
|
97382
|
+
/** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97383
|
+
card_number?: (string | undefined) | null;
|
|
97384
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
|
|
97385
|
+
is_issued?: boolean | undefined;
|
|
97386
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
|
|
97387
|
+
issued_at?: (string | undefined) | null;
|
|
97388
|
+
/** 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`. */
|
|
97389
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
97390
|
+
/** 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`. */
|
|
97391
|
+
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;
|
|
97392
|
+
/** 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. */
|
|
97393
|
+
external_type_display_name?: string | undefined;
|
|
97394
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
|
|
97395
|
+
created_at: string;
|
|
97396
|
+
/** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97397
|
+
workspace_id: string;
|
|
97398
|
+
/** 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. */
|
|
97399
|
+
starts_at?: string | undefined;
|
|
97400
|
+
/** 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`. */
|
|
97401
|
+
ends_at?: string | undefined;
|
|
97402
|
+
/** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97403
|
+
errors: {
|
|
97404
|
+
error_code: string;
|
|
97405
|
+
message: string;
|
|
97406
|
+
/** Date and time at which Seam created the error. */
|
|
97407
|
+
created_at: string;
|
|
97408
|
+
}[];
|
|
97409
|
+
/** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97410
|
+
warnings: ({
|
|
97411
|
+
/** Date and time at which Seam created the warning. */
|
|
97412
|
+
created_at: string;
|
|
97413
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97414
|
+
message: string;
|
|
97415
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97416
|
+
warning_code: 'waiting_to_be_issued';
|
|
97417
|
+
} | {
|
|
97418
|
+
/** Date and time at which Seam created the warning. */
|
|
97419
|
+
created_at: string;
|
|
97420
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97421
|
+
message: string;
|
|
97422
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97423
|
+
warning_code: 'schedule_externally_modified';
|
|
97424
|
+
} | {
|
|
97425
|
+
/** Date and time at which Seam created the warning. */
|
|
97426
|
+
created_at: string;
|
|
97427
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97428
|
+
message: string;
|
|
97429
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97430
|
+
warning_code: 'schedule_modified';
|
|
97431
|
+
} | {
|
|
97432
|
+
/** Date and time at which Seam created the warning. */
|
|
97433
|
+
created_at: string;
|
|
97434
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97435
|
+
message: string;
|
|
97436
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97437
|
+
warning_code: 'being_deleted';
|
|
97438
|
+
} | {
|
|
97439
|
+
/** Date and time at which Seam created the warning. */
|
|
97440
|
+
created_at: string;
|
|
97441
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97442
|
+
message: string;
|
|
97443
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97444
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
97445
|
+
} | {
|
|
97446
|
+
/** Date and time at which Seam created the warning. */
|
|
97447
|
+
created_at: string;
|
|
97448
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97449
|
+
message: string;
|
|
97450
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97451
|
+
warning_code: 'needs_to_be_reissued';
|
|
97452
|
+
} | {
|
|
97453
|
+
/** Date and time at which Seam created the warning. */
|
|
97454
|
+
created_at: string;
|
|
97455
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97456
|
+
message: string;
|
|
97457
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97458
|
+
warning_code: 'requested_code_unavailable';
|
|
97459
|
+
/** The originally requested PIN code that could not be used. */
|
|
97460
|
+
original_code: string;
|
|
97461
|
+
/** The PIN code that was assigned instead. */
|
|
97462
|
+
new_code: string;
|
|
97463
|
+
})[];
|
|
97464
|
+
/** 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). */
|
|
97465
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
97466
|
+
/** 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. */
|
|
97467
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
97468
|
+
/** 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. */
|
|
97469
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
97470
|
+
/** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97471
|
+
visionline_metadata?: {
|
|
97472
|
+
/** Card function type in the Visionline access system. */
|
|
97473
|
+
card_function_type?: (('guest' | 'staff') | undefined) | undefined;
|
|
97474
|
+
/** IDs of the credentials to which you want to join. */
|
|
97475
|
+
joiner_acs_credential_ids?: (string[] | undefined) | undefined;
|
|
97476
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
97477
|
+
guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
97478
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
97479
|
+
common_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
97480
|
+
/** Indicates whether the credential is valid. */
|
|
97481
|
+
is_valid?: (boolean | undefined) | undefined;
|
|
97482
|
+
/** 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. */
|
|
97483
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
97484
|
+
/** ID of the card in the Visionline access system. */
|
|
97485
|
+
card_id?: (string | undefined) | undefined;
|
|
97486
|
+
/** ID of the credential in the Visionline access system. */
|
|
97487
|
+
credential_id?: (string | undefined) | undefined;
|
|
97488
|
+
} | undefined;
|
|
97489
|
+
/** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97490
|
+
assa_abloy_vostio_metadata?: {
|
|
97491
|
+
/** 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. */
|
|
97492
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
97493
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
97494
|
+
override_guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
97495
|
+
/** Key ID in the Vostio access system. */
|
|
97496
|
+
key_id?: (string | undefined) | undefined;
|
|
97497
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
97498
|
+
key_issuing_request_id?: (string | undefined) | undefined;
|
|
97499
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
97500
|
+
door_names?: (string[] | undefined) | undefined;
|
|
97501
|
+
/** Endpoint ID in the Vostio access system. */
|
|
97502
|
+
endpoint_id?: (string | undefined) | undefined;
|
|
97503
|
+
} | undefined;
|
|
97504
|
+
/** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
97505
|
+
akiles_metadata?: {
|
|
97506
|
+
/** ID of the Akiles member PIN. */
|
|
97507
|
+
member_pin_id?: (string | undefined) | undefined;
|
|
97508
|
+
} | undefined;
|
|
97509
|
+
/** Indicates whether Seam manages the credential. */
|
|
97510
|
+
is_managed: true;
|
|
97511
|
+
};
|
|
97512
|
+
} | {
|
|
97513
|
+
/** ID of the action attempt. */
|
|
97514
|
+
action_attempt_id: string;
|
|
97515
|
+
status: 'error';
|
|
97516
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
97517
|
+
result: null;
|
|
97518
|
+
/** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
|
|
97519
|
+
action_type: 'SCAN_TO_ASSIGN_CREDENTIAL';
|
|
97520
|
+
error: {
|
|
97521
|
+
/** Type of the error associated with the action attempt. */
|
|
97522
|
+
type: 'uncategorized_error';
|
|
97523
|
+
/** Message for the error associated with the action attempt. */
|
|
97524
|
+
message: string;
|
|
97525
|
+
} | {
|
|
97526
|
+
/** Type of the error associated with the action attempt. */
|
|
97527
|
+
type: 'action_attempt_expired';
|
|
97528
|
+
/** Message for the error associated with the action attempt. */
|
|
97529
|
+
message: string;
|
|
97530
|
+
} | {
|
|
97531
|
+
/** Error type to indicate that there is no credential on the encoder. */
|
|
97532
|
+
type: 'no_credential_on_encoder';
|
|
97533
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97534
|
+
message: string;
|
|
97535
|
+
};
|
|
97536
|
+
} | {
|
|
97537
|
+
/** ID of the action attempt. */
|
|
97538
|
+
action_attempt_id: string;
|
|
97539
|
+
status: 'pending';
|
|
97540
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
97541
|
+
result: null;
|
|
97542
|
+
/** Errors associated with the action attempt. Null for pending 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
|
+
} | {
|
|
97547
|
+
/** ID of the action attempt. */
|
|
97548
|
+
action_attempt_id: string;
|
|
97549
|
+
status: 'success';
|
|
97550
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
97551
|
+
error: null;
|
|
97552
|
+
/** Action attempt to track the status of assigning a pre-registered card credential to an access method. */
|
|
97553
|
+
action_type: 'ASSIGN_CREDENTIAL';
|
|
97554
|
+
/** Result of assigning a credential. If successful, includes the updated access method with the assigned credential. */
|
|
97555
|
+
result: {
|
|
97556
|
+
/** ID of the Seam workspace associated with the access method. */
|
|
97557
|
+
workspace_id: string;
|
|
97558
|
+
/** ID of the access method. */
|
|
97559
|
+
access_method_id: string;
|
|
97560
|
+
/** Display name of the access method. */
|
|
97561
|
+
display_name: string;
|
|
97562
|
+
/** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
97563
|
+
mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
97564
|
+
/** Date and time at which the access method was created. */
|
|
97565
|
+
created_at: string;
|
|
97566
|
+
/** Date and time at which the access method was issued. */
|
|
97567
|
+
issued_at: string | null;
|
|
97568
|
+
/** Indicates whether the access method has been issued. */
|
|
97569
|
+
is_issued: boolean;
|
|
97570
|
+
/** 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`. */
|
|
97571
|
+
display_status: string;
|
|
97572
|
+
/** URL of the Instant Key for mobile key access methods. */
|
|
97573
|
+
instant_key_url?: string | undefined;
|
|
97574
|
+
/** Token of the client session associated with the access method. */
|
|
97575
|
+
client_session_token?: string | undefined;
|
|
97576
|
+
/** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
|
|
97577
|
+
is_encoding_required?: boolean | undefined;
|
|
97578
|
+
/** 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. */
|
|
97579
|
+
is_ready_for_encoding?: boolean | undefined;
|
|
97580
|
+
/** 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. */
|
|
97581
|
+
is_assignment_required?: boolean | undefined;
|
|
97582
|
+
/** 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. */
|
|
97583
|
+
is_ready_for_assignment?: boolean | undefined;
|
|
97584
|
+
/** The actual PIN code for code access methods. */
|
|
97585
|
+
code?: (string | null) | undefined;
|
|
97586
|
+
/** Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */
|
|
97587
|
+
warnings: ({
|
|
97588
|
+
/** Date and time at which Seam created the warning. */
|
|
97589
|
+
created_at: string;
|
|
97590
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97591
|
+
message: string;
|
|
97592
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97593
|
+
warning_code: 'being_deleted';
|
|
97594
|
+
} | {
|
|
97595
|
+
/** Date and time at which Seam created the warning. */
|
|
97596
|
+
created_at: string;
|
|
97597
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97598
|
+
message: string;
|
|
97599
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97600
|
+
warning_code: 'updating_access_times';
|
|
97601
|
+
} | {
|
|
97602
|
+
/** Date and time at which Seam created the warning. */
|
|
97603
|
+
created_at: string;
|
|
97604
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97605
|
+
message: string;
|
|
97606
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97607
|
+
warning_code: 'pulled_backup_access_code';
|
|
97608
|
+
/** ID of the original access method from which this backup access method was split, if applicable. */
|
|
97609
|
+
original_access_method_id?: string | undefined;
|
|
97610
|
+
} | {
|
|
97611
|
+
/** Date and time at which Seam created the warning. */
|
|
97612
|
+
created_at: string;
|
|
97613
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97614
|
+
message: string;
|
|
97615
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97616
|
+
warning_code: 'delay_in_issuing';
|
|
97617
|
+
} | {
|
|
97618
|
+
/** Date and time at which Seam created the warning. */
|
|
97619
|
+
created_at: string;
|
|
97620
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97621
|
+
message: string;
|
|
97622
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97623
|
+
warning_code: 'user_identity_missing_email_address';
|
|
97624
|
+
} | {
|
|
97625
|
+
/** Date and time at which Seam created the warning. */
|
|
97626
|
+
created_at: string;
|
|
97627
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
97628
|
+
message: string;
|
|
97629
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
97630
|
+
warning_code: 'user_identity_missing_phone_number';
|
|
97631
|
+
})[];
|
|
97632
|
+
/** Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */
|
|
97633
|
+
errors: {
|
|
97634
|
+
/** Date and time at which Seam created the error. */
|
|
97635
|
+
created_at: string;
|
|
97636
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97637
|
+
message: string;
|
|
97638
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
97639
|
+
error_code: 'failed_to_issue';
|
|
97640
|
+
}[];
|
|
97641
|
+
/** 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. */
|
|
97642
|
+
pending_mutations: ({
|
|
97643
|
+
/** Date and time at which the mutation was created. */
|
|
97644
|
+
created_at: string;
|
|
97645
|
+
/** Detailed description of the mutation. */
|
|
97646
|
+
message: string;
|
|
97647
|
+
/** Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices. */
|
|
97648
|
+
mutation_code: 'provisioning_access';
|
|
97649
|
+
/** Previous device configuration. */
|
|
97650
|
+
from: {
|
|
97651
|
+
/** Previous device IDs where access was provisioned. */
|
|
97652
|
+
device_ids: string[];
|
|
97653
|
+
};
|
|
97654
|
+
/** New device configuration. */
|
|
97655
|
+
to: {
|
|
97656
|
+
/** New device IDs where access is being provisioned. */
|
|
97657
|
+
device_ids: string[];
|
|
97658
|
+
};
|
|
97659
|
+
} | {
|
|
97660
|
+
/** Date and time at which the mutation was created. */
|
|
97661
|
+
created_at: string;
|
|
97662
|
+
/** Detailed description of the mutation. */
|
|
97663
|
+
message: string;
|
|
97664
|
+
/** Mutation code to indicate that Seam is in the process of revoking access for this access method from devices. */
|
|
97665
|
+
mutation_code: 'revoking_access';
|
|
97666
|
+
/** Previous device configuration. */
|
|
97667
|
+
from: {
|
|
97668
|
+
/** Previous device IDs where access existed. */
|
|
97669
|
+
device_ids: string[];
|
|
97670
|
+
};
|
|
97671
|
+
/** New device configuration. */
|
|
97672
|
+
to: {
|
|
97673
|
+
/** New device IDs where access should remain. */
|
|
97674
|
+
device_ids: string[];
|
|
97675
|
+
};
|
|
97676
|
+
} | {
|
|
97677
|
+
/** Date and time at which the mutation was created. */
|
|
97678
|
+
created_at: string;
|
|
97679
|
+
/** Detailed description of the mutation. */
|
|
97680
|
+
message: string;
|
|
97681
|
+
/** Mutation code to indicate that Seam is in the process of updating the access times for this access method. */
|
|
97682
|
+
mutation_code: 'updating_access_times';
|
|
97683
|
+
/** Previous access time configuration. */
|
|
97684
|
+
from: {
|
|
97685
|
+
/** Previous start time for access. */
|
|
97686
|
+
starts_at: string | null;
|
|
97687
|
+
/** Previous end time for access. */
|
|
97688
|
+
ends_at: string | null;
|
|
97689
|
+
};
|
|
97690
|
+
/** New access time configuration. */
|
|
97691
|
+
to: {
|
|
97692
|
+
/** New start time for access. */
|
|
97693
|
+
starts_at: string | null;
|
|
97694
|
+
/** New end time for access. */
|
|
97695
|
+
ends_at: string | null;
|
|
97696
|
+
};
|
|
97697
|
+
})[];
|
|
97698
|
+
/** ID of the customization profile associated with the access method. */
|
|
97699
|
+
customization_profile_id?: string | undefined;
|
|
97700
|
+
};
|
|
97701
|
+
} | {
|
|
97702
|
+
/** ID of the action attempt. */
|
|
97703
|
+
action_attempt_id: string;
|
|
97704
|
+
status: 'error';
|
|
97705
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
97706
|
+
result: null;
|
|
97707
|
+
/** Action attempt to track the status of assigning a pre-registered card credential to an access method. */
|
|
97708
|
+
action_type: 'ASSIGN_CREDENTIAL';
|
|
97709
|
+
error: {
|
|
97710
|
+
/** Type of the error associated with the action attempt. */
|
|
97711
|
+
type: 'uncategorized_error';
|
|
97712
|
+
/** Message for the error associated with the action attempt. */
|
|
97713
|
+
message: string;
|
|
97714
|
+
} | {
|
|
97715
|
+
/** Type of the error associated with the action attempt. */
|
|
97716
|
+
type: 'action_attempt_expired';
|
|
97717
|
+
/** Message for the error associated with the action attempt. */
|
|
97718
|
+
message: string;
|
|
97719
|
+
} | {
|
|
97720
|
+
/** Error type to indicate that no matching credential was found. */
|
|
97721
|
+
type: 'credential_not_found';
|
|
97722
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97723
|
+
message: string;
|
|
97724
|
+
};
|
|
97725
|
+
} | {
|
|
97726
|
+
/** ID of the action attempt. */
|
|
97727
|
+
action_attempt_id: string;
|
|
97728
|
+
status: 'pending';
|
|
97729
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
97730
|
+
result: null;
|
|
97731
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
97732
|
+
error: null;
|
|
97733
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
97734
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
97735
|
+
} | {
|
|
97736
|
+
/** ID of the action attempt. */
|
|
97737
|
+
action_attempt_id: string;
|
|
97738
|
+
status: 'success';
|
|
97739
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
97740
|
+
error: null;
|
|
97741
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
97742
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
97743
|
+
/** Result of the action. */
|
|
97744
|
+
result: {};
|
|
97745
|
+
} | {
|
|
97746
|
+
/** ID of the action attempt. */
|
|
97747
|
+
action_attempt_id: string;
|
|
97748
|
+
status: 'error';
|
|
97749
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
97750
|
+
result: null;
|
|
97751
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
97752
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
97753
|
+
/** Error associated with the action. */
|
|
97754
|
+
error: {
|
|
97755
|
+
/** Type of the error. */
|
|
97756
|
+
type: string;
|
|
97757
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97758
|
+
message: string;
|
|
97759
|
+
};
|
|
97760
|
+
} | {
|
|
97761
|
+
/** ID of the action attempt. */
|
|
97762
|
+
action_attempt_id: string;
|
|
97763
|
+
status: 'pending';
|
|
97764
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
97765
|
+
result: null;
|
|
97766
|
+
/** Errors associated with the action attempt. Null for pending 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
|
+
} | {
|
|
97771
|
+
/** ID of the action attempt. */
|
|
97772
|
+
action_attempt_id: string;
|
|
97773
|
+
status: 'success';
|
|
97774
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
97775
|
+
error: null;
|
|
97776
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
97777
|
+
action_type: 'SET_FAN_MODE';
|
|
97778
|
+
/** Result of the action. */
|
|
97779
|
+
result: {};
|
|
97780
|
+
} | {
|
|
97781
|
+
/** ID of the action attempt. */
|
|
97782
|
+
action_attempt_id: string;
|
|
97783
|
+
status: 'error';
|
|
97784
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
97785
|
+
result: null;
|
|
97786
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
97787
|
+
action_type: 'SET_FAN_MODE';
|
|
97788
|
+
/** Error associated with the action. */
|
|
97789
|
+
error: {
|
|
97790
|
+
/** Type of the error. */
|
|
97791
|
+
type: string;
|
|
97792
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97793
|
+
message: string;
|
|
97794
|
+
};
|
|
97795
|
+
} | {
|
|
97796
|
+
/** ID of the action attempt. */
|
|
97797
|
+
action_attempt_id: string;
|
|
97798
|
+
status: 'pending';
|
|
97799
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
97800
|
+
result: null;
|
|
97801
|
+
/** Errors associated with the action attempt. Null for pending 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
|
+
} | {
|
|
97806
|
+
/** ID of the action attempt. */
|
|
97807
|
+
action_attempt_id: string;
|
|
97808
|
+
status: 'success';
|
|
97809
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
97810
|
+
error: null;
|
|
97811
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
97812
|
+
action_type: 'SET_HVAC_MODE';
|
|
97813
|
+
/** Result of the action. */
|
|
97814
|
+
result: {};
|
|
97815
|
+
} | {
|
|
97816
|
+
/** ID of the action attempt. */
|
|
97817
|
+
action_attempt_id: string;
|
|
97818
|
+
status: 'error';
|
|
97819
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
97820
|
+
result: null;
|
|
97821
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
97822
|
+
action_type: 'SET_HVAC_MODE';
|
|
97823
|
+
/** Error associated with the action. */
|
|
97824
|
+
error: {
|
|
97825
|
+
/** Type of the error. */
|
|
97826
|
+
type: string;
|
|
97827
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97828
|
+
message: string;
|
|
97829
|
+
};
|
|
97830
|
+
} | {
|
|
97831
|
+
/** ID of the action attempt. */
|
|
97832
|
+
action_attempt_id: string;
|
|
97833
|
+
status: 'pending';
|
|
97834
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
97835
|
+
result: null;
|
|
97836
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
97837
|
+
error: null;
|
|
97838
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
97839
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
97840
|
+
} | {
|
|
97841
|
+
/** ID of the action attempt. */
|
|
97842
|
+
action_attempt_id: string;
|
|
97843
|
+
status: 'success';
|
|
97844
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
97845
|
+
error: null;
|
|
97846
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
97847
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
97848
|
+
/** Result of the action. */
|
|
97849
|
+
result: {};
|
|
97850
|
+
} | {
|
|
97851
|
+
/** ID of the action attempt. */
|
|
97852
|
+
action_attempt_id: string;
|
|
97853
|
+
status: 'error';
|
|
97854
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
97855
|
+
result: null;
|
|
97856
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
97857
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
97858
|
+
/** Error associated with the action. */
|
|
97859
|
+
error: {
|
|
97860
|
+
/** Type of the error. */
|
|
97861
|
+
type: string;
|
|
97862
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97863
|
+
message: string;
|
|
97864
|
+
};
|
|
97865
|
+
} | {
|
|
97866
|
+
/** ID of the action attempt. */
|
|
97867
|
+
action_attempt_id: string;
|
|
97868
|
+
status: 'pending';
|
|
97869
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
97870
|
+
result: null;
|
|
97871
|
+
/** Errors associated with the action attempt. Null for pending 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
|
+
} | {
|
|
97876
|
+
/** ID of the action attempt. */
|
|
97877
|
+
action_attempt_id: string;
|
|
97878
|
+
status: 'success';
|
|
97879
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
97880
|
+
error: null;
|
|
97881
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
97882
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
97883
|
+
/** Result of the action. */
|
|
97884
|
+
result: {};
|
|
97885
|
+
} | {
|
|
97886
|
+
/** ID of the action attempt. */
|
|
97887
|
+
action_attempt_id: string;
|
|
97888
|
+
status: 'error';
|
|
97889
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
97890
|
+
result: null;
|
|
97891
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
97892
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
97893
|
+
/** Error associated with the action. */
|
|
97894
|
+
error: {
|
|
97895
|
+
/** Type of the error. */
|
|
97896
|
+
type: string;
|
|
97897
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97898
|
+
message: string;
|
|
97899
|
+
};
|
|
97900
|
+
} | {
|
|
97901
|
+
/** ID of the action attempt. */
|
|
97902
|
+
action_attempt_id: string;
|
|
97903
|
+
status: 'pending';
|
|
97904
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
97905
|
+
result: null;
|
|
97906
|
+
/** Errors associated with the action attempt. Null for pending 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
|
+
} | {
|
|
97911
|
+
/** ID of the action attempt. */
|
|
97912
|
+
action_attempt_id: string;
|
|
97913
|
+
status: 'success';
|
|
97914
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
97915
|
+
error: null;
|
|
97916
|
+
/** Action attempt to track the status of simulating a keypad code entry. */
|
|
97917
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
97918
|
+
/** Result of the action. */
|
|
97919
|
+
result: {};
|
|
97920
|
+
} | {
|
|
97921
|
+
/** ID of the action attempt. */
|
|
97922
|
+
action_attempt_id: string;
|
|
97923
|
+
status: 'error';
|
|
97924
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
97925
|
+
result: null;
|
|
97926
|
+
/** Action attempt to track the status of simulating a keypad code entry. */
|
|
97927
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
97928
|
+
/** Error associated with the action. */
|
|
97929
|
+
error: {
|
|
97930
|
+
/** Type of the error. */
|
|
97931
|
+
type: string;
|
|
97932
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97933
|
+
message: string;
|
|
97934
|
+
};
|
|
97935
|
+
} | {
|
|
97936
|
+
/** ID of the action attempt. */
|
|
97937
|
+
action_attempt_id: string;
|
|
97938
|
+
status: 'pending';
|
|
97939
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
97940
|
+
result: null;
|
|
97941
|
+
/** Errors associated with the action attempt. Null for pending 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
|
+
} | {
|
|
97946
|
+
/** ID of the action attempt. */
|
|
97947
|
+
action_attempt_id: string;
|
|
97948
|
+
status: 'success';
|
|
97949
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
97950
|
+
error: null;
|
|
97951
|
+
/** Action attempt to track the status of simulating a manual lock action using a keypad. */
|
|
97952
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
97953
|
+
/** Result of the action. */
|
|
97954
|
+
result: {};
|
|
97955
|
+
} | {
|
|
97956
|
+
/** ID of the action attempt. */
|
|
97957
|
+
action_attempt_id: string;
|
|
97958
|
+
status: 'error';
|
|
97959
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
97960
|
+
result: null;
|
|
97961
|
+
/** Action attempt to track the status of simulating a manual lock action using a keypad. */
|
|
97962
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
97963
|
+
/** Error associated with the action. */
|
|
97964
|
+
error: {
|
|
97965
|
+
/** Type of the error. */
|
|
97966
|
+
type: string;
|
|
97967
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97968
|
+
message: string;
|
|
97969
|
+
};
|
|
97970
|
+
} | {
|
|
97971
|
+
/** ID of the action attempt. */
|
|
97972
|
+
action_attempt_id: string;
|
|
97973
|
+
status: 'pending';
|
|
97974
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
97975
|
+
result: null;
|
|
97976
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
97977
|
+
error: null;
|
|
97978
|
+
/** Action attempt to track the status of pushing thermostat programs. */
|
|
97979
|
+
action_type: 'PUSH_THERMOSTAT_PROGRAMS';
|
|
97980
|
+
} | {
|
|
97981
|
+
/** ID of the action attempt. */
|
|
97982
|
+
action_attempt_id: string;
|
|
97983
|
+
status: 'success';
|
|
97984
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
97985
|
+
error: null;
|
|
97986
|
+
/** Action attempt to track the status of pushing thermostat programs. */
|
|
97987
|
+
action_type: 'PUSH_THERMOSTAT_PROGRAMS';
|
|
97988
|
+
/** Result of the action. */
|
|
97989
|
+
result: {};
|
|
97990
|
+
} | {
|
|
97991
|
+
/** ID of the action attempt. */
|
|
97992
|
+
action_attempt_id: string;
|
|
97993
|
+
status: 'error';
|
|
97994
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
97995
|
+
result: null;
|
|
97996
|
+
/** Action attempt to track the status of pushing thermostat programs. */
|
|
97997
|
+
action_type: 'PUSH_THERMOSTAT_PROGRAMS';
|
|
97998
|
+
/** Error associated with the action. */
|
|
97999
|
+
error: {
|
|
98000
|
+
/** Type of the error. */
|
|
98001
|
+
type: string;
|
|
98002
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
98003
|
+
message: string;
|
|
98004
|
+
};
|
|
98005
|
+
} | {
|
|
98006
|
+
/** ID of the action attempt. */
|
|
98007
|
+
action_attempt_id: string;
|
|
98008
|
+
status: 'pending';
|
|
98009
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
98010
|
+
result: null;
|
|
98011
|
+
/** Errors associated with the action attempt. Null for pending 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
|
+
} | {
|
|
98016
|
+
/** ID of the action attempt. */
|
|
98017
|
+
action_attempt_id: string;
|
|
98018
|
+
status: 'success';
|
|
98019
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
98020
|
+
error: null;
|
|
98021
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
98022
|
+
action_type: 'CONFIGURE_AUTO_LOCK';
|
|
98023
|
+
/** Result of the action. */
|
|
98024
|
+
result: {};
|
|
98025
|
+
} | {
|
|
98026
|
+
/** ID of the action attempt. */
|
|
98027
|
+
action_attempt_id: string;
|
|
98028
|
+
status: 'error';
|
|
98029
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
98030
|
+
result: null;
|
|
98031
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
98032
|
+
action_type: 'CONFIGURE_AUTO_LOCK';
|
|
98033
|
+
/** Error associated with the action. */
|
|
98034
|
+
error: {
|
|
98035
|
+
/** Type of the error. */
|
|
98036
|
+
type: string;
|
|
98037
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
98038
|
+
message: string;
|
|
98039
|
+
};
|
|
98040
|
+
} | {
|
|
98041
|
+
/** ID of the action attempt. */
|
|
98042
|
+
action_attempt_id: string;
|
|
98043
|
+
status: 'pending';
|
|
98044
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
98045
|
+
result: null;
|
|
98046
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
98047
|
+
error: null;
|
|
98048
|
+
/** Syncing access codes is pending. */
|
|
98049
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
98050
|
+
} | {
|
|
98051
|
+
/** ID of the action attempt. */
|
|
98052
|
+
action_attempt_id: string;
|
|
98053
|
+
status: 'success';
|
|
98054
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
98055
|
+
error: null;
|
|
98056
|
+
/** Syncing access codes succeeded. */
|
|
98057
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
98058
|
+
/** Result of the action. */
|
|
98059
|
+
result: {};
|
|
98060
|
+
} | {
|
|
98061
|
+
/** ID of the action attempt. */
|
|
98062
|
+
action_attempt_id: string;
|
|
98063
|
+
status: 'error';
|
|
98064
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
98065
|
+
result: null;
|
|
98066
|
+
/** Syncing access codes failed. */
|
|
98067
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
98068
|
+
/** Error associated with the action. */
|
|
98069
|
+
error: {
|
|
98070
|
+
/** Type of the error. */
|
|
98071
|
+
type: string;
|
|
98072
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
98073
|
+
message: string;
|
|
98074
|
+
};
|
|
98075
|
+
} | {
|
|
98076
|
+
/** ID of the action attempt. */
|
|
98077
|
+
action_attempt_id: string;
|
|
98078
|
+
status: 'pending';
|
|
98079
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
98080
|
+
result: null;
|
|
98081
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
98082
|
+
error: null;
|
|
98083
|
+
/** Creating an access code is pending. */
|
|
98084
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
98085
|
+
} | {
|
|
98086
|
+
/** ID of the action attempt. */
|
|
98087
|
+
action_attempt_id: string;
|
|
98088
|
+
status: 'success';
|
|
98089
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
98090
|
+
error: null;
|
|
98091
|
+
/** Creating an access code succeeded. */
|
|
98092
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
98093
|
+
/** Result of the action. */
|
|
98094
|
+
result: {
|
|
98095
|
+
/** Created access code. */
|
|
98096
|
+
access_code: {
|
|
98097
|
+
[x: string]: any;
|
|
98098
|
+
};
|
|
98099
|
+
};
|
|
98100
|
+
} | {
|
|
98101
|
+
/** ID of the action attempt. */
|
|
98102
|
+
action_attempt_id: string;
|
|
98103
|
+
status: 'error';
|
|
98104
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
98105
|
+
result: null;
|
|
98106
|
+
/** Creating an access code failed. */
|
|
98107
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
98108
|
+
/** Error associated with the action. */
|
|
98109
|
+
error: {
|
|
98110
|
+
/** Type of the error. */
|
|
98111
|
+
type: string;
|
|
98112
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
98113
|
+
message: string;
|
|
98114
|
+
};
|
|
98115
|
+
} | {
|
|
98116
|
+
/** ID of the action attempt. */
|
|
98117
|
+
action_attempt_id: string;
|
|
98118
|
+
status: 'pending';
|
|
98119
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
98120
|
+
result: null;
|
|
98121
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
98122
|
+
error: null;
|
|
98123
|
+
/** Deleting an access code is pending. */
|
|
98124
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
98125
|
+
} | {
|
|
98126
|
+
/** ID of the action attempt. */
|
|
98127
|
+
action_attempt_id: string;
|
|
98128
|
+
status: 'success';
|
|
98129
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
98130
|
+
error: null;
|
|
98131
|
+
/** Deleting an access code succeeded. */
|
|
98132
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
98133
|
+
/** Result of the action. */
|
|
98134
|
+
result: {};
|
|
98135
|
+
} | {
|
|
98136
|
+
/** ID of the action attempt. */
|
|
98137
|
+
action_attempt_id: string;
|
|
98138
|
+
status: 'error';
|
|
98139
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
98140
|
+
result: null;
|
|
98141
|
+
/** Deleting an access code failed. */
|
|
98142
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
98143
|
+
/** Error associated with the action. */
|
|
98144
|
+
error: {
|
|
98145
|
+
/** Type of the error. */
|
|
98146
|
+
type: string;
|
|
98147
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
98148
|
+
message: string;
|
|
98149
|
+
};
|
|
98150
|
+
} | {
|
|
98151
|
+
/** ID of the action attempt. */
|
|
98152
|
+
action_attempt_id: string;
|
|
98153
|
+
status: 'pending';
|
|
98154
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
98155
|
+
result: null;
|
|
98156
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
98157
|
+
error: null;
|
|
98158
|
+
/** Updating an access code is pending. */
|
|
98159
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
98160
|
+
} | {
|
|
98161
|
+
/** ID of the action attempt. */
|
|
98162
|
+
action_attempt_id: string;
|
|
98163
|
+
status: 'success';
|
|
98164
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
98165
|
+
error: null;
|
|
98166
|
+
/** Updating an access code succeeded. */
|
|
98167
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
98168
|
+
/** Result of the action. */
|
|
98169
|
+
result: {
|
|
98170
|
+
/** Updated access code. */
|
|
98171
|
+
access_code?: {
|
|
98172
|
+
[x: string]: any;
|
|
98173
|
+
} | undefined;
|
|
98174
|
+
};
|
|
98175
|
+
} | {
|
|
98176
|
+
/** ID of the action attempt. */
|
|
98177
|
+
action_attempt_id: string;
|
|
98178
|
+
status: 'error';
|
|
98179
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
98180
|
+
result: null;
|
|
98181
|
+
/** Updating an access code failed. */
|
|
98182
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
98183
|
+
/** Error associated with the action. */
|
|
98184
|
+
error: {
|
|
98185
|
+
/** Type of the error. */
|
|
98186
|
+
type: string;
|
|
98187
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
98188
|
+
message: string;
|
|
98189
|
+
};
|
|
98190
|
+
} | {
|
|
98191
|
+
/** ID of the action attempt. */
|
|
98192
|
+
action_attempt_id: string;
|
|
98193
|
+
status: 'pending';
|
|
98194
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
98195
|
+
result: null;
|
|
98196
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
98197
|
+
error: null;
|
|
98198
|
+
/** Creating a noise threshold is pending. */
|
|
98199
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
98200
|
+
} | {
|
|
98201
|
+
/** ID of the action attempt. */
|
|
98202
|
+
action_attempt_id: string;
|
|
98203
|
+
status: 'success';
|
|
98204
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
98205
|
+
error: null;
|
|
98206
|
+
/** Creating a noise threshold succeeded. */
|
|
98207
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
98208
|
+
/** Result of the action. */
|
|
98209
|
+
result: {
|
|
98210
|
+
/** Created noise threshold. */
|
|
98211
|
+
noise_threshold: {
|
|
98212
|
+
[x: string]: any;
|
|
98213
|
+
};
|
|
98214
|
+
};
|
|
98215
|
+
} | {
|
|
98216
|
+
/** ID of the action attempt. */
|
|
98217
|
+
action_attempt_id: string;
|
|
98218
|
+
status: 'error';
|
|
98219
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
98220
|
+
result: null;
|
|
98221
|
+
/** Creating a noise threshold failed. */
|
|
98222
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
98223
|
+
/** Error associated with the action. */
|
|
98224
|
+
error: {
|
|
98225
|
+
/** Type of the error. */
|
|
98226
|
+
type: string;
|
|
98227
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
98228
|
+
message: string;
|
|
98229
|
+
};
|
|
98230
|
+
} | {
|
|
98231
|
+
/** ID of the action attempt. */
|
|
98232
|
+
action_attempt_id: string;
|
|
98233
|
+
status: 'pending';
|
|
98234
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
98235
|
+
result: null;
|
|
98236
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
98237
|
+
error: null;
|
|
98238
|
+
/** Deleting a noise threshold is pending. */
|
|
98239
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
98240
|
+
} | {
|
|
98241
|
+
/** ID of the action attempt. */
|
|
98242
|
+
action_attempt_id: string;
|
|
98243
|
+
status: 'success';
|
|
98244
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
98245
|
+
error: null;
|
|
98246
|
+
/** Deleting a noise threshold succeeded. */
|
|
98247
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
98248
|
+
/** Result of the action. */
|
|
98249
|
+
result: {};
|
|
98250
|
+
} | {
|
|
98251
|
+
/** ID of the action attempt. */
|
|
98252
|
+
action_attempt_id: string;
|
|
98253
|
+
status: 'error';
|
|
98254
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
98255
|
+
result: null;
|
|
98256
|
+
/** Deleting a noise threshold failed. */
|
|
98257
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
98258
|
+
/** Error associated with the action. */
|
|
98259
|
+
error: {
|
|
98260
|
+
/** Type of the error. */
|
|
98261
|
+
type: string;
|
|
98262
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
98263
|
+
message: string;
|
|
98264
|
+
};
|
|
98265
|
+
} | {
|
|
98266
|
+
/** ID of the action attempt. */
|
|
98267
|
+
action_attempt_id: string;
|
|
98268
|
+
status: 'pending';
|
|
98269
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
98270
|
+
result: null;
|
|
98271
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
98272
|
+
error: null;
|
|
98273
|
+
/** Updating a noise threshold is pending. */
|
|
98274
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
98275
|
+
} | {
|
|
98276
|
+
/** ID of the action attempt. */
|
|
98277
|
+
action_attempt_id: string;
|
|
98278
|
+
status: 'success';
|
|
98279
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
98280
|
+
error: null;
|
|
98281
|
+
/** Updating a noise threshold succeeded. */
|
|
98282
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
98283
|
+
/** Result of the action. */
|
|
98284
|
+
result: {
|
|
98285
|
+
/** Updated noise threshold. */
|
|
98286
|
+
noise_threshold: {
|
|
98287
|
+
[x: string]: any;
|
|
98288
|
+
};
|
|
98289
|
+
};
|
|
98290
|
+
} | {
|
|
98291
|
+
/** ID of the action attempt. */
|
|
98292
|
+
action_attempt_id: string;
|
|
98293
|
+
status: 'error';
|
|
98294
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
98295
|
+
result: null;
|
|
98296
|
+
/** Updating a noise threshold failed. */
|
|
98297
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
98298
|
+
/** Error associated with the action. */
|
|
98299
|
+
error: {
|
|
98300
|
+
/** Type of the error. */
|
|
98301
|
+
type: string;
|
|
98302
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
98303
|
+
message: string;
|
|
98304
|
+
};
|
|
95652
98305
|
};
|
|
95653
98306
|
};
|
|
95654
98307
|
maxDuration: undefined;
|
|
95655
98308
|
};
|
|
95656
|
-
'/thermostats/
|
|
95657
|
-
route: '/thermostats/
|
|
98309
|
+
'/thermostats/activate_weekly_program': {
|
|
98310
|
+
route: '/thermostats/activate_weekly_program';
|
|
95658
98311
|
method: 'POST';
|
|
95659
98312
|
queryParams: {};
|
|
95660
98313
|
jsonBody: {
|
|
95661
|
-
/** ID of the thermostat device
|
|
98314
|
+
/** ID of the thermostat device that you want to return to its weekly program. */
|
|
95662
98315
|
device_id: string;
|
|
95663
|
-
/**
|
|
95664
|
-
|
|
98316
|
+
/** */
|
|
98317
|
+
sync?: boolean;
|
|
95665
98318
|
};
|
|
95666
98319
|
commonParams: {};
|
|
95667
98320
|
formData: {};
|
|
@@ -97056,6 +99709,41 @@ export type Routes = {
|
|
|
97056
99709
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97057
99710
|
message: string;
|
|
97058
99711
|
};
|
|
99712
|
+
} | {
|
|
99713
|
+
/** ID of the action attempt. */
|
|
99714
|
+
action_attempt_id: string;
|
|
99715
|
+
status: 'pending';
|
|
99716
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
99717
|
+
result: null;
|
|
99718
|
+
/** Errors associated with the action attempt. Null for pending 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
|
+
} | {
|
|
99723
|
+
/** ID of the action attempt. */
|
|
99724
|
+
action_attempt_id: string;
|
|
99725
|
+
status: 'success';
|
|
99726
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
99727
|
+
error: null;
|
|
99728
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
99729
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
99730
|
+
/** Result of the action. */
|
|
99731
|
+
result: {};
|
|
99732
|
+
} | {
|
|
99733
|
+
/** ID of the action attempt. */
|
|
99734
|
+
action_attempt_id: string;
|
|
99735
|
+
status: 'error';
|
|
99736
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
99737
|
+
result: null;
|
|
99738
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
99739
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
99740
|
+
/** Error associated with the action. */
|
|
99741
|
+
error: {
|
|
99742
|
+
/** Type of the error. */
|
|
99743
|
+
type: string;
|
|
99744
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
99745
|
+
message: string;
|
|
99746
|
+
};
|
|
97059
99747
|
} | {
|
|
97060
99748
|
/** ID of the action attempt. */
|
|
97061
99749
|
action_attempt_id: string;
|
|
@@ -98872,6 +101560,41 @@ export type Routes = {
|
|
|
98872
101560
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
98873
101561
|
message: string;
|
|
98874
101562
|
};
|
|
101563
|
+
} | {
|
|
101564
|
+
/** ID of the action attempt. */
|
|
101565
|
+
action_attempt_id: string;
|
|
101566
|
+
status: 'pending';
|
|
101567
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
101568
|
+
result: null;
|
|
101569
|
+
/** Errors associated with the action attempt. Null for pending 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
|
+
} | {
|
|
101574
|
+
/** ID of the action attempt. */
|
|
101575
|
+
action_attempt_id: string;
|
|
101576
|
+
status: 'success';
|
|
101577
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
101578
|
+
error: null;
|
|
101579
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
101580
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
101581
|
+
/** Result of the action. */
|
|
101582
|
+
result: {};
|
|
101583
|
+
} | {
|
|
101584
|
+
/** ID of the action attempt. */
|
|
101585
|
+
action_attempt_id: string;
|
|
101586
|
+
status: 'error';
|
|
101587
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
101588
|
+
result: null;
|
|
101589
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
101590
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
101591
|
+
/** Error associated with the action. */
|
|
101592
|
+
error: {
|
|
101593
|
+
/** Type of the error. */
|
|
101594
|
+
type: string;
|
|
101595
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101596
|
+
message: string;
|
|
101597
|
+
};
|
|
98875
101598
|
} | {
|
|
98876
101599
|
/** ID of the action attempt. */
|
|
98877
101600
|
action_attempt_id: string;
|
|
@@ -100794,6 +103517,41 @@ export type Routes = {
|
|
|
100794
103517
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
100795
103518
|
message: string;
|
|
100796
103519
|
};
|
|
103520
|
+
} | {
|
|
103521
|
+
/** ID of the action attempt. */
|
|
103522
|
+
action_attempt_id: string;
|
|
103523
|
+
status: 'pending';
|
|
103524
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
103525
|
+
result: null;
|
|
103526
|
+
/** Errors associated with the action attempt. Null for pending 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
|
+
} | {
|
|
103531
|
+
/** ID of the action attempt. */
|
|
103532
|
+
action_attempt_id: string;
|
|
103533
|
+
status: 'success';
|
|
103534
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
103535
|
+
error: null;
|
|
103536
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
103537
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
103538
|
+
/** Result of the action. */
|
|
103539
|
+
result: {};
|
|
103540
|
+
} | {
|
|
103541
|
+
/** ID of the action attempt. */
|
|
103542
|
+
action_attempt_id: string;
|
|
103543
|
+
status: 'error';
|
|
103544
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
103545
|
+
result: null;
|
|
103546
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
103547
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
103548
|
+
/** Error associated with the action. */
|
|
103549
|
+
error: {
|
|
103550
|
+
/** Type of the error. */
|
|
103551
|
+
type: string;
|
|
103552
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
103553
|
+
message: string;
|
|
103554
|
+
};
|
|
100797
103555
|
} | {
|
|
100798
103556
|
/** ID of the action attempt. */
|
|
100799
103557
|
action_attempt_id: string;
|
|
@@ -102737,6 +105495,8 @@ export type Routes = {
|
|
|
102737
105495
|
can_hvac_heat_cool?: boolean | undefined;
|
|
102738
105496
|
/** Indicates whether the thermostat can be turned off. */
|
|
102739
105497
|
can_turn_off_hvac?: boolean | undefined;
|
|
105498
|
+
/** 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. */
|
|
105499
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
102740
105500
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
102741
105501
|
can_simulate_removal?: boolean | undefined;
|
|
102742
105502
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -104172,6 +106932,41 @@ export type Routes = {
|
|
|
104172
106932
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
104173
106933
|
message: string;
|
|
104174
106934
|
};
|
|
106935
|
+
} | {
|
|
106936
|
+
/** ID of the action attempt. */
|
|
106937
|
+
action_attempt_id: string;
|
|
106938
|
+
status: 'pending';
|
|
106939
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
106940
|
+
result: null;
|
|
106941
|
+
/** Errors associated with the action attempt. Null for pending 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
|
+
} | {
|
|
106946
|
+
/** ID of the action attempt. */
|
|
106947
|
+
action_attempt_id: string;
|
|
106948
|
+
status: 'success';
|
|
106949
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
106950
|
+
error: null;
|
|
106951
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
106952
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
106953
|
+
/** Result of the action. */
|
|
106954
|
+
result: {};
|
|
106955
|
+
} | {
|
|
106956
|
+
/** ID of the action attempt. */
|
|
106957
|
+
action_attempt_id: string;
|
|
106958
|
+
status: 'error';
|
|
106959
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
106960
|
+
result: null;
|
|
106961
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
106962
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
106963
|
+
/** Error associated with the action. */
|
|
106964
|
+
error: {
|
|
106965
|
+
/** Type of the error. */
|
|
106966
|
+
type: string;
|
|
106967
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
106968
|
+
message: string;
|
|
106969
|
+
};
|
|
104175
106970
|
} | {
|
|
104176
106971
|
/** ID of the action attempt. */
|
|
104177
106972
|
action_attempt_id: string;
|
|
@@ -105992,6 +108787,41 @@ export type Routes = {
|
|
|
105992
108787
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
105993
108788
|
message: string;
|
|
105994
108789
|
};
|
|
108790
|
+
} | {
|
|
108791
|
+
/** ID of the action attempt. */
|
|
108792
|
+
action_attempt_id: string;
|
|
108793
|
+
status: 'pending';
|
|
108794
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
108795
|
+
result: null;
|
|
108796
|
+
/** Errors associated with the action attempt. Null for pending 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
|
+
} | {
|
|
108801
|
+
/** ID of the action attempt. */
|
|
108802
|
+
action_attempt_id: string;
|
|
108803
|
+
status: 'success';
|
|
108804
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
108805
|
+
error: null;
|
|
108806
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
108807
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
108808
|
+
/** Result of the action. */
|
|
108809
|
+
result: {};
|
|
108810
|
+
} | {
|
|
108811
|
+
/** ID of the action attempt. */
|
|
108812
|
+
action_attempt_id: string;
|
|
108813
|
+
status: 'error';
|
|
108814
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
108815
|
+
result: null;
|
|
108816
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
108817
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
108818
|
+
/** Error associated with the action. */
|
|
108819
|
+
error: {
|
|
108820
|
+
/** Type of the error. */
|
|
108821
|
+
type: string;
|
|
108822
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
108823
|
+
message: string;
|
|
108824
|
+
};
|
|
105995
108825
|
} | {
|
|
105996
108826
|
/** ID of the action attempt. */
|
|
105997
108827
|
action_attempt_id: string;
|
|
@@ -107927,6 +110757,8 @@ export type Routes = {
|
|
|
107927
110757
|
can_hvac_heat_cool?: boolean | undefined;
|
|
107928
110758
|
/** Indicates whether the thermostat can be turned off. */
|
|
107929
110759
|
can_turn_off_hvac?: boolean | undefined;
|
|
110760
|
+
/** 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. */
|
|
110761
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
107930
110762
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
107931
110763
|
can_simulate_removal?: boolean | undefined;
|
|
107932
110764
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -109457,6 +112289,8 @@ export type Routes = {
|
|
|
109457
112289
|
can_hvac_heat_cool?: boolean | undefined;
|
|
109458
112290
|
/** Indicates whether the thermostat can be turned off. */
|
|
109459
112291
|
can_turn_off_hvac?: boolean | undefined;
|
|
112292
|
+
/** 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. */
|
|
112293
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
109460
112294
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
109461
112295
|
can_simulate_removal?: boolean | undefined;
|
|
109462
112296
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -110888,6 +113722,41 @@ export type Routes = {
|
|
|
110888
113722
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
110889
113723
|
message: string;
|
|
110890
113724
|
};
|
|
113725
|
+
} | {
|
|
113726
|
+
/** ID of the action attempt. */
|
|
113727
|
+
action_attempt_id: string;
|
|
113728
|
+
status: 'pending';
|
|
113729
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
113730
|
+
result: null;
|
|
113731
|
+
/** Errors associated with the action attempt. Null for pending 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
|
+
} | {
|
|
113736
|
+
/** ID of the action attempt. */
|
|
113737
|
+
action_attempt_id: string;
|
|
113738
|
+
status: 'success';
|
|
113739
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
113740
|
+
error: null;
|
|
113741
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
113742
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
113743
|
+
/** Result of the action. */
|
|
113744
|
+
result: {};
|
|
113745
|
+
} | {
|
|
113746
|
+
/** ID of the action attempt. */
|
|
113747
|
+
action_attempt_id: string;
|
|
113748
|
+
status: 'error';
|
|
113749
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
113750
|
+
result: null;
|
|
113751
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
113752
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
113753
|
+
/** Error associated with the action. */
|
|
113754
|
+
error: {
|
|
113755
|
+
/** Type of the error. */
|
|
113756
|
+
type: string;
|
|
113757
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
113758
|
+
message: string;
|
|
113759
|
+
};
|
|
110891
113760
|
} | {
|
|
110892
113761
|
/** ID of the action attempt. */
|
|
110893
113762
|
action_attempt_id: string;
|
|
@@ -112909,6 +115778,41 @@ export type Routes = {
|
|
|
112909
115778
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
112910
115779
|
message: string;
|
|
112911
115780
|
};
|
|
115781
|
+
} | {
|
|
115782
|
+
/** ID of the action attempt. */
|
|
115783
|
+
action_attempt_id: string;
|
|
115784
|
+
status: 'pending';
|
|
115785
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
115786
|
+
result: null;
|
|
115787
|
+
/** Errors associated with the action attempt. Null for pending 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
|
+
} | {
|
|
115792
|
+
/** ID of the action attempt. */
|
|
115793
|
+
action_attempt_id: string;
|
|
115794
|
+
status: 'success';
|
|
115795
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
115796
|
+
error: null;
|
|
115797
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
115798
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
115799
|
+
/** Result of the action. */
|
|
115800
|
+
result: {};
|
|
115801
|
+
} | {
|
|
115802
|
+
/** ID of the action attempt. */
|
|
115803
|
+
action_attempt_id: string;
|
|
115804
|
+
status: 'error';
|
|
115805
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
115806
|
+
result: null;
|
|
115807
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
115808
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
115809
|
+
/** Error associated with the action. */
|
|
115810
|
+
error: {
|
|
115811
|
+
/** Type of the error. */
|
|
115812
|
+
type: string;
|
|
115813
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
115814
|
+
message: string;
|
|
115815
|
+
};
|
|
112912
115816
|
} | {
|
|
112913
115817
|
/** ID of the action attempt. */
|
|
112914
115818
|
action_attempt_id: string;
|
|
@@ -114752,6 +117656,41 @@ export type Routes = {
|
|
|
114752
117656
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
114753
117657
|
message: string;
|
|
114754
117658
|
};
|
|
117659
|
+
} | {
|
|
117660
|
+
/** ID of the action attempt. */
|
|
117661
|
+
action_attempt_id: string;
|
|
117662
|
+
status: 'pending';
|
|
117663
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
117664
|
+
result: null;
|
|
117665
|
+
/** Errors associated with the action attempt. Null for pending 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
|
+
} | {
|
|
117670
|
+
/** ID of the action attempt. */
|
|
117671
|
+
action_attempt_id: string;
|
|
117672
|
+
status: 'success';
|
|
117673
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
117674
|
+
error: null;
|
|
117675
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
117676
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
117677
|
+
/** Result of the action. */
|
|
117678
|
+
result: {};
|
|
117679
|
+
} | {
|
|
117680
|
+
/** ID of the action attempt. */
|
|
117681
|
+
action_attempt_id: string;
|
|
117682
|
+
status: 'error';
|
|
117683
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
117684
|
+
result: null;
|
|
117685
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
117686
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
117687
|
+
/** Error associated with the action. */
|
|
117688
|
+
error: {
|
|
117689
|
+
/** Type of the error. */
|
|
117690
|
+
type: string;
|
|
117691
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
117692
|
+
message: string;
|
|
117693
|
+
};
|
|
114755
117694
|
} | {
|
|
114756
117695
|
/** ID of the action attempt. */
|
|
114757
117696
|
action_attempt_id: string;
|
|
@@ -116707,6 +119646,41 @@ export type Routes = {
|
|
|
116707
119646
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
116708
119647
|
message: string;
|
|
116709
119648
|
};
|
|
119649
|
+
} | {
|
|
119650
|
+
/** ID of the action attempt. */
|
|
119651
|
+
action_attempt_id: string;
|
|
119652
|
+
status: 'pending';
|
|
119653
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
119654
|
+
result: null;
|
|
119655
|
+
/** Errors associated with the action attempt. Null for pending 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
|
+
} | {
|
|
119660
|
+
/** ID of the action attempt. */
|
|
119661
|
+
action_attempt_id: string;
|
|
119662
|
+
status: 'success';
|
|
119663
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
119664
|
+
error: null;
|
|
119665
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
119666
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
119667
|
+
/** Result of the action. */
|
|
119668
|
+
result: {};
|
|
119669
|
+
} | {
|
|
119670
|
+
/** ID of the action attempt. */
|
|
119671
|
+
action_attempt_id: string;
|
|
119672
|
+
status: 'error';
|
|
119673
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
119674
|
+
result: null;
|
|
119675
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
119676
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
119677
|
+
/** Error associated with the action. */
|
|
119678
|
+
error: {
|
|
119679
|
+
/** Type of the error. */
|
|
119680
|
+
type: string;
|
|
119681
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
119682
|
+
message: string;
|
|
119683
|
+
};
|
|
116710
119684
|
} | {
|
|
116711
119685
|
/** ID of the action attempt. */
|
|
116712
119686
|
action_attempt_id: string;
|
|
@@ -119241,6 +122215,8 @@ export type Routes = {
|
|
|
119241
122215
|
can_hvac_heat_cool?: boolean | undefined;
|
|
119242
122216
|
/** Indicates whether the thermostat can be turned off. */
|
|
119243
122217
|
can_turn_off_hvac?: boolean | undefined;
|
|
122218
|
+
/** 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. */
|
|
122219
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
119244
122220
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
119245
122221
|
can_simulate_removal?: boolean | undefined;
|
|
119246
122222
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -120773,6 +123749,8 @@ export type Routes = {
|
|
|
120773
123749
|
can_hvac_heat_cool?: boolean | undefined;
|
|
120774
123750
|
/** Indicates whether the thermostat can be turned off. */
|
|
120775
123751
|
can_turn_off_hvac?: boolean | undefined;
|
|
123752
|
+
/** 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. */
|
|
123753
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
120776
123754
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
120777
123755
|
can_simulate_removal?: boolean | undefined;
|
|
120778
123756
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -123642,6 +126620,8 @@ export type Routes = {
|
|
|
123642
126620
|
can_hvac_heat_cool?: boolean | undefined;
|
|
123643
126621
|
/** Indicates whether the thermostat can be turned off. */
|
|
123644
126622
|
can_turn_off_hvac?: boolean | undefined;
|
|
126623
|
+
/** 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. */
|
|
126624
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
123645
126625
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
123646
126626
|
can_simulate_removal?: boolean | undefined;
|
|
123647
126627
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -125862,6 +128842,41 @@ export type Routes = {
|
|
|
125862
128842
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
125863
128843
|
message: string;
|
|
125864
128844
|
};
|
|
128845
|
+
} | {
|
|
128846
|
+
/** ID of the action attempt. */
|
|
128847
|
+
action_attempt_id: string;
|
|
128848
|
+
status: 'pending';
|
|
128849
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
128850
|
+
result: null;
|
|
128851
|
+
/** Errors associated with the action attempt. Null for pending 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
|
+
} | {
|
|
128856
|
+
/** ID of the action attempt. */
|
|
128857
|
+
action_attempt_id: string;
|
|
128858
|
+
status: 'success';
|
|
128859
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
128860
|
+
error: null;
|
|
128861
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
128862
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
128863
|
+
/** Result of the action. */
|
|
128864
|
+
result: {};
|
|
128865
|
+
} | {
|
|
128866
|
+
/** ID of the action attempt. */
|
|
128867
|
+
action_attempt_id: string;
|
|
128868
|
+
status: 'error';
|
|
128869
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
128870
|
+
result: null;
|
|
128871
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
128872
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
128873
|
+
/** Error associated with the action. */
|
|
128874
|
+
error: {
|
|
128875
|
+
/** Type of the error. */
|
|
128876
|
+
type: string;
|
|
128877
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
128878
|
+
message: string;
|
|
128879
|
+
};
|
|
125865
128880
|
} | {
|
|
125866
128881
|
/** ID of the action attempt. */
|
|
125867
128882
|
action_attempt_id: string;
|
|
@@ -127188,6 +130203,8 @@ export type Routes = {
|
|
|
127188
130203
|
can_hvac_heat_cool?: boolean | undefined;
|
|
127189
130204
|
/** Indicates whether the thermostat can be turned off. */
|
|
127190
130205
|
can_turn_off_hvac?: boolean | undefined;
|
|
130206
|
+
/** 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. */
|
|
130207
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
127191
130208
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
127192
130209
|
can_simulate_removal?: boolean | undefined;
|
|
127193
130210
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -131246,6 +134263,8 @@ export type Routes = {
|
|
|
131246
134263
|
image_url?: string | undefined;
|
|
131247
134264
|
/** URL to a short video clip captured at the time of activation. */
|
|
131248
134265
|
video_url?: string | undefined;
|
|
134266
|
+
/** Status of the recorded clip and thumbnail for this activation, when the camera supports event recordings. `pending` while Seam retrieves the recording, `available` once it is stored, `unavailable` if no recording covers the activation, and `failed` if retrieval failed. */
|
|
134267
|
+
media_status?: ('pending' | 'available' | 'unavailable' | 'failed') | undefined;
|
|
131249
134268
|
} | {
|
|
131250
134269
|
/** ID of the event. */
|
|
131251
134270
|
event_id: string;
|
|
@@ -134171,6 +137190,41 @@ export type Routes = {
|
|
|
134171
137190
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
134172
137191
|
message: string;
|
|
134173
137192
|
};
|
|
137193
|
+
} | {
|
|
137194
|
+
/** ID of the action attempt. */
|
|
137195
|
+
action_attempt_id: string;
|
|
137196
|
+
status: 'pending';
|
|
137197
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
137198
|
+
result: null;
|
|
137199
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
137200
|
+
error: null;
|
|
137201
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
137202
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
137203
|
+
} | {
|
|
137204
|
+
/** ID of the action attempt. */
|
|
137205
|
+
action_attempt_id: string;
|
|
137206
|
+
status: 'success';
|
|
137207
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
137208
|
+
error: null;
|
|
137209
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
137210
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
137211
|
+
/** Result of the action. */
|
|
137212
|
+
result: {};
|
|
137213
|
+
} | {
|
|
137214
|
+
/** ID of the action attempt. */
|
|
137215
|
+
action_attempt_id: string;
|
|
137216
|
+
status: 'error';
|
|
137217
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
137218
|
+
result: null;
|
|
137219
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
137220
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
137221
|
+
/** Error associated with the action. */
|
|
137222
|
+
error: {
|
|
137223
|
+
/** Type of the error. */
|
|
137224
|
+
type: string;
|
|
137225
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
137226
|
+
message: string;
|
|
137227
|
+
};
|
|
134174
137228
|
} | {
|
|
134175
137229
|
/** ID of the action attempt. */
|
|
134176
137230
|
action_attempt_id: string;
|