@seamapi/types 0.1.0 → 0.2.1
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/dist/connect.cjs.map +1 -1
- package/lib/seam/connect/index.d.ts +3 -3
- package/lib/seam/connect/index.js +3 -3
- package/lib/seam/connect/model-types.d.ts +1 -1
- package/lib/seam/connect/models/connect-webview.d.ts +1 -1
- package/lib/seam/connect/models/connect-webview.js +3 -3
- package/lib/seam/connect/models/index.d.ts +1 -1
- package/lib/seam/connect/models/index.js +1 -1
- package/lib/seam/connect/route-types.d.ts +307 -307
- package/lib/seam/connect/schemas.d.ts +1 -1
- package/lib/seam/connect/schemas.js +1 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/index.ts +3 -3
- package/src/lib/seam/connect/model-types.ts +1 -1
- package/src/lib/seam/connect/models/connect-webview.ts +3 -3
- package/src/lib/seam/connect/models/index.ts +1 -1
- package/src/lib/seam/connect/route-types.ts +805 -805
- package/src/lib/seam/connect/schemas.ts +1 -1
- package/src/lib/seam/.prettierrc.json +0 -5
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export interface Routes {
|
|
2
|
-
|
|
3
|
-
route:
|
|
4
|
-
method:
|
|
2
|
+
'/access_codes/create': {
|
|
3
|
+
route: '/access_codes/create';
|
|
4
|
+
method: 'POST';
|
|
5
5
|
queryParams: {};
|
|
6
6
|
jsonBody: {
|
|
7
7
|
device_id: string;
|
|
@@ -19,19 +19,19 @@ export interface Routes {
|
|
|
19
19
|
formData: {};
|
|
20
20
|
jsonResponse: {
|
|
21
21
|
action_attempt: {
|
|
22
|
-
status:
|
|
22
|
+
status: 'success';
|
|
23
23
|
action_type: string;
|
|
24
24
|
action_attempt_id: string;
|
|
25
25
|
result?: any;
|
|
26
26
|
error: null;
|
|
27
27
|
} | {
|
|
28
|
-
status:
|
|
28
|
+
status: 'pending';
|
|
29
29
|
action_type: string;
|
|
30
30
|
action_attempt_id: string;
|
|
31
31
|
result: null;
|
|
32
32
|
error: null;
|
|
33
33
|
} | {
|
|
34
|
-
status:
|
|
34
|
+
status: 'error';
|
|
35
35
|
action_type: string;
|
|
36
36
|
action_attempt_id: string;
|
|
37
37
|
result: null;
|
|
@@ -43,7 +43,7 @@ export interface Routes {
|
|
|
43
43
|
access_code: {
|
|
44
44
|
common_code_key: string | null;
|
|
45
45
|
is_scheduled_on_device?: boolean | undefined;
|
|
46
|
-
type:
|
|
46
|
+
type: 'time_bound' | 'ongoing';
|
|
47
47
|
is_waiting_for_code_assignment?: boolean | undefined;
|
|
48
48
|
access_code_id: string;
|
|
49
49
|
device_id: string;
|
|
@@ -55,20 +55,20 @@ export interface Routes {
|
|
|
55
55
|
is_managed: true;
|
|
56
56
|
starts_at?: string | undefined;
|
|
57
57
|
ends_at?: string | undefined;
|
|
58
|
-
status:
|
|
58
|
+
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
59
59
|
is_backup_access_code_available: boolean;
|
|
60
60
|
is_backup?: boolean | undefined;
|
|
61
61
|
pulled_backup_access_code_id?: (string | null) | undefined;
|
|
62
62
|
};
|
|
63
63
|
};
|
|
64
64
|
};
|
|
65
|
-
|
|
66
|
-
route:
|
|
67
|
-
method:
|
|
65
|
+
'/access_codes/create_multiple': {
|
|
66
|
+
route: '/access_codes/create_multiple';
|
|
67
|
+
method: 'POST' | 'PUT';
|
|
68
68
|
queryParams: {};
|
|
69
69
|
jsonBody: {
|
|
70
70
|
device_ids: string[];
|
|
71
|
-
behavior_when_code_cannot_be_shared?:
|
|
71
|
+
behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code';
|
|
72
72
|
name?: string | undefined;
|
|
73
73
|
starts_at?: string | undefined;
|
|
74
74
|
ends_at?: string | undefined;
|
|
@@ -83,7 +83,7 @@ export interface Routes {
|
|
|
83
83
|
access_codes: Array<{
|
|
84
84
|
common_code_key: string | null;
|
|
85
85
|
is_scheduled_on_device?: boolean | undefined;
|
|
86
|
-
type:
|
|
86
|
+
type: 'time_bound' | 'ongoing';
|
|
87
87
|
is_waiting_for_code_assignment?: boolean | undefined;
|
|
88
88
|
access_code_id: string;
|
|
89
89
|
device_id: string;
|
|
@@ -95,16 +95,16 @@ export interface Routes {
|
|
|
95
95
|
is_managed: true;
|
|
96
96
|
starts_at?: string | undefined;
|
|
97
97
|
ends_at?: string | undefined;
|
|
98
|
-
status:
|
|
98
|
+
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
99
99
|
is_backup_access_code_available: boolean;
|
|
100
100
|
is_backup?: boolean | undefined;
|
|
101
101
|
pulled_backup_access_code_id?: (string | null) | undefined;
|
|
102
102
|
}>;
|
|
103
103
|
};
|
|
104
104
|
};
|
|
105
|
-
|
|
106
|
-
route:
|
|
107
|
-
method:
|
|
105
|
+
'/access_codes/delete': {
|
|
106
|
+
route: '/access_codes/delete';
|
|
107
|
+
method: 'DELETE' | 'POST';
|
|
108
108
|
queryParams: {};
|
|
109
109
|
jsonBody: {};
|
|
110
110
|
commonParams: {
|
|
@@ -115,19 +115,19 @@ export interface Routes {
|
|
|
115
115
|
formData: {};
|
|
116
116
|
jsonResponse: {
|
|
117
117
|
action_attempt: {
|
|
118
|
-
status:
|
|
118
|
+
status: 'success';
|
|
119
119
|
action_type: string;
|
|
120
120
|
action_attempt_id: string;
|
|
121
121
|
result?: any;
|
|
122
122
|
error: null;
|
|
123
123
|
} | {
|
|
124
|
-
status:
|
|
124
|
+
status: 'pending';
|
|
125
125
|
action_type: string;
|
|
126
126
|
action_attempt_id: string;
|
|
127
127
|
result: null;
|
|
128
128
|
error: null;
|
|
129
129
|
} | {
|
|
130
|
-
status:
|
|
130
|
+
status: 'error';
|
|
131
131
|
action_type: string;
|
|
132
132
|
action_attempt_id: string;
|
|
133
133
|
result: null;
|
|
@@ -138,9 +138,9 @@ export interface Routes {
|
|
|
138
138
|
};
|
|
139
139
|
};
|
|
140
140
|
};
|
|
141
|
-
|
|
142
|
-
route:
|
|
143
|
-
method:
|
|
141
|
+
'/access_codes/get': {
|
|
142
|
+
route: '/access_codes/get';
|
|
143
|
+
method: 'GET' | 'POST';
|
|
144
144
|
queryParams: {};
|
|
145
145
|
jsonBody: {};
|
|
146
146
|
commonParams: {
|
|
@@ -153,7 +153,7 @@ export interface Routes {
|
|
|
153
153
|
access_code: {
|
|
154
154
|
common_code_key: string | null;
|
|
155
155
|
is_scheduled_on_device?: boolean | undefined;
|
|
156
|
-
type:
|
|
156
|
+
type: 'time_bound' | 'ongoing';
|
|
157
157
|
is_waiting_for_code_assignment?: boolean | undefined;
|
|
158
158
|
access_code_id: string;
|
|
159
159
|
device_id: string;
|
|
@@ -165,16 +165,16 @@ export interface Routes {
|
|
|
165
165
|
is_managed: true;
|
|
166
166
|
starts_at?: string | undefined;
|
|
167
167
|
ends_at?: string | undefined;
|
|
168
|
-
status:
|
|
168
|
+
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
169
169
|
is_backup_access_code_available: boolean;
|
|
170
170
|
is_backup?: boolean | undefined;
|
|
171
171
|
pulled_backup_access_code_id?: (string | null) | undefined;
|
|
172
172
|
};
|
|
173
173
|
};
|
|
174
174
|
};
|
|
175
|
-
|
|
176
|
-
route:
|
|
177
|
-
method:
|
|
175
|
+
'/access_codes/list': {
|
|
176
|
+
route: '/access_codes/list';
|
|
177
|
+
method: 'GET' | 'POST';
|
|
178
178
|
queryParams: {};
|
|
179
179
|
jsonBody: {};
|
|
180
180
|
commonParams: {
|
|
@@ -186,7 +186,7 @@ export interface Routes {
|
|
|
186
186
|
access_codes: Array<{
|
|
187
187
|
common_code_key: string | null;
|
|
188
188
|
is_scheduled_on_device?: boolean | undefined;
|
|
189
|
-
type:
|
|
189
|
+
type: 'time_bound' | 'ongoing';
|
|
190
190
|
is_waiting_for_code_assignment?: boolean | undefined;
|
|
191
191
|
access_code_id: string;
|
|
192
192
|
device_id: string;
|
|
@@ -198,16 +198,16 @@ export interface Routes {
|
|
|
198
198
|
is_managed: true;
|
|
199
199
|
starts_at?: string | undefined;
|
|
200
200
|
ends_at?: string | undefined;
|
|
201
|
-
status:
|
|
201
|
+
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
202
202
|
is_backup_access_code_available: boolean;
|
|
203
203
|
is_backup?: boolean | undefined;
|
|
204
204
|
pulled_backup_access_code_id?: (string | null) | undefined;
|
|
205
205
|
}>;
|
|
206
206
|
};
|
|
207
207
|
};
|
|
208
|
-
|
|
209
|
-
route:
|
|
210
|
-
method:
|
|
208
|
+
'/access_codes/pull_backup_access_code': {
|
|
209
|
+
route: '/access_codes/pull_backup_access_code';
|
|
210
|
+
method: 'POST';
|
|
211
211
|
queryParams: {};
|
|
212
212
|
jsonBody: {
|
|
213
213
|
access_code_id: string;
|
|
@@ -218,7 +218,7 @@ export interface Routes {
|
|
|
218
218
|
backup_access_code: {
|
|
219
219
|
common_code_key: string | null;
|
|
220
220
|
is_scheduled_on_device?: boolean | undefined;
|
|
221
|
-
type:
|
|
221
|
+
type: 'time_bound' | 'ongoing';
|
|
222
222
|
is_waiting_for_code_assignment?: boolean | undefined;
|
|
223
223
|
access_code_id: string;
|
|
224
224
|
device_id: string;
|
|
@@ -230,16 +230,16 @@ export interface Routes {
|
|
|
230
230
|
is_managed: true;
|
|
231
231
|
starts_at?: string | undefined;
|
|
232
232
|
ends_at?: string | undefined;
|
|
233
|
-
status:
|
|
233
|
+
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
234
234
|
is_backup_access_code_available: boolean;
|
|
235
235
|
is_backup?: boolean | undefined;
|
|
236
236
|
pulled_backup_access_code_id?: (string | null) | undefined;
|
|
237
237
|
};
|
|
238
238
|
};
|
|
239
239
|
};
|
|
240
|
-
|
|
241
|
-
route:
|
|
242
|
-
method:
|
|
240
|
+
'/access_codes/simulate/create_unmanaged_access_code': {
|
|
241
|
+
route: '/access_codes/simulate/create_unmanaged_access_code';
|
|
242
|
+
method: 'POST';
|
|
243
243
|
queryParams: {};
|
|
244
244
|
jsonBody: {
|
|
245
245
|
device_id: string;
|
|
@@ -252,27 +252,27 @@ export interface Routes {
|
|
|
252
252
|
access_code: {
|
|
253
253
|
access_code_id: string;
|
|
254
254
|
code: string | null;
|
|
255
|
-
status:
|
|
255
|
+
status: 'set';
|
|
256
256
|
created_at: string | Date;
|
|
257
257
|
is_managed: false;
|
|
258
|
-
type:
|
|
258
|
+
type: 'ongoing';
|
|
259
259
|
starts_at: null;
|
|
260
260
|
ends_at: null;
|
|
261
261
|
} | {
|
|
262
262
|
access_code_id: string;
|
|
263
263
|
code: string | null;
|
|
264
|
-
status:
|
|
264
|
+
status: 'set';
|
|
265
265
|
created_at: string | Date;
|
|
266
266
|
is_managed: false;
|
|
267
|
-
type:
|
|
267
|
+
type: 'time_bound';
|
|
268
268
|
starts_at: string | null;
|
|
269
269
|
ends_at: string | null;
|
|
270
270
|
};
|
|
271
271
|
};
|
|
272
272
|
};
|
|
273
|
-
|
|
274
|
-
route:
|
|
275
|
-
method:
|
|
273
|
+
'/access_codes/unmanaged/convert_to_managed': {
|
|
274
|
+
route: '/access_codes/unmanaged/convert_to_managed';
|
|
275
|
+
method: 'POST' | 'PATCH';
|
|
276
276
|
queryParams: {};
|
|
277
277
|
jsonBody: {};
|
|
278
278
|
commonParams: {
|
|
@@ -283,9 +283,9 @@ export interface Routes {
|
|
|
283
283
|
formData: {};
|
|
284
284
|
jsonResponse: {};
|
|
285
285
|
};
|
|
286
|
-
|
|
287
|
-
route:
|
|
288
|
-
method:
|
|
286
|
+
'/access_codes/unmanaged/delete': {
|
|
287
|
+
route: '/access_codes/unmanaged/delete';
|
|
288
|
+
method: 'DELETE' | 'POST';
|
|
289
289
|
queryParams: {};
|
|
290
290
|
jsonBody: {};
|
|
291
291
|
commonParams: {
|
|
@@ -295,19 +295,19 @@ export interface Routes {
|
|
|
295
295
|
formData: {};
|
|
296
296
|
jsonResponse: {
|
|
297
297
|
action_attempt: {
|
|
298
|
-
status:
|
|
298
|
+
status: 'success';
|
|
299
299
|
action_type: string;
|
|
300
300
|
action_attempt_id: string;
|
|
301
301
|
result?: any;
|
|
302
302
|
error: null;
|
|
303
303
|
} | {
|
|
304
|
-
status:
|
|
304
|
+
status: 'pending';
|
|
305
305
|
action_type: string;
|
|
306
306
|
action_attempt_id: string;
|
|
307
307
|
result: null;
|
|
308
308
|
error: null;
|
|
309
309
|
} | {
|
|
310
|
-
status:
|
|
310
|
+
status: 'error';
|
|
311
311
|
action_type: string;
|
|
312
312
|
action_attempt_id: string;
|
|
313
313
|
result: null;
|
|
@@ -318,9 +318,9 @@ export interface Routes {
|
|
|
318
318
|
};
|
|
319
319
|
};
|
|
320
320
|
};
|
|
321
|
-
|
|
322
|
-
route:
|
|
323
|
-
method:
|
|
321
|
+
'/access_codes/unmanaged/get': {
|
|
322
|
+
route: '/access_codes/unmanaged/get';
|
|
323
|
+
method: 'GET' | 'POST';
|
|
324
324
|
queryParams: {};
|
|
325
325
|
jsonBody: {};
|
|
326
326
|
commonParams: {
|
|
@@ -331,7 +331,7 @@ export interface Routes {
|
|
|
331
331
|
formData: {};
|
|
332
332
|
jsonResponse: {
|
|
333
333
|
access_code: {
|
|
334
|
-
type:
|
|
334
|
+
type: 'time_bound' | 'ongoing';
|
|
335
335
|
access_code_id: string;
|
|
336
336
|
device_id: string;
|
|
337
337
|
name: string | null;
|
|
@@ -342,13 +342,13 @@ export interface Routes {
|
|
|
342
342
|
is_managed: false;
|
|
343
343
|
starts_at: string | null;
|
|
344
344
|
ends_at: string | null;
|
|
345
|
-
status:
|
|
345
|
+
status: 'set';
|
|
346
346
|
};
|
|
347
347
|
};
|
|
348
348
|
};
|
|
349
|
-
|
|
350
|
-
route:
|
|
351
|
-
method:
|
|
349
|
+
'/access_codes/unmanaged/list': {
|
|
350
|
+
route: '/access_codes/unmanaged/list';
|
|
351
|
+
method: 'GET' | 'POST';
|
|
352
352
|
queryParams: {};
|
|
353
353
|
jsonBody: {};
|
|
354
354
|
commonParams: {
|
|
@@ -357,7 +357,7 @@ export interface Routes {
|
|
|
357
357
|
formData: {};
|
|
358
358
|
jsonResponse: {
|
|
359
359
|
access_codes: Array<{
|
|
360
|
-
type:
|
|
360
|
+
type: 'time_bound' | 'ongoing';
|
|
361
361
|
access_code_id: string;
|
|
362
362
|
device_id: string;
|
|
363
363
|
name: string | null;
|
|
@@ -368,13 +368,13 @@ export interface Routes {
|
|
|
368
368
|
is_managed: false;
|
|
369
369
|
starts_at: string | null;
|
|
370
370
|
ends_at: string | null;
|
|
371
|
-
status:
|
|
371
|
+
status: 'set';
|
|
372
372
|
}>;
|
|
373
373
|
};
|
|
374
374
|
};
|
|
375
|
-
|
|
376
|
-
route:
|
|
377
|
-
method:
|
|
375
|
+
'/access_codes/unmanaged/update': {
|
|
376
|
+
route: '/access_codes/unmanaged/update';
|
|
377
|
+
method: 'POST' | 'PATCH';
|
|
378
378
|
queryParams: {};
|
|
379
379
|
jsonBody: {};
|
|
380
380
|
commonParams: {
|
|
@@ -385,9 +385,9 @@ export interface Routes {
|
|
|
385
385
|
formData: {};
|
|
386
386
|
jsonResponse: {};
|
|
387
387
|
};
|
|
388
|
-
|
|
389
|
-
route:
|
|
390
|
-
method:
|
|
388
|
+
'/access_codes/update': {
|
|
389
|
+
route: '/access_codes/update';
|
|
390
|
+
method: 'POST' | 'PUT';
|
|
391
391
|
queryParams: {};
|
|
392
392
|
jsonBody: {
|
|
393
393
|
name?: string | undefined;
|
|
@@ -400,25 +400,25 @@ export interface Routes {
|
|
|
400
400
|
use_backup_access_code_pool?: boolean | undefined;
|
|
401
401
|
access_code_id: string;
|
|
402
402
|
device_id?: string | undefined;
|
|
403
|
-
type?: (
|
|
403
|
+
type?: ('ongoing' | 'time_bound') | undefined;
|
|
404
404
|
};
|
|
405
405
|
commonParams: {};
|
|
406
406
|
formData: {};
|
|
407
407
|
jsonResponse: {
|
|
408
408
|
action_attempt: {
|
|
409
|
-
status:
|
|
409
|
+
status: 'success';
|
|
410
410
|
action_type: string;
|
|
411
411
|
action_attempt_id: string;
|
|
412
412
|
result?: any;
|
|
413
413
|
error: null;
|
|
414
414
|
} | {
|
|
415
|
-
status:
|
|
415
|
+
status: 'pending';
|
|
416
416
|
action_type: string;
|
|
417
417
|
action_attempt_id: string;
|
|
418
418
|
result: null;
|
|
419
419
|
error: null;
|
|
420
420
|
} | {
|
|
421
|
-
status:
|
|
421
|
+
status: 'error';
|
|
422
422
|
action_type: string;
|
|
423
423
|
action_attempt_id: string;
|
|
424
424
|
result: null;
|
|
@@ -429,9 +429,9 @@ export interface Routes {
|
|
|
429
429
|
};
|
|
430
430
|
};
|
|
431
431
|
};
|
|
432
|
-
|
|
433
|
-
route:
|
|
434
|
-
method:
|
|
432
|
+
'/action_attempts/get': {
|
|
433
|
+
route: '/action_attempts/get';
|
|
434
|
+
method: 'GET' | 'POST';
|
|
435
435
|
queryParams: {};
|
|
436
436
|
jsonBody: {};
|
|
437
437
|
commonParams: {
|
|
@@ -440,19 +440,19 @@ export interface Routes {
|
|
|
440
440
|
formData: {};
|
|
441
441
|
jsonResponse: {
|
|
442
442
|
action_attempt: {
|
|
443
|
-
status:
|
|
443
|
+
status: 'success';
|
|
444
444
|
action_type: string;
|
|
445
445
|
action_attempt_id: string;
|
|
446
446
|
result?: any;
|
|
447
447
|
error: null;
|
|
448
448
|
} | {
|
|
449
|
-
status:
|
|
449
|
+
status: 'pending';
|
|
450
450
|
action_type: string;
|
|
451
451
|
action_attempt_id: string;
|
|
452
452
|
result: null;
|
|
453
453
|
error: null;
|
|
454
454
|
} | {
|
|
455
|
-
status:
|
|
455
|
+
status: 'error';
|
|
456
456
|
action_type: string;
|
|
457
457
|
action_attempt_id: string;
|
|
458
458
|
result: null;
|
|
@@ -463,9 +463,9 @@ export interface Routes {
|
|
|
463
463
|
};
|
|
464
464
|
};
|
|
465
465
|
};
|
|
466
|
-
|
|
467
|
-
route:
|
|
468
|
-
method:
|
|
466
|
+
'/action_attempts/list': {
|
|
467
|
+
route: '/action_attempts/list';
|
|
468
|
+
method: 'GET' | 'POST';
|
|
469
469
|
queryParams: {};
|
|
470
470
|
jsonBody: {};
|
|
471
471
|
commonParams: {
|
|
@@ -474,19 +474,19 @@ export interface Routes {
|
|
|
474
474
|
formData: {};
|
|
475
475
|
jsonResponse: {
|
|
476
476
|
action_attempts: Array<{
|
|
477
|
-
status:
|
|
477
|
+
status: 'success';
|
|
478
478
|
action_type: string;
|
|
479
479
|
action_attempt_id: string;
|
|
480
480
|
result?: any;
|
|
481
481
|
error: null;
|
|
482
482
|
} | {
|
|
483
|
-
status:
|
|
483
|
+
status: 'pending';
|
|
484
484
|
action_type: string;
|
|
485
485
|
action_attempt_id: string;
|
|
486
486
|
result: null;
|
|
487
487
|
error: null;
|
|
488
488
|
} | {
|
|
489
|
-
status:
|
|
489
|
+
status: 'error';
|
|
490
490
|
action_type: string;
|
|
491
491
|
action_attempt_id: string;
|
|
492
492
|
result: null;
|
|
@@ -497,9 +497,9 @@ export interface Routes {
|
|
|
497
497
|
}>;
|
|
498
498
|
};
|
|
499
499
|
};
|
|
500
|
-
|
|
501
|
-
route:
|
|
502
|
-
method:
|
|
500
|
+
'/client_sessions/create': {
|
|
501
|
+
route: '/client_sessions/create';
|
|
502
|
+
method: 'POST' | 'PUT';
|
|
503
503
|
queryParams: {};
|
|
504
504
|
jsonBody: any | {
|
|
505
505
|
user_identifier_key: string;
|
|
@@ -516,9 +516,9 @@ export interface Routes {
|
|
|
516
516
|
};
|
|
517
517
|
};
|
|
518
518
|
};
|
|
519
|
-
|
|
520
|
-
route:
|
|
521
|
-
method:
|
|
519
|
+
'/client_sessions/delete': {
|
|
520
|
+
route: '/client_sessions/delete';
|
|
521
|
+
method: 'POST' | 'GET';
|
|
522
522
|
queryParams: {};
|
|
523
523
|
jsonBody: {};
|
|
524
524
|
commonParams: {
|
|
@@ -527,9 +527,9 @@ export interface Routes {
|
|
|
527
527
|
formData: {};
|
|
528
528
|
jsonResponse: {};
|
|
529
529
|
};
|
|
530
|
-
|
|
531
|
-
route:
|
|
532
|
-
method:
|
|
530
|
+
'/client_sessions/list': {
|
|
531
|
+
route: '/client_sessions/list';
|
|
532
|
+
method: 'POST' | 'GET';
|
|
533
533
|
queryParams: {};
|
|
534
534
|
jsonBody: {};
|
|
535
535
|
commonParams: {};
|
|
@@ -545,16 +545,16 @@ export interface Routes {
|
|
|
545
545
|
}>;
|
|
546
546
|
};
|
|
547
547
|
};
|
|
548
|
-
|
|
549
|
-
route:
|
|
550
|
-
method:
|
|
548
|
+
'/connect_webviews/create': {
|
|
549
|
+
route: '/connect_webviews/create';
|
|
550
|
+
method: 'POST';
|
|
551
551
|
queryParams: {};
|
|
552
552
|
jsonBody: {
|
|
553
|
-
device_selection_mode?: (
|
|
553
|
+
device_selection_mode?: ('none' | 'single' | 'multiple') | undefined;
|
|
554
554
|
custom_redirect_url?: string | undefined;
|
|
555
555
|
custom_redirect_failure_url?: string | undefined;
|
|
556
|
-
accepted_providers?: Array<
|
|
557
|
-
provider_category?: (
|
|
556
|
+
accepted_providers?: Array<'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'yale_access'> | undefined;
|
|
557
|
+
provider_category?: ('stable' | 'internal_beta') | undefined;
|
|
558
558
|
custom_metadata?: Record<string, string | number | null | boolean> | undefined;
|
|
559
559
|
};
|
|
560
560
|
commonParams: {};
|
|
@@ -565,20 +565,20 @@ export interface Routes {
|
|
|
565
565
|
connected_account_id?: string | undefined;
|
|
566
566
|
url: string;
|
|
567
567
|
workspace_id: string;
|
|
568
|
-
device_selection_mode:
|
|
568
|
+
device_selection_mode: 'none' | 'single' | 'multiple';
|
|
569
569
|
accepted_providers: string[];
|
|
570
570
|
accepted_devices: string[];
|
|
571
571
|
any_provider_allowed: boolean;
|
|
572
572
|
any_device_allowed: boolean;
|
|
573
573
|
created_at: string;
|
|
574
574
|
login_successful: boolean;
|
|
575
|
-
status:
|
|
575
|
+
status: 'pending' | 'failed' | 'authorized';
|
|
576
576
|
};
|
|
577
577
|
};
|
|
578
578
|
};
|
|
579
|
-
|
|
580
|
-
route:
|
|
581
|
-
method:
|
|
579
|
+
'/connect_webviews/delete': {
|
|
580
|
+
route: '/connect_webviews/delete';
|
|
581
|
+
method: 'DELETE' | 'POST';
|
|
582
582
|
queryParams: {};
|
|
583
583
|
jsonBody: {
|
|
584
584
|
connect_webview_id: string;
|
|
@@ -587,9 +587,9 @@ export interface Routes {
|
|
|
587
587
|
formData: {};
|
|
588
588
|
jsonResponse: {};
|
|
589
589
|
};
|
|
590
|
-
|
|
591
|
-
route:
|
|
592
|
-
method:
|
|
590
|
+
'/connect_webviews/get': {
|
|
591
|
+
route: '/connect_webviews/get';
|
|
592
|
+
method: 'GET' | 'POST';
|
|
593
593
|
queryParams: {};
|
|
594
594
|
jsonBody: {};
|
|
595
595
|
commonParams: {
|
|
@@ -602,20 +602,20 @@ export interface Routes {
|
|
|
602
602
|
connected_account_id?: string | undefined;
|
|
603
603
|
url: string;
|
|
604
604
|
workspace_id: string;
|
|
605
|
-
device_selection_mode:
|
|
605
|
+
device_selection_mode: 'none' | 'single' | 'multiple';
|
|
606
606
|
accepted_providers: string[];
|
|
607
607
|
accepted_devices: string[];
|
|
608
608
|
any_provider_allowed: boolean;
|
|
609
609
|
any_device_allowed: boolean;
|
|
610
610
|
created_at: string;
|
|
611
611
|
login_successful: boolean;
|
|
612
|
-
status:
|
|
612
|
+
status: 'pending' | 'failed' | 'authorized';
|
|
613
613
|
};
|
|
614
614
|
};
|
|
615
615
|
};
|
|
616
|
-
|
|
617
|
-
route:
|
|
618
|
-
method:
|
|
616
|
+
'/connect_webviews/list': {
|
|
617
|
+
route: '/connect_webviews/list';
|
|
618
|
+
method: 'GET' | 'POST';
|
|
619
619
|
queryParams: {};
|
|
620
620
|
jsonBody: {};
|
|
621
621
|
commonParams: {};
|
|
@@ -626,20 +626,20 @@ export interface Routes {
|
|
|
626
626
|
connected_account_id?: string | undefined;
|
|
627
627
|
url: string;
|
|
628
628
|
workspace_id: string;
|
|
629
|
-
device_selection_mode:
|
|
629
|
+
device_selection_mode: 'none' | 'single' | 'multiple';
|
|
630
630
|
accepted_providers: string[];
|
|
631
631
|
accepted_devices: string[];
|
|
632
632
|
any_provider_allowed: boolean;
|
|
633
633
|
any_device_allowed: boolean;
|
|
634
634
|
created_at: string;
|
|
635
635
|
login_successful: boolean;
|
|
636
|
-
status:
|
|
636
|
+
status: 'pending' | 'failed' | 'authorized';
|
|
637
637
|
}>;
|
|
638
638
|
};
|
|
639
639
|
};
|
|
640
|
-
|
|
641
|
-
route:
|
|
642
|
-
method:
|
|
640
|
+
'/connect_webviews/view': {
|
|
641
|
+
route: '/connect_webviews/view';
|
|
642
|
+
method: 'GET';
|
|
643
643
|
queryParams: {
|
|
644
644
|
connect_webview_id: string;
|
|
645
645
|
auth_token: string;
|
|
@@ -649,9 +649,9 @@ export interface Routes {
|
|
|
649
649
|
formData: {};
|
|
650
650
|
jsonResponse: {};
|
|
651
651
|
};
|
|
652
|
-
|
|
653
|
-
route:
|
|
654
|
-
method:
|
|
652
|
+
'/connected_accounts/delete': {
|
|
653
|
+
route: '/connected_accounts/delete';
|
|
654
|
+
method: 'DELETE' | 'POST';
|
|
655
655
|
queryParams: {};
|
|
656
656
|
jsonBody: {
|
|
657
657
|
connected_account_id: string;
|
|
@@ -660,16 +660,16 @@ export interface Routes {
|
|
|
660
660
|
formData: {};
|
|
661
661
|
jsonResponse: {};
|
|
662
662
|
};
|
|
663
|
-
|
|
664
|
-
route:
|
|
665
|
-
method:
|
|
666
|
-
queryParams: {
|
|
663
|
+
'/connected_accounts/get': {
|
|
664
|
+
route: '/connected_accounts/get';
|
|
665
|
+
method: 'GET' | 'POST';
|
|
666
|
+
queryParams: {};
|
|
667
|
+
jsonBody: {};
|
|
668
|
+
commonParams: {
|
|
667
669
|
connected_account_id: string;
|
|
668
670
|
} | {
|
|
669
671
|
email: string;
|
|
670
672
|
};
|
|
671
|
-
jsonBody: {};
|
|
672
|
-
commonParams: {};
|
|
673
673
|
formData: {};
|
|
674
674
|
jsonResponse: {
|
|
675
675
|
connected_account: {
|
|
@@ -689,9 +689,9 @@ export interface Routes {
|
|
|
689
689
|
};
|
|
690
690
|
};
|
|
691
691
|
};
|
|
692
|
-
|
|
693
|
-
route:
|
|
694
|
-
method:
|
|
692
|
+
'/connected_accounts/list': {
|
|
693
|
+
route: '/connected_accounts/list';
|
|
694
|
+
method: 'GET' | 'POST';
|
|
695
695
|
queryParams: {};
|
|
696
696
|
jsonBody: {};
|
|
697
697
|
commonParams: {};
|
|
@@ -714,9 +714,9 @@ export interface Routes {
|
|
|
714
714
|
}>;
|
|
715
715
|
};
|
|
716
716
|
};
|
|
717
|
-
|
|
718
|
-
route:
|
|
719
|
-
method:
|
|
717
|
+
'/devices/delete': {
|
|
718
|
+
route: '/devices/delete';
|
|
719
|
+
method: 'DELETE' | 'POST';
|
|
720
720
|
queryParams: {};
|
|
721
721
|
jsonBody: {};
|
|
722
722
|
commonParams: {
|
|
@@ -725,9 +725,9 @@ export interface Routes {
|
|
|
725
725
|
formData: {};
|
|
726
726
|
jsonResponse: {};
|
|
727
727
|
};
|
|
728
|
-
|
|
729
|
-
route:
|
|
730
|
-
method:
|
|
728
|
+
'/devices/get': {
|
|
729
|
+
route: '/devices/get';
|
|
730
|
+
method: 'GET';
|
|
731
731
|
queryParams: {
|
|
732
732
|
device_id?: string | undefined;
|
|
733
733
|
name?: string | undefined;
|
|
@@ -738,7 +738,7 @@ export interface Routes {
|
|
|
738
738
|
jsonResponse: {
|
|
739
739
|
device: {
|
|
740
740
|
device_id: string;
|
|
741
|
-
device_type:
|
|
741
|
+
device_type: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat';
|
|
742
742
|
capabilities_supported: string[];
|
|
743
743
|
properties: {
|
|
744
744
|
online: boolean;
|
|
@@ -763,25 +763,25 @@ export interface Routes {
|
|
|
763
763
|
};
|
|
764
764
|
};
|
|
765
765
|
};
|
|
766
|
-
|
|
767
|
-
route:
|
|
768
|
-
method:
|
|
766
|
+
'/devices/list': {
|
|
767
|
+
route: '/devices/list';
|
|
768
|
+
method: 'GET' | 'POST';
|
|
769
769
|
queryParams: {};
|
|
770
770
|
jsonBody: {};
|
|
771
771
|
commonParams: {
|
|
772
772
|
connected_account_id?: string | undefined;
|
|
773
773
|
connected_account_ids?: string[] | undefined;
|
|
774
774
|
connect_webview_id?: string | undefined;
|
|
775
|
-
device_type?: (
|
|
776
|
-
device_types?: Array<
|
|
777
|
-
manufacturer?: (
|
|
775
|
+
device_type?: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat') | undefined;
|
|
776
|
+
device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat'> | undefined;
|
|
777
|
+
manufacturer?: ('akuvox' | 'august' | 'brivo' | 'butterflymx' | 'doorking' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat') | undefined;
|
|
778
778
|
device_ids?: string[] | undefined;
|
|
779
779
|
};
|
|
780
780
|
formData: {};
|
|
781
781
|
jsonResponse: {
|
|
782
782
|
devices: Array<{
|
|
783
783
|
device_id: string;
|
|
784
|
-
device_type:
|
|
784
|
+
device_type: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat';
|
|
785
785
|
capabilities_supported: string[];
|
|
786
786
|
properties: {
|
|
787
787
|
online: boolean;
|
|
@@ -806,13 +806,13 @@ export interface Routes {
|
|
|
806
806
|
}>;
|
|
807
807
|
};
|
|
808
808
|
};
|
|
809
|
-
|
|
810
|
-
route:
|
|
811
|
-
method:
|
|
809
|
+
'/devices/list_device_providers': {
|
|
810
|
+
route: '/devices/list_device_providers';
|
|
811
|
+
method: 'GET';
|
|
812
812
|
queryParams: {};
|
|
813
813
|
jsonBody: {};
|
|
814
814
|
commonParams: {
|
|
815
|
-
provider_category?:
|
|
815
|
+
provider_category?: 'stable' | undefined;
|
|
816
816
|
};
|
|
817
817
|
formData: {};
|
|
818
818
|
jsonResponse: {
|
|
@@ -820,29 +820,29 @@ export interface Routes {
|
|
|
820
820
|
device_provider_name: string;
|
|
821
821
|
display_name: string;
|
|
822
822
|
image_url: string;
|
|
823
|
-
provider_categories: Array<
|
|
823
|
+
provider_categories: Array<'stable'>;
|
|
824
824
|
}>;
|
|
825
825
|
};
|
|
826
826
|
};
|
|
827
|
-
|
|
828
|
-
route:
|
|
829
|
-
method:
|
|
827
|
+
'/devices/unmanaged/list': {
|
|
828
|
+
route: '/devices/unmanaged/list';
|
|
829
|
+
method: 'GET' | 'POST';
|
|
830
830
|
queryParams: {};
|
|
831
831
|
jsonBody: {};
|
|
832
832
|
commonParams: {
|
|
833
833
|
connected_account_id?: string | undefined;
|
|
834
834
|
connected_account_ids?: string[] | undefined;
|
|
835
835
|
connect_webview_id?: string | undefined;
|
|
836
|
-
device_type?: (
|
|
837
|
-
device_types?: Array<
|
|
838
|
-
manufacturer?: (
|
|
836
|
+
device_type?: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat') | undefined;
|
|
837
|
+
device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat'> | undefined;
|
|
838
|
+
manufacturer?: ('akuvox' | 'august' | 'brivo' | 'butterflymx' | 'doorking' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat') | undefined;
|
|
839
839
|
device_ids?: string[] | undefined;
|
|
840
840
|
};
|
|
841
841
|
formData: {};
|
|
842
842
|
jsonResponse: {
|
|
843
843
|
devices: Array<{
|
|
844
844
|
device_id: string;
|
|
845
|
-
device_type:
|
|
845
|
+
device_type: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat';
|
|
846
846
|
connected_account_id: string;
|
|
847
847
|
capabilities_supported: string[];
|
|
848
848
|
workspace_id: string;
|
|
@@ -869,9 +869,9 @@ export interface Routes {
|
|
|
869
869
|
}>;
|
|
870
870
|
};
|
|
871
871
|
};
|
|
872
|
-
|
|
873
|
-
route:
|
|
874
|
-
method:
|
|
872
|
+
'/devices/unmanaged/update': {
|
|
873
|
+
route: '/devices/unmanaged/update';
|
|
874
|
+
method: 'POST' | 'PATCH';
|
|
875
875
|
queryParams: {};
|
|
876
876
|
jsonBody: {};
|
|
877
877
|
commonParams: {
|
|
@@ -881,9 +881,9 @@ export interface Routes {
|
|
|
881
881
|
formData: {};
|
|
882
882
|
jsonResponse: {};
|
|
883
883
|
};
|
|
884
|
-
|
|
885
|
-
route:
|
|
886
|
-
method:
|
|
884
|
+
'/devices/update': {
|
|
885
|
+
route: '/devices/update';
|
|
886
|
+
method: 'POST' | 'PATCH';
|
|
887
887
|
queryParams: {};
|
|
888
888
|
jsonBody: {};
|
|
889
889
|
commonParams: {
|
|
@@ -898,9 +898,9 @@ export interface Routes {
|
|
|
898
898
|
formData: {};
|
|
899
899
|
jsonResponse: {};
|
|
900
900
|
};
|
|
901
|
-
|
|
902
|
-
route:
|
|
903
|
-
method:
|
|
901
|
+
'/events/get': {
|
|
902
|
+
route: '/events/get';
|
|
903
|
+
method: 'GET';
|
|
904
904
|
queryParams: {};
|
|
905
905
|
jsonBody: {};
|
|
906
906
|
commonParams: {
|
|
@@ -921,9 +921,9 @@ export interface Routes {
|
|
|
921
921
|
message?: string | undefined;
|
|
922
922
|
};
|
|
923
923
|
};
|
|
924
|
-
|
|
925
|
-
route:
|
|
926
|
-
method:
|
|
924
|
+
'/events/list': {
|
|
925
|
+
route: '/events/list';
|
|
926
|
+
method: 'GET' | 'POST';
|
|
927
927
|
queryParams: {};
|
|
928
928
|
jsonBody: {};
|
|
929
929
|
commonParams: {
|
|
@@ -933,8 +933,8 @@ export interface Routes {
|
|
|
933
933
|
device_ids?: string[] | undefined;
|
|
934
934
|
access_code_id?: string | undefined;
|
|
935
935
|
access_code_ids?: string[] | undefined;
|
|
936
|
-
event_type?: (
|
|
937
|
-
event_types?: Array<
|
|
936
|
+
event_type?: ('device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled') | undefined;
|
|
937
|
+
event_types?: Array<'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled'> | undefined;
|
|
938
938
|
connected_account_id?: string | undefined;
|
|
939
939
|
};
|
|
940
940
|
formData: {};
|
|
@@ -950,45 +950,45 @@ export interface Routes {
|
|
|
950
950
|
message?: string | undefined;
|
|
951
951
|
};
|
|
952
952
|
};
|
|
953
|
-
|
|
954
|
-
route:
|
|
955
|
-
method:
|
|
953
|
+
'/health': {
|
|
954
|
+
route: '/health';
|
|
955
|
+
method: 'GET';
|
|
956
956
|
queryParams: {};
|
|
957
957
|
jsonBody: {};
|
|
958
958
|
commonParams: {};
|
|
959
959
|
formData: {};
|
|
960
960
|
jsonResponse: {
|
|
961
961
|
ok: boolean;
|
|
962
|
-
msg:
|
|
962
|
+
msg: 'I\u2019m one with the Force. The Force is with me.';
|
|
963
963
|
last_service_evaluation_at: string;
|
|
964
964
|
service_health_statuses: Array<{
|
|
965
965
|
service: string;
|
|
966
|
-
status:
|
|
966
|
+
status: 'healthy' | 'degraded' | 'down';
|
|
967
967
|
description: string;
|
|
968
968
|
}>;
|
|
969
969
|
};
|
|
970
970
|
};
|
|
971
|
-
|
|
972
|
-
route:
|
|
973
|
-
method:
|
|
971
|
+
'/health/get_health': {
|
|
972
|
+
route: '/health/get_health';
|
|
973
|
+
method: 'GET';
|
|
974
974
|
queryParams: {};
|
|
975
975
|
jsonBody: {};
|
|
976
976
|
commonParams: {};
|
|
977
977
|
formData: {};
|
|
978
978
|
jsonResponse: {
|
|
979
979
|
ok: boolean;
|
|
980
|
-
msg:
|
|
980
|
+
msg: 'I\u2019m one with the Force. The Force is with me.';
|
|
981
981
|
last_service_evaluation_at: string;
|
|
982
982
|
service_health_statuses: Array<{
|
|
983
983
|
service: string;
|
|
984
|
-
status:
|
|
984
|
+
status: 'healthy' | 'degraded' | 'down';
|
|
985
985
|
description: string;
|
|
986
986
|
}>;
|
|
987
987
|
};
|
|
988
988
|
};
|
|
989
|
-
|
|
990
|
-
route:
|
|
991
|
-
method:
|
|
989
|
+
'/health/get_service_health': {
|
|
990
|
+
route: '/health/get_service_health';
|
|
991
|
+
method: 'GET';
|
|
992
992
|
queryParams: {};
|
|
993
993
|
jsonBody: {};
|
|
994
994
|
commonParams: {
|
|
@@ -1000,14 +1000,14 @@ export interface Routes {
|
|
|
1000
1000
|
last_service_evaluation_at: string;
|
|
1001
1001
|
service_health: {
|
|
1002
1002
|
service: string;
|
|
1003
|
-
status:
|
|
1003
|
+
status: 'healthy' | 'degraded' | 'down';
|
|
1004
1004
|
description: string;
|
|
1005
1005
|
};
|
|
1006
1006
|
};
|
|
1007
1007
|
};
|
|
1008
|
-
|
|
1009
|
-
route:
|
|
1010
|
-
method:
|
|
1008
|
+
'/health/service/[service_name]': {
|
|
1009
|
+
route: '/health/service/[service_name]';
|
|
1010
|
+
method: 'GET';
|
|
1011
1011
|
queryParams: {
|
|
1012
1012
|
service_name: string;
|
|
1013
1013
|
};
|
|
@@ -1019,14 +1019,14 @@ export interface Routes {
|
|
|
1019
1019
|
last_service_evaluation_at: string;
|
|
1020
1020
|
service_health: {
|
|
1021
1021
|
service: string;
|
|
1022
|
-
status:
|
|
1022
|
+
status: 'healthy' | 'degraded' | 'down';
|
|
1023
1023
|
description: string;
|
|
1024
1024
|
};
|
|
1025
1025
|
};
|
|
1026
1026
|
};
|
|
1027
|
-
|
|
1028
|
-
route:
|
|
1029
|
-
method:
|
|
1027
|
+
'/locks/get': {
|
|
1028
|
+
route: '/locks/get';
|
|
1029
|
+
method: 'GET' | 'POST';
|
|
1030
1030
|
queryParams: {};
|
|
1031
1031
|
jsonBody: {};
|
|
1032
1032
|
commonParams: {
|
|
@@ -1039,18 +1039,18 @@ export interface Routes {
|
|
|
1039
1039
|
device?: any;
|
|
1040
1040
|
};
|
|
1041
1041
|
};
|
|
1042
|
-
|
|
1043
|
-
route:
|
|
1044
|
-
method:
|
|
1042
|
+
'/locks/list': {
|
|
1043
|
+
route: '/locks/list';
|
|
1044
|
+
method: 'GET' | 'POST';
|
|
1045
1045
|
queryParams: {};
|
|
1046
1046
|
jsonBody: {};
|
|
1047
1047
|
commonParams: {
|
|
1048
1048
|
connected_account_id?: string | undefined;
|
|
1049
1049
|
connected_account_ids?: string[] | undefined;
|
|
1050
1050
|
connect_webview_id?: string | undefined;
|
|
1051
|
-
device_type?: (
|
|
1052
|
-
device_types?: Array<
|
|
1053
|
-
manufacturer?: (
|
|
1051
|
+
device_type?: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat') | undefined;
|
|
1052
|
+
device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat'> | undefined;
|
|
1053
|
+
manufacturer?: ('akuvox' | 'august' | 'brivo' | 'butterflymx' | 'doorking' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat') | undefined;
|
|
1054
1054
|
device_ids?: string[] | undefined;
|
|
1055
1055
|
};
|
|
1056
1056
|
formData: {};
|
|
@@ -1059,9 +1059,9 @@ export interface Routes {
|
|
|
1059
1059
|
devices?: any;
|
|
1060
1060
|
};
|
|
1061
1061
|
};
|
|
1062
|
-
|
|
1063
|
-
route:
|
|
1064
|
-
method:
|
|
1062
|
+
'/locks/lock_door': {
|
|
1063
|
+
route: '/locks/lock_door';
|
|
1064
|
+
method: 'POST';
|
|
1065
1065
|
queryParams: {};
|
|
1066
1066
|
jsonBody: {
|
|
1067
1067
|
device_id: string;
|
|
@@ -1071,19 +1071,19 @@ export interface Routes {
|
|
|
1071
1071
|
formData: {};
|
|
1072
1072
|
jsonResponse: {
|
|
1073
1073
|
action_attempt: {
|
|
1074
|
-
status:
|
|
1074
|
+
status: 'success';
|
|
1075
1075
|
action_type: string;
|
|
1076
1076
|
action_attempt_id: string;
|
|
1077
1077
|
result?: any;
|
|
1078
1078
|
error: null;
|
|
1079
1079
|
} | {
|
|
1080
|
-
status:
|
|
1080
|
+
status: 'pending';
|
|
1081
1081
|
action_type: string;
|
|
1082
1082
|
action_attempt_id: string;
|
|
1083
1083
|
result: null;
|
|
1084
1084
|
error: null;
|
|
1085
1085
|
} | {
|
|
1086
|
-
status:
|
|
1086
|
+
status: 'error';
|
|
1087
1087
|
action_type: string;
|
|
1088
1088
|
action_attempt_id: string;
|
|
1089
1089
|
result: null;
|
|
@@ -1094,9 +1094,9 @@ export interface Routes {
|
|
|
1094
1094
|
};
|
|
1095
1095
|
};
|
|
1096
1096
|
};
|
|
1097
|
-
|
|
1098
|
-
route:
|
|
1099
|
-
method:
|
|
1097
|
+
'/locks/unlock_door': {
|
|
1098
|
+
route: '/locks/unlock_door';
|
|
1099
|
+
method: 'POST';
|
|
1100
1100
|
queryParams: {};
|
|
1101
1101
|
jsonBody: {
|
|
1102
1102
|
device_id: string;
|
|
@@ -1106,19 +1106,19 @@ export interface Routes {
|
|
|
1106
1106
|
formData: {};
|
|
1107
1107
|
jsonResponse: {
|
|
1108
1108
|
action_attempt: {
|
|
1109
|
-
status:
|
|
1109
|
+
status: 'success';
|
|
1110
1110
|
action_type: string;
|
|
1111
1111
|
action_attempt_id: string;
|
|
1112
1112
|
result?: any;
|
|
1113
1113
|
error: null;
|
|
1114
1114
|
} | {
|
|
1115
|
-
status:
|
|
1115
|
+
status: 'pending';
|
|
1116
1116
|
action_type: string;
|
|
1117
1117
|
action_attempt_id: string;
|
|
1118
1118
|
result: null;
|
|
1119
1119
|
error: null;
|
|
1120
1120
|
} | {
|
|
1121
|
-
status:
|
|
1121
|
+
status: 'error';
|
|
1122
1122
|
action_type: string;
|
|
1123
1123
|
action_attempt_id: string;
|
|
1124
1124
|
result: null;
|
|
@@ -1129,9 +1129,9 @@ export interface Routes {
|
|
|
1129
1129
|
};
|
|
1130
1130
|
};
|
|
1131
1131
|
};
|
|
1132
|
-
|
|
1133
|
-
route:
|
|
1134
|
-
method:
|
|
1132
|
+
'/noise_sensors/noise_thresholds/create': {
|
|
1133
|
+
route: '/noise_sensors/noise_thresholds/create';
|
|
1134
|
+
method: 'POST';
|
|
1135
1135
|
queryParams: {};
|
|
1136
1136
|
jsonBody: {
|
|
1137
1137
|
device_id: string;
|
|
@@ -1146,19 +1146,19 @@ export interface Routes {
|
|
|
1146
1146
|
formData: {};
|
|
1147
1147
|
jsonResponse: {
|
|
1148
1148
|
action_attempt: {
|
|
1149
|
-
status:
|
|
1149
|
+
status: 'success';
|
|
1150
1150
|
action_type: string;
|
|
1151
1151
|
action_attempt_id: string;
|
|
1152
1152
|
result?: any;
|
|
1153
1153
|
error: null;
|
|
1154
1154
|
} | {
|
|
1155
|
-
status:
|
|
1155
|
+
status: 'pending';
|
|
1156
1156
|
action_type: string;
|
|
1157
1157
|
action_attempt_id: string;
|
|
1158
1158
|
result: null;
|
|
1159
1159
|
error: null;
|
|
1160
1160
|
} | {
|
|
1161
|
-
status:
|
|
1161
|
+
status: 'error';
|
|
1162
1162
|
action_type: string;
|
|
1163
1163
|
action_attempt_id: string;
|
|
1164
1164
|
result: null;
|
|
@@ -1169,9 +1169,9 @@ export interface Routes {
|
|
|
1169
1169
|
};
|
|
1170
1170
|
};
|
|
1171
1171
|
};
|
|
1172
|
-
|
|
1173
|
-
route:
|
|
1174
|
-
method:
|
|
1172
|
+
'/noise_sensors/noise_thresholds/delete': {
|
|
1173
|
+
route: '/noise_sensors/noise_thresholds/delete';
|
|
1174
|
+
method: 'DELETE' | 'POST';
|
|
1175
1175
|
queryParams: {};
|
|
1176
1176
|
jsonBody: {
|
|
1177
1177
|
noise_threshold_id: string;
|
|
@@ -1182,19 +1182,19 @@ export interface Routes {
|
|
|
1182
1182
|
formData: {};
|
|
1183
1183
|
jsonResponse: {
|
|
1184
1184
|
action_attempt: {
|
|
1185
|
-
status:
|
|
1185
|
+
status: 'success';
|
|
1186
1186
|
action_type: string;
|
|
1187
1187
|
action_attempt_id: string;
|
|
1188
1188
|
result?: any;
|
|
1189
1189
|
error: null;
|
|
1190
1190
|
} | {
|
|
1191
|
-
status:
|
|
1191
|
+
status: 'pending';
|
|
1192
1192
|
action_type: string;
|
|
1193
1193
|
action_attempt_id: string;
|
|
1194
1194
|
result: null;
|
|
1195
1195
|
error: null;
|
|
1196
1196
|
} | {
|
|
1197
|
-
status:
|
|
1197
|
+
status: 'error';
|
|
1198
1198
|
action_type: string;
|
|
1199
1199
|
action_attempt_id: string;
|
|
1200
1200
|
result: null;
|
|
@@ -1205,9 +1205,9 @@ export interface Routes {
|
|
|
1205
1205
|
};
|
|
1206
1206
|
};
|
|
1207
1207
|
};
|
|
1208
|
-
|
|
1209
|
-
route:
|
|
1210
|
-
method:
|
|
1208
|
+
'/noise_sensors/noise_thresholds/get': {
|
|
1209
|
+
route: '/noise_sensors/noise_thresholds/get';
|
|
1210
|
+
method: 'GET' | 'POST';
|
|
1211
1211
|
queryParams: {};
|
|
1212
1212
|
jsonBody: {};
|
|
1213
1213
|
commonParams: {
|
|
@@ -1226,9 +1226,9 @@ export interface Routes {
|
|
|
1226
1226
|
};
|
|
1227
1227
|
};
|
|
1228
1228
|
};
|
|
1229
|
-
|
|
1230
|
-
route:
|
|
1231
|
-
method:
|
|
1229
|
+
'/noise_sensors/noise_thresholds/list': {
|
|
1230
|
+
route: '/noise_sensors/noise_thresholds/list';
|
|
1231
|
+
method: 'GET' | 'POST';
|
|
1232
1232
|
queryParams: {};
|
|
1233
1233
|
jsonBody: {};
|
|
1234
1234
|
commonParams: {
|
|
@@ -1247,9 +1247,9 @@ export interface Routes {
|
|
|
1247
1247
|
}>;
|
|
1248
1248
|
};
|
|
1249
1249
|
};
|
|
1250
|
-
|
|
1251
|
-
route:
|
|
1252
|
-
method:
|
|
1250
|
+
'/noise_sensors/noise_thresholds/update': {
|
|
1251
|
+
route: '/noise_sensors/noise_thresholds/update';
|
|
1252
|
+
method: 'PUT' | 'POST';
|
|
1253
1253
|
queryParams: {};
|
|
1254
1254
|
jsonBody: {
|
|
1255
1255
|
noise_threshold_id: string;
|
|
@@ -1265,19 +1265,19 @@ export interface Routes {
|
|
|
1265
1265
|
formData: {};
|
|
1266
1266
|
jsonResponse: {
|
|
1267
1267
|
action_attempt: {
|
|
1268
|
-
status:
|
|
1268
|
+
status: 'success';
|
|
1269
1269
|
action_type: string;
|
|
1270
1270
|
action_attempt_id: string;
|
|
1271
1271
|
result?: any;
|
|
1272
1272
|
error: null;
|
|
1273
1273
|
} | {
|
|
1274
|
-
status:
|
|
1274
|
+
status: 'pending';
|
|
1275
1275
|
action_type: string;
|
|
1276
1276
|
action_attempt_id: string;
|
|
1277
1277
|
result: null;
|
|
1278
1278
|
error: null;
|
|
1279
1279
|
} | {
|
|
1280
|
-
status:
|
|
1280
|
+
status: 'error';
|
|
1281
1281
|
action_type: string;
|
|
1282
1282
|
action_attempt_id: string;
|
|
1283
1283
|
result: null;
|
|
@@ -1288,9 +1288,9 @@ export interface Routes {
|
|
|
1288
1288
|
};
|
|
1289
1289
|
};
|
|
1290
1290
|
};
|
|
1291
|
-
|
|
1292
|
-
route:
|
|
1293
|
-
method:
|
|
1291
|
+
'/noise_sensors/simulate/trigger_noise_threshold': {
|
|
1292
|
+
route: '/noise_sensors/simulate/trigger_noise_threshold';
|
|
1293
|
+
method: 'POST';
|
|
1294
1294
|
queryParams: {};
|
|
1295
1295
|
jsonBody: {
|
|
1296
1296
|
device_id: string;
|
|
@@ -1299,19 +1299,19 @@ export interface Routes {
|
|
|
1299
1299
|
formData: {};
|
|
1300
1300
|
jsonResponse: {};
|
|
1301
1301
|
};
|
|
1302
|
-
|
|
1303
|
-
route:
|
|
1304
|
-
method:
|
|
1302
|
+
'/thermostats/climate_setting_schedules/create': {
|
|
1303
|
+
route: '/thermostats/climate_setting_schedules/create';
|
|
1304
|
+
method: 'POST';
|
|
1305
1305
|
queryParams: {};
|
|
1306
1306
|
jsonBody: {
|
|
1307
|
-
schedule_type?:
|
|
1307
|
+
schedule_type?: 'time_bound';
|
|
1308
1308
|
device_id: string;
|
|
1309
1309
|
name?: string | undefined;
|
|
1310
1310
|
schedule_starts_at: string;
|
|
1311
1311
|
schedule_ends_at: string;
|
|
1312
1312
|
automatic_heating_enabled?: boolean | undefined;
|
|
1313
1313
|
automatic_cooling_enabled?: boolean | undefined;
|
|
1314
|
-
hvac_mode_setting?: (
|
|
1314
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heatcool') | undefined;
|
|
1315
1315
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
1316
1316
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
1317
1317
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
@@ -1323,7 +1323,7 @@ export interface Routes {
|
|
|
1323
1323
|
jsonResponse: {
|
|
1324
1324
|
climate_setting_schedule: {
|
|
1325
1325
|
climate_setting_schedule_id: string;
|
|
1326
|
-
schedule_type:
|
|
1326
|
+
schedule_type: 'time_bound';
|
|
1327
1327
|
device_id: string;
|
|
1328
1328
|
name?: string | undefined;
|
|
1329
1329
|
schedule_starts_at: string;
|
|
@@ -1331,7 +1331,7 @@ export interface Routes {
|
|
|
1331
1331
|
created_at: string;
|
|
1332
1332
|
automatic_heating_enabled?: boolean | undefined;
|
|
1333
1333
|
automatic_cooling_enabled?: boolean | undefined;
|
|
1334
|
-
hvac_mode_setting?: (
|
|
1334
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heatcool') | undefined;
|
|
1335
1335
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
1336
1336
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
1337
1337
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
@@ -1340,9 +1340,9 @@ export interface Routes {
|
|
|
1340
1340
|
};
|
|
1341
1341
|
};
|
|
1342
1342
|
};
|
|
1343
|
-
|
|
1344
|
-
route:
|
|
1345
|
-
method:
|
|
1343
|
+
'/thermostats/climate_setting_schedules/delete': {
|
|
1344
|
+
route: '/thermostats/climate_setting_schedules/delete';
|
|
1345
|
+
method: 'PUT' | 'POST' | 'DELETE';
|
|
1346
1346
|
queryParams: {};
|
|
1347
1347
|
jsonBody: {};
|
|
1348
1348
|
commonParams: {
|
|
@@ -1351,9 +1351,9 @@ export interface Routes {
|
|
|
1351
1351
|
formData: {};
|
|
1352
1352
|
jsonResponse: {};
|
|
1353
1353
|
};
|
|
1354
|
-
|
|
1355
|
-
route:
|
|
1356
|
-
method:
|
|
1354
|
+
'/thermostats/climate_setting_schedules/get': {
|
|
1355
|
+
route: '/thermostats/climate_setting_schedules/get';
|
|
1356
|
+
method: 'GET' | 'POST';
|
|
1357
1357
|
queryParams: {};
|
|
1358
1358
|
jsonBody: {};
|
|
1359
1359
|
commonParams: {
|
|
@@ -1364,7 +1364,7 @@ export interface Routes {
|
|
|
1364
1364
|
jsonResponse: {
|
|
1365
1365
|
climate_setting_schedule: {
|
|
1366
1366
|
climate_setting_schedule_id: string;
|
|
1367
|
-
schedule_type:
|
|
1367
|
+
schedule_type: 'time_bound';
|
|
1368
1368
|
device_id: string;
|
|
1369
1369
|
name?: string | undefined;
|
|
1370
1370
|
schedule_starts_at: string;
|
|
@@ -1372,7 +1372,7 @@ export interface Routes {
|
|
|
1372
1372
|
created_at: string;
|
|
1373
1373
|
automatic_heating_enabled?: boolean | undefined;
|
|
1374
1374
|
automatic_cooling_enabled?: boolean | undefined;
|
|
1375
|
-
hvac_mode_setting?: (
|
|
1375
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heatcool') | undefined;
|
|
1376
1376
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
1377
1377
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
1378
1378
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
@@ -1381,9 +1381,9 @@ export interface Routes {
|
|
|
1381
1381
|
};
|
|
1382
1382
|
};
|
|
1383
1383
|
};
|
|
1384
|
-
|
|
1385
|
-
route:
|
|
1386
|
-
method:
|
|
1384
|
+
'/thermostats/climate_setting_schedules/list': {
|
|
1385
|
+
route: '/thermostats/climate_setting_schedules/list';
|
|
1386
|
+
method: 'GET' | 'POST';
|
|
1387
1387
|
queryParams: {};
|
|
1388
1388
|
jsonBody: {};
|
|
1389
1389
|
commonParams: {
|
|
@@ -1393,7 +1393,7 @@ export interface Routes {
|
|
|
1393
1393
|
jsonResponse: {
|
|
1394
1394
|
climate_setting_schedules: Array<{
|
|
1395
1395
|
climate_setting_schedule_id: string;
|
|
1396
|
-
schedule_type:
|
|
1396
|
+
schedule_type: 'time_bound';
|
|
1397
1397
|
device_id: string;
|
|
1398
1398
|
name?: string | undefined;
|
|
1399
1399
|
schedule_starts_at: string;
|
|
@@ -1401,7 +1401,7 @@ export interface Routes {
|
|
|
1401
1401
|
created_at: string;
|
|
1402
1402
|
automatic_heating_enabled?: boolean | undefined;
|
|
1403
1403
|
automatic_cooling_enabled?: boolean | undefined;
|
|
1404
|
-
hvac_mode_setting?: (
|
|
1404
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heatcool') | undefined;
|
|
1405
1405
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
1406
1406
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
1407
1407
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
@@ -1410,19 +1410,19 @@ export interface Routes {
|
|
|
1410
1410
|
}>;
|
|
1411
1411
|
};
|
|
1412
1412
|
};
|
|
1413
|
-
|
|
1414
|
-
route:
|
|
1415
|
-
method:
|
|
1413
|
+
'/thermostats/climate_setting_schedules/update': {
|
|
1414
|
+
route: '/thermostats/climate_setting_schedules/update';
|
|
1415
|
+
method: 'PUT' | 'POST';
|
|
1416
1416
|
queryParams: {};
|
|
1417
1417
|
jsonBody: {
|
|
1418
1418
|
climate_setting_schedule_id: string;
|
|
1419
|
-
schedule_type?:
|
|
1419
|
+
schedule_type?: 'time_bound';
|
|
1420
1420
|
name?: string | undefined;
|
|
1421
1421
|
schedule_starts_at?: string | undefined;
|
|
1422
1422
|
schedule_ends_at?: string | undefined;
|
|
1423
1423
|
automatic_heating_enabled?: boolean | undefined;
|
|
1424
1424
|
automatic_cooling_enabled?: boolean | undefined;
|
|
1425
|
-
hvac_mode_setting?: (
|
|
1425
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heatcool') | undefined;
|
|
1426
1426
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
1427
1427
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
1428
1428
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
@@ -1434,7 +1434,7 @@ export interface Routes {
|
|
|
1434
1434
|
jsonResponse: {
|
|
1435
1435
|
climate_setting_schedule: {
|
|
1436
1436
|
climate_setting_schedule_id: string;
|
|
1437
|
-
schedule_type:
|
|
1437
|
+
schedule_type: 'time_bound';
|
|
1438
1438
|
device_id: string;
|
|
1439
1439
|
name?: string | undefined;
|
|
1440
1440
|
schedule_starts_at: string;
|
|
@@ -1442,7 +1442,7 @@ export interface Routes {
|
|
|
1442
1442
|
created_at: string;
|
|
1443
1443
|
automatic_heating_enabled?: boolean | undefined;
|
|
1444
1444
|
automatic_cooling_enabled?: boolean | undefined;
|
|
1445
|
-
hvac_mode_setting?: (
|
|
1445
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heatcool') | undefined;
|
|
1446
1446
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
1447
1447
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
1448
1448
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
@@ -1451,9 +1451,9 @@ export interface Routes {
|
|
|
1451
1451
|
};
|
|
1452
1452
|
};
|
|
1453
1453
|
};
|
|
1454
|
-
|
|
1455
|
-
route:
|
|
1456
|
-
method:
|
|
1454
|
+
'/thermostats/get': {
|
|
1455
|
+
route: '/thermostats/get';
|
|
1456
|
+
method: 'GET' | 'POST';
|
|
1457
1457
|
queryParams: {};
|
|
1458
1458
|
jsonBody: {};
|
|
1459
1459
|
commonParams: {
|
|
@@ -1464,7 +1464,7 @@ export interface Routes {
|
|
|
1464
1464
|
jsonResponse: {
|
|
1465
1465
|
thermostat: {
|
|
1466
1466
|
device_id: string;
|
|
1467
|
-
device_type:
|
|
1467
|
+
device_type: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat';
|
|
1468
1468
|
capabilities_supported: string[];
|
|
1469
1469
|
properties: {
|
|
1470
1470
|
online: boolean;
|
|
@@ -1489,25 +1489,25 @@ export interface Routes {
|
|
|
1489
1489
|
};
|
|
1490
1490
|
};
|
|
1491
1491
|
};
|
|
1492
|
-
|
|
1493
|
-
route:
|
|
1494
|
-
method:
|
|
1492
|
+
'/thermostats/list': {
|
|
1493
|
+
route: '/thermostats/list';
|
|
1494
|
+
method: 'GET' | 'POST';
|
|
1495
1495
|
queryParams: {};
|
|
1496
1496
|
jsonBody: {};
|
|
1497
1497
|
commonParams: {
|
|
1498
1498
|
connected_account_id?: string | undefined;
|
|
1499
1499
|
connected_account_ids?: string[] | undefined;
|
|
1500
1500
|
connect_webview_id?: string | undefined;
|
|
1501
|
-
device_type?: (
|
|
1502
|
-
device_types?: Array<
|
|
1503
|
-
manufacturer?: (
|
|
1501
|
+
device_type?: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat') | undefined;
|
|
1502
|
+
device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat'> | undefined;
|
|
1503
|
+
manufacturer?: ('akuvox' | 'august' | 'brivo' | 'butterflymx' | 'doorking' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat') | undefined;
|
|
1504
1504
|
device_ids?: string[] | undefined;
|
|
1505
1505
|
};
|
|
1506
1506
|
formData: {};
|
|
1507
1507
|
jsonResponse: {
|
|
1508
1508
|
thermostats: Array<{
|
|
1509
1509
|
device_id: string;
|
|
1510
|
-
device_type:
|
|
1510
|
+
device_type: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat';
|
|
1511
1511
|
capabilities_supported: string[];
|
|
1512
1512
|
properties: {
|
|
1513
1513
|
online: boolean;
|
|
@@ -1532,9 +1532,9 @@ export interface Routes {
|
|
|
1532
1532
|
}>;
|
|
1533
1533
|
};
|
|
1534
1534
|
};
|
|
1535
|
-
|
|
1536
|
-
route:
|
|
1537
|
-
method:
|
|
1535
|
+
'/thermostats/set_cooling_set_point': {
|
|
1536
|
+
route: '/thermostats/set_cooling_set_point';
|
|
1537
|
+
method: 'POST';
|
|
1538
1538
|
queryParams: {};
|
|
1539
1539
|
jsonBody: {
|
|
1540
1540
|
device_id: string;
|
|
@@ -1546,31 +1546,31 @@ export interface Routes {
|
|
|
1546
1546
|
formData: {};
|
|
1547
1547
|
jsonResponse: {};
|
|
1548
1548
|
};
|
|
1549
|
-
|
|
1550
|
-
route:
|
|
1551
|
-
method:
|
|
1549
|
+
'/thermostats/set_mode': {
|
|
1550
|
+
route: '/thermostats/set_mode';
|
|
1551
|
+
method: 'POST';
|
|
1552
1552
|
queryParams: {};
|
|
1553
1553
|
jsonBody: {
|
|
1554
1554
|
device_id: string;
|
|
1555
1555
|
automatic_heating_enabled?: boolean | undefined;
|
|
1556
1556
|
automatic_cooling_enabled?: boolean | undefined;
|
|
1557
|
-
hvac_mode_setting?: (
|
|
1557
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heatcool') | undefined;
|
|
1558
1558
|
sync?: boolean;
|
|
1559
1559
|
};
|
|
1560
1560
|
commonParams: {};
|
|
1561
1561
|
formData: {};
|
|
1562
1562
|
jsonResponse: {};
|
|
1563
1563
|
};
|
|
1564
|
-
|
|
1565
|
-
route:
|
|
1566
|
-
method:
|
|
1564
|
+
'/thermostats/update': {
|
|
1565
|
+
route: '/thermostats/update';
|
|
1566
|
+
method: 'POST';
|
|
1567
1567
|
queryParams: {};
|
|
1568
1568
|
jsonBody: {
|
|
1569
1569
|
device_id: string;
|
|
1570
1570
|
default_climate_setting: {
|
|
1571
1571
|
automatic_heating_enabled?: boolean | undefined;
|
|
1572
1572
|
automatic_cooling_enabled?: boolean | undefined;
|
|
1573
|
-
hvac_mode_setting?: (
|
|
1573
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heatcool') | undefined;
|
|
1574
1574
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
1575
1575
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
1576
1576
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
@@ -1582,9 +1582,9 @@ export interface Routes {
|
|
|
1582
1582
|
formData: {};
|
|
1583
1583
|
jsonResponse: {};
|
|
1584
1584
|
};
|
|
1585
|
-
|
|
1586
|
-
route:
|
|
1587
|
-
method:
|
|
1585
|
+
'/webhooks/create': {
|
|
1586
|
+
route: '/webhooks/create';
|
|
1587
|
+
method: 'POST';
|
|
1588
1588
|
queryParams: {};
|
|
1589
1589
|
jsonBody: {
|
|
1590
1590
|
url: string;
|
|
@@ -1601,9 +1601,9 @@ export interface Routes {
|
|
|
1601
1601
|
};
|
|
1602
1602
|
};
|
|
1603
1603
|
};
|
|
1604
|
-
|
|
1605
|
-
route:
|
|
1606
|
-
method:
|
|
1604
|
+
'/webhooks/delete': {
|
|
1605
|
+
route: '/webhooks/delete';
|
|
1606
|
+
method: 'DELETE' | 'POST';
|
|
1607
1607
|
queryParams: {};
|
|
1608
1608
|
jsonBody: {};
|
|
1609
1609
|
commonParams: {
|
|
@@ -1612,9 +1612,9 @@ export interface Routes {
|
|
|
1612
1612
|
formData: {};
|
|
1613
1613
|
jsonResponse: {};
|
|
1614
1614
|
};
|
|
1615
|
-
|
|
1616
|
-
route:
|
|
1617
|
-
method:
|
|
1615
|
+
'/webhooks/get': {
|
|
1616
|
+
route: '/webhooks/get';
|
|
1617
|
+
method: 'GET';
|
|
1618
1618
|
queryParams: {
|
|
1619
1619
|
webhook_id: string;
|
|
1620
1620
|
};
|
|
@@ -1630,9 +1630,9 @@ export interface Routes {
|
|
|
1630
1630
|
};
|
|
1631
1631
|
};
|
|
1632
1632
|
};
|
|
1633
|
-
|
|
1634
|
-
route:
|
|
1635
|
-
method:
|
|
1633
|
+
'/webhooks/list': {
|
|
1634
|
+
route: '/webhooks/list';
|
|
1635
|
+
method: 'GET';
|
|
1636
1636
|
queryParams: {};
|
|
1637
1637
|
jsonBody: {};
|
|
1638
1638
|
commonParams: {};
|
|
@@ -1646,9 +1646,9 @@ export interface Routes {
|
|
|
1646
1646
|
}>;
|
|
1647
1647
|
};
|
|
1648
1648
|
};
|
|
1649
|
-
|
|
1650
|
-
route:
|
|
1651
|
-
method:
|
|
1649
|
+
'/workspaces/get': {
|
|
1650
|
+
route: '/workspaces/get';
|
|
1651
|
+
method: 'GET';
|
|
1652
1652
|
queryParams: {};
|
|
1653
1653
|
jsonBody: {};
|
|
1654
1654
|
commonParams: {};
|
|
@@ -1662,9 +1662,9 @@ export interface Routes {
|
|
|
1662
1662
|
} | undefined;
|
|
1663
1663
|
};
|
|
1664
1664
|
};
|
|
1665
|
-
|
|
1666
|
-
route:
|
|
1667
|
-
method:
|
|
1665
|
+
'/workspaces/list': {
|
|
1666
|
+
route: '/workspaces/list';
|
|
1667
|
+
method: 'GET';
|
|
1668
1668
|
queryParams: {};
|
|
1669
1669
|
jsonBody: {};
|
|
1670
1670
|
commonParams: {};
|
|
@@ -1677,9 +1677,9 @@ export interface Routes {
|
|
|
1677
1677
|
}>;
|
|
1678
1678
|
};
|
|
1679
1679
|
};
|
|
1680
|
-
|
|
1681
|
-
route:
|
|
1682
|
-
method:
|
|
1680
|
+
'/workspaces/reset_sandbox': {
|
|
1681
|
+
route: '/workspaces/reset_sandbox';
|
|
1682
|
+
method: 'POST';
|
|
1683
1683
|
queryParams: {};
|
|
1684
1684
|
jsonBody: {};
|
|
1685
1685
|
commonParams: {};
|
|
@@ -1689,6 +1689,6 @@ export interface Routes {
|
|
|
1689
1689
|
};
|
|
1690
1690
|
};
|
|
1691
1691
|
}
|
|
1692
|
-
export type RouteResponse<Path extends keyof Routes> = Routes[Path][
|
|
1693
|
-
export type RouteRequestBody<Path extends keyof Routes> = Routes[Path][
|
|
1694
|
-
export type RouteRequestParams<Path extends keyof Routes> = Routes[Path][
|
|
1692
|
+
export type RouteResponse<Path extends keyof Routes> = Routes[Path]['jsonResponse'];
|
|
1693
|
+
export type RouteRequestBody<Path extends keyof Routes> = Routes[Path]['jsonBody'] & Routes[Path]['commonParams'];
|
|
1694
|
+
export type RouteRequestParams<Path extends keyof Routes> = Routes[Path]['queryParams'] & Routes[Path]['commonParams'];
|