@seamapi/types 0.0.6 → 0.1.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.
Files changed (36) hide show
  1. package/dist/connect.cjs +33 -4
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +47 -3
  4. package/lib/seam/connect/index.d.ts +5 -1
  5. package/lib/seam/connect/index.js +6 -1
  6. package/lib/seam/connect/index.js.map +1 -1
  7. package/lib/seam/connect/model-types.d.ts +1 -0
  8. package/lib/seam/connect/model-types.js +2 -0
  9. package/lib/seam/connect/model-types.js.map +1 -0
  10. package/lib/seam/connect/models/connect-webview.d.ts +42 -0
  11. package/lib/seam/connect/models/connect-webview.js +16 -0
  12. package/lib/seam/connect/models/connect-webview.js.map +1 -0
  13. package/lib/seam/connect/models/index.d.ts +1 -1
  14. package/lib/seam/connect/models/index.js +1 -1
  15. package/lib/seam/connect/models/index.js.map +1 -1
  16. package/lib/seam/connect/openapi.d.ts +2 -0
  17. package/lib/seam/connect/openapi.js +2 -0
  18. package/lib/seam/connect/openapi.js.map +1 -0
  19. package/lib/seam/connect/route-types.d.ts +1694 -0
  20. package/lib/seam/connect/route-types.js +2 -0
  21. package/lib/seam/connect/route-types.js.map +1 -0
  22. package/lib/seam/connect/schemas.d.ts +1 -0
  23. package/lib/seam/connect/schemas.js +2 -0
  24. package/lib/seam/connect/schemas.js.map +1 -0
  25. package/package.json +1 -1
  26. package/src/lib/seam/connect/index.ts +8 -1
  27. package/src/lib/seam/connect/model-types.ts +1 -0
  28. package/src/lib/seam/connect/models/connect-webview.ts +18 -0
  29. package/src/lib/seam/connect/models/index.ts +1 -1
  30. package/src/lib/seam/connect/openapi.ts +1 -0
  31. package/src/lib/seam/connect/route-types.ts +2321 -0
  32. package/src/lib/seam/connect/schemas.ts +1 -0
  33. package/lib/seam/connect/models/workspace.d.ts +0 -9
  34. package/lib/seam/connect/models/workspace.js +0 -5
  35. package/lib/seam/connect/models/workspace.js.map +0 -1
  36. package/src/lib/seam/connect/models/workspace.ts +0 -6
@@ -0,0 +1,2321 @@
1
+ export interface Routes {
2
+ "/access_codes/create": {
3
+ route: "/access_codes/create"
4
+ method: "POST"
5
+ queryParams: {}
6
+ jsonBody: {
7
+ device_id: string
8
+ name?: string | undefined
9
+ starts_at?: string | undefined
10
+ ends_at?: string | undefined
11
+ code?: string | undefined
12
+ sync?: boolean
13
+ attempt_for_offline_device?: boolean
14
+ common_code_key?: string | undefined
15
+ prefer_native_scheduling?: boolean | undefined
16
+ use_backup_access_code_pool?: boolean | undefined
17
+ }
18
+ commonParams: {}
19
+ formData: {}
20
+ jsonResponse: {
21
+ action_attempt:
22
+ | {
23
+ status: "success"
24
+ action_type: string
25
+ action_attempt_id: string
26
+ result?: any
27
+ error: null
28
+ }
29
+ | {
30
+ status: "pending"
31
+ action_type: string
32
+ action_attempt_id: string
33
+ result: null
34
+ error: null
35
+ }
36
+ | {
37
+ status: "error"
38
+ action_type: string
39
+ action_attempt_id: string
40
+ result: null
41
+ error: {
42
+ type: string
43
+ message: string
44
+ }
45
+ }
46
+ access_code: {
47
+ common_code_key: string | null
48
+ is_scheduled_on_device?: boolean | undefined
49
+ type: "time_bound" | "ongoing"
50
+ is_waiting_for_code_assignment?: boolean | undefined
51
+ access_code_id: string
52
+ device_id: string
53
+ name: string | null
54
+ code: string | null
55
+ created_at: string
56
+ errors?: any
57
+ warnings?: any
58
+ is_managed: true
59
+ starts_at?: string | undefined
60
+ ends_at?: string | undefined
61
+ status: "setting" | "set" | "unset" | "removing" | "unknown"
62
+ is_backup_access_code_available: boolean
63
+ is_backup?: boolean | undefined
64
+ pulled_backup_access_code_id?: (string | null) | undefined
65
+ }
66
+ }
67
+ }
68
+ "/access_codes/create_multiple": {
69
+ route: "/access_codes/create_multiple"
70
+ method: "POST" | "PUT"
71
+ queryParams: {}
72
+ jsonBody: {
73
+ device_ids: string[]
74
+ behavior_when_code_cannot_be_shared?: "throw" | "create_random_code"
75
+ name?: string | undefined
76
+ starts_at?: string | undefined
77
+ ends_at?: string | undefined
78
+ code?: string | undefined
79
+ attempt_for_offline_device?: boolean
80
+ prefer_native_scheduling?: boolean | undefined
81
+ use_backup_access_code_pool?: boolean | undefined
82
+ }
83
+ commonParams: {}
84
+ formData: {}
85
+ jsonResponse: {
86
+ access_codes: Array<{
87
+ common_code_key: string | null
88
+ is_scheduled_on_device?: boolean | undefined
89
+ type: "time_bound" | "ongoing"
90
+ is_waiting_for_code_assignment?: boolean | undefined
91
+ access_code_id: string
92
+ device_id: string
93
+ name: string | null
94
+ code: string | null
95
+ created_at: string
96
+ errors?: any
97
+ warnings?: any
98
+ is_managed: true
99
+ starts_at?: string | undefined
100
+ ends_at?: string | undefined
101
+ status: "setting" | "set" | "unset" | "removing" | "unknown"
102
+ is_backup_access_code_available: boolean
103
+ is_backup?: boolean | undefined
104
+ pulled_backup_access_code_id?: (string | null) | undefined
105
+ }>
106
+ }
107
+ }
108
+ "/access_codes/delete": {
109
+ route: "/access_codes/delete"
110
+ method: "DELETE" | "POST"
111
+ queryParams: {}
112
+ jsonBody: {}
113
+ commonParams: {
114
+ device_id?: string | undefined
115
+ access_code_id: string
116
+ sync?: boolean
117
+ }
118
+ formData: {}
119
+ jsonResponse: {
120
+ action_attempt:
121
+ | {
122
+ status: "success"
123
+ action_type: string
124
+ action_attempt_id: string
125
+ result?: any
126
+ error: null
127
+ }
128
+ | {
129
+ status: "pending"
130
+ action_type: string
131
+ action_attempt_id: string
132
+ result: null
133
+ error: null
134
+ }
135
+ | {
136
+ status: "error"
137
+ action_type: string
138
+ action_attempt_id: string
139
+ result: null
140
+ error: {
141
+ type: string
142
+ message: string
143
+ }
144
+ }
145
+ }
146
+ }
147
+ "/access_codes/get": {
148
+ route: "/access_codes/get"
149
+ method: "GET" | "POST"
150
+ queryParams: {}
151
+ jsonBody: {}
152
+ commonParams: {
153
+ device_id?: string | undefined
154
+ access_code_id?: string | undefined
155
+ code?: string | undefined
156
+ }
157
+ formData: {}
158
+ jsonResponse: {
159
+ access_code: {
160
+ common_code_key: string | null
161
+ is_scheduled_on_device?: boolean | undefined
162
+ type: "time_bound" | "ongoing"
163
+ is_waiting_for_code_assignment?: boolean | undefined
164
+ access_code_id: string
165
+ device_id: string
166
+ name: string | null
167
+ code: string | null
168
+ created_at: string
169
+ errors?: any
170
+ warnings?: any
171
+ is_managed: true
172
+ starts_at?: string | undefined
173
+ ends_at?: string | undefined
174
+ status: "setting" | "set" | "unset" | "removing" | "unknown"
175
+ is_backup_access_code_available: boolean
176
+ is_backup?: boolean | undefined
177
+ pulled_backup_access_code_id?: (string | null) | undefined
178
+ }
179
+ }
180
+ }
181
+ "/access_codes/list": {
182
+ route: "/access_codes/list"
183
+ method: "GET" | "POST"
184
+ queryParams: {}
185
+ jsonBody: {}
186
+ commonParams: {
187
+ device_id: string
188
+ access_code_ids?: string[] | undefined
189
+ }
190
+ formData: {}
191
+ jsonResponse: {
192
+ access_codes: Array<{
193
+ common_code_key: string | null
194
+ is_scheduled_on_device?: boolean | undefined
195
+ type: "time_bound" | "ongoing"
196
+ is_waiting_for_code_assignment?: boolean | undefined
197
+ access_code_id: string
198
+ device_id: string
199
+ name: string | null
200
+ code: string | null
201
+ created_at: string
202
+ errors?: any
203
+ warnings?: any
204
+ is_managed: true
205
+ starts_at?: string | undefined
206
+ ends_at?: string | undefined
207
+ status: "setting" | "set" | "unset" | "removing" | "unknown"
208
+ is_backup_access_code_available: boolean
209
+ is_backup?: boolean | undefined
210
+ pulled_backup_access_code_id?: (string | null) | undefined
211
+ }>
212
+ }
213
+ }
214
+ "/access_codes/pull_backup_access_code": {
215
+ route: "/access_codes/pull_backup_access_code"
216
+ method: "POST"
217
+ queryParams: {}
218
+ jsonBody: {
219
+ access_code_id: string
220
+ }
221
+ commonParams: {}
222
+ formData: {}
223
+ jsonResponse: {
224
+ backup_access_code: {
225
+ common_code_key: string | null
226
+ is_scheduled_on_device?: boolean | undefined
227
+ type: "time_bound" | "ongoing"
228
+ is_waiting_for_code_assignment?: boolean | undefined
229
+ access_code_id: string
230
+ device_id: string
231
+ name: string | null
232
+ code: string | null
233
+ created_at: string
234
+ errors?: any
235
+ warnings?: any
236
+ is_managed: true
237
+ starts_at?: string | undefined
238
+ ends_at?: string | undefined
239
+ status: "setting" | "set" | "unset" | "removing" | "unknown"
240
+ is_backup_access_code_available: boolean
241
+ is_backup?: boolean | undefined
242
+ pulled_backup_access_code_id?: (string | null) | undefined
243
+ }
244
+ }
245
+ }
246
+ "/access_codes/simulate/create_unmanaged_access_code": {
247
+ route: "/access_codes/simulate/create_unmanaged_access_code"
248
+ method: "POST"
249
+ queryParams: {}
250
+ jsonBody: {
251
+ device_id: string
252
+ name: string
253
+ code: string
254
+ }
255
+ commonParams: {}
256
+ formData: {}
257
+ jsonResponse: {
258
+ access_code:
259
+ | {
260
+ access_code_id: string
261
+ code: string | null
262
+ status: "set"
263
+ created_at: string | Date
264
+ is_managed: false
265
+ type: "ongoing"
266
+ starts_at: null
267
+ ends_at: null
268
+ }
269
+ | {
270
+ access_code_id: string
271
+ code: string | null
272
+ status: "set"
273
+ created_at: string | Date
274
+ is_managed: false
275
+ type: "time_bound"
276
+ starts_at: string | null
277
+ ends_at: string | null
278
+ }
279
+ }
280
+ }
281
+ "/access_codes/unmanaged/convert_to_managed": {
282
+ route: "/access_codes/unmanaged/convert_to_managed"
283
+ method: "POST" | "PATCH"
284
+ queryParams: {}
285
+ jsonBody: {}
286
+ commonParams: {
287
+ access_code_id: string
288
+ force?: boolean | undefined
289
+ sync?: boolean
290
+ }
291
+ formData: {}
292
+ jsonResponse: {}
293
+ }
294
+ "/access_codes/unmanaged/delete": {
295
+ route: "/access_codes/unmanaged/delete"
296
+ method: "DELETE" | "POST"
297
+ queryParams: {}
298
+ jsonBody: {}
299
+ commonParams: {
300
+ access_code_id: string
301
+ sync?: boolean
302
+ }
303
+ formData: {}
304
+ jsonResponse: {
305
+ action_attempt:
306
+ | {
307
+ status: "success"
308
+ action_type: string
309
+ action_attempt_id: string
310
+ result?: any
311
+ error: null
312
+ }
313
+ | {
314
+ status: "pending"
315
+ action_type: string
316
+ action_attempt_id: string
317
+ result: null
318
+ error: null
319
+ }
320
+ | {
321
+ status: "error"
322
+ action_type: string
323
+ action_attempt_id: string
324
+ result: null
325
+ error: {
326
+ type: string
327
+ message: string
328
+ }
329
+ }
330
+ }
331
+ }
332
+ "/access_codes/unmanaged/get": {
333
+ route: "/access_codes/unmanaged/get"
334
+ method: "GET" | "POST"
335
+ queryParams: {}
336
+ jsonBody: {}
337
+ commonParams: {
338
+ device_id?: string | undefined
339
+ access_code_id?: string | undefined
340
+ code?: string | undefined
341
+ }
342
+ formData: {}
343
+ jsonResponse: {
344
+ access_code: {
345
+ type: "time_bound" | "ongoing"
346
+ access_code_id: string
347
+ device_id: string
348
+ name: string | null
349
+ code: string | null
350
+ created_at: string
351
+ errors?: any
352
+ warnings?: any
353
+ is_managed: false
354
+ starts_at: string | null
355
+ ends_at: string | null
356
+ status: "set"
357
+ }
358
+ }
359
+ }
360
+ "/access_codes/unmanaged/list": {
361
+ route: "/access_codes/unmanaged/list"
362
+ method: "GET" | "POST"
363
+ queryParams: {}
364
+ jsonBody: {}
365
+ commonParams: {
366
+ device_id: string
367
+ }
368
+ formData: {}
369
+ jsonResponse: {
370
+ access_codes: Array<{
371
+ type: "time_bound" | "ongoing"
372
+ access_code_id: string
373
+ device_id: string
374
+ name: string | null
375
+ code: string | null
376
+ created_at: string
377
+ errors?: any
378
+ warnings?: any
379
+ is_managed: false
380
+ starts_at: string | null
381
+ ends_at: string | null
382
+ status: "set"
383
+ }>
384
+ }
385
+ }
386
+ "/access_codes/unmanaged/update": {
387
+ route: "/access_codes/unmanaged/update"
388
+ method: "POST" | "PATCH"
389
+ queryParams: {}
390
+ jsonBody: {}
391
+ commonParams: {
392
+ access_code_id: string
393
+ is_managed: boolean
394
+ force?: boolean | undefined
395
+ }
396
+ formData: {}
397
+ jsonResponse: {}
398
+ }
399
+ "/access_codes/update": {
400
+ route: "/access_codes/update"
401
+ method: "POST" | "PUT"
402
+ queryParams: {}
403
+ jsonBody: {
404
+ name?: string | undefined
405
+ starts_at?: string | undefined
406
+ ends_at?: string | undefined
407
+ code?: string | undefined
408
+ sync?: boolean
409
+ attempt_for_offline_device?: boolean
410
+ prefer_native_scheduling?: boolean | undefined
411
+ use_backup_access_code_pool?: boolean | undefined
412
+ access_code_id: string
413
+ device_id?: string | undefined
414
+ type?: ("ongoing" | "time_bound") | undefined
415
+ }
416
+ commonParams: {}
417
+ formData: {}
418
+ jsonResponse: {
419
+ action_attempt:
420
+ | {
421
+ status: "success"
422
+ action_type: string
423
+ action_attempt_id: string
424
+ result?: any
425
+ error: null
426
+ }
427
+ | {
428
+ status: "pending"
429
+ action_type: string
430
+ action_attempt_id: string
431
+ result: null
432
+ error: null
433
+ }
434
+ | {
435
+ status: "error"
436
+ action_type: string
437
+ action_attempt_id: string
438
+ result: null
439
+ error: {
440
+ type: string
441
+ message: string
442
+ }
443
+ }
444
+ }
445
+ }
446
+ "/action_attempts/get": {
447
+ route: "/action_attempts/get"
448
+ method: "GET" | "POST"
449
+ queryParams: {}
450
+ jsonBody: {}
451
+ commonParams: {
452
+ action_attempt_id: string
453
+ }
454
+ formData: {}
455
+ jsonResponse: {
456
+ action_attempt:
457
+ | {
458
+ status: "success"
459
+ action_type: string
460
+ action_attempt_id: string
461
+ result?: any
462
+ error: null
463
+ }
464
+ | {
465
+ status: "pending"
466
+ action_type: string
467
+ action_attempt_id: string
468
+ result: null
469
+ error: null
470
+ }
471
+ | {
472
+ status: "error"
473
+ action_type: string
474
+ action_attempt_id: string
475
+ result: null
476
+ error: {
477
+ type: string
478
+ message: string
479
+ }
480
+ }
481
+ }
482
+ }
483
+ "/action_attempts/list": {
484
+ route: "/action_attempts/list"
485
+ method: "GET" | "POST"
486
+ queryParams: {}
487
+ jsonBody: {}
488
+ commonParams: {
489
+ action_attempt_ids: string[]
490
+ }
491
+ formData: {}
492
+ jsonResponse: {
493
+ action_attempts: Array<
494
+ | {
495
+ status: "success"
496
+ action_type: string
497
+ action_attempt_id: string
498
+ result?: any
499
+ error: null
500
+ }
501
+ | {
502
+ status: "pending"
503
+ action_type: string
504
+ action_attempt_id: string
505
+ result: null
506
+ error: null
507
+ }
508
+ | {
509
+ status: "error"
510
+ action_type: string
511
+ action_attempt_id: string
512
+ result: null
513
+ error: {
514
+ type: string
515
+ message: string
516
+ }
517
+ }
518
+ >
519
+ }
520
+ }
521
+ "/client_sessions/create": {
522
+ route: "/client_sessions/create"
523
+ method: "POST" | "PUT"
524
+ queryParams: {}
525
+ jsonBody:
526
+ | any
527
+ | {
528
+ user_identifier_key: string
529
+ connect_webview_ids?: string[] | undefined
530
+ connected_account_ids?: string[] | undefined
531
+ }
532
+ commonParams: {}
533
+ formData: {}
534
+ jsonResponse: {
535
+ client_session: {
536
+ token: string
537
+ client_session_id: string
538
+ created_at: string
539
+ }
540
+ }
541
+ }
542
+ "/client_sessions/delete": {
543
+ route: "/client_sessions/delete"
544
+ method: "POST" | "GET"
545
+ queryParams: {}
546
+ jsonBody: {}
547
+ commonParams: {
548
+ client_session_id: string
549
+ }
550
+ formData: {}
551
+ jsonResponse: {}
552
+ }
553
+ "/client_sessions/list": {
554
+ route: "/client_sessions/list"
555
+ method: "POST" | "GET"
556
+ queryParams: {}
557
+ jsonBody: {}
558
+ commonParams: {}
559
+ formData: {}
560
+ jsonResponse: {
561
+ client_sessions: Array<{
562
+ user_identifier_key: string | null
563
+ client_session_id: string
564
+ created_at: string
565
+ device_count: number
566
+ token: string
567
+ workspace_id: string
568
+ }>
569
+ }
570
+ }
571
+ "/connect_webviews/create": {
572
+ route: "/connect_webviews/create"
573
+ method: "POST"
574
+ queryParams: {}
575
+ jsonBody: {
576
+ device_selection_mode?: ("none" | "single" | "multiple") | undefined
577
+ custom_redirect_url?: string | undefined
578
+ custom_redirect_failure_url?: string | undefined
579
+ accepted_providers?:
580
+ | Array<
581
+ | "akuvox"
582
+ | "august"
583
+ | "avigilon_alta"
584
+ | "brivo"
585
+ | "butterflymx"
586
+ | "schlage"
587
+ | "smartthings"
588
+ | "yale"
589
+ | "genie"
590
+ | "doorking"
591
+ | "salto"
592
+ | "lockly"
593
+ | "ttlock"
594
+ | "linear"
595
+ | "noiseaware"
596
+ | "nuki"
597
+ | "seam_relay_admin"
598
+ | "igloo"
599
+ | "kwikset"
600
+ | "minut"
601
+ | "my_2n"
602
+ | "controlbyweb"
603
+ | "nest"
604
+ | "igloohome"
605
+ | "ecobee"
606
+ | "hubitat"
607
+ | "yale_access"
608
+ >
609
+ | undefined
610
+ provider_category?: ("stable" | "internal_beta") | undefined
611
+ custom_metadata?:
612
+ | Record<string, string | number | null | boolean>
613
+ | undefined
614
+ }
615
+ commonParams: {}
616
+ formData: {}
617
+ jsonResponse: {
618
+ connect_webview: {
619
+ connect_webview_id: string
620
+ connected_account_id?: string | undefined
621
+ url: string
622
+ workspace_id: string
623
+ device_selection_mode: "none" | "single" | "multiple"
624
+ accepted_providers: string[]
625
+ accepted_devices: string[]
626
+ any_provider_allowed: boolean
627
+ any_device_allowed: boolean
628
+ created_at: string
629
+ login_successful: boolean
630
+ status: "pending" | "failed" | "authorized"
631
+ }
632
+ }
633
+ }
634
+ "/connect_webviews/delete": {
635
+ route: "/connect_webviews/delete"
636
+ method: "DELETE" | "POST"
637
+ queryParams: {}
638
+ jsonBody: {
639
+ connect_webview_id: string
640
+ }
641
+ commonParams: {}
642
+ formData: {}
643
+ jsonResponse: {}
644
+ }
645
+ "/connect_webviews/get": {
646
+ route: "/connect_webviews/get"
647
+ method: "GET" | "POST"
648
+ queryParams: {}
649
+ jsonBody: {}
650
+ commonParams: {
651
+ connect_webview_id: string
652
+ }
653
+ formData: {}
654
+ jsonResponse: {
655
+ connect_webview: {
656
+ connect_webview_id: string
657
+ connected_account_id?: string | undefined
658
+ url: string
659
+ workspace_id: string
660
+ device_selection_mode: "none" | "single" | "multiple"
661
+ accepted_providers: string[]
662
+ accepted_devices: string[]
663
+ any_provider_allowed: boolean
664
+ any_device_allowed: boolean
665
+ created_at: string
666
+ login_successful: boolean
667
+ status: "pending" | "failed" | "authorized"
668
+ }
669
+ }
670
+ }
671
+ "/connect_webviews/list": {
672
+ route: "/connect_webviews/list"
673
+ method: "GET" | "POST"
674
+ queryParams: {}
675
+ jsonBody: {}
676
+ commonParams: {}
677
+ formData: {}
678
+ jsonResponse: {
679
+ connect_webviews: Array<{
680
+ connect_webview_id: string
681
+ connected_account_id?: string | undefined
682
+ url: string
683
+ workspace_id: string
684
+ device_selection_mode: "none" | "single" | "multiple"
685
+ accepted_providers: string[]
686
+ accepted_devices: string[]
687
+ any_provider_allowed: boolean
688
+ any_device_allowed: boolean
689
+ created_at: string
690
+ login_successful: boolean
691
+ status: "pending" | "failed" | "authorized"
692
+ }>
693
+ }
694
+ }
695
+ "/connect_webviews/view": {
696
+ route: "/connect_webviews/view"
697
+ method: "GET"
698
+ queryParams: {
699
+ connect_webview_id: string
700
+ auth_token: string
701
+ }
702
+ jsonBody: {}
703
+ commonParams: {}
704
+ formData: {}
705
+ jsonResponse: {}
706
+ }
707
+ "/connected_accounts/delete": {
708
+ route: "/connected_accounts/delete"
709
+ method: "DELETE" | "POST"
710
+ queryParams: {}
711
+ jsonBody: {
712
+ connected_account_id: string
713
+ }
714
+ commonParams: {}
715
+ formData: {}
716
+ jsonResponse: {}
717
+ }
718
+ "/connected_accounts/get": {
719
+ route: "/connected_accounts/get"
720
+ method: "GET"
721
+ queryParams:
722
+ | {
723
+ connected_account_id: string
724
+ }
725
+ | {
726
+ email: string
727
+ }
728
+ jsonBody: {}
729
+ commonParams: {}
730
+ formData: {}
731
+ jsonResponse: {
732
+ connected_account: {
733
+ connected_account_id?: string | undefined
734
+ created_at?: string | undefined
735
+ user_identifier?:
736
+ | {
737
+ username?: string | undefined
738
+ api_url?: string | undefined
739
+ email?: string | undefined
740
+ phone?: string | undefined
741
+ exclusive?: boolean | undefined
742
+ }
743
+ | undefined
744
+ account_type?: string | undefined
745
+ errors?: any
746
+ warnings?: any
747
+ custom_metadata?:
748
+ | Record<string, string | number | boolean | null>
749
+ | undefined
750
+ }
751
+ }
752
+ }
753
+ "/connected_accounts/list": {
754
+ route: "/connected_accounts/list"
755
+ method: "GET"
756
+ queryParams: {}
757
+ jsonBody: {}
758
+ commonParams: {}
759
+ formData: {}
760
+ jsonResponse: {
761
+ connected_accounts: Array<{
762
+ connected_account_id?: string | undefined
763
+ created_at?: string | undefined
764
+ user_identifier?:
765
+ | {
766
+ username?: string | undefined
767
+ api_url?: string | undefined
768
+ email?: string | undefined
769
+ phone?: string | undefined
770
+ exclusive?: boolean | undefined
771
+ }
772
+ | undefined
773
+ account_type?: string | undefined
774
+ errors?: any
775
+ warnings?: any
776
+ custom_metadata?:
777
+ | Record<string, string | number | boolean | null>
778
+ | undefined
779
+ }>
780
+ }
781
+ }
782
+ "/devices/delete": {
783
+ route: "/devices/delete"
784
+ method: "DELETE" | "POST"
785
+ queryParams: {}
786
+ jsonBody: {}
787
+ commonParams: {
788
+ device_id: string
789
+ }
790
+ formData: {}
791
+ jsonResponse: {}
792
+ }
793
+ "/devices/get": {
794
+ route: "/devices/get"
795
+ method: "GET"
796
+ queryParams: {
797
+ device_id?: string | undefined
798
+ name?: string | undefined
799
+ }
800
+ jsonBody: {}
801
+ commonParams: {}
802
+ formData: {}
803
+ jsonResponse: {
804
+ device: {
805
+ device_id: string
806
+ device_type:
807
+ | "akuvox_lock"
808
+ | "august_lock"
809
+ | "brivo_access_point"
810
+ | "butterflymx_panel"
811
+ | "doorking_lock"
812
+ | "genie_door"
813
+ | "igloo_lock"
814
+ | "linear_lock"
815
+ | "lockly_lock"
816
+ | "kwikset_lock"
817
+ | "nuki_lock"
818
+ | "salto_lock"
819
+ | "schlage_lock"
820
+ | "seam_relay"
821
+ | "smartthings_lock"
822
+ | "yale_lock"
823
+ | "two_n_intercom"
824
+ | "controlbyweb_device"
825
+ | "ttlock_lock"
826
+ | "igloohome_lock"
827
+ | "hubitat_lock"
828
+ | "noiseaware_activity_zone"
829
+ | "minut_sensor"
830
+ | "ecobee_thermostat"
831
+ | "nest_thermostat"
832
+ capabilities_supported: string[]
833
+ properties: {
834
+ online: boolean
835
+ name: string
836
+ model: {
837
+ display_name: string
838
+ }
839
+ } & Record<string, any>
840
+ location?: any
841
+ connected_account_id: string
842
+ workspace_id: string
843
+ errors: Array<{
844
+ error_code: string
845
+ message: string
846
+ }>
847
+ warnings: Array<{
848
+ warning_code: string
849
+ message: string
850
+ }>
851
+ created_at: string
852
+ is_managed: true
853
+ }
854
+ }
855
+ }
856
+ "/devices/list": {
857
+ route: "/devices/list"
858
+ method: "GET" | "POST"
859
+ queryParams: {}
860
+ jsonBody: {}
861
+ commonParams: {
862
+ connected_account_id?: string | undefined
863
+ connected_account_ids?: string[] | undefined
864
+ connect_webview_id?: string | undefined
865
+ device_type?:
866
+ | (
867
+ | "akuvox_lock"
868
+ | "august_lock"
869
+ | "brivo_access_point"
870
+ | "butterflymx_panel"
871
+ | "doorking_lock"
872
+ | "genie_door"
873
+ | "igloo_lock"
874
+ | "linear_lock"
875
+ | "lockly_lock"
876
+ | "kwikset_lock"
877
+ | "nuki_lock"
878
+ | "salto_lock"
879
+ | "schlage_lock"
880
+ | "seam_relay"
881
+ | "smartthings_lock"
882
+ | "yale_lock"
883
+ | "two_n_intercom"
884
+ | "controlbyweb_device"
885
+ | "ttlock_lock"
886
+ | "igloohome_lock"
887
+ | "hubitat_lock"
888
+ | "noiseaware_activity_zone"
889
+ | "minut_sensor"
890
+ | "ecobee_thermostat"
891
+ | "nest_thermostat"
892
+ )
893
+ | undefined
894
+ device_types?:
895
+ | Array<
896
+ | "akuvox_lock"
897
+ | "august_lock"
898
+ | "brivo_access_point"
899
+ | "butterflymx_panel"
900
+ | "doorking_lock"
901
+ | "genie_door"
902
+ | "igloo_lock"
903
+ | "linear_lock"
904
+ | "lockly_lock"
905
+ | "kwikset_lock"
906
+ | "nuki_lock"
907
+ | "salto_lock"
908
+ | "schlage_lock"
909
+ | "seam_relay"
910
+ | "smartthings_lock"
911
+ | "yale_lock"
912
+ | "two_n_intercom"
913
+ | "controlbyweb_device"
914
+ | "ttlock_lock"
915
+ | "igloohome_lock"
916
+ | "hubitat_lock"
917
+ | "noiseaware_activity_zone"
918
+ | "minut_sensor"
919
+ | "ecobee_thermostat"
920
+ | "nest_thermostat"
921
+ >
922
+ | undefined
923
+ manufacturer?:
924
+ | (
925
+ | "akuvox"
926
+ | "august"
927
+ | "brivo"
928
+ | "butterflymx"
929
+ | "doorking"
930
+ | "genie"
931
+ | "igloo"
932
+ | "keywe"
933
+ | "kwikset"
934
+ | "linear"
935
+ | "lockly"
936
+ | "nuki"
937
+ | "philia"
938
+ | "salto"
939
+ | "samsung"
940
+ | "schlage"
941
+ | "seam"
942
+ | "unknown"
943
+ | "yale"
944
+ | "minut"
945
+ | "two_n"
946
+ | "ttlock"
947
+ | "nest"
948
+ | "igloohome"
949
+ | "ecobee"
950
+ | "hubitat"
951
+ )
952
+ | undefined
953
+ device_ids?: string[] | undefined
954
+ }
955
+ formData: {}
956
+ jsonResponse: {
957
+ devices: Array<{
958
+ device_id: string
959
+ device_type:
960
+ | "akuvox_lock"
961
+ | "august_lock"
962
+ | "brivo_access_point"
963
+ | "butterflymx_panel"
964
+ | "doorking_lock"
965
+ | "genie_door"
966
+ | "igloo_lock"
967
+ | "linear_lock"
968
+ | "lockly_lock"
969
+ | "kwikset_lock"
970
+ | "nuki_lock"
971
+ | "salto_lock"
972
+ | "schlage_lock"
973
+ | "seam_relay"
974
+ | "smartthings_lock"
975
+ | "yale_lock"
976
+ | "two_n_intercom"
977
+ | "controlbyweb_device"
978
+ | "ttlock_lock"
979
+ | "igloohome_lock"
980
+ | "hubitat_lock"
981
+ | "noiseaware_activity_zone"
982
+ | "minut_sensor"
983
+ | "ecobee_thermostat"
984
+ | "nest_thermostat"
985
+ capabilities_supported: string[]
986
+ properties: {
987
+ online: boolean
988
+ name: string
989
+ model: {
990
+ display_name: string
991
+ }
992
+ } & Record<string, any>
993
+ location?: any
994
+ connected_account_id: string
995
+ workspace_id: string
996
+ errors: Array<{
997
+ error_code: string
998
+ message: string
999
+ }>
1000
+ warnings: Array<{
1001
+ warning_code: string
1002
+ message: string
1003
+ }>
1004
+ created_at: string
1005
+ is_managed: true
1006
+ }>
1007
+ }
1008
+ }
1009
+ "/devices/list_device_providers": {
1010
+ route: "/devices/list_device_providers"
1011
+ method: "GET"
1012
+ queryParams: {}
1013
+ jsonBody: {}
1014
+ commonParams: {
1015
+ provider_category?: "stable" | undefined
1016
+ }
1017
+ formData: {}
1018
+ jsonResponse: {
1019
+ device_providers: Array<{
1020
+ device_provider_name: string
1021
+ display_name: string
1022
+ image_url: string
1023
+ provider_categories: Array<"stable">
1024
+ }>
1025
+ }
1026
+ }
1027
+ "/devices/unmanaged/list": {
1028
+ route: "/devices/unmanaged/list"
1029
+ method: "GET" | "POST"
1030
+ queryParams: {}
1031
+ jsonBody: {}
1032
+ commonParams: {
1033
+ connected_account_id?: string | undefined
1034
+ connected_account_ids?: string[] | undefined
1035
+ connect_webview_id?: string | undefined
1036
+ device_type?:
1037
+ | (
1038
+ | "akuvox_lock"
1039
+ | "august_lock"
1040
+ | "brivo_access_point"
1041
+ | "butterflymx_panel"
1042
+ | "doorking_lock"
1043
+ | "genie_door"
1044
+ | "igloo_lock"
1045
+ | "linear_lock"
1046
+ | "lockly_lock"
1047
+ | "kwikset_lock"
1048
+ | "nuki_lock"
1049
+ | "salto_lock"
1050
+ | "schlage_lock"
1051
+ | "seam_relay"
1052
+ | "smartthings_lock"
1053
+ | "yale_lock"
1054
+ | "two_n_intercom"
1055
+ | "controlbyweb_device"
1056
+ | "ttlock_lock"
1057
+ | "igloohome_lock"
1058
+ | "hubitat_lock"
1059
+ | "noiseaware_activity_zone"
1060
+ | "minut_sensor"
1061
+ | "ecobee_thermostat"
1062
+ | "nest_thermostat"
1063
+ )
1064
+ | undefined
1065
+ device_types?:
1066
+ | Array<
1067
+ | "akuvox_lock"
1068
+ | "august_lock"
1069
+ | "brivo_access_point"
1070
+ | "butterflymx_panel"
1071
+ | "doorking_lock"
1072
+ | "genie_door"
1073
+ | "igloo_lock"
1074
+ | "linear_lock"
1075
+ | "lockly_lock"
1076
+ | "kwikset_lock"
1077
+ | "nuki_lock"
1078
+ | "salto_lock"
1079
+ | "schlage_lock"
1080
+ | "seam_relay"
1081
+ | "smartthings_lock"
1082
+ | "yale_lock"
1083
+ | "two_n_intercom"
1084
+ | "controlbyweb_device"
1085
+ | "ttlock_lock"
1086
+ | "igloohome_lock"
1087
+ | "hubitat_lock"
1088
+ | "noiseaware_activity_zone"
1089
+ | "minut_sensor"
1090
+ | "ecobee_thermostat"
1091
+ | "nest_thermostat"
1092
+ >
1093
+ | undefined
1094
+ manufacturer?:
1095
+ | (
1096
+ | "akuvox"
1097
+ | "august"
1098
+ | "brivo"
1099
+ | "butterflymx"
1100
+ | "doorking"
1101
+ | "genie"
1102
+ | "igloo"
1103
+ | "keywe"
1104
+ | "kwikset"
1105
+ | "linear"
1106
+ | "lockly"
1107
+ | "nuki"
1108
+ | "philia"
1109
+ | "salto"
1110
+ | "samsung"
1111
+ | "schlage"
1112
+ | "seam"
1113
+ | "unknown"
1114
+ | "yale"
1115
+ | "minut"
1116
+ | "two_n"
1117
+ | "ttlock"
1118
+ | "nest"
1119
+ | "igloohome"
1120
+ | "ecobee"
1121
+ | "hubitat"
1122
+ )
1123
+ | undefined
1124
+ device_ids?: string[] | undefined
1125
+ }
1126
+ formData: {}
1127
+ jsonResponse: {
1128
+ devices: Array<{
1129
+ device_id: string
1130
+ device_type:
1131
+ | "akuvox_lock"
1132
+ | "august_lock"
1133
+ | "brivo_access_point"
1134
+ | "butterflymx_panel"
1135
+ | "doorking_lock"
1136
+ | "genie_door"
1137
+ | "igloo_lock"
1138
+ | "linear_lock"
1139
+ | "lockly_lock"
1140
+ | "kwikset_lock"
1141
+ | "nuki_lock"
1142
+ | "salto_lock"
1143
+ | "schlage_lock"
1144
+ | "seam_relay"
1145
+ | "smartthings_lock"
1146
+ | "yale_lock"
1147
+ | "two_n_intercom"
1148
+ | "controlbyweb_device"
1149
+ | "ttlock_lock"
1150
+ | "igloohome_lock"
1151
+ | "hubitat_lock"
1152
+ | "noiseaware_activity_zone"
1153
+ | "minut_sensor"
1154
+ | "ecobee_thermostat"
1155
+ | "nest_thermostat"
1156
+ connected_account_id: string
1157
+ capabilities_supported: string[]
1158
+ workspace_id: string
1159
+ errors: Array<{
1160
+ error_code: string
1161
+ message: string
1162
+ }>
1163
+ warnings: Array<{
1164
+ warning_code: string
1165
+ message: string
1166
+ }>
1167
+ created_at: string
1168
+ is_managed: false
1169
+ properties: {
1170
+ name: string
1171
+ online: boolean
1172
+ manufacturer?: string | undefined
1173
+ image_url?: string | undefined
1174
+ image_alt_text?: string | undefined
1175
+ model: {
1176
+ display_name: string
1177
+ }
1178
+ }
1179
+ }>
1180
+ }
1181
+ }
1182
+ "/devices/unmanaged/update": {
1183
+ route: "/devices/unmanaged/update"
1184
+ method: "POST" | "PATCH"
1185
+ queryParams: {}
1186
+ jsonBody: {}
1187
+ commonParams: {
1188
+ device_id: string
1189
+ is_managed: true
1190
+ }
1191
+ formData: {}
1192
+ jsonResponse: {}
1193
+ }
1194
+ "/devices/update": {
1195
+ route: "/devices/update"
1196
+ method: "POST" | "PATCH"
1197
+ queryParams: {}
1198
+ jsonBody: {}
1199
+ commonParams: {
1200
+ device_id: string
1201
+ properties?:
1202
+ | {
1203
+ name?: (string | null) | undefined
1204
+ }
1205
+ | undefined
1206
+ name?: (string | null) | undefined
1207
+ location?: {} | undefined
1208
+ is_managed?: boolean
1209
+ }
1210
+ formData: {}
1211
+ jsonResponse: {}
1212
+ }
1213
+ "/events/get": {
1214
+ route: "/events/get"
1215
+ method: "GET"
1216
+ queryParams: {}
1217
+ jsonBody: {}
1218
+ commonParams: {
1219
+ event_id?: string | undefined
1220
+ event_type?: string | undefined
1221
+ device_id?: string | undefined
1222
+ }
1223
+ formData: {}
1224
+ jsonResponse: {
1225
+ event?:
1226
+ | {
1227
+ event_id: string
1228
+ device_id?: string | undefined
1229
+ event_type: string
1230
+ workspace_id: string
1231
+ created_at: Date
1232
+ occurred_at: Date
1233
+ }
1234
+ | undefined
1235
+ message?: string | undefined
1236
+ }
1237
+ }
1238
+ "/events/list": {
1239
+ route: "/events/list"
1240
+ method: "GET" | "POST"
1241
+ queryParams: {}
1242
+ jsonBody: {}
1243
+ commonParams: {
1244
+ since?: string | undefined
1245
+ between?: Array<string | Date> | undefined
1246
+ device_id?: string | undefined
1247
+ device_ids?: string[] | undefined
1248
+ access_code_id?: string | undefined
1249
+ access_code_ids?: string[] | undefined
1250
+ event_type?:
1251
+ | (
1252
+ | "device.connected"
1253
+ | "device.unmanaged.connected"
1254
+ | "device.disconnected"
1255
+ | "device.unmanaged.disconnected"
1256
+ | "device.converted_to_unmanaged"
1257
+ | "device.unmanaged.converted_to_managed"
1258
+ | "device.removed"
1259
+ | "device.tampered"
1260
+ | "device.low_battery"
1261
+ | "device.battery_status_changed"
1262
+ | "access_code.created"
1263
+ | "access_code.changed"
1264
+ | "access_code.scheduled_on_device"
1265
+ | "access_code.set_on_device"
1266
+ | "access_code.removed_from_device"
1267
+ | "access_code.failed_to_set_on_device"
1268
+ | "access_code.delay_in_setting_on_device"
1269
+ | "access_code.failed_to_remove_from_device"
1270
+ | "access_code.delay_in_removing_from_device"
1271
+ | "access_code.unmanaged.converted_to_managed"
1272
+ | "access_code.unmanaged.failed_to_convert_to_managed"
1273
+ | "access_code.unmanaged.created"
1274
+ | "access_code.unmanaged.removed"
1275
+ | "lock.locked"
1276
+ | "lock.unlocked"
1277
+ | "connected_account.connected"
1278
+ | "connected_account.created"
1279
+ | "connected_account.disconnected"
1280
+ | "connected_account.completed_first_sync"
1281
+ | "noise_sensor.noise_threshold_triggered"
1282
+ | "access_code.backup_access_code_pulled"
1283
+ )
1284
+ | undefined
1285
+ event_types?:
1286
+ | Array<
1287
+ | "device.connected"
1288
+ | "device.unmanaged.connected"
1289
+ | "device.disconnected"
1290
+ | "device.unmanaged.disconnected"
1291
+ | "device.converted_to_unmanaged"
1292
+ | "device.unmanaged.converted_to_managed"
1293
+ | "device.removed"
1294
+ | "device.tampered"
1295
+ | "device.low_battery"
1296
+ | "device.battery_status_changed"
1297
+ | "access_code.created"
1298
+ | "access_code.changed"
1299
+ | "access_code.scheduled_on_device"
1300
+ | "access_code.set_on_device"
1301
+ | "access_code.removed_from_device"
1302
+ | "access_code.failed_to_set_on_device"
1303
+ | "access_code.delay_in_setting_on_device"
1304
+ | "access_code.failed_to_remove_from_device"
1305
+ | "access_code.delay_in_removing_from_device"
1306
+ | "access_code.unmanaged.converted_to_managed"
1307
+ | "access_code.unmanaged.failed_to_convert_to_managed"
1308
+ | "access_code.unmanaged.created"
1309
+ | "access_code.unmanaged.removed"
1310
+ | "lock.locked"
1311
+ | "lock.unlocked"
1312
+ | "connected_account.connected"
1313
+ | "connected_account.created"
1314
+ | "connected_account.disconnected"
1315
+ | "connected_account.completed_first_sync"
1316
+ | "noise_sensor.noise_threshold_triggered"
1317
+ | "access_code.backup_access_code_pulled"
1318
+ >
1319
+ | undefined
1320
+ connected_account_id?: string | undefined
1321
+ }
1322
+ formData: {}
1323
+ jsonResponse: {
1324
+ events?:
1325
+ | Array<{
1326
+ event_id: string
1327
+ device_id?: string | undefined
1328
+ event_type: string
1329
+ workspace_id: string
1330
+ created_at: Date
1331
+ occurred_at: Date
1332
+ }>
1333
+ | undefined
1334
+ message?: string | undefined
1335
+ }
1336
+ }
1337
+ "/health": {
1338
+ route: "/health"
1339
+ method: "GET"
1340
+ queryParams: {}
1341
+ jsonBody: {}
1342
+ commonParams: {}
1343
+ formData: {}
1344
+ jsonResponse: {
1345
+ ok: boolean
1346
+ msg: "I\u2019m one with the Force. The Force is with me."
1347
+ last_service_evaluation_at: string
1348
+ service_health_statuses: Array<{
1349
+ service: string
1350
+ status: "healthy" | "degraded" | "down"
1351
+ description: string
1352
+ }>
1353
+ }
1354
+ }
1355
+ "/health/get_health": {
1356
+ route: "/health/get_health"
1357
+ method: "GET"
1358
+ queryParams: {}
1359
+ jsonBody: {}
1360
+ commonParams: {}
1361
+ formData: {}
1362
+ jsonResponse: {
1363
+ ok: boolean
1364
+ msg: "I\u2019m one with the Force. The Force is with me."
1365
+ last_service_evaluation_at: string
1366
+ service_health_statuses: Array<{
1367
+ service: string
1368
+ status: "healthy" | "degraded" | "down"
1369
+ description: string
1370
+ }>
1371
+ }
1372
+ }
1373
+ "/health/get_service_health": {
1374
+ route: "/health/get_service_health"
1375
+ method: "GET"
1376
+ queryParams: {}
1377
+ jsonBody: {}
1378
+ commonParams: {
1379
+ service: string
1380
+ }
1381
+ formData: {}
1382
+ jsonResponse: {
1383
+ ok: true
1384
+ last_service_evaluation_at: string
1385
+ service_health: {
1386
+ service: string
1387
+ status: "healthy" | "degraded" | "down"
1388
+ description: string
1389
+ }
1390
+ }
1391
+ }
1392
+ "/health/service/[service_name]": {
1393
+ route: "/health/service/[service_name]"
1394
+ method: "GET"
1395
+ queryParams: {
1396
+ service_name: string
1397
+ }
1398
+ jsonBody: {}
1399
+ commonParams: {}
1400
+ formData: {}
1401
+ jsonResponse: {
1402
+ ok: true
1403
+ last_service_evaluation_at: string
1404
+ service_health: {
1405
+ service: string
1406
+ status: "healthy" | "degraded" | "down"
1407
+ description: string
1408
+ }
1409
+ }
1410
+ }
1411
+ "/locks/get": {
1412
+ route: "/locks/get"
1413
+ method: "GET" | "POST"
1414
+ queryParams: {}
1415
+ jsonBody: {}
1416
+ commonParams: {
1417
+ device_id?: string | undefined
1418
+ name?: string | undefined
1419
+ }
1420
+ formData: {}
1421
+ jsonResponse: {
1422
+ lock?: any
1423
+ device?: any
1424
+ }
1425
+ }
1426
+ "/locks/list": {
1427
+ route: "/locks/list"
1428
+ method: "GET" | "POST"
1429
+ queryParams: {}
1430
+ jsonBody: {}
1431
+ commonParams: {
1432
+ connected_account_id?: string | undefined
1433
+ connected_account_ids?: string[] | undefined
1434
+ connect_webview_id?: string | undefined
1435
+ device_type?:
1436
+ | (
1437
+ | "akuvox_lock"
1438
+ | "august_lock"
1439
+ | "brivo_access_point"
1440
+ | "butterflymx_panel"
1441
+ | "doorking_lock"
1442
+ | "genie_door"
1443
+ | "igloo_lock"
1444
+ | "linear_lock"
1445
+ | "lockly_lock"
1446
+ | "kwikset_lock"
1447
+ | "nuki_lock"
1448
+ | "salto_lock"
1449
+ | "schlage_lock"
1450
+ | "seam_relay"
1451
+ | "smartthings_lock"
1452
+ | "yale_lock"
1453
+ | "two_n_intercom"
1454
+ | "controlbyweb_device"
1455
+ | "ttlock_lock"
1456
+ | "igloohome_lock"
1457
+ | "hubitat_lock"
1458
+ | "noiseaware_activity_zone"
1459
+ | "minut_sensor"
1460
+ | "ecobee_thermostat"
1461
+ | "nest_thermostat"
1462
+ )
1463
+ | undefined
1464
+ device_types?:
1465
+ | Array<
1466
+ | "akuvox_lock"
1467
+ | "august_lock"
1468
+ | "brivo_access_point"
1469
+ | "butterflymx_panel"
1470
+ | "doorking_lock"
1471
+ | "genie_door"
1472
+ | "igloo_lock"
1473
+ | "linear_lock"
1474
+ | "lockly_lock"
1475
+ | "kwikset_lock"
1476
+ | "nuki_lock"
1477
+ | "salto_lock"
1478
+ | "schlage_lock"
1479
+ | "seam_relay"
1480
+ | "smartthings_lock"
1481
+ | "yale_lock"
1482
+ | "two_n_intercom"
1483
+ | "controlbyweb_device"
1484
+ | "ttlock_lock"
1485
+ | "igloohome_lock"
1486
+ | "hubitat_lock"
1487
+ | "noiseaware_activity_zone"
1488
+ | "minut_sensor"
1489
+ | "ecobee_thermostat"
1490
+ | "nest_thermostat"
1491
+ >
1492
+ | undefined
1493
+ manufacturer?:
1494
+ | (
1495
+ | "akuvox"
1496
+ | "august"
1497
+ | "brivo"
1498
+ | "butterflymx"
1499
+ | "doorking"
1500
+ | "genie"
1501
+ | "igloo"
1502
+ | "keywe"
1503
+ | "kwikset"
1504
+ | "linear"
1505
+ | "lockly"
1506
+ | "nuki"
1507
+ | "philia"
1508
+ | "salto"
1509
+ | "samsung"
1510
+ | "schlage"
1511
+ | "seam"
1512
+ | "unknown"
1513
+ | "yale"
1514
+ | "minut"
1515
+ | "two_n"
1516
+ | "ttlock"
1517
+ | "nest"
1518
+ | "igloohome"
1519
+ | "ecobee"
1520
+ | "hubitat"
1521
+ )
1522
+ | undefined
1523
+ device_ids?: string[] | undefined
1524
+ }
1525
+ formData: {}
1526
+ jsonResponse: {
1527
+ locks?: any
1528
+ devices?: any
1529
+ }
1530
+ }
1531
+ "/locks/lock_door": {
1532
+ route: "/locks/lock_door"
1533
+ method: "POST"
1534
+ queryParams: {}
1535
+ jsonBody: {
1536
+ device_id: string
1537
+ sync?: boolean
1538
+ }
1539
+ commonParams: {}
1540
+ formData: {}
1541
+ jsonResponse: {
1542
+ action_attempt:
1543
+ | {
1544
+ status: "success"
1545
+ action_type: string
1546
+ action_attempt_id: string
1547
+ result?: any
1548
+ error: null
1549
+ }
1550
+ | {
1551
+ status: "pending"
1552
+ action_type: string
1553
+ action_attempt_id: string
1554
+ result: null
1555
+ error: null
1556
+ }
1557
+ | {
1558
+ status: "error"
1559
+ action_type: string
1560
+ action_attempt_id: string
1561
+ result: null
1562
+ error: {
1563
+ type: string
1564
+ message: string
1565
+ }
1566
+ }
1567
+ }
1568
+ }
1569
+ "/locks/unlock_door": {
1570
+ route: "/locks/unlock_door"
1571
+ method: "POST"
1572
+ queryParams: {}
1573
+ jsonBody: {
1574
+ device_id: string
1575
+ sync?: boolean
1576
+ }
1577
+ commonParams: {}
1578
+ formData: {}
1579
+ jsonResponse: {
1580
+ action_attempt:
1581
+ | {
1582
+ status: "success"
1583
+ action_type: string
1584
+ action_attempt_id: string
1585
+ result?: any
1586
+ error: null
1587
+ }
1588
+ | {
1589
+ status: "pending"
1590
+ action_type: string
1591
+ action_attempt_id: string
1592
+ result: null
1593
+ error: null
1594
+ }
1595
+ | {
1596
+ status: "error"
1597
+ action_type: string
1598
+ action_attempt_id: string
1599
+ result: null
1600
+ error: {
1601
+ type: string
1602
+ message: string
1603
+ }
1604
+ }
1605
+ }
1606
+ }
1607
+ "/noise_sensors/noise_thresholds/create": {
1608
+ route: "/noise_sensors/noise_thresholds/create"
1609
+ method: "POST"
1610
+ queryParams: {}
1611
+ jsonBody: {
1612
+ device_id: string
1613
+ sync?: boolean
1614
+ name?: string | undefined
1615
+ starts_daily_at: string
1616
+ ends_daily_at: string
1617
+ noise_threshold_decibels?: number | undefined
1618
+ noise_threshold_nrs?: number | undefined
1619
+ }
1620
+ commonParams: {}
1621
+ formData: {}
1622
+ jsonResponse: {
1623
+ action_attempt:
1624
+ | {
1625
+ status: "success"
1626
+ action_type: string
1627
+ action_attempt_id: string
1628
+ result?: any
1629
+ error: null
1630
+ }
1631
+ | {
1632
+ status: "pending"
1633
+ action_type: string
1634
+ action_attempt_id: string
1635
+ result: null
1636
+ error: null
1637
+ }
1638
+ | {
1639
+ status: "error"
1640
+ action_type: string
1641
+ action_attempt_id: string
1642
+ result: null
1643
+ error: {
1644
+ type: string
1645
+ message: string
1646
+ }
1647
+ }
1648
+ }
1649
+ }
1650
+ "/noise_sensors/noise_thresholds/delete": {
1651
+ route: "/noise_sensors/noise_thresholds/delete"
1652
+ method: "DELETE" | "POST"
1653
+ queryParams: {}
1654
+ jsonBody: {
1655
+ noise_threshold_id: string
1656
+ device_id: string
1657
+ sync?: boolean
1658
+ }
1659
+ commonParams: {}
1660
+ formData: {}
1661
+ jsonResponse: {
1662
+ action_attempt:
1663
+ | {
1664
+ status: "success"
1665
+ action_type: string
1666
+ action_attempt_id: string
1667
+ result?: any
1668
+ error: null
1669
+ }
1670
+ | {
1671
+ status: "pending"
1672
+ action_type: string
1673
+ action_attempt_id: string
1674
+ result: null
1675
+ error: null
1676
+ }
1677
+ | {
1678
+ status: "error"
1679
+ action_type: string
1680
+ action_attempt_id: string
1681
+ result: null
1682
+ error: {
1683
+ type: string
1684
+ message: string
1685
+ }
1686
+ }
1687
+ }
1688
+ }
1689
+ "/noise_sensors/noise_thresholds/get": {
1690
+ route: "/noise_sensors/noise_thresholds/get"
1691
+ method: "GET" | "POST"
1692
+ queryParams: {}
1693
+ jsonBody: {}
1694
+ commonParams: {
1695
+ noise_threshold_id: string
1696
+ }
1697
+ formData: {}
1698
+ jsonResponse: {
1699
+ noise_threshold: {
1700
+ noise_threshold_id: string
1701
+ device_id: string
1702
+ name: string
1703
+ noise_threshold_nrs?: number | undefined
1704
+ starts_daily_at: string
1705
+ ends_daily_at: string
1706
+ noise_threshold_decibels: number
1707
+ }
1708
+ }
1709
+ }
1710
+ "/noise_sensors/noise_thresholds/list": {
1711
+ route: "/noise_sensors/noise_thresholds/list"
1712
+ method: "GET" | "POST"
1713
+ queryParams: {}
1714
+ jsonBody: {}
1715
+ commonParams: {
1716
+ device_id: string
1717
+ }
1718
+ formData: {}
1719
+ jsonResponse: {
1720
+ noise_thresholds: Array<{
1721
+ noise_threshold_id: string
1722
+ device_id: string
1723
+ name: string
1724
+ noise_threshold_nrs?: number | undefined
1725
+ starts_daily_at: string
1726
+ ends_daily_at: string
1727
+ noise_threshold_decibels: number
1728
+ }>
1729
+ }
1730
+ }
1731
+ "/noise_sensors/noise_thresholds/update": {
1732
+ route: "/noise_sensors/noise_thresholds/update"
1733
+ method: "PUT" | "POST"
1734
+ queryParams: {}
1735
+ jsonBody: {
1736
+ noise_threshold_id: string
1737
+ device_id: string
1738
+ sync?: boolean
1739
+ name?: string | undefined
1740
+ starts_daily_at?: string | undefined
1741
+ ends_daily_at?: string | undefined
1742
+ noise_threshold_decibels?: number | undefined
1743
+ noise_threshold_nrs?: number | undefined
1744
+ }
1745
+ commonParams: {}
1746
+ formData: {}
1747
+ jsonResponse: {
1748
+ action_attempt:
1749
+ | {
1750
+ status: "success"
1751
+ action_type: string
1752
+ action_attempt_id: string
1753
+ result?: any
1754
+ error: null
1755
+ }
1756
+ | {
1757
+ status: "pending"
1758
+ action_type: string
1759
+ action_attempt_id: string
1760
+ result: null
1761
+ error: null
1762
+ }
1763
+ | {
1764
+ status: "error"
1765
+ action_type: string
1766
+ action_attempt_id: string
1767
+ result: null
1768
+ error: {
1769
+ type: string
1770
+ message: string
1771
+ }
1772
+ }
1773
+ }
1774
+ }
1775
+ "/noise_sensors/simulate/trigger_noise_threshold": {
1776
+ route: "/noise_sensors/simulate/trigger_noise_threshold"
1777
+ method: "POST"
1778
+ queryParams: {}
1779
+ jsonBody: {
1780
+ device_id: string
1781
+ }
1782
+ commonParams: {}
1783
+ formData: {}
1784
+ jsonResponse: {}
1785
+ }
1786
+ "/thermostats/climate_setting_schedules/create": {
1787
+ route: "/thermostats/climate_setting_schedules/create"
1788
+ method: "POST"
1789
+ queryParams: {}
1790
+ jsonBody: {
1791
+ schedule_type?: "time_bound"
1792
+ device_id: string
1793
+ name?: string | undefined
1794
+ schedule_starts_at: string
1795
+ schedule_ends_at: string
1796
+ automatic_heating_enabled?: boolean | undefined
1797
+ automatic_cooling_enabled?: boolean | undefined
1798
+ hvac_mode_setting?: ("off" | "heat" | "cool" | "heatcool") | undefined
1799
+ cooling_set_point_celsius?: (number | undefined) | undefined
1800
+ heating_set_point_celsius?: (number | undefined) | undefined
1801
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
1802
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
1803
+ manual_override_allowed?: boolean | undefined
1804
+ }
1805
+ commonParams: {}
1806
+ formData: {}
1807
+ jsonResponse: {
1808
+ climate_setting_schedule: {
1809
+ climate_setting_schedule_id: string
1810
+ schedule_type: "time_bound"
1811
+ device_id: string
1812
+ name?: string | undefined
1813
+ schedule_starts_at: string
1814
+ schedule_ends_at: string
1815
+ created_at: string
1816
+ automatic_heating_enabled?: boolean | undefined
1817
+ automatic_cooling_enabled?: boolean | undefined
1818
+ hvac_mode_setting?: ("off" | "heat" | "cool" | "heatcool") | undefined
1819
+ cooling_set_point_celsius?: (number | undefined) | undefined
1820
+ heating_set_point_celsius?: (number | undefined) | undefined
1821
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
1822
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
1823
+ manual_override_allowed?: boolean | undefined
1824
+ }
1825
+ }
1826
+ }
1827
+ "/thermostats/climate_setting_schedules/delete": {
1828
+ route: "/thermostats/climate_setting_schedules/delete"
1829
+ method: "PUT" | "POST" | "DELETE"
1830
+ queryParams: {}
1831
+ jsonBody: {}
1832
+ commonParams: {
1833
+ climate_setting_schedule_id: string
1834
+ }
1835
+ formData: {}
1836
+ jsonResponse: {}
1837
+ }
1838
+ "/thermostats/climate_setting_schedules/get": {
1839
+ route: "/thermostats/climate_setting_schedules/get"
1840
+ method: "GET" | "POST"
1841
+ queryParams: {}
1842
+ jsonBody: {}
1843
+ commonParams: {
1844
+ climate_setting_schedule_id?: string | undefined
1845
+ device_id?: string | undefined
1846
+ }
1847
+ formData: {}
1848
+ jsonResponse: {
1849
+ climate_setting_schedule: {
1850
+ climate_setting_schedule_id: string
1851
+ schedule_type: "time_bound"
1852
+ device_id: string
1853
+ name?: string | undefined
1854
+ schedule_starts_at: string
1855
+ schedule_ends_at: string
1856
+ created_at: string
1857
+ automatic_heating_enabled?: boolean | undefined
1858
+ automatic_cooling_enabled?: boolean | undefined
1859
+ hvac_mode_setting?: ("off" | "heat" | "cool" | "heatcool") | undefined
1860
+ cooling_set_point_celsius?: (number | undefined) | undefined
1861
+ heating_set_point_celsius?: (number | undefined) | undefined
1862
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
1863
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
1864
+ manual_override_allowed?: boolean | undefined
1865
+ }
1866
+ }
1867
+ }
1868
+ "/thermostats/climate_setting_schedules/list": {
1869
+ route: "/thermostats/climate_setting_schedules/list"
1870
+ method: "GET" | "POST"
1871
+ queryParams: {}
1872
+ jsonBody: {}
1873
+ commonParams: {
1874
+ device_id: string
1875
+ }
1876
+ formData: {}
1877
+ jsonResponse: {
1878
+ climate_setting_schedules: Array<{
1879
+ climate_setting_schedule_id: string
1880
+ schedule_type: "time_bound"
1881
+ device_id: string
1882
+ name?: string | undefined
1883
+ schedule_starts_at: string
1884
+ schedule_ends_at: string
1885
+ created_at: string
1886
+ automatic_heating_enabled?: boolean | undefined
1887
+ automatic_cooling_enabled?: boolean | undefined
1888
+ hvac_mode_setting?: ("off" | "heat" | "cool" | "heatcool") | undefined
1889
+ cooling_set_point_celsius?: (number | undefined) | undefined
1890
+ heating_set_point_celsius?: (number | undefined) | undefined
1891
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
1892
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
1893
+ manual_override_allowed?: boolean | undefined
1894
+ }>
1895
+ }
1896
+ }
1897
+ "/thermostats/climate_setting_schedules/update": {
1898
+ route: "/thermostats/climate_setting_schedules/update"
1899
+ method: "PUT" | "POST"
1900
+ queryParams: {}
1901
+ jsonBody: {
1902
+ climate_setting_schedule_id: string
1903
+ schedule_type?: "time_bound"
1904
+ name?: string | undefined
1905
+ schedule_starts_at?: string | undefined
1906
+ schedule_ends_at?: string | undefined
1907
+ automatic_heating_enabled?: boolean | undefined
1908
+ automatic_cooling_enabled?: boolean | undefined
1909
+ hvac_mode_setting?: ("off" | "heat" | "cool" | "heatcool") | undefined
1910
+ cooling_set_point_celsius?: (number | undefined) | undefined
1911
+ heating_set_point_celsius?: (number | undefined) | undefined
1912
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
1913
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
1914
+ manual_override_allowed?: boolean | undefined
1915
+ }
1916
+ commonParams: {}
1917
+ formData: {}
1918
+ jsonResponse: {
1919
+ climate_setting_schedule: {
1920
+ climate_setting_schedule_id: string
1921
+ schedule_type: "time_bound"
1922
+ device_id: string
1923
+ name?: string | undefined
1924
+ schedule_starts_at: string
1925
+ schedule_ends_at: string
1926
+ created_at: string
1927
+ automatic_heating_enabled?: boolean | undefined
1928
+ automatic_cooling_enabled?: boolean | undefined
1929
+ hvac_mode_setting?: ("off" | "heat" | "cool" | "heatcool") | undefined
1930
+ cooling_set_point_celsius?: (number | undefined) | undefined
1931
+ heating_set_point_celsius?: (number | undefined) | undefined
1932
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
1933
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
1934
+ manual_override_allowed?: boolean | undefined
1935
+ }
1936
+ }
1937
+ }
1938
+ "/thermostats/get": {
1939
+ route: "/thermostats/get"
1940
+ method: "GET" | "POST"
1941
+ queryParams: {}
1942
+ jsonBody: {}
1943
+ commonParams: {
1944
+ device_id?: string | undefined
1945
+ name?: string | undefined
1946
+ }
1947
+ formData: {}
1948
+ jsonResponse: {
1949
+ thermostat: {
1950
+ device_id: string
1951
+ device_type:
1952
+ | "akuvox_lock"
1953
+ | "august_lock"
1954
+ | "brivo_access_point"
1955
+ | "butterflymx_panel"
1956
+ | "doorking_lock"
1957
+ | "genie_door"
1958
+ | "igloo_lock"
1959
+ | "linear_lock"
1960
+ | "lockly_lock"
1961
+ | "kwikset_lock"
1962
+ | "nuki_lock"
1963
+ | "salto_lock"
1964
+ | "schlage_lock"
1965
+ | "seam_relay"
1966
+ | "smartthings_lock"
1967
+ | "yale_lock"
1968
+ | "two_n_intercom"
1969
+ | "controlbyweb_device"
1970
+ | "ttlock_lock"
1971
+ | "igloohome_lock"
1972
+ | "hubitat_lock"
1973
+ | "noiseaware_activity_zone"
1974
+ | "minut_sensor"
1975
+ | "ecobee_thermostat"
1976
+ | "nest_thermostat"
1977
+ capabilities_supported: string[]
1978
+ properties: {
1979
+ online: boolean
1980
+ name: string
1981
+ model: {
1982
+ display_name: string
1983
+ }
1984
+ } & Record<string, any>
1985
+ location?: any
1986
+ connected_account_id: string
1987
+ workspace_id: string
1988
+ errors: Array<{
1989
+ error_code: string
1990
+ message: string
1991
+ }>
1992
+ warnings: Array<{
1993
+ warning_code: string
1994
+ message: string
1995
+ }>
1996
+ created_at: string
1997
+ is_managed: true
1998
+ }
1999
+ }
2000
+ }
2001
+ "/thermostats/list": {
2002
+ route: "/thermostats/list"
2003
+ method: "GET" | "POST"
2004
+ queryParams: {}
2005
+ jsonBody: {}
2006
+ commonParams: {
2007
+ connected_account_id?: string | undefined
2008
+ connected_account_ids?: string[] | undefined
2009
+ connect_webview_id?: string | undefined
2010
+ device_type?:
2011
+ | (
2012
+ | "akuvox_lock"
2013
+ | "august_lock"
2014
+ | "brivo_access_point"
2015
+ | "butterflymx_panel"
2016
+ | "doorking_lock"
2017
+ | "genie_door"
2018
+ | "igloo_lock"
2019
+ | "linear_lock"
2020
+ | "lockly_lock"
2021
+ | "kwikset_lock"
2022
+ | "nuki_lock"
2023
+ | "salto_lock"
2024
+ | "schlage_lock"
2025
+ | "seam_relay"
2026
+ | "smartthings_lock"
2027
+ | "yale_lock"
2028
+ | "two_n_intercom"
2029
+ | "controlbyweb_device"
2030
+ | "ttlock_lock"
2031
+ | "igloohome_lock"
2032
+ | "hubitat_lock"
2033
+ | "noiseaware_activity_zone"
2034
+ | "minut_sensor"
2035
+ | "ecobee_thermostat"
2036
+ | "nest_thermostat"
2037
+ )
2038
+ | undefined
2039
+ device_types?:
2040
+ | Array<
2041
+ | "akuvox_lock"
2042
+ | "august_lock"
2043
+ | "brivo_access_point"
2044
+ | "butterflymx_panel"
2045
+ | "doorking_lock"
2046
+ | "genie_door"
2047
+ | "igloo_lock"
2048
+ | "linear_lock"
2049
+ | "lockly_lock"
2050
+ | "kwikset_lock"
2051
+ | "nuki_lock"
2052
+ | "salto_lock"
2053
+ | "schlage_lock"
2054
+ | "seam_relay"
2055
+ | "smartthings_lock"
2056
+ | "yale_lock"
2057
+ | "two_n_intercom"
2058
+ | "controlbyweb_device"
2059
+ | "ttlock_lock"
2060
+ | "igloohome_lock"
2061
+ | "hubitat_lock"
2062
+ | "noiseaware_activity_zone"
2063
+ | "minut_sensor"
2064
+ | "ecobee_thermostat"
2065
+ | "nest_thermostat"
2066
+ >
2067
+ | undefined
2068
+ manufacturer?:
2069
+ | (
2070
+ | "akuvox"
2071
+ | "august"
2072
+ | "brivo"
2073
+ | "butterflymx"
2074
+ | "doorking"
2075
+ | "genie"
2076
+ | "igloo"
2077
+ | "keywe"
2078
+ | "kwikset"
2079
+ | "linear"
2080
+ | "lockly"
2081
+ | "nuki"
2082
+ | "philia"
2083
+ | "salto"
2084
+ | "samsung"
2085
+ | "schlage"
2086
+ | "seam"
2087
+ | "unknown"
2088
+ | "yale"
2089
+ | "minut"
2090
+ | "two_n"
2091
+ | "ttlock"
2092
+ | "nest"
2093
+ | "igloohome"
2094
+ | "ecobee"
2095
+ | "hubitat"
2096
+ )
2097
+ | undefined
2098
+ device_ids?: string[] | undefined
2099
+ }
2100
+ formData: {}
2101
+ jsonResponse: {
2102
+ thermostats: Array<{
2103
+ device_id: string
2104
+ device_type:
2105
+ | "akuvox_lock"
2106
+ | "august_lock"
2107
+ | "brivo_access_point"
2108
+ | "butterflymx_panel"
2109
+ | "doorking_lock"
2110
+ | "genie_door"
2111
+ | "igloo_lock"
2112
+ | "linear_lock"
2113
+ | "lockly_lock"
2114
+ | "kwikset_lock"
2115
+ | "nuki_lock"
2116
+ | "salto_lock"
2117
+ | "schlage_lock"
2118
+ | "seam_relay"
2119
+ | "smartthings_lock"
2120
+ | "yale_lock"
2121
+ | "two_n_intercom"
2122
+ | "controlbyweb_device"
2123
+ | "ttlock_lock"
2124
+ | "igloohome_lock"
2125
+ | "hubitat_lock"
2126
+ | "noiseaware_activity_zone"
2127
+ | "minut_sensor"
2128
+ | "ecobee_thermostat"
2129
+ | "nest_thermostat"
2130
+ capabilities_supported: string[]
2131
+ properties: {
2132
+ online: boolean
2133
+ name: string
2134
+ model: {
2135
+ display_name: string
2136
+ }
2137
+ } & Record<string, any>
2138
+ location?: any
2139
+ connected_account_id: string
2140
+ workspace_id: string
2141
+ errors: Array<{
2142
+ error_code: string
2143
+ message: string
2144
+ }>
2145
+ warnings: Array<{
2146
+ warning_code: string
2147
+ message: string
2148
+ }>
2149
+ created_at: string
2150
+ is_managed: true
2151
+ }>
2152
+ }
2153
+ }
2154
+ "/thermostats/set_cooling_set_point": {
2155
+ route: "/thermostats/set_cooling_set_point"
2156
+ method: "POST"
2157
+ queryParams: {}
2158
+ jsonBody: {
2159
+ device_id: string
2160
+ cooling_set_point_celsius?: number | undefined
2161
+ cooling_set_point_fahrenheit?: number | undefined
2162
+ sync?: boolean
2163
+ }
2164
+ commonParams: {}
2165
+ formData: {}
2166
+ jsonResponse: {}
2167
+ }
2168
+ "/thermostats/set_mode": {
2169
+ route: "/thermostats/set_mode"
2170
+ method: "POST"
2171
+ queryParams: {}
2172
+ jsonBody: {
2173
+ device_id: string
2174
+ automatic_heating_enabled?: boolean | undefined
2175
+ automatic_cooling_enabled?: boolean | undefined
2176
+ hvac_mode_setting?: ("off" | "heat" | "cool" | "heatcool") | undefined
2177
+ sync?: boolean
2178
+ }
2179
+ commonParams: {}
2180
+ formData: {}
2181
+ jsonResponse: {}
2182
+ }
2183
+ "/thermostats/update": {
2184
+ route: "/thermostats/update"
2185
+ method: "POST"
2186
+ queryParams: {}
2187
+ jsonBody: {
2188
+ device_id: string
2189
+ default_climate_setting: {
2190
+ automatic_heating_enabled?: boolean | undefined
2191
+ automatic_cooling_enabled?: boolean | undefined
2192
+ hvac_mode_setting?: ("off" | "heat" | "cool" | "heatcool") | undefined
2193
+ cooling_set_point_celsius?: (number | undefined) | undefined
2194
+ heating_set_point_celsius?: (number | undefined) | undefined
2195
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
2196
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
2197
+ manual_override_allowed?: boolean | undefined
2198
+ }
2199
+ }
2200
+ commonParams: {}
2201
+ formData: {}
2202
+ jsonResponse: {}
2203
+ }
2204
+ "/webhooks/create": {
2205
+ route: "/webhooks/create"
2206
+ method: "POST"
2207
+ queryParams: {}
2208
+ jsonBody: {
2209
+ url: string
2210
+ event_types?: string[]
2211
+ }
2212
+ commonParams: {}
2213
+ formData: {}
2214
+ jsonResponse: {
2215
+ webhook: {
2216
+ webhook_id: string
2217
+ url: string
2218
+ event_types?: string[] | undefined
2219
+ secret?: string | undefined
2220
+ }
2221
+ }
2222
+ }
2223
+ "/webhooks/delete": {
2224
+ route: "/webhooks/delete"
2225
+ method: "DELETE" | "POST"
2226
+ queryParams: {}
2227
+ jsonBody: {}
2228
+ commonParams: {
2229
+ webhook_id: string
2230
+ }
2231
+ formData: {}
2232
+ jsonResponse: {}
2233
+ }
2234
+ "/webhooks/get": {
2235
+ route: "/webhooks/get"
2236
+ method: "GET"
2237
+ queryParams: {
2238
+ webhook_id: string
2239
+ }
2240
+ jsonBody: {}
2241
+ commonParams: {}
2242
+ formData: {}
2243
+ jsonResponse: {
2244
+ webhook: {
2245
+ webhook_id: string
2246
+ url: string
2247
+ event_types?: string[] | undefined
2248
+ secret?: string | undefined
2249
+ }
2250
+ }
2251
+ }
2252
+ "/webhooks/list": {
2253
+ route: "/webhooks/list"
2254
+ method: "GET"
2255
+ queryParams: {}
2256
+ jsonBody: {}
2257
+ commonParams: {}
2258
+ formData: {}
2259
+ jsonResponse: {
2260
+ webhooks: Array<{
2261
+ webhook_id: string
2262
+ url: string
2263
+ event_types?: string[] | undefined
2264
+ secret?: string | undefined
2265
+ }>
2266
+ }
2267
+ }
2268
+ "/workspaces/get": {
2269
+ route: "/workspaces/get"
2270
+ method: "GET"
2271
+ queryParams: {}
2272
+ jsonBody: {}
2273
+ commonParams: {}
2274
+ formData: {}
2275
+ jsonResponse: {
2276
+ workspace?:
2277
+ | {
2278
+ workspace_id: string
2279
+ name: string
2280
+ is_sandbox: boolean
2281
+ connect_partner_name: string | null
2282
+ }
2283
+ | undefined
2284
+ }
2285
+ }
2286
+ "/workspaces/list": {
2287
+ route: "/workspaces/list"
2288
+ method: "GET"
2289
+ queryParams: {}
2290
+ jsonBody: {}
2291
+ commonParams: {}
2292
+ formData: {}
2293
+ jsonResponse: {
2294
+ workspaces: Array<{
2295
+ workspace_id: string
2296
+ name: string
2297
+ is_sandbox: boolean
2298
+ }>
2299
+ }
2300
+ }
2301
+ "/workspaces/reset_sandbox": {
2302
+ route: "/workspaces/reset_sandbox"
2303
+ method: "POST"
2304
+ queryParams: {}
2305
+ jsonBody: {}
2306
+ commonParams: {}
2307
+ formData: {}
2308
+ jsonResponse: {
2309
+ message: string
2310
+ }
2311
+ }
2312
+ }
2313
+
2314
+ export type RouteResponse<Path extends keyof Routes> =
2315
+ Routes[Path]["jsonResponse"]
2316
+
2317
+ export type RouteRequestBody<Path extends keyof Routes> =
2318
+ Routes[Path]["jsonBody"] & Routes[Path]["commonParams"]
2319
+
2320
+ export type RouteRequestParams<Path extends keyof Routes> =
2321
+ Routes[Path]["queryParams"] & Routes[Path]["commonParams"]