github.com/e154/smart-home@v0.17.2-0.20240311175135-e530a6e5cd45/static_source/admin/src/api/stub.ts (about) 1 /* eslint-disable */ 2 /* tslint:disable */ 3 /* 4 * --------------------------------------------------------------- 5 * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API ## 6 * ## ## 7 * ## AUTHOR: acacode ## 8 * ## SOURCE: https://github.com/acacode/swagger-typescript-api ## 9 * --------------------------------------------------------------- 10 */ 11 12 /** 13 * Generic Error Response 14 * Generic Error Response 15 */ 16 export interface GenericErrorResponse { 17 message?: string; 18 code?: string; 19 } 20 21 export interface AccessListListOfString { 22 items: string[]; 23 } 24 25 export interface GetImageFilterListResultfilter { 26 date: string; 27 /** @format int32 */ 28 count: number; 29 } 30 31 export interface UpdateDashboardCardRequestItem { 32 /** @format int64 */ 33 id: number; 34 title: string; 35 type: string; 36 /** @format int32 */ 37 weight: number; 38 enabled: boolean; 39 entityId?: string; 40 /** 41 * @format byte 42 * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ 43 */ 44 payload: string; 45 hidden: boolean; 46 frozen: boolean; 47 showOn?: string[]; 48 hideOn?: string[]; 49 } 50 51 export interface UpdateRoleAccessListRequestAccessListDiff { 52 items: Record<string, boolean>; 53 } 54 55 export interface ApiAccessItem { 56 actions: string[]; 57 method: string; 58 description: string; 59 roleName: string; 60 } 61 62 export interface ApiAccessLevels { 63 items: Record<string, ApiAccessItem>; 64 } 65 66 export interface ApiAccessList { 67 levels: Record<string, ApiAccessLevels>; 68 } 69 70 export interface ApiAccessListResponse { 71 accessList?: ApiAccessList; 72 } 73 74 export interface ApiAction { 75 /** @format int64 */ 76 id: number; 77 name: string; 78 description: string; 79 /** @format int64 */ 80 scriptId?: number; 81 script?: ApiScript; 82 /** @format int64 */ 83 areaId?: number; 84 area?: ApiArea; 85 entity?: ApiEntity; 86 entityId?: string; 87 entityActionName?: string; 88 completed?: boolean; 89 /** @format date-time */ 90 createdAt: string; 91 /** @format date-time */ 92 updatedAt: string; 93 } 94 95 export interface ApiArea { 96 /** @format int64 */ 97 id: number; 98 name: string; 99 description: string; 100 polygon: ApiAreaLocation[]; 101 center?: ApiAreaLocation; 102 /** @format float */ 103 zoom: number; 104 /** @format float */ 105 resolution: number; 106 /** @format date-time */ 107 createdAt: string; 108 /** @format date-time */ 109 updatedAt: string; 110 } 111 112 export interface ApiAreaLocation { 113 /** @format double */ 114 lat: number; 115 /** @format double */ 116 lon: number; 117 } 118 119 export interface ApiAttribute { 120 name: string; 121 type: ApiTypes; 122 /** @format int64 */ 123 int?: number; 124 string?: string; 125 bool?: boolean; 126 /** @format float */ 127 float?: number; 128 array?: ApiAttribute[]; 129 map?: Record<string, ApiAttribute>; 130 /** @format date-time */ 131 time?: string; 132 imageUrl?: string; 133 icon?: string; 134 point?: string; 135 encrypted?: string; 136 } 137 138 export interface ApiAutomationRequest { 139 /** @format int64 */ 140 id: number; 141 name: string; 142 } 143 144 export interface ApiBusStateItem { 145 topic: string; 146 /** @format int32 */ 147 subscribers: number; 148 /** @format int64 */ 149 min: number; 150 /** @format int64 */ 151 max: number; 152 /** @format int64 */ 153 avg: number; 154 /** @format double */ 155 rps: number; 156 } 157 158 export interface ApiClient { 159 clientId: string; 160 username: string; 161 /** @format uint16 */ 162 keepAlive: number; 163 /** @format int32 */ 164 version: number; 165 willRetain: boolean; 166 /** @format uint8 */ 167 willQos: number; 168 willTopic: string; 169 willPayload: string; 170 remoteAddr: string; 171 localAddr: string; 172 /** @format uint32 */ 173 subscriptionsCurrent: number; 174 /** @format uint32 */ 175 subscriptionsTotal: number; 176 /** @format uint64 */ 177 packetsReceivedBytes: number; 178 /** @format uint64 */ 179 packetsReceivedNums: number; 180 /** @format uint64 */ 181 packetsSendBytes: number; 182 /** @format uint64 */ 183 packetsSendNums: number; 184 /** @format uint64 */ 185 messageDropped: number; 186 /** @format uint32 */ 187 inflightLen: number; 188 /** @format uint32 */ 189 queueLen: number; 190 /** @format date-time */ 191 connectedAt: string; 192 /** @format date-time */ 193 disconnectedAt?: string; 194 } 195 196 export interface ApiCondition { 197 /** @format int64 */ 198 id: number; 199 name: string; 200 description: string; 201 /** @format int64 */ 202 scriptId?: number; 203 script?: ApiScript; 204 area?: ApiArea; 205 /** @format int64 */ 206 areaId?: number; 207 /** @format date-time */ 208 createdAt: string; 209 /** @format date-time */ 210 updatedAt: string; 211 } 212 213 export interface ApiCurrentUser { 214 /** @format int64 */ 215 id?: number; 216 nickname?: string; 217 firstName?: string; 218 lastName?: string; 219 email?: string; 220 status?: string; 221 history?: ApiUserHistory[]; 222 image?: ApiImage; 223 /** @format int64 */ 224 signInCount?: number; 225 meta?: ApiUserMeta[]; 226 role?: ApiRole; 227 lang?: string; 228 /** @format date-time */ 229 createdAt?: string; 230 /** @format date-time */ 231 updatedAt?: string; 232 /** @format date-time */ 233 currentSignInAt?: string; 234 /** @format date-time */ 235 lastSignInAt?: string; 236 } 237 238 export interface ApiDashboard { 239 /** @format int64 */ 240 id: number; 241 name: string; 242 description: string; 243 enabled: boolean; 244 /** @format int64 */ 245 areaId?: number; 246 area?: ApiArea; 247 tabs: ApiDashboardTab[]; 248 entities: Record<string, ApiEntity>; 249 /** @format date-time */ 250 createdAt: string; 251 /** @format date-time */ 252 updatedAt: string; 253 } 254 255 export interface ApiDashboardCard { 256 /** @format int64 */ 257 id: number; 258 title: string; 259 /** @format int32 */ 260 height: number; 261 /** @format int32 */ 262 width: number; 263 background?: string; 264 /** @format int32 */ 265 weight: number; 266 enabled: boolean; 267 /** @format int64 */ 268 dashboardTabId: number; 269 /** 270 * @format byte 271 * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ 272 */ 273 payload: string; 274 items: ApiDashboardCardItem[]; 275 entities: Record<string, ApiEntity>; 276 hidden: boolean; 277 entityId?: string; 278 /** @format date-time */ 279 createdAt: string; 280 /** @format date-time */ 281 updatedAt: string; 282 } 283 284 export interface ApiDashboardCardItem { 285 /** @format int64 */ 286 id: number; 287 title: string; 288 type: string; 289 /** @format int32 */ 290 weight: number; 291 enabled: boolean; 292 /** @format int64 */ 293 dashboardCardId: number; 294 entityId?: string; 295 /** 296 * @format byte 297 * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ 298 */ 299 payload: string; 300 hidden: boolean; 301 frozen: boolean; 302 /** @format date-time */ 303 createdAt: string; 304 /** @format date-time */ 305 updatedAt: string; 306 } 307 308 export interface ApiDashboardShort { 309 /** @format int64 */ 310 id: number; 311 name: string; 312 description: string; 313 enabled: boolean; 314 /** @format int64 */ 315 areaId?: number; 316 area?: ApiArea; 317 /** @format date-time */ 318 createdAt: string; 319 /** @format date-time */ 320 updatedAt: string; 321 } 322 323 export interface ApiDashboardTab { 324 /** @format int64 */ 325 id: number; 326 name: string; 327 /** @format int32 */ 328 columnWidth: number; 329 gap: boolean; 330 background?: string; 331 icon: string; 332 enabled: boolean; 333 /** @format int32 */ 334 weight: number; 335 /** @format int64 */ 336 dashboardId: number; 337 cards: ApiDashboardCard[]; 338 entities: Record<string, ApiEntity>; 339 /** 340 * @format byte 341 * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ 342 */ 343 payload: string; 344 /** @format date-time */ 345 createdAt: string; 346 /** @format date-time */ 347 updatedAt: string; 348 } 349 350 export interface ApiDashboardTabShort { 351 /** @format int64 */ 352 id?: number; 353 name?: string; 354 /** @format int32 */ 355 columnWidth?: number; 356 gap?: boolean; 357 background?: string; 358 icon?: string; 359 enabled?: boolean; 360 /** @format int32 */ 361 weight?: number; 362 /** @format int64 */ 363 dashboardId?: number; 364 /** @format date-time */ 365 createdAt?: string; 366 /** @format date-time */ 367 updatedAt?: string; 368 } 369 370 export interface ApiDeviceBanRequest { 371 /** @format int64 */ 372 id: number; 373 friendlyName: string; 374 } 375 376 export interface ApiDeviceListResult { 377 items: ApiZigbee2MqttDevice[]; 378 meta?: ApiMeta; 379 } 380 381 export interface ApiDeviceRenameRequest { 382 friendlyName: string; 383 newName: string; 384 } 385 386 export interface ApiDeviceWhitelistRequest { 387 /** @format int64 */ 388 id: number; 389 friendlyName: string; 390 } 391 392 export type ApiDisablePluginResult = object; 393 394 export type ApiEnablePluginResult = object; 395 396 export interface ApiEntity { 397 id: string; 398 pluginName: string; 399 description: string; 400 area?: ApiArea; 401 image?: ApiImage; 402 icon?: string; 403 autoLoad: boolean; 404 restoreState: boolean; 405 parent?: ApiEntityParent; 406 actions: ApiEntityAction[]; 407 states: ApiEntityState[]; 408 scripts: ApiScript[]; 409 scriptIds: number[]; 410 attributes: Record<string, ApiAttribute>; 411 settings: Record<string, ApiAttribute>; 412 metrics: ApiMetric[]; 413 isLoaded?: boolean; 414 /** @format date-time */ 415 createdAt: string; 416 /** @format date-time */ 417 updatedAt: string; 418 tags: string[]; 419 } 420 421 export interface ApiEntityAction { 422 name: string; 423 description: string; 424 icon?: string; 425 image?: ApiImage; 426 script?: ApiScript; 427 /** @format int64 */ 428 scriptId?: number; 429 type: string; 430 } 431 432 export interface ApiEntityCallActionRequest { 433 id?: string; 434 name: string; 435 attributes: Record<string, ApiAttribute>; 436 tags: string[]; 437 /** @format int64 */ 438 areaId?: number; 439 } 440 441 export interface ApiEntityParent { 442 id: string; 443 } 444 445 export interface ApiEntityRequest { 446 id: string; 447 name: string; 448 } 449 450 export interface ApiEntityShort { 451 id: string; 452 pluginName: string; 453 description: string; 454 area?: ApiArea; 455 icon?: string; 456 autoLoad: boolean; 457 restoreState: boolean; 458 parentId?: string; 459 isLoaded?: boolean; 460 /** @format date-time */ 461 createdAt: string; 462 /** @format date-time */ 463 updatedAt: string; 464 tags: string[]; 465 } 466 467 export interface ApiEntityState { 468 name: string; 469 description: string; 470 icon?: string; 471 image?: ApiImage; 472 style: string; 473 } 474 475 export interface ApiEntityStorageFilter { 476 entityId: string; 477 description: string; 478 } 479 480 export interface ApiEntityStorage { 481 /** @format int64 */ 482 id: number; 483 entityId: string; 484 entity_description: string; 485 state: string; 486 state_description: string; 487 attributes: Record<string, ApiAttribute>; 488 /** @format date-time */ 489 createdAt: string; 490 } 491 492 export interface ApiEventBusStateListResult { 493 items: ApiBusStateItem[]; 494 meta?: ApiMeta; 495 } 496 497 export interface ApiExecScriptResult { 498 result: string; 499 } 500 501 export interface ApiExecSrcScriptRequest { 502 lang: string; 503 name: string; 504 source: string; 505 description: string; 506 } 507 508 export interface ApiGetActionListResult { 509 items: ApiAction[]; 510 meta?: ApiMeta; 511 } 512 513 export interface ApiGetAreaListResult { 514 items: ApiArea[]; 515 meta?: ApiMeta; 516 } 517 518 export interface ApiGetBackupListResult { 519 items: string[]; 520 meta?: ApiMeta; 521 } 522 523 export interface ApiGetBridgeListResult { 524 items: ApiZigbee2MqttShort[]; 525 meta?: ApiMeta; 526 } 527 528 export interface ApiGetClientListResult { 529 items: ApiClient[]; 530 meta?: ApiMeta; 531 } 532 533 export interface ApiGetConditionListResult { 534 items: ApiCondition[]; 535 meta?: ApiMeta; 536 } 537 538 export interface ApiGetDashboardCardItemListResult { 539 items: ApiDashboardCardItem[]; 540 meta?: ApiMeta; 541 } 542 543 export interface ApiGetDashboardCardListResult { 544 items: ApiDashboardCard[]; 545 meta?: ApiMeta; 546 } 547 548 export interface ApiGetDashboardListResult { 549 items: ApiDashboardShort[]; 550 meta?: ApiMeta; 551 } 552 553 export interface ApiGetDashboardTabListResult { 554 items: ApiDashboardTabShort[]; 555 meta?: ApiMeta; 556 } 557 558 export interface ApiGetEntityListResult { 559 items: ApiEntityShort[]; 560 meta?: ApiMeta; 561 } 562 563 export interface ApiGetEntityStorageResult { 564 items: ApiEntityStorage[]; 565 filter: ApiEntityStorageFilter[]; 566 meta: ApiMeta; 567 } 568 569 export interface ApiGetImageFilterListResult { 570 items: GetImageFilterListResultfilter[]; 571 } 572 573 export interface ApiGetImageListByDateResult { 574 items: ApiImage[]; 575 } 576 577 export interface ApiGetImageListResult { 578 items: ApiImage[]; 579 meta?: ApiMeta; 580 } 581 582 export interface ApiGetLogListResult { 583 items: ApiLog[]; 584 meta?: ApiMeta; 585 } 586 587 export interface ApiGetMessageDeliveryListResult { 588 items: ApiMessageDelivery[]; 589 meta?: ApiMeta; 590 } 591 592 export interface ApiGetPluginListResult { 593 items: ApiPluginShort[]; 594 meta?: ApiMeta; 595 } 596 597 export interface ApiGetRoleListResult { 598 items: ApiRole[]; 599 meta?: ApiMeta; 600 } 601 602 export interface ApiGetScriptListResult { 603 items: ApiScript[]; 604 meta?: ApiMeta; 605 } 606 607 export interface ApiGetSubscriptionListResult { 608 items: ApiSubscription[]; 609 meta?: ApiMeta; 610 } 611 612 export interface ApiGetTaskListResult { 613 items: ApiTask[]; 614 meta?: ApiMeta; 615 } 616 617 export interface ApiGetTriggerListResult { 618 items: ApiTrigger[]; 619 meta?: ApiMeta; 620 } 621 622 export interface ApiGetUserListResult { 623 items: ApiUserShot[]; 624 meta?: ApiMeta; 625 } 626 627 export interface ApiGetVariableListResult { 628 items: ApiVariable[]; 629 meta?: ApiMeta; 630 } 631 632 export interface ApiGetTagListResult { 633 items: ApiTag[]; 634 meta?: ApiMeta; 635 } 636 637 export interface ApiBackup { 638 name: string; 639 /** @format int64 */ 640 size: number; 641 /** @format uint32 */ 642 fileMode: number; 643 /** @format date-time */ 644 modTime: string; 645 } 646 647 export interface ApiImage { 648 /** @format int64 */ 649 id: number; 650 thumb: string; 651 url: string; 652 image: string; 653 mimeType: string; 654 title: string; 655 /** @format int64 */ 656 size: number; 657 name: string; 658 /** @format date-time */ 659 createdAt: string; 660 } 661 662 export interface ApiLog { 663 /** @format int64 */ 664 id: number; 665 level: string; 666 body: string; 667 owner: string; 668 /** @format date-time */ 669 createdAt: string; 670 } 671 672 export interface ApiMessage { 673 /** @format int64 */ 674 id: number; 675 type: string; 676 entityId?: string; 677 attributes: Record<string, string>; 678 /** @format date-time */ 679 createdAt: string; 680 /** @format date-time */ 681 updatedAt: string; 682 } 683 684 export interface ApiMessageDelivery { 685 /** @format int64 */ 686 id: number; 687 message: ApiMessage; 688 address: string; 689 status: string; 690 errorMessageStatus?: string; 691 errorMessageBody?: string; 692 /** @format date-time */ 693 createdAt: string; 694 /** @format date-time */ 695 updatedAt: string; 696 } 697 698 export interface ApiPagination { 699 /** @format uint64 */ 700 limit: number; 701 /** @format uint64 */ 702 page: number; 703 /** @format uint64 */ 704 total: number; 705 } 706 707 export interface ApiMeta { 708 pagination: ApiPagination; 709 sort: string; 710 } 711 712 export interface ApiMetric { 713 /** @format int64 */ 714 id: number; 715 name: string; 716 description: string; 717 options?: ApiMetricOption; 718 data: ApiMetricOptionData[]; 719 type: string; 720 ranges: string[]; 721 /** @format date-time */ 722 createdAt: string; 723 /** @format date-time */ 724 updatedAt: string; 725 } 726 727 export interface ApiMetricOption { 728 items: ApiMetricOptionItem[]; 729 } 730 731 export interface ApiMetricOptionData { 732 value: Record<string, any>; 733 /** @format int64 */ 734 metricId?: number; 735 /** @format date-time */ 736 time: string; 737 } 738 739 export interface ApiMetricOptionItem { 740 name: string; 741 description: string; 742 color: string; 743 translate: string; 744 label: string; 745 } 746 747 export interface ApiNetworkmapResponse { 748 networkmap: string; 749 } 750 751 export interface ApiNewActionRequest { 752 name: string; 753 description: string; 754 /** @format int64 */ 755 scriptId?: number; 756 /** @format int64 */ 757 areaId?: number; 758 entityId?: string; 759 entityActionName?: string; 760 } 761 762 export interface ApiNewAreaRequest { 763 name: string; 764 description: string; 765 polygon: ApiAreaLocation[]; 766 center?: ApiAreaLocation; 767 /** @format float */ 768 zoom: number; 769 /** @format float */ 770 resolution: number; 771 } 772 773 export interface ApiNewConditionRequest { 774 name: string; 775 description: string; 776 /** @format int64 */ 777 scriptId?: number; 778 /** @format int64 */ 779 areaId?: number; 780 } 781 782 export interface ApiNewDashboardCardItemRequest { 783 title: string; 784 type: string; 785 /** @format int32 */ 786 weight: number; 787 enabled: boolean; 788 /** @format int64 */ 789 dashboardCardId: number; 790 entityId?: string; 791 /** 792 * @format byte 793 * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ 794 */ 795 payload: string; 796 hidden: boolean; 797 frozen: boolean; 798 } 799 800 export interface ApiNewDashboardCardRequest { 801 title: string; 802 /** @format int32 */ 803 height: number; 804 /** @format int32 */ 805 width: number; 806 background?: string; 807 /** @format int32 */ 808 weight: number; 809 enabled: boolean; 810 /** @format int64 */ 811 dashboardTabId: number; 812 /** 813 * @format byte 814 * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ 815 */ 816 payload: string; 817 hidden: boolean; 818 entityId?: string; 819 } 820 821 export interface ApiNewDashboardRequest { 822 name: string; 823 description: string; 824 enabled: boolean; 825 /** @format int64 */ 826 areaId?: number; 827 } 828 829 export interface ApiNewDashboardTabRequest { 830 name: string; 831 /** @format int32 */ 832 columnWidth: number; 833 gap: boolean; 834 background?: string; 835 icon: string; 836 enabled: boolean; 837 /** @format int32 */ 838 weight: number; 839 /** @format int64 */ 840 dashboardId: number; 841 /** 842 * @format byte 843 * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ 844 */ 845 payload: string; 846 } 847 848 export interface ApiNewEntityRequest { 849 name: string; 850 pluginName: string; 851 description: string; 852 /** @format int64 */ 853 areaId?: number; 854 icon?: string; 855 /** @format int64 */ 856 imageId?: number; 857 autoLoad: boolean; 858 restoreState: boolean; 859 parentId?: string; 860 actions: ApiNewEntityRequestAction[]; 861 states: ApiNewEntityRequestState[]; 862 attributes: Record<string, ApiAttribute>; 863 settings: Record<string, ApiAttribute>; 864 metrics: ApiMetric[]; 865 scriptIds: number[]; 866 tags: string[]; 867 } 868 869 export interface ApiNewEntityRequestAction { 870 name: string; 871 description: string; 872 icon?: string; 873 /** @format int64 */ 874 imageId?: number; 875 /** @format int64 */ 876 scriptId?: number; 877 type: string; 878 } 879 880 export interface ApiNewEntityRequestState { 881 name: string; 882 description: string; 883 icon?: string; 884 /** @format int64 */ 885 imageId?: number; 886 style: string; 887 } 888 889 export interface ApiNewImageRequest { 890 thumb: string; 891 image: string; 892 mimeType: string; 893 title: string; 894 /** @format int64 */ 895 size: number; 896 name: string; 897 } 898 899 export interface ApiNewRoleRequest { 900 name: string; 901 description: string; 902 parent?: string; 903 } 904 905 export interface ApiNewScriptRequest { 906 lang: string; 907 name: string; 908 source: string; 909 description: string; 910 } 911 912 export interface ApiNewTaskRequest { 913 name: string; 914 description: string; 915 enabled: boolean; 916 condition: string; 917 triggerIds: number[]; 918 conditionIds: number[]; 919 actionIds: number[]; 920 /** @format int64 */ 921 areaId?: number; 922 } 923 924 export interface ApiNewTriggerRequest { 925 name: string; 926 description: string; 927 entityIds: string[]; 928 script?: ApiScript; 929 /** @format int64 */ 930 scriptId?: number; 931 pluginName: string; 932 attributes: Record<string, ApiAttribute>; 933 enabled: boolean; 934 /** @format int64 */ 935 areaId?: number; 936 } 937 938 export interface ApiNewVariableRequest { 939 name: string; 940 value: string; 941 tags: string[]; 942 } 943 944 export interface ApiNewZigbee2MqttRequest { 945 name: string; 946 login: string; 947 password?: string; 948 permitJoin: boolean; 949 baseTopic: string; 950 } 951 952 export interface ApiNewtUserRequest { 953 nickname: string; 954 firstName?: string; 955 lastName?: string; 956 password: string; 957 passwordRepeat: string; 958 email: string; 959 status?: string; 960 lang?: string; 961 /** @format int64 */ 962 imageId?: number; 963 roleName: string; 964 meta?: ApiUserMeta[]; 965 } 966 967 export interface ApiPasswordResetRequest { 968 email: string; 969 token?: string; 970 newPassword?: string; 971 } 972 973 export interface ApiPlugin { 974 name: string; 975 version: string; 976 enabled: boolean; 977 system: boolean; 978 actor: boolean; 979 settings: Record<string, ApiAttribute>; 980 options?: ApiPluginOptionsResult; 981 isLoaded?: boolean; 982 } 983 984 export interface ApiPluginOptionsResult { 985 triggers: boolean; 986 actors: boolean; 987 actorCustomAttrs: boolean; 988 actorAttrs: Record<string, ApiAttribute>; 989 actorCustomActions: boolean; 990 actorActions: Record<string, ApiPluginOptionsResultEntityAction>; 991 actorCustomStates: boolean; 992 actorStates: Record<string, ApiPluginOptionsResultEntityState>; 993 actorCustomSetts: boolean; 994 actorSetts: Record<string, ApiAttribute>; 995 setts: Record<string, ApiAttribute>; 996 } 997 998 export interface ApiPluginOptionsResultEntityAction { 999 name: string; 1000 description: string; 1001 imageUrl: string; 1002 icon: string; 1003 } 1004 1005 export interface ApiPluginOptionsResultEntityState { 1006 name: string; 1007 description: string; 1008 imageUrl: string; 1009 icon: string; 1010 } 1011 1012 export interface ApiPluginShort { 1013 name: string; 1014 version: string; 1015 enabled: boolean; 1016 system: boolean; 1017 actor?: boolean; 1018 isLoaded?: boolean; 1019 } 1020 1021 export interface ApiReloadRequest { 1022 id: string; 1023 } 1024 1025 export interface ApiResponse { 1026 id?: string; 1027 query?: string; 1028 /** 1029 * @format byte 1030 * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ 1031 */ 1032 body?: string; 1033 } 1034 1035 export interface ApiRestoreBackupRequest { 1036 name: string; 1037 } 1038 1039 export interface ApiRole { 1040 parent?: ApiRole; 1041 name: string; 1042 description: string; 1043 children: ApiRole[]; 1044 accessList?: ApiRoleAccessList; 1045 /** @format date-time */ 1046 createdAt: string; 1047 /** @format date-time */ 1048 updatedAt: string; 1049 } 1050 1051 export interface ApiRoleAccessList { 1052 levels: Record<string, AccessListListOfString>; 1053 } 1054 1055 export interface ApiRoleAccessListResult { 1056 levels: Record<string, ApiAccessLevels>; 1057 } 1058 1059 export interface ApiScriptVersion { 1060 /** @format int64 */ 1061 id: number; 1062 lang: string; 1063 source: string; 1064 /** @format date-time */ 1065 createdAt: string; 1066 } 1067 1068 export interface ApiTag { 1069 /** @format int64 */ 1070 id: number; 1071 name: string; 1072 } 1073 1074 export interface ApiScript { 1075 /** @format int64 */ 1076 id: number; 1077 lang: string; 1078 name: string; 1079 source: string; 1080 description: string; 1081 scriptInfo?: ApiScriptInfo; 1082 versions: ApiScriptVersion[]; 1083 /** @format date-time */ 1084 createdAt: string; 1085 /** @format date-time */ 1086 updatedAt: string; 1087 } 1088 1089 export interface ApiScriptInfo { 1090 /** @format int32 */ 1091 alexaIntents: number; 1092 /** @format int32 */ 1093 entityActions: number; 1094 /** @format int32 */ 1095 entityScripts: number; 1096 /** @format int32 */ 1097 automationTriggers: number; 1098 /** @format int32 */ 1099 automationConditions: number; 1100 /** @format int32 */ 1101 automationActions: number; 1102 } 1103 1104 export interface ApiSearchActionResult { 1105 items: ApiAction[]; 1106 } 1107 1108 export interface ApiSearchAreaResult { 1109 items: ApiArea[]; 1110 } 1111 1112 export interface ApiSearchConditionResult { 1113 items: ApiCondition[]; 1114 } 1115 1116 export interface ApiSearchDashboardResult { 1117 items: ApiDashboard[]; 1118 } 1119 1120 export interface ApiSearchDeviceResult { 1121 items: ApiZigbee2MqttDevice[]; 1122 } 1123 1124 export interface ApiSearchEntityResult { 1125 items: ApiEntityShort[]; 1126 } 1127 1128 export interface ApiSearchPluginResult { 1129 items: ApiPluginShort[]; 1130 } 1131 1132 export interface ApiSearchRoleListResult { 1133 items: ApiRole[]; 1134 } 1135 1136 export interface ApiSearchScriptListResult { 1137 items: ApiScript[]; 1138 } 1139 1140 export interface ApiSearchTagListResult { 1141 items: ApiTag[]; 1142 } 1143 1144 export interface ApiSearchTriggerResult { 1145 items: ApiTrigger[]; 1146 } 1147 1148 export interface ApiSearchVariableResult { 1149 items: ApiVariable[]; 1150 } 1151 1152 export interface ApiSigninResponse { 1153 currentUser?: ApiCurrentUser; 1154 accessToken: string; 1155 } 1156 1157 export interface ApiStatistic { 1158 name: string; 1159 description: string; 1160 /** @format int32 */ 1161 value: number; 1162 /** @format int32 */ 1163 diff: number; 1164 } 1165 1166 export interface ApiStatistics { 1167 items: ApiStatistic[]; 1168 } 1169 1170 export interface ApiSubscription { 1171 /** @format uint32 */ 1172 id: number; 1173 clientId: string; 1174 topicName: string; 1175 name: string; 1176 /** @format uint32 */ 1177 qos: number; 1178 noLocal: boolean; 1179 retainAsPublished: boolean; 1180 /** @format uint32 */ 1181 retainHandling: number; 1182 } 1183 1184 export interface ApiTask { 1185 /** @format int64 */ 1186 id: number; 1187 name: string; 1188 description: string; 1189 enabled: boolean; 1190 condition: string; 1191 triggers: ApiTrigger[]; 1192 conditions: ApiCondition[]; 1193 actions: ApiAction[]; 1194 area?: ApiArea; 1195 /** @format int64 */ 1196 areaId?: number; 1197 isLoaded?: boolean; 1198 triggerIds: number[]; 1199 conditionIds: number[]; 1200 actionIds: number[]; 1201 completed?: boolean; 1202 telemetry: ApiTelemetryItem[]; 1203 /** @format date-time */ 1204 createdAt: string; 1205 /** @format date-time */ 1206 updatedAt: string; 1207 } 1208 1209 export interface ApiTelemetryItem { 1210 name: string; 1211 /** @format int32 */ 1212 num: number; 1213 /** @format int64 */ 1214 start: number; 1215 /** @format int64 */ 1216 end?: number; 1217 /** @format int64 */ 1218 timeEstimate: number; 1219 attributes: Record<string, string>; 1220 status: string; 1221 /** @format int32 */ 1222 level: number; 1223 } 1224 1225 export interface ApiTrigger { 1226 /** @format int64 */ 1227 id: number; 1228 name: string; 1229 description: string; 1230 entities: ApiEntityShort[]; 1231 entityIds: string[]; 1232 script?: ApiScript; 1233 /** @format int64 */ 1234 scriptId?: number; 1235 area?: ApiArea; 1236 /** @format int64 */ 1237 areaId?: number; 1238 pluginName: string; 1239 attributes: Record<string, ApiAttribute>; 1240 enabled: boolean; 1241 isLoaded?: boolean; 1242 completed?: boolean; 1243 /** @format date-time */ 1244 createdAt: string; 1245 /** @format date-time */ 1246 updatedAt: string; 1247 } 1248 1249 /** @default "INT" */ 1250 export enum ApiTypes { 1251 INT = "INT", 1252 STRING = "STRING", 1253 FLOAT = "FLOAT", 1254 BOOL = "BOOL", 1255 ARRAY = "ARRAY", 1256 MAP = "MAP", 1257 TIME = "TIME", 1258 IMAGE = "IMAGE", 1259 ICON = "ICON", 1260 POINT = "POINT", 1261 ENCRYPTED = "ENCRYPTED", 1262 } 1263 1264 export interface ApiUpdateEntityRequestAction { 1265 name: string; 1266 description: string; 1267 icon?: string; 1268 /** @format int64 */ 1269 imageId?: number; 1270 /** @format int64 */ 1271 scriptId?: number; 1272 type: string; 1273 } 1274 1275 export interface ApiUpdateEntityRequestState { 1276 name: string; 1277 description: string; 1278 icon?: string; 1279 /** @format int64 */ 1280 imageId?: number; 1281 style: string; 1282 } 1283 1284 export interface ApiUserFull { 1285 /** @format int64 */ 1286 id: number; 1287 nickname: string; 1288 firstName?: string; 1289 lastName?: string; 1290 email: string; 1291 status: string; 1292 history: ApiUserHistory[]; 1293 image?: ApiImage; 1294 /** @format int64 */ 1295 signInCount: number; 1296 meta: ApiUserMeta[]; 1297 role: ApiRole; 1298 roleName: string; 1299 lang: string; 1300 authenticationToken: string; 1301 currentSignInIp?: string; 1302 lastSignInIp?: string; 1303 user?: ApiUserFullParent; 1304 /** @format date-time */ 1305 createdAt: string; 1306 /** @format date-time */ 1307 updatedAt: string; 1308 /** @format date-time */ 1309 currentSignInAt?: string; 1310 /** @format date-time */ 1311 lastSignInAt?: string; 1312 /** @format date-time */ 1313 resetPasswordSentAt?: string; 1314 /** @format date-time */ 1315 deletedAt?: string; 1316 } 1317 1318 export interface ApiUserFullParent { 1319 /** @format int64 */ 1320 id: number; 1321 nickname: string; 1322 } 1323 1324 export interface ApiUserHistory { 1325 ip: string; 1326 /** @format date-time */ 1327 time: string; 1328 } 1329 1330 export interface ApiUserMeta { 1331 key: string; 1332 value: string; 1333 } 1334 1335 export interface ApiUserShot { 1336 /** @format int64 */ 1337 id: number; 1338 nickname: string; 1339 firstName?: string; 1340 lastName?: string; 1341 email: string; 1342 status: string; 1343 image?: ApiImage; 1344 lang: string; 1345 role: ApiRole; 1346 roleName: string; 1347 user?: ApiUserShotParent; 1348 /** @format date-time */ 1349 createdAt: string; 1350 /** @format date-time */ 1351 updatedAt: string; 1352 } 1353 1354 export interface ApiUserShotParent { 1355 /** @format int64 */ 1356 id: number; 1357 nickname: string; 1358 } 1359 1360 export interface ApiVariable { 1361 name: string; 1362 value: string; 1363 system: boolean; 1364 tags: string[]; 1365 /** @format date-time */ 1366 createdAt: string; 1367 /** @format date-time */ 1368 updatedAt: string; 1369 } 1370 1371 export interface ApiZigbee2Mqtt { 1372 scanInProcess: boolean; 1373 /** @format date-time */ 1374 lastScan?: string; 1375 networkmap: string; 1376 status: string; 1377 /** @format int64 */ 1378 id: number; 1379 name: string; 1380 login: string; 1381 permitJoin: boolean; 1382 baseTopic: string; 1383 /** @format date-time */ 1384 createdAt: string; 1385 /** @format date-time */ 1386 updatedAt: string; 1387 } 1388 1389 export interface ApiZigbee2MqttDevice { 1390 id: string; 1391 /** @format int64 */ 1392 zigbee2mqttId: number; 1393 name: string; 1394 type: string; 1395 model: string; 1396 description: string; 1397 manufacturer: string; 1398 functions: string[]; 1399 imageUrl: string; 1400 icon: string; 1401 status: string; 1402 /** @format date-time */ 1403 createdAt: string; 1404 /** @format date-time */ 1405 updatedAt: string; 1406 } 1407 1408 export interface ApiZigbee2MqttShort { 1409 /** @format int64 */ 1410 id: number; 1411 name: string; 1412 login: string; 1413 permitJoin: boolean; 1414 baseTopic: string; 1415 /** @format date-time */ 1416 createdAt: string; 1417 /** @format date-time */ 1418 updatedAt: string; 1419 } 1420 1421 /** 1422 * `Any` contains an arbitrary serialized protocol buffer message along with a 1423 * URL that describes the type of the serialized message. 1424 * 1425 * Protobuf library provides support to pack/unpack Any values in the form 1426 * of utility functions or additional generated methods of the Any type. 1427 * 1428 * Example 1: Pack and unpack a message in C++. 1429 * 1430 * Foo foo = ...; 1431 * Any any; 1432 * any.PackFrom(foo); 1433 * ... 1434 * if (any.UnpackTo(&foo)) { 1435 * ... 1436 * } 1437 * 1438 * Example 2: Pack and unpack a message in Java. 1439 * 1440 * Foo foo = ...; 1441 * Any any = Any.pack(foo); 1442 * ... 1443 * if (any.is(Foo.class)) { 1444 * foo = any.unpack(Foo.class); 1445 * } 1446 * 1447 * Example 3: Pack and unpack a message in Python. 1448 * 1449 * foo = Foo(...) 1450 * any = Any() 1451 * any.Pack(foo) 1452 * ... 1453 * if any.Is(Foo.DESCRIPTOR): 1454 * any.Unpack(foo) 1455 * ... 1456 * 1457 * Example 4: Pack and unpack a message in Go 1458 * 1459 * foo := &pb.Foo{...} 1460 * any, err := anypb.New(foo) 1461 * if err != nil { 1462 * ... 1463 * } 1464 * ... 1465 * foo := &pb.Foo{} 1466 * if err := any.UnmarshalTo(foo); err != nil { 1467 * ... 1468 * } 1469 * 1470 * The pack methods provided by protobuf library will by default use 1471 * 'type.googleapis.com/full.type.name' as the type URL and the unpack 1472 * methods only use the fully qualified type name after the last '/' 1473 * in the type URL, for example "foo.bar.com/x/y.z" will yield type 1474 * name "y.z". 1475 * 1476 * 1477 * JSON 1478 * 1479 * The JSON representation of an `Any` value uses the regular 1480 * representation of the deserialized, embedded message, with an 1481 * additional field `@type` which contains the type URL. Example: 1482 * 1483 * package google.profile; 1484 * message Person { 1485 * string first_name = 1; 1486 * string last_name = 2; 1487 * } 1488 * 1489 * { 1490 * "@type": "type.googleapis.com/google.profile.Person", 1491 * "firstName": <string>, 1492 * "lastName": <string> 1493 * } 1494 * 1495 * If the embedded message type is well-known and has a custom JSON 1496 * representation, that representation will be embedded adding a field 1497 * `value` which holds the custom JSON in addition to the `@type` 1498 * field. Example (for message [google.protobuf.Duration][]): 1499 * 1500 * { 1501 * "@type": "type.googleapis.com/google.protobuf.Duration", 1502 * "value": "1.212s" 1503 * } 1504 */ 1505 export interface ProtobufAny { 1506 /** 1507 * A URL/resource name that uniquely identifies the type of the serialized 1508 * protocol buffer message. This string must contain at least 1509 * one "/" character. The last segment of the URL's path must represent 1510 * the fully qualified name of the type (as in 1511 * `path/google.protobuf.Duration`). The name should be in a canonical form 1512 * (e.g., leading "." is not accepted). 1513 * 1514 * In practice, teams usually precompile into the binary all types that they 1515 * expect it to use in the context of Any. However, for URLs which use the 1516 * scheme `http`, `https`, or no scheme, one can optionally set up a type 1517 * server that maps type URLs to message definitions as follows: 1518 * 1519 * * If no scheme is provided, `https` is assumed. 1520 * * An HTTP GET on the URL must yield a [google.protobuf.Type][] 1521 * value in binary format, or produce an error. 1522 * * Applications are allowed to cache lookup results based on the 1523 * URL, or have them precompiled into a binary to avoid any 1524 * lookup. Therefore, binary compatibility needs to be preserved 1525 * on changes to types. (Use versioned type names to manage 1526 * breaking changes.) 1527 * 1528 * Note: this functionality is not currently available in the official 1529 * protobuf release, and it is not used for type URLs beginning with 1530 * type.googleapis.com. 1531 * 1532 * Schemes other than `http`, `https` (or the empty scheme) might be 1533 * used with implementation specific semantics. 1534 */ 1535 "@type"?: string; 1536 [key: string]: any; 1537 } 1538 1539 export interface RpcStatus { 1540 /** @format int32 */ 1541 code?: number; 1542 message?: string; 1543 details?: ProtobufAny[]; 1544 } 1545 1546 import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse, HeadersDefaults, ResponseType } from "axios"; 1547 1548 export type QueryParamsType = Record<string | number, any>; 1549 1550 export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> { 1551 /** set parameter to `true` for call `securityWorker` for this request */ 1552 secure?: boolean; 1553 /** request path */ 1554 path: string; 1555 /** content type of request body */ 1556 type?: ContentType; 1557 /** query params */ 1558 query?: QueryParamsType; 1559 /** format of response (i.e. response.json() -> format: "json") */ 1560 format?: ResponseType; 1561 /** request body */ 1562 body?: unknown; 1563 } 1564 1565 export type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">; 1566 1567 export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, "data" | "cancelToken"> { 1568 securityWorker?: ( 1569 securityData: SecurityDataType | null, 1570 ) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void; 1571 secure?: boolean; 1572 format?: ResponseType; 1573 } 1574 1575 export enum ContentType { 1576 Json = "application/json", 1577 FormData = "multipart/form-data", 1578 UrlEncoded = "application/x-www-form-urlencoded", 1579 Text = "text/plain", 1580 } 1581 1582 export class HttpClient<SecurityDataType = unknown> { 1583 public instance: AxiosInstance; 1584 private securityData: SecurityDataType | null = null; 1585 private securityWorker?: ApiConfig<SecurityDataType>["securityWorker"]; 1586 private secure?: boolean; 1587 private format?: ResponseType; 1588 1589 constructor({ securityWorker, secure, format, ...axiosConfig }: ApiConfig<SecurityDataType> = {}) { 1590 this.instance = axios.create({ ...axiosConfig, baseURL: axiosConfig.baseURL || "/" }); 1591 this.secure = secure; 1592 this.format = format; 1593 this.securityWorker = securityWorker; 1594 } 1595 1596 public setSecurityData = (data: SecurityDataType | null) => { 1597 this.securityData = data; 1598 }; 1599 1600 protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig { 1601 const method = params1.method || (params2 && params2.method); 1602 1603 return { 1604 ...this.instance.defaults, 1605 ...params1, 1606 ...(params2 || {}), 1607 headers: { 1608 ...((method && this.instance.defaults.headers[method.toLowerCase() as keyof HeadersDefaults]) || {}), 1609 ...(params1.headers || {}), 1610 ...((params2 && params2.headers) || {}), 1611 }, 1612 }; 1613 } 1614 1615 protected stringifyFormItem(formItem: unknown) { 1616 if (typeof formItem === "object" && formItem !== null) { 1617 return JSON.stringify(formItem); 1618 } else { 1619 return `${formItem}`; 1620 } 1621 } 1622 1623 protected createFormData(input: Record<string, unknown>): FormData { 1624 return Object.keys(input || {}).reduce((formData, key) => { 1625 const property = input[key]; 1626 const propertyContent: any[] = property instanceof Array ? property : [property]; 1627 1628 for (const formItem of propertyContent) { 1629 const isFileType = formItem instanceof Blob || formItem instanceof File; 1630 formData.append(key, isFileType ? formItem : this.stringifyFormItem(formItem)); 1631 } 1632 1633 return formData; 1634 }, new FormData()); 1635 } 1636 1637 public request = async <T = any, _E = any>({ 1638 secure, 1639 path, 1640 type, 1641 query, 1642 format, 1643 body, 1644 ...params 1645 }: FullRequestParams): Promise<AxiosResponse<T>> => { 1646 const secureParams = 1647 ((typeof secure === "boolean" ? secure : this.secure) && 1648 this.securityWorker && 1649 (await this.securityWorker(this.securityData))) || 1650 {}; 1651 const requestParams = this.mergeRequestParams(params, secureParams); 1652 const responseFormat = format || this.format || undefined; 1653 1654 if (type === ContentType.FormData && body && body !== null && typeof body === "object") { 1655 body = this.createFormData(body as Record<string, unknown>); 1656 } 1657 1658 if (type === ContentType.Text && body && body !== null && typeof body !== "string") { 1659 body = JSON.stringify(body); 1660 } 1661 1662 return this.instance.request({ 1663 ...requestParams, 1664 headers: { 1665 ...(requestParams.headers || {}), 1666 ...(type && type !== ContentType.FormData ? { "Content-Type": type } : {}), 1667 }, 1668 params: query, 1669 responseType: responseFormat, 1670 data: body, 1671 url: path, 1672 }); 1673 }; 1674 } 1675 1676 /** 1677 * @title Smart home api 1678 * @version 1.0 1679 * @baseUrl / 1680 * @contact Alex Filippov <support@e154.ru> (https://e154.github.io/smart-home/) 1681 * 1682 * This documentation describes APIs found under https://github.com/e154/smart-home 1683 */ 1684 export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> { 1685 v1 = { 1686 /** 1687 * No description 1688 * 1689 * @tags AuthService 1690 * @name AuthServiceAccessList 1691 * @summary get user access list object 1692 * @request GET:/v1/access_list 1693 * @secure 1694 */ 1695 authServiceAccessList: (params: RequestParams = {}) => 1696 this.request< 1697 ApiAccessListResponse, 1698 { 1699 error?: GenericErrorResponse & { 1700 code?: "UNAUTHORIZED"; 1701 }; 1702 } 1703 >({ 1704 path: `/v1/access_list`, 1705 method: "GET", 1706 secure: true, 1707 format: "json", 1708 ...params, 1709 }), 1710 1711 /** 1712 * No description 1713 * 1714 * @tags ActionService 1715 * @name ActionServiceAddAction 1716 * @summary add new action 1717 * @request POST:/v1/action 1718 * @secure 1719 */ 1720 actionServiceAddAction: (data: ApiNewActionRequest, params: RequestParams = {}) => 1721 this.request< 1722 ApiAction, 1723 | { 1724 error?: GenericErrorResponse; 1725 } 1726 | { 1727 error?: GenericErrorResponse & { 1728 code?: "UNAUTHORIZED"; 1729 }; 1730 } 1731 >({ 1732 path: `/v1/action`, 1733 method: "POST", 1734 body: data, 1735 secure: true, 1736 type: ContentType.Json, 1737 format: "json", 1738 ...params, 1739 }), 1740 1741 /** 1742 * No description 1743 * 1744 * @tags ActionService 1745 * @name ActionServiceGetActionById 1746 * @summary get action by id 1747 * @request GET:/v1/action/{id} 1748 * @secure 1749 */ 1750 actionServiceGetActionById: (id: number, params: RequestParams = {}) => 1751 this.request< 1752 ApiAction, 1753 | { 1754 error?: GenericErrorResponse & { 1755 code?: "UNAUTHORIZED"; 1756 }; 1757 } 1758 | { 1759 error?: GenericErrorResponse; 1760 } 1761 >({ 1762 path: `/v1/action/${id}`, 1763 method: "GET", 1764 secure: true, 1765 format: "json", 1766 ...params, 1767 }), 1768 1769 /** 1770 * No description 1771 * 1772 * @tags ActionService 1773 * @name ActionServiceUpdateAction 1774 * @summary update action 1775 * @request PUT:/v1/action/{id} 1776 * @secure 1777 */ 1778 actionServiceUpdateAction: ( 1779 id: number, 1780 data: { 1781 name: string; 1782 description: string; 1783 /** @format int64 */ 1784 scriptId?: number; 1785 /** @format int64 */ 1786 areaId?: number; 1787 entityId?: string; 1788 entityActionName?: string; 1789 }, 1790 params: RequestParams = {}, 1791 ) => 1792 this.request< 1793 ApiAction, 1794 | { 1795 error?: GenericErrorResponse; 1796 } 1797 | { 1798 error?: GenericErrorResponse & { 1799 code?: "UNAUTHORIZED"; 1800 }; 1801 } 1802 >({ 1803 path: `/v1/action/${id}`, 1804 method: "PUT", 1805 body: data, 1806 secure: true, 1807 type: ContentType.Json, 1808 format: "json", 1809 ...params, 1810 }), 1811 1812 /** 1813 * No description 1814 * 1815 * @tags ActionService 1816 * @name ActionServiceDeleteAction 1817 * @summary delete action 1818 * @request DELETE:/v1/action/{id} 1819 * @secure 1820 */ 1821 actionServiceDeleteAction: (id: number, params: RequestParams = {}) => 1822 this.request< 1823 ApiDisablePluginResult, 1824 | { 1825 error?: GenericErrorResponse & { 1826 code?: "UNAUTHORIZED"; 1827 }; 1828 } 1829 | { 1830 error?: GenericErrorResponse; 1831 } 1832 >({ 1833 path: `/v1/action/${id}`, 1834 method: "DELETE", 1835 secure: true, 1836 format: "json", 1837 ...params, 1838 }), 1839 1840 /** 1841 * No description 1842 * 1843 * @tags ActionService 1844 * @name ActionServiceGetActionList 1845 * @summary get action list 1846 * @request GET:/v1/actions 1847 * @secure 1848 */ 1849 actionServiceGetActionList: ( 1850 query?: { 1851 /** 1852 * Field on which to sort and its direction 1853 * @example "-created_at" 1854 */ 1855 sort?: string; 1856 /** 1857 * Page number of the requested result set 1858 * @format uint64 1859 * @default 1 1860 * @example 1 1861 */ 1862 page?: number; 1863 /** 1864 * The number of results returned on a page 1865 * @format uint64 1866 */ 1867 limit?: number; 1868 /** The number of results returned on a page */ 1869 "ids[]"?: number[]; 1870 }, 1871 params: RequestParams = {}, 1872 ) => 1873 this.request< 1874 ApiGetActionListResult, 1875 { 1876 error?: GenericErrorResponse & { 1877 code?: "UNAUTHORIZED"; 1878 }; 1879 } 1880 >({ 1881 path: `/v1/actions`, 1882 method: "GET", 1883 query: query, 1884 secure: true, 1885 format: "json", 1886 ...params, 1887 }), 1888 1889 /** 1890 * No description 1891 * 1892 * @tags ActionService 1893 * @name ActionServiceSearchAction 1894 * @summary search action 1895 * @request GET:/v1/actions/search 1896 * @secure 1897 */ 1898 actionServiceSearchAction: ( 1899 query?: { 1900 query?: string; 1901 /** @format int64 */ 1902 offset?: number; 1903 /** @format int64 */ 1904 limit?: number; 1905 }, 1906 params: RequestParams = {}, 1907 ) => 1908 this.request< 1909 ApiSearchActionResult, 1910 { 1911 error?: GenericErrorResponse & { 1912 code?: "UNAUTHORIZED"; 1913 }; 1914 } 1915 >({ 1916 path: `/v1/actions/search`, 1917 method: "GET", 1918 query: query, 1919 secure: true, 1920 format: "json", 1921 ...params, 1922 }), 1923 1924 /** 1925 * No description 1926 * 1927 * @tags AreaService 1928 * @name AreaServiceAddArea 1929 * @summary add new area 1930 * @request POST:/v1/area 1931 * @secure 1932 */ 1933 areaServiceAddArea: (data: ApiNewAreaRequest, params: RequestParams = {}) => 1934 this.request< 1935 ApiArea, 1936 | { 1937 error?: GenericErrorResponse; 1938 } 1939 | { 1940 error?: GenericErrorResponse & { 1941 code?: "UNAUTHORIZED"; 1942 }; 1943 } 1944 >({ 1945 path: `/v1/area`, 1946 method: "POST", 1947 body: data, 1948 secure: true, 1949 type: ContentType.Json, 1950 format: "json", 1951 ...params, 1952 }), 1953 1954 /** 1955 * No description 1956 * 1957 * @tags AreaService 1958 * @name AreaServiceGetAreaById 1959 * @summary get area by id 1960 * @request GET:/v1/area/{id} 1961 * @secure 1962 */ 1963 areaServiceGetAreaById: (id: number, params: RequestParams = {}) => 1964 this.request< 1965 ApiArea, 1966 | { 1967 error?: GenericErrorResponse & { 1968 code?: "UNAUTHORIZED"; 1969 }; 1970 } 1971 | { 1972 error?: GenericErrorResponse; 1973 } 1974 >({ 1975 path: `/v1/area/${id}`, 1976 method: "GET", 1977 secure: true, 1978 format: "json", 1979 ...params, 1980 }), 1981 1982 /** 1983 * No description 1984 * 1985 * @tags AreaService 1986 * @name AreaServiceUpdateArea 1987 * @summary update area 1988 * @request PUT:/v1/area/{id} 1989 * @secure 1990 */ 1991 areaServiceUpdateArea: ( 1992 id: number, 1993 data: { 1994 name: string; 1995 description: string; 1996 polygon: ApiAreaLocation[]; 1997 center?: ApiAreaLocation; 1998 /** @format float */ 1999 zoom: number; 2000 /** @format float */ 2001 resolution: number; 2002 }, 2003 params: RequestParams = {}, 2004 ) => 2005 this.request< 2006 ApiArea, 2007 | { 2008 error?: GenericErrorResponse; 2009 } 2010 | { 2011 error?: GenericErrorResponse & { 2012 code?: "UNAUTHORIZED"; 2013 }; 2014 } 2015 >({ 2016 path: `/v1/area/${id}`, 2017 method: "PUT", 2018 body: data, 2019 secure: true, 2020 type: ContentType.Json, 2021 format: "json", 2022 ...params, 2023 }), 2024 2025 /** 2026 * No description 2027 * 2028 * @tags AreaService 2029 * @name AreaServiceDeleteArea 2030 * @summary delete area 2031 * @request DELETE:/v1/area/{id} 2032 * @secure 2033 */ 2034 areaServiceDeleteArea: (id: number, params: RequestParams = {}) => 2035 this.request< 2036 ApiDisablePluginResult, 2037 | { 2038 error?: GenericErrorResponse & { 2039 code?: "UNAUTHORIZED"; 2040 }; 2041 } 2042 | { 2043 error?: GenericErrorResponse; 2044 } 2045 >({ 2046 path: `/v1/area/${id}`, 2047 method: "DELETE", 2048 secure: true, 2049 format: "json", 2050 ...params, 2051 }), 2052 2053 /** 2054 * No description 2055 * 2056 * @tags AreaService 2057 * @name AreaServiceGetAreaList 2058 * @summary get area list 2059 * @request GET:/v1/areas 2060 * @secure 2061 */ 2062 areaServiceGetAreaList: ( 2063 query?: { 2064 /** 2065 * Field on which to sort and its direction 2066 * @example "-created_at" 2067 */ 2068 sort?: string; 2069 /** 2070 * Page number of the requested result set 2071 * @format uint64 2072 * @default 1 2073 * @example 1 2074 */ 2075 page?: number; 2076 /** 2077 * The number of results returned on a page 2078 * @format uint64 2079 */ 2080 limit?: number; 2081 }, 2082 params: RequestParams = {}, 2083 ) => 2084 this.request< 2085 ApiGetAreaListResult, 2086 { 2087 error?: GenericErrorResponse & { 2088 code?: "UNAUTHORIZED"; 2089 }; 2090 } 2091 >({ 2092 path: `/v1/areas`, 2093 method: "GET", 2094 query: query, 2095 secure: true, 2096 format: "json", 2097 ...params, 2098 }), 2099 2100 /** 2101 * No description 2102 * 2103 * @tags AreaService 2104 * @name AreaServiceSearchArea 2105 * @summary search area 2106 * @request GET:/v1/areas/search 2107 * @secure 2108 */ 2109 areaServiceSearchArea: ( 2110 query?: { 2111 query?: string; 2112 /** @format int64 */ 2113 offset?: number; 2114 /** @format int64 */ 2115 limit?: number; 2116 }, 2117 params: RequestParams = {}, 2118 ) => 2119 this.request< 2120 ApiSearchAreaResult, 2121 { 2122 error?: GenericErrorResponse & { 2123 code?: "UNAUTHORIZED"; 2124 }; 2125 } 2126 >({ 2127 path: `/v1/areas/search`, 2128 method: "GET", 2129 query: query, 2130 secure: true, 2131 format: "json", 2132 ...params, 2133 }), 2134 2135 /** 2136 * No description 2137 * 2138 * @tags BackupService 2139 * @name BackupServiceGetBackupList 2140 * @summary get backup list 2141 * @request GET:/v1/backups 2142 * @secure 2143 */ 2144 backupServiceGetBackupList: ( 2145 query?: { 2146 /** 2147 * Field on which to sort and its direction 2148 * @example "-created_at" 2149 */ 2150 sort?: string; 2151 /** 2152 * Page number of the requested result set 2153 * @format uint64 2154 * @default 1 2155 * @example 1 2156 */ 2157 page?: number; 2158 /** 2159 * The number of results returned on a page 2160 * @format uint64 2161 */ 2162 limit?: number; 2163 }, 2164 params: RequestParams = {}, 2165 ) => 2166 this.request< 2167 ApiGetBackupListResult, 2168 { 2169 error?: GenericErrorResponse & { 2170 code?: "UNAUTHORIZED"; 2171 }; 2172 } 2173 >({ 2174 path: `/v1/backups`, 2175 method: "GET", 2176 query: query, 2177 secure: true, 2178 format: "json", 2179 ...params, 2180 }), 2181 2182 /** 2183 * No description 2184 * 2185 * @tags BackupService 2186 * @name BackupServiceNewBackup 2187 * @summary new backup 2188 * @request POST:/v1/backups 2189 * @secure 2190 */ 2191 backupServiceNewBackup: (data: ApiDisablePluginResult, params: RequestParams = {}) => 2192 this.request< 2193 ApiDisablePluginResult, 2194 { 2195 error?: GenericErrorResponse & { 2196 code?: "UNAUTHORIZED"; 2197 }; 2198 } 2199 >({ 2200 path: `/v1/backups`, 2201 method: "POST", 2202 body: data, 2203 secure: true, 2204 type: ContentType.Json, 2205 format: "json", 2206 ...params, 2207 }), 2208 2209 /** 2210 * No description 2211 * 2212 * @tags BackupService 2213 * @name BackupServiceUploadBackup 2214 * @summary upload backup file 2215 * @request POST:/v1/backup/upload 2216 * @secure 2217 */ 2218 backupServiceUploadBackup: ( 2219 data: { 2220 filename?: File[]; 2221 }, 2222 params: RequestParams = {}, 2223 ) => 2224 this.request< 2225 ApiBackup, 2226 | { 2227 error?: GenericErrorResponse; 2228 } 2229 | { 2230 error?: GenericErrorResponse & { 2231 code?: "UNAUTHORIZED"; 2232 }; 2233 } 2234 >({ 2235 path: `/v1/backup/upload`, 2236 method: "POST", 2237 body: data, 2238 secure: true, 2239 type: ContentType.FormData, 2240 format: "json", 2241 ...params, 2242 }), 2243 2244 /** 2245 * No description 2246 * 2247 * @tags BackupService 2248 * @name BackupServiceApplyState 2249 * @summary apply state 2250 * @request POST:/v1/backup/apply 2251 * @secure 2252 */ 2253 backupServiceApplyState: (params: RequestParams = {}) => 2254 this.request< 2255 void, 2256 { 2257 error?: GenericErrorResponse & { 2258 code?: "UNAUTHORIZED"; 2259 }; 2260 } 2261 >({ 2262 path: `/v1/backup/apply`, 2263 method: "POST", 2264 secure: true, 2265 ...params, 2266 }), 2267 2268 /** 2269 * No description 2270 * 2271 * @tags BackupService 2272 * @name BackupServiceRevertState 2273 * @summary revert state 2274 * @request POST:/v1/backup/rollback 2275 * @secure 2276 */ 2277 backupServiceRevertState: (params: RequestParams = {}) => 2278 this.request< 2279 void, 2280 { 2281 error?: GenericErrorResponse & { 2282 code?: "UNAUTHORIZED"; 2283 }; 2284 } 2285 >({ 2286 path: `/v1/backup/rollback`, 2287 method: "POST", 2288 secure: true, 2289 ...params, 2290 }), 2291 2292 /** 2293 * No description 2294 * 2295 * @tags BackupService 2296 * @name BackupServiceRestoreBackup 2297 * @summary restore backup 2298 * @request PUT:/v1/backup/{name} 2299 * @secure 2300 */ 2301 backupServiceRestoreBackup: (name: string, params: RequestParams = {}) => 2302 this.request< 2303 ApiDisablePluginResult, 2304 { 2305 error?: GenericErrorResponse & { 2306 code?: "UNAUTHORIZED"; 2307 }; 2308 } 2309 >({ 2310 path: `/v1/backup/${name}`, 2311 method: "PUT", 2312 secure: true, 2313 format: "json", 2314 ...params, 2315 }), 2316 2317 /** 2318 * No description 2319 * 2320 * @tags BackupService 2321 * @name BackupServiceDeleteBackup 2322 * @summary delete backup 2323 * @request DELETE:/v1/backup/{name} 2324 * @secure 2325 */ 2326 backupServiceDeleteBackup: (name: string, params: RequestParams = {}) => 2327 this.request< 2328 ApiDisablePluginResult, 2329 | { 2330 error?: GenericErrorResponse & { 2331 code?: "UNAUTHORIZED"; 2332 }; 2333 } 2334 | { 2335 error?: GenericErrorResponse; 2336 } 2337 >({ 2338 path: `/v1/backup/${name}`, 2339 method: "DELETE", 2340 secure: true, 2341 format: "json", 2342 ...params, 2343 }), 2344 2345 /** 2346 * No description 2347 * 2348 * @tags ConditionService 2349 * @name ConditionServiceAddCondition 2350 * @summary add new condition 2351 * @request POST:/v1/condition 2352 * @secure 2353 */ 2354 conditionServiceAddCondition: (data: ApiNewConditionRequest, params: RequestParams = {}) => 2355 this.request< 2356 ApiCondition, 2357 | { 2358 error?: GenericErrorResponse; 2359 } 2360 | { 2361 error?: GenericErrorResponse & { 2362 code?: "UNAUTHORIZED"; 2363 }; 2364 } 2365 >({ 2366 path: `/v1/condition`, 2367 method: "POST", 2368 body: data, 2369 secure: true, 2370 type: ContentType.Json, 2371 format: "json", 2372 ...params, 2373 }), 2374 2375 /** 2376 * No description 2377 * 2378 * @tags ConditionService 2379 * @name ConditionServiceGetConditionById 2380 * @summary get condition by id 2381 * @request GET:/v1/condition/{id} 2382 * @secure 2383 */ 2384 conditionServiceGetConditionById: (id: number, params: RequestParams = {}) => 2385 this.request< 2386 ApiCondition, 2387 | { 2388 error?: GenericErrorResponse & { 2389 code?: "UNAUTHORIZED"; 2390 }; 2391 } 2392 | { 2393 error?: GenericErrorResponse; 2394 } 2395 >({ 2396 path: `/v1/condition/${id}`, 2397 method: "GET", 2398 secure: true, 2399 format: "json", 2400 ...params, 2401 }), 2402 2403 /** 2404 * No description 2405 * 2406 * @tags ConditionService 2407 * @name ConditionServiceUpdateCondition 2408 * @summary update condition 2409 * @request PUT:/v1/condition/{id} 2410 * @secure 2411 */ 2412 conditionServiceUpdateCondition: ( 2413 id: number, 2414 data: { 2415 name: string; 2416 description: string; 2417 /** @format int64 */ 2418 scriptId?: number; 2419 /** @format int64 */ 2420 areaId?: number; 2421 }, 2422 params: RequestParams = {}, 2423 ) => 2424 this.request< 2425 ApiCondition, 2426 | { 2427 error?: GenericErrorResponse; 2428 } 2429 | { 2430 error?: GenericErrorResponse & { 2431 code?: "UNAUTHORIZED"; 2432 }; 2433 } 2434 >({ 2435 path: `/v1/condition/${id}`, 2436 method: "PUT", 2437 body: data, 2438 secure: true, 2439 type: ContentType.Json, 2440 format: "json", 2441 ...params, 2442 }), 2443 2444 /** 2445 * No description 2446 * 2447 * @tags ConditionService 2448 * @name ConditionServiceDeleteCondition 2449 * @summary delete condition 2450 * @request DELETE:/v1/condition/{id} 2451 * @secure 2452 */ 2453 conditionServiceDeleteCondition: (id: number, params: RequestParams = {}) => 2454 this.request< 2455 ApiDisablePluginResult, 2456 | { 2457 error?: GenericErrorResponse & { 2458 code?: "UNAUTHORIZED"; 2459 }; 2460 } 2461 | { 2462 error?: GenericErrorResponse; 2463 } 2464 >({ 2465 path: `/v1/condition/${id}`, 2466 method: "DELETE", 2467 secure: true, 2468 format: "json", 2469 ...params, 2470 }), 2471 2472 /** 2473 * No description 2474 * 2475 * @tags ConditionService 2476 * @name ConditionServiceGetConditionList 2477 * @summary get condition list 2478 * @request GET:/v1/conditions 2479 * @secure 2480 */ 2481 conditionServiceGetConditionList: ( 2482 query?: { 2483 /** 2484 * Field on which to sort and its direction 2485 * @example "-created_at" 2486 */ 2487 sort?: string; 2488 /** 2489 * Page number of the requested result set 2490 * @format uint64 2491 * @default 1 2492 * @example 1 2493 */ 2494 page?: number; 2495 /** 2496 * The number of results returned on a page 2497 * @format uint64 2498 */ 2499 limit?: number; 2500 /** The number of results returned on a page */ 2501 "ids[]"?: number[]; 2502 }, 2503 params: RequestParams = {}, 2504 ) => 2505 this.request< 2506 ApiGetConditionListResult, 2507 { 2508 error?: GenericErrorResponse & { 2509 code?: "UNAUTHORIZED"; 2510 }; 2511 } 2512 >({ 2513 path: `/v1/conditions`, 2514 method: "GET", 2515 query: query, 2516 secure: true, 2517 format: "json", 2518 ...params, 2519 }), 2520 2521 /** 2522 * No description 2523 * 2524 * @tags ConditionService 2525 * @name ConditionServiceSearchCondition 2526 * @summary search condition 2527 * @request GET:/v1/conditions/search 2528 * @secure 2529 */ 2530 conditionServiceSearchCondition: ( 2531 query?: { 2532 query?: string; 2533 /** @format int64 */ 2534 offset?: number; 2535 /** @format int64 */ 2536 limit?: number; 2537 }, 2538 params: RequestParams = {}, 2539 ) => 2540 this.request< 2541 ApiSearchConditionResult, 2542 { 2543 error?: GenericErrorResponse & { 2544 code?: "UNAUTHORIZED"; 2545 }; 2546 } 2547 >({ 2548 path: `/v1/conditions/search`, 2549 method: "GET", 2550 query: query, 2551 secure: true, 2552 format: "json", 2553 ...params, 2554 }), 2555 2556 /** 2557 * No description 2558 * 2559 * @tags DashboardService 2560 * @name DashboardServiceAddDashboard 2561 * @summary add new dashboard 2562 * @request POST:/v1/dashboard 2563 * @secure 2564 */ 2565 dashboardServiceAddDashboard: (data: ApiNewDashboardRequest, params: RequestParams = {}) => 2566 this.request< 2567 ApiDashboard, 2568 | { 2569 error?: GenericErrorResponse; 2570 } 2571 | { 2572 error?: GenericErrorResponse & { 2573 code?: "UNAUTHORIZED"; 2574 }; 2575 } 2576 >({ 2577 path: `/v1/dashboard`, 2578 method: "POST", 2579 body: data, 2580 secure: true, 2581 type: ContentType.Json, 2582 format: "json", 2583 ...params, 2584 }), 2585 2586 /** 2587 * No description 2588 * 2589 * @tags DashboardService 2590 * @name DashboardServiceGetDashboardById 2591 * @summary get dashboard by id 2592 * @request GET:/v1/dashboard/{id} 2593 * @secure 2594 */ 2595 dashboardServiceGetDashboardById: (id: number, params: RequestParams = {}) => 2596 this.request< 2597 ApiDashboard, 2598 | { 2599 error?: GenericErrorResponse & { 2600 code?: "UNAUTHORIZED"; 2601 }; 2602 } 2603 | { 2604 error?: GenericErrorResponse; 2605 } 2606 >({ 2607 path: `/v1/dashboard/${id}`, 2608 method: "GET", 2609 secure: true, 2610 format: "json", 2611 ...params, 2612 }), 2613 2614 /** 2615 * No description 2616 * 2617 * @tags DashboardService 2618 * @name DashboardServiceUpdateDashboard 2619 * @summary update dashboard 2620 * @request PUT:/v1/dashboard/{id} 2621 * @secure 2622 */ 2623 dashboardServiceUpdateDashboard: ( 2624 id: number, 2625 data: { 2626 name: string; 2627 description: string; 2628 enabled: boolean; 2629 /** @format int64 */ 2630 areaId?: number; 2631 }, 2632 params: RequestParams = {}, 2633 ) => 2634 this.request< 2635 ApiDashboard, 2636 | { 2637 error?: GenericErrorResponse; 2638 } 2639 | { 2640 error?: GenericErrorResponse & { 2641 code?: "UNAUTHORIZED"; 2642 }; 2643 } 2644 >({ 2645 path: `/v1/dashboard/${id}`, 2646 method: "PUT", 2647 body: data, 2648 secure: true, 2649 type: ContentType.Json, 2650 format: "json", 2651 ...params, 2652 }), 2653 2654 /** 2655 * No description 2656 * 2657 * @tags DashboardService 2658 * @name DashboardServiceDeleteDashboard 2659 * @summary delete dashboard 2660 * @request DELETE:/v1/dashboard/{id} 2661 * @secure 2662 */ 2663 dashboardServiceDeleteDashboard: (id: number, params: RequestParams = {}) => 2664 this.request< 2665 ApiDisablePluginResult, 2666 | { 2667 error?: GenericErrorResponse & { 2668 code?: "UNAUTHORIZED"; 2669 }; 2670 } 2671 | { 2672 error?: GenericErrorResponse; 2673 } 2674 >({ 2675 path: `/v1/dashboard/${id}`, 2676 method: "DELETE", 2677 secure: true, 2678 format: "json", 2679 ...params, 2680 }), 2681 2682 /** 2683 * No description 2684 * 2685 * @tags DashboardCardService 2686 * @name DashboardCardServiceAddDashboardCard 2687 * @summary add new dashboard_card 2688 * @request POST:/v1/dashboard_card 2689 * @secure 2690 */ 2691 dashboardCardServiceAddDashboardCard: (data: ApiNewDashboardCardRequest, params: RequestParams = {}) => 2692 this.request< 2693 ApiDashboardCard, 2694 | { 2695 error?: GenericErrorResponse; 2696 } 2697 | { 2698 error?: GenericErrorResponse & { 2699 code?: "UNAUTHORIZED"; 2700 }; 2701 } 2702 >({ 2703 path: `/v1/dashboard_card`, 2704 method: "POST", 2705 body: data, 2706 secure: true, 2707 type: ContentType.Json, 2708 format: "json", 2709 ...params, 2710 }), 2711 2712 /** 2713 * No description 2714 * 2715 * @tags DashboardCardService 2716 * @name DashboardCardServiceImportDashboardCard 2717 * @summary import dashboard_card 2718 * @request POST:/v1/dashboard_card/import 2719 * @secure 2720 */ 2721 dashboardCardServiceImportDashboardCard: (data: ApiDashboardCard, params: RequestParams = {}) => 2722 this.request< 2723 ApiDashboardCard, 2724 | { 2725 error?: GenericErrorResponse; 2726 } 2727 | { 2728 error?: GenericErrorResponse & { 2729 code?: "UNAUTHORIZED"; 2730 }; 2731 } 2732 >({ 2733 path: `/v1/dashboard_card/import`, 2734 method: "POST", 2735 body: data, 2736 secure: true, 2737 type: ContentType.Json, 2738 format: "json", 2739 ...params, 2740 }), 2741 2742 /** 2743 * No description 2744 * 2745 * @tags DashboardCardService 2746 * @name DashboardCardServiceGetDashboardCardById 2747 * @summary get dashboard_card by id 2748 * @request GET:/v1/dashboard_card/{id} 2749 * @secure 2750 */ 2751 dashboardCardServiceGetDashboardCardById: (id: number, params: RequestParams = {}) => 2752 this.request< 2753 ApiDashboardCard, 2754 | { 2755 error?: GenericErrorResponse & { 2756 code?: "UNAUTHORIZED"; 2757 }; 2758 } 2759 | { 2760 error?: GenericErrorResponse; 2761 } 2762 >({ 2763 path: `/v1/dashboard_card/${id}`, 2764 method: "GET", 2765 secure: true, 2766 format: "json", 2767 ...params, 2768 }), 2769 2770 /** 2771 * No description 2772 * 2773 * @tags DashboardCardService 2774 * @name DashboardCardServiceUpdateDashboardCard 2775 * @summary update dashboard_card 2776 * @request PUT:/v1/dashboard_card/{id} 2777 * @secure 2778 */ 2779 dashboardCardServiceUpdateDashboardCard: ( 2780 id: number, 2781 data: { 2782 title: string; 2783 /** @format int32 */ 2784 height: number; 2785 /** @format int32 */ 2786 width: number; 2787 background?: string; 2788 /** @format int32 */ 2789 weight: number; 2790 enabled: boolean; 2791 /** @format int64 */ 2792 dashboardTabId: number; 2793 /** 2794 * @format byte 2795 * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ 2796 */ 2797 payload: string; 2798 items: UpdateDashboardCardRequestItem[]; 2799 hidden: boolean; 2800 entityId?: string; 2801 }, 2802 params: RequestParams = {}, 2803 ) => 2804 this.request< 2805 ApiDashboardCard, 2806 | { 2807 error?: GenericErrorResponse; 2808 } 2809 | { 2810 error?: GenericErrorResponse & { 2811 code?: "UNAUTHORIZED"; 2812 }; 2813 } 2814 >({ 2815 path: `/v1/dashboard_card/${id}`, 2816 method: "PUT", 2817 body: data, 2818 secure: true, 2819 type: ContentType.Json, 2820 format: "json", 2821 ...params, 2822 }), 2823 2824 /** 2825 * No description 2826 * 2827 * @tags DashboardCardService 2828 * @name DashboardCardServiceDeleteDashboardCard 2829 * @summary delete dashboard_card 2830 * @request DELETE:/v1/dashboard_card/{id} 2831 * @secure 2832 */ 2833 dashboardCardServiceDeleteDashboardCard: (id: number, params: RequestParams = {}) => 2834 this.request< 2835 ApiDisablePluginResult, 2836 | { 2837 error?: GenericErrorResponse & { 2838 code?: "UNAUTHORIZED"; 2839 }; 2840 } 2841 | { 2842 error?: GenericErrorResponse; 2843 } 2844 >({ 2845 path: `/v1/dashboard_card/${id}`, 2846 method: "DELETE", 2847 secure: true, 2848 format: "json", 2849 ...params, 2850 }), 2851 2852 /** 2853 * No description 2854 * 2855 * @tags DashboardCardItemService 2856 * @name DashboardCardItemServiceAddDashboardCardItem 2857 * @summary add new dashboard_card 2858 * @request POST:/v1/dashboard_card_item 2859 * @secure 2860 */ 2861 dashboardCardItemServiceAddDashboardCardItem: (data: ApiNewDashboardCardItemRequest, params: RequestParams = {}) => 2862 this.request< 2863 ApiDashboardCardItem, 2864 | { 2865 error?: GenericErrorResponse; 2866 } 2867 | { 2868 error?: GenericErrorResponse & { 2869 code?: "UNAUTHORIZED"; 2870 }; 2871 } 2872 >({ 2873 path: `/v1/dashboard_card_item`, 2874 method: "POST", 2875 body: data, 2876 secure: true, 2877 type: ContentType.Json, 2878 format: "json", 2879 ...params, 2880 }), 2881 2882 /** 2883 * No description 2884 * 2885 * @tags DashboardCardItemService 2886 * @name DashboardCardItemServiceGetDashboardCardItemById 2887 * @summary get dashboard_card_item by id 2888 * @request GET:/v1/dashboard_card_item/{id} 2889 * @secure 2890 */ 2891 dashboardCardItemServiceGetDashboardCardItemById: (id: number, params: RequestParams = {}) => 2892 this.request< 2893 ApiDashboardCardItem, 2894 | { 2895 error?: GenericErrorResponse & { 2896 code?: "UNAUTHORIZED"; 2897 }; 2898 } 2899 | { 2900 error?: GenericErrorResponse; 2901 } 2902 >({ 2903 path: `/v1/dashboard_card_item/${id}`, 2904 method: "GET", 2905 secure: true, 2906 format: "json", 2907 ...params, 2908 }), 2909 2910 /** 2911 * No description 2912 * 2913 * @tags DashboardCardItemService 2914 * @name DashboardCardItemServiceUpdateDashboardCardItem 2915 * @summary update dashboard_card_item 2916 * @request PUT:/v1/dashboard_card_item/{id} 2917 * @secure 2918 */ 2919 dashboardCardItemServiceUpdateDashboardCardItem: ( 2920 id: number, 2921 data: { 2922 title: string; 2923 type: string; 2924 /** @format int32 */ 2925 weight: number; 2926 enabled: boolean; 2927 /** @format int64 */ 2928 dashboardCardId: number; 2929 entityId?: string; 2930 /** 2931 * @format byte 2932 * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ 2933 */ 2934 payload: string; 2935 hidden: boolean; 2936 frozen: boolean; 2937 }, 2938 params: RequestParams = {}, 2939 ) => 2940 this.request< 2941 ApiDashboardCardItem, 2942 | { 2943 error?: GenericErrorResponse; 2944 } 2945 | { 2946 error?: GenericErrorResponse & { 2947 code?: "UNAUTHORIZED"; 2948 }; 2949 } 2950 >({ 2951 path: `/v1/dashboard_card_item/${id}`, 2952 method: "PUT", 2953 body: data, 2954 secure: true, 2955 type: ContentType.Json, 2956 format: "json", 2957 ...params, 2958 }), 2959 2960 /** 2961 * No description 2962 * 2963 * @tags DashboardCardItemService 2964 * @name DashboardCardItemServiceDeleteDashboardCardItem 2965 * @summary delete dashboard_card_item 2966 * @request DELETE:/v1/dashboard_card_item/{id} 2967 * @secure 2968 */ 2969 dashboardCardItemServiceDeleteDashboardCardItem: (id: number, params: RequestParams = {}) => 2970 this.request< 2971 ApiDisablePluginResult, 2972 | { 2973 error?: GenericErrorResponse & { 2974 code?: "UNAUTHORIZED"; 2975 }; 2976 } 2977 | { 2978 error?: GenericErrorResponse; 2979 } 2980 >({ 2981 path: `/v1/dashboard_card_item/${id}`, 2982 method: "DELETE", 2983 secure: true, 2984 format: "json", 2985 ...params, 2986 }), 2987 2988 /** 2989 * No description 2990 * 2991 * @tags DashboardCardItemService 2992 * @name DashboardCardItemServiceGetDashboardCardItemList 2993 * @summary get dashboard_card_item list 2994 * @request GET:/v1/dashboard_card_items 2995 * @secure 2996 */ 2997 dashboardCardItemServiceGetDashboardCardItemList: ( 2998 query?: { 2999 /** 3000 * Field on which to sort and its direction 3001 * @example "-created_at" 3002 */ 3003 sort?: string; 3004 /** 3005 * Page number of the requested result set 3006 * @format uint64 3007 * @default 1 3008 * @example 1 3009 */ 3010 page?: number; 3011 /** 3012 * The number of results returned on a page 3013 * @format uint64 3014 */ 3015 limit?: number; 3016 }, 3017 params: RequestParams = {}, 3018 ) => 3019 this.request< 3020 ApiGetDashboardCardItemListResult, 3021 { 3022 error?: GenericErrorResponse & { 3023 code?: "UNAUTHORIZED"; 3024 }; 3025 } 3026 >({ 3027 path: `/v1/dashboard_card_items`, 3028 method: "GET", 3029 query: query, 3030 secure: true, 3031 format: "json", 3032 ...params, 3033 }), 3034 3035 /** 3036 * No description 3037 * 3038 * @tags DashboardCardService 3039 * @name DashboardCardServiceGetDashboardCardList 3040 * @summary get dashboard_card list 3041 * @request GET:/v1/dashboard_cards 3042 * @secure 3043 */ 3044 dashboardCardServiceGetDashboardCardList: ( 3045 query?: { 3046 /** 3047 * Field on which to sort and its direction 3048 * @example "-created_at" 3049 */ 3050 sort?: string; 3051 /** 3052 * Page number of the requested result set 3053 * @format uint64 3054 * @default 1 3055 * @example 1 3056 */ 3057 page?: number; 3058 /** 3059 * The number of results returned on a page 3060 * @format uint64 3061 */ 3062 limit?: number; 3063 }, 3064 params: RequestParams = {}, 3065 ) => 3066 this.request< 3067 ApiGetDashboardCardListResult, 3068 { 3069 error?: GenericErrorResponse & { 3070 code?: "UNAUTHORIZED"; 3071 }; 3072 } 3073 >({ 3074 path: `/v1/dashboard_cards`, 3075 method: "GET", 3076 query: query, 3077 secure: true, 3078 format: "json", 3079 ...params, 3080 }), 3081 3082 /** 3083 * No description 3084 * 3085 * @tags DashboardTabService 3086 * @name DashboardTabServiceAddDashboardTab 3087 * @summary add new dashboard_tab 3088 * @request POST:/v1/dashboard_tab 3089 * @secure 3090 */ 3091 dashboardTabServiceAddDashboardTab: (data: ApiNewDashboardTabRequest, params: RequestParams = {}) => 3092 this.request< 3093 ApiDashboardTab, 3094 | { 3095 error?: GenericErrorResponse; 3096 } 3097 | { 3098 error?: GenericErrorResponse & { 3099 code?: "UNAUTHORIZED"; 3100 }; 3101 } 3102 >({ 3103 path: `/v1/dashboard_tab`, 3104 method: "POST", 3105 body: data, 3106 secure: true, 3107 type: ContentType.Json, 3108 format: "json", 3109 ...params, 3110 }), 3111 3112 /** 3113 * No description 3114 * 3115 * @tags DashboardTabService 3116 * @name DashboardTabServiceGetDashboardTabById 3117 * @summary get dashboard_tab by id 3118 * @request GET:/v1/dashboard_tab/{id} 3119 * @secure 3120 */ 3121 dashboardTabServiceGetDashboardTabById: (id: number, params: RequestParams = {}) => 3122 this.request< 3123 ApiDashboardTab, 3124 | { 3125 error?: GenericErrorResponse & { 3126 code?: "UNAUTHORIZED"; 3127 }; 3128 } 3129 | { 3130 error?: GenericErrorResponse; 3131 } 3132 >({ 3133 path: `/v1/dashboard_tab/${id}`, 3134 method: "GET", 3135 secure: true, 3136 format: "json", 3137 ...params, 3138 }), 3139 3140 /** 3141 * No description 3142 * 3143 * @tags DashboardTabService 3144 * @name DashboardTabServiceUpdateDashboardTab 3145 * @summary update dashboard 3146 * @request PUT:/v1/dashboard_tab/{id} 3147 * @secure 3148 */ 3149 dashboardTabServiceUpdateDashboardTab: ( 3150 id: number, 3151 data: { 3152 name: string; 3153 /** @format int32 */ 3154 columnWidth: number; 3155 gap: boolean; 3156 background?: string; 3157 icon: string; 3158 enabled: boolean; 3159 /** @format int32 */ 3160 weight: number; 3161 /** @format int64 */ 3162 dashboardId: number; 3163 /** 3164 * @format byte 3165 * @pattern ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$ 3166 */ 3167 payload: string; 3168 }, 3169 params: RequestParams = {}, 3170 ) => 3171 this.request< 3172 ApiDashboardTab, 3173 | { 3174 error?: GenericErrorResponse; 3175 } 3176 | { 3177 error?: GenericErrorResponse & { 3178 code?: "UNAUTHORIZED"; 3179 }; 3180 } 3181 >({ 3182 path: `/v1/dashboard_tab/${id}`, 3183 method: "PUT", 3184 body: data, 3185 secure: true, 3186 type: ContentType.Json, 3187 format: "json", 3188 ...params, 3189 }), 3190 3191 /** 3192 * No description 3193 * 3194 * @tags DashboardTabService 3195 * @name DashboardTabServiceDeleteDashboardTab 3196 * @summary delete dashboard_tab 3197 * @request DELETE:/v1/dashboard_tab/{id} 3198 * @secure 3199 */ 3200 dashboardTabServiceDeleteDashboardTab: (id: number, params: RequestParams = {}) => 3201 this.request< 3202 ApiDisablePluginResult, 3203 | { 3204 error?: GenericErrorResponse & { 3205 code?: "UNAUTHORIZED"; 3206 }; 3207 } 3208 | { 3209 error?: GenericErrorResponse; 3210 } 3211 >({ 3212 path: `/v1/dashboard_tab/${id}`, 3213 method: "DELETE", 3214 secure: true, 3215 format: "json", 3216 ...params, 3217 }), 3218 3219 /** 3220 * No description 3221 * 3222 * @tags DashboardTabService 3223 * @name DashboardTabServiceGetDashboardTabList 3224 * @summary get dashboard_tab list 3225 * @request GET:/v1/dashboard_tabs 3226 * @secure 3227 */ 3228 dashboardTabServiceGetDashboardTabList: ( 3229 query?: { 3230 /** 3231 * Field on which to sort and its direction 3232 * @example "-created_at" 3233 */ 3234 sort?: string; 3235 /** 3236 * Page number of the requested result set 3237 * @format uint64 3238 * @default 1 3239 * @example 1 3240 */ 3241 page?: number; 3242 /** 3243 * The number of results returned on a page 3244 * @format uint64 3245 */ 3246 limit?: number; 3247 }, 3248 params: RequestParams = {}, 3249 ) => 3250 this.request< 3251 ApiGetDashboardTabListResult, 3252 { 3253 error?: GenericErrorResponse & { 3254 code?: "UNAUTHORIZED"; 3255 }; 3256 } 3257 >({ 3258 path: `/v1/dashboard_tabs`, 3259 method: "GET", 3260 query: query, 3261 secure: true, 3262 format: "json", 3263 ...params, 3264 }), 3265 3266 /** 3267 * No description 3268 * 3269 * @tags DashboardTabService 3270 * @name DashboardTabServiceImportDashboardTab 3271 * @summary import dashboard_tab 3272 * @request POST:/v1/dashboard_tabs/import 3273 * @secure 3274 */ 3275 dashboardTabServiceImportDashboardTab: (data: ApiDashboardTab, params: RequestParams = {}) => 3276 this.request< 3277 ApiDashboardTab, 3278 | { 3279 error?: GenericErrorResponse; 3280 } 3281 | { 3282 error?: GenericErrorResponse & { 3283 code?: "UNAUTHORIZED"; 3284 }; 3285 } 3286 >({ 3287 path: `/v1/dashboard_tabs/import`, 3288 method: "POST", 3289 body: data, 3290 secure: true, 3291 type: ContentType.Json, 3292 format: "json", 3293 ...params, 3294 }), 3295 3296 /** 3297 * No description 3298 * 3299 * @tags DashboardService 3300 * @name DashboardServiceGetDashboardList 3301 * @summary get dashboard list 3302 * @request GET:/v1/dashboards 3303 * @secure 3304 */ 3305 dashboardServiceGetDashboardList: ( 3306 query?: { 3307 /** 3308 * Field on which to sort and its direction 3309 * @example "-created_at" 3310 */ 3311 sort?: string; 3312 /** 3313 * Page number of the requested result set 3314 * @format uint64 3315 * @default 1 3316 * @example 1 3317 */ 3318 page?: number; 3319 /** 3320 * The number of results returned on a page 3321 * @format uint64 3322 */ 3323 limit?: number; 3324 }, 3325 params: RequestParams = {}, 3326 ) => 3327 this.request< 3328 ApiGetDashboardListResult, 3329 { 3330 error?: GenericErrorResponse & { 3331 code?: "UNAUTHORIZED"; 3332 }; 3333 } 3334 >({ 3335 path: `/v1/dashboards`, 3336 method: "GET", 3337 query: query, 3338 secure: true, 3339 format: "json", 3340 ...params, 3341 }), 3342 3343 /** 3344 * No description 3345 * 3346 * @tags DashboardService 3347 * @name DashboardServiceImportDashboard 3348 * @summary import dashboard 3349 * @request POST:/v1/dashboards/import 3350 * @secure 3351 */ 3352 dashboardServiceImportDashboard: (data: ApiDashboard, params: RequestParams = {}) => 3353 this.request< 3354 ApiDashboard, 3355 | { 3356 error?: GenericErrorResponse; 3357 } 3358 | { 3359 error?: GenericErrorResponse & { 3360 code?: "UNAUTHORIZED"; 3361 }; 3362 } 3363 >({ 3364 path: `/v1/dashboards/import`, 3365 method: "POST", 3366 body: data, 3367 secure: true, 3368 type: ContentType.Json, 3369 format: "json", 3370 ...params, 3371 }), 3372 3373 /** 3374 * No description 3375 * 3376 * @tags DashboardService 3377 * @name DashboardServiceSearchDashboard 3378 * @summary search area 3379 * @request GET:/v1/dashboards/search 3380 * @secure 3381 */ 3382 dashboardServiceSearchDashboard: ( 3383 query?: { 3384 query?: string; 3385 /** @format int64 */ 3386 offset?: number; 3387 /** @format int64 */ 3388 limit?: number; 3389 }, 3390 params: RequestParams = {}, 3391 ) => 3392 this.request< 3393 ApiSearchDashboardResult, 3394 { 3395 error?: GenericErrorResponse & { 3396 code?: "UNAUTHORIZED"; 3397 }; 3398 } 3399 >({ 3400 path: `/v1/dashboards/search`, 3401 method: "GET", 3402 query: query, 3403 secure: true, 3404 format: "json", 3405 ...params, 3406 }), 3407 3408 /** 3409 * No description 3410 * 3411 * @tags DeveloperToolsService 3412 * @name DeveloperToolsServiceCallAction 3413 * @summary call action 3414 * @request POST:/v1/developer_tools/automation/call_action 3415 * @secure 3416 */ 3417 developerToolsServiceCallAction: (data: ApiAutomationRequest, params: RequestParams = {}) => 3418 this.request< 3419 ApiDisablePluginResult, 3420 { 3421 error?: GenericErrorResponse & { 3422 code?: "UNAUTHORIZED"; 3423 }; 3424 } 3425 >({ 3426 path: `/v1/developer_tools/automation/call_action`, 3427 method: "POST", 3428 body: data, 3429 secure: true, 3430 type: ContentType.Json, 3431 format: "json", 3432 ...params, 3433 }), 3434 3435 /** 3436 * No description 3437 * 3438 * @tags DeveloperToolsService 3439 * @name DeveloperToolsServiceCallTrigger 3440 * @summary call trigger 3441 * @request POST:/v1/developer_tools/automation/call_trigger 3442 * @secure 3443 */ 3444 developerToolsServiceCallTrigger: (data: ApiAutomationRequest, params: RequestParams = {}) => 3445 this.request< 3446 ApiDisablePluginResult, 3447 | { 3448 error?: GenericErrorResponse; 3449 } 3450 | { 3451 error?: GenericErrorResponse & { 3452 code?: "UNAUTHORIZED"; 3453 }; 3454 } 3455 >({ 3456 path: `/v1/developer_tools/automation/call_trigger`, 3457 method: "POST", 3458 body: data, 3459 secure: true, 3460 type: ContentType.Json, 3461 format: "json", 3462 ...params, 3463 }), 3464 3465 /** 3466 * No description 3467 * 3468 * @tags DeveloperToolsService 3469 * @name DeveloperToolsServiceGetEventBusStateList 3470 * @summary bas state 3471 * @request GET:/v1/developer_tools/bus/state 3472 * @secure 3473 */ 3474 developerToolsServiceGetEventBusStateList: ( 3475 query?: { 3476 /** 3477 * Field on which to sort and its direction 3478 * @example "-created_at" 3479 */ 3480 sort?: string; 3481 /** 3482 * Page number of the requested result set 3483 * @format uint64 3484 * @default 1 3485 * @example 1 3486 */ 3487 page?: number; 3488 /** 3489 * The number of results returned on a page 3490 * @format uint64 3491 */ 3492 limit?: number; 3493 }, 3494 params: RequestParams = {}, 3495 ) => 3496 this.request< 3497 ApiEventBusStateListResult, 3498 { 3499 error?: GenericErrorResponse & { 3500 code?: "UNAUTHORIZED"; 3501 }; 3502 } 3503 >({ 3504 path: `/v1/developer_tools/bus/state`, 3505 method: "GET", 3506 query: query, 3507 secure: true, 3508 format: "json", 3509 ...params, 3510 }), 3511 3512 /** 3513 * No description 3514 * 3515 * @tags DeveloperToolsService 3516 * @name DeveloperToolsServiceReloadEntity 3517 * @summary reload entity 3518 * @request POST:/v1/developer_tools/entity/reload 3519 * @secure 3520 */ 3521 developerToolsServiceReloadEntity: (data: ApiReloadRequest, params: RequestParams = {}) => 3522 this.request< 3523 ApiDisablePluginResult, 3524 | { 3525 error?: GenericErrorResponse; 3526 } 3527 | { 3528 error?: GenericErrorResponse & { 3529 code?: "UNAUTHORIZED"; 3530 }; 3531 } 3532 >({ 3533 path: `/v1/developer_tools/entity/reload`, 3534 method: "POST", 3535 body: data, 3536 secure: true, 3537 type: ContentType.Json, 3538 format: "json", 3539 ...params, 3540 }), 3541 3542 /** 3543 * No description 3544 * 3545 * @tags DeveloperToolsService 3546 * @name DeveloperToolsServiceEntitySetState 3547 * @summary entity set state 3548 * @request POST:/v1/developer_tools/entity/set_state 3549 * @secure 3550 */ 3551 developerToolsServiceEntitySetState: (data: ApiEntityRequest, params: RequestParams = {}) => 3552 this.request< 3553 ApiDisablePluginResult, 3554 | { 3555 error?: GenericErrorResponse; 3556 } 3557 | { 3558 error?: GenericErrorResponse & { 3559 code?: "UNAUTHORIZED"; 3560 }; 3561 } 3562 >({ 3563 path: `/v1/developer_tools/entity/set_state`, 3564 method: "POST", 3565 body: data, 3566 secure: true, 3567 type: ContentType.Json, 3568 format: "json", 3569 ...params, 3570 }), 3571 3572 /** 3573 * No description 3574 * 3575 * @tags EntityService 3576 * @name EntityServiceGetEntityList 3577 * @summary get entity list 3578 * @request GET:/v1/entities 3579 * @secure 3580 */ 3581 entityServiceGetEntityList: ( 3582 query?: { 3583 /** 3584 * Field on which to sort and its direction 3585 * @example "-created_at" 3586 */ 3587 sort?: string; 3588 /** 3589 * Page number of the requested result set 3590 * @format uint64 3591 * @default 1 3592 * @example 1 3593 */ 3594 page?: number; 3595 /** 3596 * The number of results returned on a page 3597 * @format uint64 3598 */ 3599 limit?: number; 3600 query?: string; 3601 "tags[]"?: string[]; 3602 plugin?: string; 3603 /** @format int64 */ 3604 area?: number; 3605 }, 3606 params: RequestParams = {}, 3607 ) => 3608 this.request< 3609 ApiGetEntityListResult, 3610 { 3611 error?: GenericErrorResponse & { 3612 code?: "UNAUTHORIZED"; 3613 }; 3614 } 3615 >({ 3616 path: `/v1/entities`, 3617 method: "GET", 3618 query: query, 3619 secure: true, 3620 format: "json", 3621 ...params, 3622 }), 3623 3624 /** 3625 * No description 3626 * 3627 * @tags EntityService 3628 * @name EntityServiceImportEntity 3629 * @summary import entity 3630 * @request POST:/v1/entities/import 3631 * @secure 3632 */ 3633 entityServiceImportEntity: (data: ApiEntity, params: RequestParams = {}) => 3634 this.request< 3635 ApiDisablePluginResult, 3636 | { 3637 error?: GenericErrorResponse; 3638 } 3639 | { 3640 error?: GenericErrorResponse & { 3641 code?: "UNAUTHORIZED"; 3642 }; 3643 } 3644 >({ 3645 path: `/v1/entities/import`, 3646 method: "POST", 3647 body: data, 3648 secure: true, 3649 type: ContentType.Json, 3650 format: "json", 3651 ...params, 3652 }), 3653 3654 /** 3655 * No description 3656 * 3657 * @tags EntityService 3658 * @name EntityServiceAddEntity 3659 * @summary add new entity 3660 * @request POST:/v1/entity 3661 * @secure 3662 */ 3663 entityServiceAddEntity: (data: ApiNewEntityRequest, params: RequestParams = {}) => 3664 this.request< 3665 ApiEntity, 3666 | { 3667 error?: GenericErrorResponse; 3668 } 3669 | { 3670 error?: GenericErrorResponse & { 3671 code?: "UNAUTHORIZED"; 3672 }; 3673 } 3674 >({ 3675 path: `/v1/entity`, 3676 method: "POST", 3677 body: data, 3678 secure: true, 3679 type: ContentType.Json, 3680 format: "json", 3681 ...params, 3682 }), 3683 3684 /** 3685 * No description 3686 * 3687 * @tags EntityService 3688 * @name EntityServiceSearchEntity 3689 * @summary search entity 3690 * @request GET:/v1/entity/search 3691 * @secure 3692 */ 3693 entityServiceSearchEntity: ( 3694 query?: { 3695 query?: string; 3696 /** @format int64 */ 3697 offset?: number; 3698 /** @format int64 */ 3699 limit?: number; 3700 }, 3701 params: RequestParams = {}, 3702 ) => 3703 this.request< 3704 ApiSearchEntityResult, 3705 { 3706 error?: GenericErrorResponse & { 3707 code?: "UNAUTHORIZED"; 3708 }; 3709 } 3710 >({ 3711 path: `/v1/entity/search`, 3712 method: "GET", 3713 query: query, 3714 secure: true, 3715 format: "json", 3716 ...params, 3717 }), 3718 3719 /** 3720 * No description 3721 * 3722 * @tags EntityService 3723 * @name EntityServiceGetEntity 3724 * @summary get entity 3725 * @request GET:/v1/entity/{id} 3726 * @secure 3727 */ 3728 entityServiceGetEntity: (id: string, params: RequestParams = {}) => 3729 this.request< 3730 ApiEntity, 3731 | { 3732 error?: GenericErrorResponse & { 3733 code?: "UNAUTHORIZED"; 3734 }; 3735 } 3736 | { 3737 error?: GenericErrorResponse; 3738 } 3739 >({ 3740 path: `/v1/entity/${id}`, 3741 method: "GET", 3742 secure: true, 3743 format: "json", 3744 ...params, 3745 }), 3746 3747 /** 3748 * No description 3749 * 3750 * @tags EntityService 3751 * @name EntityServiceUpdateEntity 3752 * @summary update entity 3753 * @request PUT:/v1/entity/{id} 3754 * @secure 3755 */ 3756 entityServiceUpdateEntity: ( 3757 id: string, 3758 data: { 3759 id: string; 3760 name?: string; 3761 pluginName: string; 3762 description: string; 3763 /** @format int64 */ 3764 areaId?: number; 3765 icon?: string; 3766 /** @format int64 */ 3767 imageId?: number; 3768 autoLoad: boolean; 3769 restoreState: boolean; 3770 parentId?: string; 3771 actions: ApiUpdateEntityRequestAction[]; 3772 states: ApiUpdateEntityRequestState[]; 3773 attributes: Record<string, ApiAttribute>; 3774 settings: Record<string, ApiAttribute>; 3775 scriptIds: number[]; 3776 metrics: ApiMetric[]; 3777 tags: string[]; 3778 }, 3779 params: RequestParams = {}, 3780 ) => 3781 this.request< 3782 ApiEntity, 3783 | { 3784 error?: GenericErrorResponse; 3785 } 3786 | { 3787 error?: GenericErrorResponse & { 3788 code?: "UNAUTHORIZED"; 3789 }; 3790 } 3791 >({ 3792 path: `/v1/entity/${id}`, 3793 method: "PUT", 3794 body: data, 3795 secure: true, 3796 type: ContentType.Json, 3797 format: "json", 3798 ...params, 3799 }), 3800 3801 /** 3802 * No description 3803 * 3804 * @tags EntityService 3805 * @name EntityServiceDeleteEntity 3806 * @summary delete entity 3807 * @request DELETE:/v1/entity/{id} 3808 * @secure 3809 */ 3810 entityServiceDeleteEntity: (id: string, params: RequestParams = {}) => 3811 this.request< 3812 ApiDisablePluginResult, 3813 | { 3814 error?: GenericErrorResponse & { 3815 code?: "UNAUTHORIZED"; 3816 }; 3817 } 3818 | { 3819 error?: GenericErrorResponse; 3820 } 3821 >({ 3822 path: `/v1/entity/${id}`, 3823 method: "DELETE", 3824 secure: true, 3825 format: "json", 3826 ...params, 3827 }), 3828 3829 /** 3830 * No description 3831 * 3832 * @tags EntityService 3833 * @name EntityServiceDisabledEntity 3834 * @summary disable entity 3835 * @request POST:/v1/entity/{id}/disable 3836 * @secure 3837 */ 3838 entityServiceDisabledEntity: (id: string, params: RequestParams = {}) => 3839 this.request< 3840 ApiDisablePluginResult, 3841 | { 3842 error?: GenericErrorResponse; 3843 } 3844 | { 3845 error?: GenericErrorResponse & { 3846 code?: "UNAUTHORIZED"; 3847 }; 3848 } 3849 >({ 3850 path: `/v1/entity/${id}/disable`, 3851 method: "POST", 3852 secure: true, 3853 format: "json", 3854 ...params, 3855 }), 3856 3857 /** 3858 * No description 3859 * 3860 * @tags EntityService 3861 * @name EntityServiceEnabledEntity 3862 * @summary enabled entity 3863 * @request POST:/v1/entity/{id}/enable 3864 * @secure 3865 */ 3866 entityServiceEnabledEntity: (id: string, params: RequestParams = {}) => 3867 this.request< 3868 ApiDisablePluginResult, 3869 | { 3870 error?: GenericErrorResponse; 3871 } 3872 | { 3873 error?: GenericErrorResponse & { 3874 code?: "UNAUTHORIZED"; 3875 }; 3876 } 3877 >({ 3878 path: `/v1/entity/${id}/enable`, 3879 method: "POST", 3880 secure: true, 3881 format: "json", 3882 ...params, 3883 }), 3884 3885 /** 3886 * No description 3887 * 3888 * @tags EntityService 3889 * @name EntityServiceGetStatistic 3890 * @summary get statistic 3891 * @request GET:/v1/entities/statistic 3892 * @secure 3893 */ 3894 entityServiceGetStatistic: (params: RequestParams = {}) => 3895 this.request< 3896 ApiStatistics, 3897 { 3898 error?: GenericErrorResponse & { 3899 code?: "UNAUTHORIZED"; 3900 }; 3901 } 3902 >({ 3903 path: `/v1/entities/statistic`, 3904 method: "GET", 3905 secure: true, 3906 format: "json", 3907 ...params, 3908 }), 3909 3910 /** 3911 * No description 3912 * 3913 * @tags EntityStorageService 3914 * @name EntityStorageServiceGetEntityStorageList 3915 * @request GET:/v1/entity_storage 3916 * @secure 3917 */ 3918 entityStorageServiceGetEntityStorageList: ( 3919 query?: { 3920 /** 3921 * Field on which to sort and its direction 3922 * @example "-created_at" 3923 */ 3924 sort?: string; 3925 /** 3926 * Page number of the requested result set 3927 * @format uint64 3928 * @default 1 3929 * @example 1 3930 */ 3931 page?: number; 3932 /** 3933 * The number of results returned on a page 3934 * @format uint64 3935 */ 3936 limit?: number; 3937 /** @format date-time */ 3938 startDate?: string; 3939 /** @format date-time */ 3940 endDate?: string; 3941 "entityId[]"?: string[]; 3942 }, 3943 params: RequestParams = {}, 3944 ) => 3945 this.request< 3946 ApiGetEntityStorageResult, 3947 { 3948 error?: GenericErrorResponse & { 3949 code?: "UNAUTHORIZED"; 3950 }; 3951 } 3952 >({ 3953 path: `/v1/entity_storage`, 3954 method: "GET", 3955 query: query, 3956 secure: true, 3957 format: "json", 3958 ...params, 3959 }), 3960 3961 /** 3962 * No description 3963 * 3964 * @tags ImageService 3965 * @name ImageServiceAddImage 3966 * @summary add new image 3967 * @request POST:/v1/image 3968 * @secure 3969 */ 3970 imageServiceAddImage: (data: ApiNewImageRequest, params: RequestParams = {}) => 3971 this.request< 3972 ApiImage, 3973 | { 3974 error?: GenericErrorResponse; 3975 } 3976 | { 3977 error?: GenericErrorResponse & { 3978 code?: "UNAUTHORIZED"; 3979 }; 3980 } 3981 >({ 3982 path: `/v1/image`, 3983 method: "POST", 3984 body: data, 3985 secure: true, 3986 type: ContentType.Json, 3987 format: "json", 3988 ...params, 3989 }), 3990 3991 /** 3992 * No description 3993 * 3994 * @tags ImageService 3995 * @name ImageServiceUploadImage 3996 * @summary upload image 3997 * @request POST:/v1/image/upload 3998 * @secure 3999 */ 4000 imageServiceUploadImage: ( 4001 data: { 4002 filename?: File[]; 4003 }, 4004 params: RequestParams = {}, 4005 ) => 4006 this.request< 4007 ApiImage, 4008 | { 4009 error?: GenericErrorResponse; 4010 } 4011 | { 4012 error?: GenericErrorResponse & { 4013 code?: "UNAUTHORIZED"; 4014 }; 4015 } 4016 >({ 4017 path: `/v1/image/upload`, 4018 method: "POST", 4019 body: data, 4020 secure: true, 4021 type: ContentType.FormData, 4022 format: "json", 4023 ...params, 4024 }), 4025 4026 /** 4027 * No description 4028 * 4029 * @tags ImageService 4030 * @name ImageServiceGetImageById 4031 * @summary get image by id 4032 * @request GET:/v1/image/{id} 4033 * @secure 4034 */ 4035 imageServiceGetImageById: (id: number, params: RequestParams = {}) => 4036 this.request< 4037 ApiImage, 4038 | { 4039 error?: GenericErrorResponse & { 4040 code?: "UNAUTHORIZED"; 4041 }; 4042 } 4043 | { 4044 error?: GenericErrorResponse; 4045 } 4046 >({ 4047 path: `/v1/image/${id}`, 4048 method: "GET", 4049 secure: true, 4050 format: "json", 4051 ...params, 4052 }), 4053 4054 /** 4055 * No description 4056 * 4057 * @tags ImageService 4058 * @name ImageServiceUpdateImageById 4059 * @summary update image 4060 * @request PUT:/v1/image/{id} 4061 * @secure 4062 */ 4063 imageServiceUpdateImageById: ( 4064 id: number, 4065 data: { 4066 thumb: string; 4067 image: string; 4068 mimeType: string; 4069 title: string; 4070 /** @format int64 */ 4071 size: number; 4072 name: string; 4073 }, 4074 params: RequestParams = {}, 4075 ) => 4076 this.request< 4077 ApiImage, 4078 | { 4079 error?: GenericErrorResponse; 4080 } 4081 | { 4082 error?: GenericErrorResponse & { 4083 code?: "UNAUTHORIZED"; 4084 }; 4085 } 4086 >({ 4087 path: `/v1/image/${id}`, 4088 method: "PUT", 4089 body: data, 4090 secure: true, 4091 type: ContentType.Json, 4092 format: "json", 4093 ...params, 4094 }), 4095 4096 /** 4097 * No description 4098 * 4099 * @tags ImageService 4100 * @name ImageServiceDeleteImageById 4101 * @summary delete image by id 4102 * @request DELETE:/v1/image/{id} 4103 * @secure 4104 */ 4105 imageServiceDeleteImageById: (id: number, params: RequestParams = {}) => 4106 this.request< 4107 ApiDisablePluginResult, 4108 | { 4109 error?: GenericErrorResponse & { 4110 code?: "UNAUTHORIZED"; 4111 }; 4112 } 4113 | { 4114 error?: GenericErrorResponse; 4115 } 4116 >({ 4117 path: `/v1/image/${id}`, 4118 method: "DELETE", 4119 secure: true, 4120 format: "json", 4121 ...params, 4122 }), 4123 4124 /** 4125 * No description 4126 * 4127 * @tags ImageService 4128 * @name ImageServiceGetImageList 4129 * @summary get image list 4130 * @request GET:/v1/images 4131 * @secure 4132 */ 4133 imageServiceGetImageList: ( 4134 query?: { 4135 /** 4136 * Field on which to sort and its direction 4137 * @example "-created_at" 4138 */ 4139 sort?: string; 4140 /** 4141 * Page number of the requested result set 4142 * @format uint64 4143 * @default 1 4144 * @example 1 4145 */ 4146 page?: number; 4147 /** 4148 * The number of results returned on a page 4149 * @format uint64 4150 */ 4151 limit?: number; 4152 }, 4153 params: RequestParams = {}, 4154 ) => 4155 this.request< 4156 ApiGetImageListResult, 4157 { 4158 error?: GenericErrorResponse & { 4159 code?: "UNAUTHORIZED"; 4160 }; 4161 } 4162 >({ 4163 path: `/v1/images`, 4164 method: "GET", 4165 query: query, 4166 secure: true, 4167 format: "json", 4168 ...params, 4169 }), 4170 4171 /** 4172 * No description 4173 * 4174 * @tags ImageService 4175 * @name ImageServiceGetImageFilterList 4176 * @summary get image filter list 4177 * @request GET:/v1/images/filter_list 4178 * @secure 4179 */ 4180 imageServiceGetImageFilterList: (params: RequestParams = {}) => 4181 this.request< 4182 ApiGetImageFilterListResult, 4183 { 4184 error?: GenericErrorResponse & { 4185 code?: "UNAUTHORIZED"; 4186 }; 4187 } 4188 >({ 4189 path: `/v1/images/filter_list`, 4190 method: "GET", 4191 secure: true, 4192 format: "json", 4193 ...params, 4194 }), 4195 4196 /** 4197 * No description 4198 * 4199 * @tags ImageService 4200 * @name ImageServiceGetImageListByDate 4201 * @summary get image list by date 4202 * @request GET:/v1/images/filtered 4203 * @secure 4204 */ 4205 imageServiceGetImageListByDate: ( 4206 query?: { 4207 filter?: string; 4208 }, 4209 params: RequestParams = {}, 4210 ) => 4211 this.request< 4212 ApiGetImageListByDateResult, 4213 { 4214 error?: GenericErrorResponse & { 4215 code?: "UNAUTHORIZED"; 4216 }; 4217 } 4218 >({ 4219 path: `/v1/images/filtered`, 4220 method: "GET", 4221 query: query, 4222 secure: true, 4223 format: "json", 4224 ...params, 4225 }), 4226 4227 /** 4228 * No description 4229 * 4230 * @tags InteractService 4231 * @name InteractServiceEntityCallAction 4232 * @summary entity call action 4233 * @request POST:/v1/interact/entity/call_action 4234 * @secure 4235 */ 4236 interactServiceEntityCallAction: (data: ApiEntityCallActionRequest, params: RequestParams = {}) => 4237 this.request< 4238 ApiDisablePluginResult, 4239 | { 4240 error?: GenericErrorResponse; 4241 } 4242 | { 4243 error?: GenericErrorResponse & { 4244 code?: "UNAUTHORIZED"; 4245 }; 4246 } 4247 >({ 4248 path: `/v1/interact/entity/call_action`, 4249 method: "POST", 4250 body: data, 4251 secure: true, 4252 format: "json", 4253 ...params, 4254 }), 4255 4256 /** 4257 * No description 4258 * 4259 * @tags LogService 4260 * @name LogServiceGetLogList 4261 * @request GET:/v1/logs 4262 * @secure 4263 */ 4264 logServiceGetLogList: ( 4265 query?: { 4266 /** 4267 * Field on which to sort and its direction 4268 * @example "-created_at" 4269 */ 4270 sort?: string; 4271 /** 4272 * Page number of the requested result set 4273 * @format uint64 4274 * @default 1 4275 * @example 1 4276 */ 4277 page?: number; 4278 /** 4279 * The number of results returned on a page 4280 * @format uint64 4281 */ 4282 limit?: number; 4283 /** @format date-time */ 4284 startDate?: string; 4285 /** @format date-time */ 4286 endDate?: string; 4287 query?: string; 4288 }, 4289 params: RequestParams = {}, 4290 ) => 4291 this.request< 4292 ApiGetLogListResult, 4293 { 4294 error?: GenericErrorResponse & { 4295 code?: "UNAUTHORIZED"; 4296 }; 4297 } 4298 >({ 4299 path: `/v1/logs`, 4300 method: "GET", 4301 query: query, 4302 secure: true, 4303 format: "json", 4304 ...params, 4305 }), 4306 4307 /** 4308 * No description 4309 * 4310 * @tags MessageDeliveryService 4311 * @name MessageDeliveryServiceGetMessageDeliveryList 4312 * @summary get list 4313 * @request GET:/v1/message_delivery 4314 * @secure 4315 */ 4316 messageDeliveryServiceGetMessageDeliveryList: ( 4317 query?: { 4318 /** 4319 * Field on which to sort and its direction 4320 * @example "-created_at" 4321 */ 4322 sort?: string; 4323 /** 4324 * Page number of the requested result set 4325 * @format uint64 4326 * @default 1 4327 * @example 1 4328 */ 4329 page?: number; 4330 /** 4331 * The number of results returned on a page 4332 * @format uint64 4333 */ 4334 limit?: number; 4335 /** @format date-time */ 4336 startDate?: string; 4337 /** @format date-time */ 4338 endDate?: string; 4339 messageType?: string; 4340 }, 4341 params: RequestParams = {}, 4342 ) => 4343 this.request< 4344 ApiGetMessageDeliveryListResult, 4345 { 4346 error?: GenericErrorResponse & { 4347 code?: "UNAUTHORIZED"; 4348 }; 4349 } 4350 >({ 4351 path: `/v1/message_delivery`, 4352 method: "GET", 4353 query: query, 4354 secure: true, 4355 format: "json", 4356 ...params, 4357 }), 4358 4359 /** 4360 * No description 4361 * 4362 * @tags MetricService 4363 * @name MetricServiceGetMetric 4364 * @summary get metric 4365 * @request GET:/v1/metric 4366 * @secure 4367 */ 4368 metricServiceGetMetric: ( 4369 query: { 4370 /** @format int64 */ 4371 id: number; 4372 range?: "6h" | "12h" | "24h" | "7d" | "30d" | "1m"; 4373 /** @format date-time */ 4374 startDate?: string; 4375 /** @format date-time */ 4376 endDate?: string; 4377 }, 4378 params: RequestParams = {}, 4379 ) => 4380 this.request< 4381 ApiMetric, 4382 { 4383 error?: GenericErrorResponse & { 4384 code?: "UNAUTHORIZED"; 4385 }; 4386 } 4387 >({ 4388 path: `/v1/metric`, 4389 method: "GET", 4390 query: query, 4391 secure: true, 4392 format: "json", 4393 ...params, 4394 }), 4395 4396 /** 4397 * No description 4398 * 4399 * @tags MqttService 4400 * @name MqttServiceGetClientById 4401 * @summary get client by id 4402 * @request GET:/v1/mqtt/client/{id} 4403 * @secure 4404 */ 4405 mqttServiceGetClientById: (id: string, params: RequestParams = {}) => 4406 this.request< 4407 ApiClient, 4408 | { 4409 error?: GenericErrorResponse & { 4410 code?: "UNAUTHORIZED"; 4411 }; 4412 } 4413 | { 4414 error?: GenericErrorResponse; 4415 } 4416 >({ 4417 path: `/v1/mqtt/client/${id}`, 4418 method: "GET", 4419 secure: true, 4420 format: "json", 4421 ...params, 4422 }), 4423 4424 /** 4425 * No description 4426 * 4427 * @tags MqttService 4428 * @name MqttServiceGetClientList 4429 * @summary get client list 4430 * @request GET:/v1/mqtt/clients 4431 * @secure 4432 */ 4433 mqttServiceGetClientList: ( 4434 query?: { 4435 /** 4436 * Field on which to sort and its direction 4437 * @example "-created_at" 4438 */ 4439 sort?: string; 4440 /** 4441 * Page number of the requested result set 4442 * @format uint64 4443 * @default 1 4444 * @example 1 4445 */ 4446 page?: number; 4447 /** 4448 * The number of results returned on a page 4449 * @format uint64 4450 */ 4451 limit?: number; 4452 }, 4453 params: RequestParams = {}, 4454 ) => 4455 this.request< 4456 ApiGetClientListResult, 4457 { 4458 error?: GenericErrorResponse & { 4459 code?: "UNAUTHORIZED"; 4460 }; 4461 } 4462 >({ 4463 path: `/v1/mqtt/clients`, 4464 method: "GET", 4465 query: query, 4466 secure: true, 4467 format: "json", 4468 ...params, 4469 }), 4470 4471 /** 4472 * No description 4473 * 4474 * @tags MqttService 4475 * @name MqttServiceGetSubscriptionList 4476 * @summary get subscription list 4477 * @request GET:/v1/mqtt/subscriptions 4478 * @secure 4479 */ 4480 mqttServiceGetSubscriptionList: ( 4481 query?: { 4482 /** 4483 * Field on which to sort and its direction 4484 * @example "-created_at" 4485 */ 4486 sort?: string; 4487 /** 4488 * Page number of the requested result set 4489 * @format uint64 4490 * @default 1 4491 * @example 1 4492 */ 4493 page?: number; 4494 /** 4495 * The number of results returned on a page 4496 * @format uint64 4497 */ 4498 limit?: number; 4499 clientId?: string; 4500 }, 4501 params: RequestParams = {}, 4502 ) => 4503 this.request< 4504 ApiGetSubscriptionListResult, 4505 { 4506 error?: GenericErrorResponse & { 4507 code?: "UNAUTHORIZED"; 4508 }; 4509 } 4510 >({ 4511 path: `/v1/mqtt/subscriptions`, 4512 method: "GET", 4513 query: query, 4514 secure: true, 4515 format: "json", 4516 ...params, 4517 }), 4518 4519 /** 4520 * No description 4521 * 4522 * @tags AuthService 4523 * @name AuthServicePasswordReset 4524 * @summary sign out user 4525 * @request POST:/v1/password_reset 4526 * @secure 4527 */ 4528 authServicePasswordReset: (data: ApiPasswordResetRequest, params: RequestParams = {}) => 4529 this.request< 4530 ApiDisablePluginResult, 4531 | { 4532 error?: GenericErrorResponse; 4533 } 4534 | { 4535 error?: GenericErrorResponse & { 4536 code?: "UNAUTHORIZED"; 4537 }; 4538 } 4539 >({ 4540 path: `/v1/password_reset`, 4541 method: "POST", 4542 body: data, 4543 secure: true, 4544 type: ContentType.Json, 4545 format: "json", 4546 ...params, 4547 }), 4548 4549 /** 4550 * No description 4551 * 4552 * @tags PluginService 4553 * @name PluginServiceGetPlugin 4554 * @summary get plugin 4555 * @request GET:/v1/plugin/{name} 4556 * @secure 4557 */ 4558 pluginServiceGetPlugin: (name: string, params: RequestParams = {}) => 4559 this.request< 4560 ApiPlugin, 4561 | { 4562 error?: GenericErrorResponse & { 4563 code?: "UNAUTHORIZED"; 4564 }; 4565 } 4566 | { 4567 error?: GenericErrorResponse; 4568 } 4569 >({ 4570 path: `/v1/plugin/${name}`, 4571 method: "GET", 4572 secure: true, 4573 format: "json", 4574 ...params, 4575 }), 4576 4577 /** 4578 * No description 4579 * 4580 * @tags PluginService 4581 * @name PluginServiceDisablePlugin 4582 * @summary disable plugin 4583 * @request POST:/v1/plugin/{name}/disable 4584 * @secure 4585 */ 4586 pluginServiceDisablePlugin: (name: string, params: RequestParams = {}) => 4587 this.request< 4588 ApiDisablePluginResult, 4589 | { 4590 error?: GenericErrorResponse; 4591 } 4592 | { 4593 error?: GenericErrorResponse & { 4594 code?: "UNAUTHORIZED"; 4595 }; 4596 } 4597 >({ 4598 path: `/v1/plugin/${name}/disable`, 4599 method: "POST", 4600 secure: true, 4601 format: "json", 4602 ...params, 4603 }), 4604 4605 /** 4606 * No description 4607 * 4608 * @tags PluginService 4609 * @name PluginServiceEnablePlugin 4610 * @summary enable plugin 4611 * @request POST:/v1/plugin/{name}/enable 4612 * @secure 4613 */ 4614 pluginServiceEnablePlugin: (name: string, params: RequestParams = {}) => 4615 this.request< 4616 ApiEnablePluginResult, 4617 | { 4618 error?: GenericErrorResponse; 4619 } 4620 | { 4621 error?: GenericErrorResponse & { 4622 code?: "UNAUTHORIZED"; 4623 }; 4624 } 4625 >({ 4626 path: `/v1/plugin/${name}/enable`, 4627 method: "POST", 4628 secure: true, 4629 format: "json", 4630 ...params, 4631 }), 4632 4633 /** 4634 * No description 4635 * 4636 * @tags PluginService 4637 * @name PluginServiceUpdatePluginSettings 4638 * @summary update plugin settings 4639 * @request PUT:/v1/plugin/{name}/settings 4640 * @secure 4641 */ 4642 pluginServiceUpdatePluginSettings: ( 4643 name: string, 4644 data: { 4645 settings: Record<string, ApiAttribute>; 4646 }, 4647 params: RequestParams = {}, 4648 ) => 4649 this.request< 4650 ApiDisablePluginResult, 4651 | { 4652 error?: GenericErrorResponse; 4653 } 4654 | { 4655 error?: GenericErrorResponse & { 4656 code?: "UNAUTHORIZED"; 4657 }; 4658 } 4659 >({ 4660 path: `/v1/plugin/${name}/settings`, 4661 method: "PUT", 4662 body: data, 4663 secure: true, 4664 type: ContentType.Json, 4665 format: "json", 4666 ...params, 4667 }), 4668 4669 /** 4670 * No description 4671 * 4672 * @tags PluginService 4673 * @name PluginServiceGetPluginReadme 4674 * @summary get plugin readme 4675 * @request GET:/v1/plugin/{name}/readme 4676 * @secure 4677 */ 4678 pluginServiceGetPluginReadme: ( 4679 name: string, 4680 query?: { 4681 lang?: string; 4682 }, 4683 params: RequestParams = {}, 4684 ) => 4685 this.request< 4686 string, 4687 | { 4688 error?: GenericErrorResponse; 4689 } 4690 | { 4691 error?: GenericErrorResponse & { 4692 code?: "UNAUTHORIZED"; 4693 }; 4694 } 4695 >({ 4696 path: `/v1/plugin/${name}/readme`, 4697 method: "GET", 4698 query: query, 4699 secure: true, 4700 ...params, 4701 }), 4702 4703 /** 4704 * No description 4705 * 4706 * @tags PluginService 4707 * @name PluginServiceGetPluginList 4708 * @summary get plugin list 4709 * @request GET:/v1/plugins 4710 * @secure 4711 */ 4712 pluginServiceGetPluginList: ( 4713 query?: { 4714 /** 4715 * Field on which to sort and its direction 4716 * @example "-created_at" 4717 */ 4718 sort?: string; 4719 /** 4720 * Page number of the requested result set 4721 * @format uint64 4722 * @default 1 4723 * @example 1 4724 */ 4725 page?: number; 4726 /** 4727 * The number of results returned on a page 4728 * @format uint64 4729 */ 4730 limit?: number; 4731 }, 4732 params: RequestParams = {}, 4733 ) => 4734 this.request< 4735 ApiGetPluginListResult, 4736 { 4737 error?: GenericErrorResponse & { 4738 code?: "UNAUTHORIZED"; 4739 }; 4740 } 4741 >({ 4742 path: `/v1/plugins`, 4743 method: "GET", 4744 query: query, 4745 secure: true, 4746 format: "json", 4747 ...params, 4748 }), 4749 4750 /** 4751 * No description 4752 * 4753 * @tags PluginService 4754 * @name PluginServiceSearchPlugin 4755 * @summary search plugin 4756 * @request GET:/v1/plugins/search 4757 * @secure 4758 */ 4759 pluginServiceSearchPlugin: ( 4760 query?: { 4761 query?: string; 4762 /** @format int64 */ 4763 offset?: number; 4764 /** @format int64 */ 4765 limit?: number; 4766 }, 4767 params: RequestParams = {}, 4768 ) => 4769 this.request< 4770 ApiSearchPluginResult, 4771 { 4772 error?: GenericErrorResponse & { 4773 code?: "UNAUTHORIZED"; 4774 }; 4775 } 4776 >({ 4777 path: `/v1/plugins/search`, 4778 method: "GET", 4779 query: query, 4780 secure: true, 4781 format: "json", 4782 ...params, 4783 }), 4784 4785 /** 4786 * No description 4787 * 4788 * @tags RoleService 4789 * @name RoleServiceAddRole 4790 * @summary add new role 4791 * @request POST:/v1/role 4792 * @secure 4793 */ 4794 roleServiceAddRole: (data: ApiNewRoleRequest, params: RequestParams = {}) => 4795 this.request< 4796 ApiRole, 4797 | { 4798 error?: GenericErrorResponse; 4799 } 4800 | { 4801 error?: GenericErrorResponse & { 4802 code?: "UNAUTHORIZED"; 4803 }; 4804 } 4805 >({ 4806 path: `/v1/role`, 4807 method: "POST", 4808 body: data, 4809 secure: true, 4810 type: ContentType.Json, 4811 format: "json", 4812 ...params, 4813 }), 4814 4815 /** 4816 * No description 4817 * 4818 * @tags RoleService 4819 * @name RoleServiceGetRoleByName 4820 * @summary get role by name 4821 * @request GET:/v1/role/{name} 4822 * @secure 4823 */ 4824 roleServiceGetRoleByName: (name: string, params: RequestParams = {}) => 4825 this.request< 4826 ApiRole, 4827 | { 4828 error?: GenericErrorResponse & { 4829 code?: "UNAUTHORIZED"; 4830 }; 4831 } 4832 | { 4833 error?: GenericErrorResponse; 4834 } 4835 >({ 4836 path: `/v1/role/${name}`, 4837 method: "GET", 4838 secure: true, 4839 format: "json", 4840 ...params, 4841 }), 4842 4843 /** 4844 * No description 4845 * 4846 * @tags RoleService 4847 * @name RoleServiceUpdateRoleByName 4848 * @summary update role 4849 * @request PUT:/v1/role/{name} 4850 * @secure 4851 */ 4852 roleServiceUpdateRoleByName: ( 4853 name: string, 4854 data: { 4855 description: string; 4856 parent?: string; 4857 }, 4858 params: RequestParams = {}, 4859 ) => 4860 this.request< 4861 ApiRole, 4862 | { 4863 error?: GenericErrorResponse; 4864 } 4865 | { 4866 error?: GenericErrorResponse & { 4867 code?: "UNAUTHORIZED"; 4868 }; 4869 } 4870 >({ 4871 path: `/v1/role/${name}`, 4872 method: "PUT", 4873 body: data, 4874 secure: true, 4875 type: ContentType.Json, 4876 format: "json", 4877 ...params, 4878 }), 4879 4880 /** 4881 * No description 4882 * 4883 * @tags RoleService 4884 * @name RoleServiceDeleteRoleByName 4885 * @summary delete role by name 4886 * @request DELETE:/v1/role/{name} 4887 * @secure 4888 */ 4889 roleServiceDeleteRoleByName: (name: string, params: RequestParams = {}) => 4890 this.request< 4891 ApiDisablePluginResult, 4892 | { 4893 error?: GenericErrorResponse & { 4894 code?: "UNAUTHORIZED"; 4895 }; 4896 } 4897 | { 4898 error?: GenericErrorResponse; 4899 } 4900 >({ 4901 path: `/v1/role/${name}`, 4902 method: "DELETE", 4903 secure: true, 4904 format: "json", 4905 ...params, 4906 }), 4907 4908 /** 4909 * No description 4910 * 4911 * @tags RoleService 4912 * @name RoleServiceGetRoleAccessList 4913 * @summary get role access list 4914 * @request GET:/v1/role/{name}/access_list 4915 * @secure 4916 */ 4917 roleServiceGetRoleAccessList: (name: string, params: RequestParams = {}) => 4918 this.request< 4919 ApiRoleAccessListResult, 4920 { 4921 error?: GenericErrorResponse & { 4922 code?: "UNAUTHORIZED"; 4923 }; 4924 } 4925 >({ 4926 path: `/v1/role/${name}/access_list`, 4927 method: "GET", 4928 secure: true, 4929 format: "json", 4930 ...params, 4931 }), 4932 4933 /** 4934 * No description 4935 * 4936 * @tags RoleService 4937 * @name RoleServiceUpdateRoleAccessList 4938 * @summary update role access list 4939 * @request PUT:/v1/role/{name}/access_list 4940 * @secure 4941 */ 4942 roleServiceUpdateRoleAccessList: ( 4943 name: string, 4944 data: { 4945 accessListDiff: Record<string, UpdateRoleAccessListRequestAccessListDiff>; 4946 }, 4947 params: RequestParams = {}, 4948 ) => 4949 this.request< 4950 ApiRoleAccessListResult, 4951 | { 4952 error?: GenericErrorResponse; 4953 } 4954 | { 4955 error?: GenericErrorResponse & { 4956 code?: "UNAUTHORIZED"; 4957 }; 4958 } 4959 >({ 4960 path: `/v1/role/${name}/access_list`, 4961 method: "PUT", 4962 body: data, 4963 secure: true, 4964 type: ContentType.Json, 4965 format: "json", 4966 ...params, 4967 }), 4968 4969 /** 4970 * No description 4971 * 4972 * @tags RoleService 4973 * @name RoleServiceGetRoleList 4974 * @summary get role list 4975 * @request GET:/v1/roles 4976 * @secure 4977 */ 4978 roleServiceGetRoleList: ( 4979 query?: { 4980 /** 4981 * Field on which to sort and its direction 4982 * @example "-created_at" 4983 */ 4984 sort?: string; 4985 /** 4986 * Page number of the requested result set 4987 * @format uint64 4988 * @default 1 4989 * @example 1 4990 */ 4991 page?: number; 4992 /** 4993 * The number of results returned on a page 4994 * @format uint64 4995 */ 4996 limit?: number; 4997 }, 4998 params: RequestParams = {}, 4999 ) => 5000 this.request< 5001 ApiGetRoleListResult, 5002 { 5003 error?: GenericErrorResponse & { 5004 code?: "UNAUTHORIZED"; 5005 }; 5006 } 5007 >({ 5008 path: `/v1/roles`, 5009 method: "GET", 5010 query: query, 5011 secure: true, 5012 format: "json", 5013 ...params, 5014 }), 5015 5016 /** 5017 * No description 5018 * 5019 * @tags RoleService 5020 * @name RoleServiceSearchRoleByName 5021 * @summary delete role by name 5022 * @request GET:/v1/roles/search 5023 * @secure 5024 */ 5025 roleServiceSearchRoleByName: ( 5026 query?: { 5027 query?: string; 5028 /** @format int64 */ 5029 offset?: number; 5030 /** @format int64 */ 5031 limit?: number; 5032 }, 5033 params: RequestParams = {}, 5034 ) => 5035 this.request< 5036 ApiSearchRoleListResult, 5037 { 5038 error?: GenericErrorResponse & { 5039 code?: "UNAUTHORIZED"; 5040 }; 5041 } 5042 >({ 5043 path: `/v1/roles/search`, 5044 method: "GET", 5045 query: query, 5046 secure: true, 5047 format: "json", 5048 ...params, 5049 }), 5050 5051 /** 5052 * No description 5053 * 5054 * @tags ScriptService 5055 * @name ScriptServiceAddScript 5056 * @summary add new script 5057 * @request POST:/v1/script 5058 * @secure 5059 */ 5060 scriptServiceAddScript: (data: ApiNewScriptRequest, params: RequestParams = {}) => 5061 this.request< 5062 ApiScript, 5063 | { 5064 error?: GenericErrorResponse; 5065 } 5066 | { 5067 error?: GenericErrorResponse & { 5068 code?: "UNAUTHORIZED"; 5069 }; 5070 } 5071 >({ 5072 path: `/v1/script`, 5073 method: "POST", 5074 body: data, 5075 secure: true, 5076 type: ContentType.Json, 5077 format: "json", 5078 ...params, 5079 }), 5080 5081 /** 5082 * No description 5083 * 5084 * @tags ScriptService 5085 * @name ScriptServiceExecSrcScriptById 5086 * @summary exec src script by id 5087 * @request POST:/v1/script/exec_src 5088 * @secure 5089 */ 5090 scriptServiceExecSrcScriptById: (data: ApiExecSrcScriptRequest, params: RequestParams = {}) => 5091 this.request< 5092 ApiExecScriptResult, 5093 | { 5094 error?: GenericErrorResponse; 5095 } 5096 | { 5097 error?: GenericErrorResponse & { 5098 code?: "UNAUTHORIZED"; 5099 }; 5100 } 5101 >({ 5102 path: `/v1/script/exec_src`, 5103 method: "POST", 5104 body: data, 5105 secure: true, 5106 type: ContentType.Json, 5107 format: "json", 5108 ...params, 5109 }), 5110 5111 /** 5112 * No description 5113 * 5114 * @tags ScriptService 5115 * @name ScriptServiceGetScriptById 5116 * @summary get script by id 5117 * @request GET:/v1/script/{id} 5118 * @secure 5119 */ 5120 scriptServiceGetScriptById: (id: number, params: RequestParams = {}) => 5121 this.request< 5122 ApiScript, 5123 | { 5124 error?: GenericErrorResponse & { 5125 code?: "UNAUTHORIZED"; 5126 }; 5127 } 5128 | { 5129 error?: GenericErrorResponse; 5130 } 5131 >({ 5132 path: `/v1/script/${id}`, 5133 method: "GET", 5134 secure: true, 5135 format: "json", 5136 ...params, 5137 }), 5138 5139 /** 5140 * No description 5141 * 5142 * @tags ScriptService 5143 * @name ScriptServiceUpdateScriptById 5144 * @summary update script 5145 * @request PUT:/v1/script/{id} 5146 * @secure 5147 */ 5148 scriptServiceUpdateScriptById: ( 5149 id: number, 5150 data: { 5151 lang: string; 5152 name: string; 5153 source: string; 5154 description: string; 5155 }, 5156 params: RequestParams = {}, 5157 ) => 5158 this.request< 5159 ApiScript, 5160 | { 5161 error?: GenericErrorResponse; 5162 } 5163 | { 5164 error?: GenericErrorResponse & { 5165 code?: "UNAUTHORIZED"; 5166 }; 5167 } 5168 >({ 5169 path: `/v1/script/${id}`, 5170 method: "PUT", 5171 body: data, 5172 secure: true, 5173 type: ContentType.Json, 5174 format: "json", 5175 ...params, 5176 }), 5177 5178 /** 5179 * No description 5180 * 5181 * @tags ScriptService 5182 * @name ScriptServiceDeleteScriptById 5183 * @summary delete script by id 5184 * @request DELETE:/v1/script/{id} 5185 * @secure 5186 */ 5187 scriptServiceDeleteScriptById: (id: number, params: RequestParams = {}) => 5188 this.request< 5189 ApiDisablePluginResult, 5190 | { 5191 error?: GenericErrorResponse & { 5192 code?: "UNAUTHORIZED"; 5193 }; 5194 } 5195 | { 5196 error?: GenericErrorResponse; 5197 } 5198 >({ 5199 path: `/v1/script/${id}`, 5200 method: "DELETE", 5201 secure: true, 5202 format: "json", 5203 ...params, 5204 }), 5205 5206 /** 5207 * No description 5208 * 5209 * @tags ScriptService 5210 * @name ScriptServiceCopyScriptById 5211 * @summary copy script by id 5212 * @request POST:/v1/script/{id}/copy 5213 * @secure 5214 */ 5215 scriptServiceCopyScriptById: (id: number, params: RequestParams = {}) => 5216 this.request< 5217 ApiScript, 5218 | { 5219 error?: GenericErrorResponse; 5220 } 5221 | { 5222 error?: GenericErrorResponse & { 5223 code?: "UNAUTHORIZED"; 5224 }; 5225 } 5226 >({ 5227 path: `/v1/script/${id}/copy`, 5228 method: "POST", 5229 secure: true, 5230 format: "json", 5231 ...params, 5232 }), 5233 5234 /** 5235 * No description 5236 * 5237 * @tags ScriptService 5238 * @name ScriptServiceGetCompiledScriptById 5239 * @summary get compiled script by id 5240 * @request GET:/v1/script/{id}/compiled 5241 * @secure 5242 */ 5243 scriptServiceGetCompiledScriptById: (id: number, params: RequestParams = {}) => 5244 this.request< 5245 string, 5246 | { 5247 error?: GenericErrorResponse; 5248 } 5249 | { 5250 error?: GenericErrorResponse & { 5251 code?: "UNAUTHORIZED"; 5252 }; 5253 } 5254 >({ 5255 path: `/v1/script/${id}/compiled`, 5256 method: "GET", 5257 secure: true, 5258 ...params, 5259 }), 5260 5261 /** 5262 * No description 5263 * 5264 * @tags ScriptService 5265 * @name ScriptServiceExecScriptById 5266 * @summary exec script by id 5267 * @request POST:/v1/script/{id}/exec 5268 * @secure 5269 */ 5270 scriptServiceExecScriptById: (id: number, params: RequestParams = {}) => 5271 this.request< 5272 ApiExecScriptResult, 5273 | { 5274 error?: GenericErrorResponse; 5275 } 5276 | { 5277 error?: GenericErrorResponse & { 5278 code?: "UNAUTHORIZED"; 5279 }; 5280 } 5281 >({ 5282 path: `/v1/script/${id}/exec`, 5283 method: "POST", 5284 secure: true, 5285 format: "json", 5286 ...params, 5287 }), 5288 5289 /** 5290 * No description 5291 * 5292 * @tags ScriptService 5293 * @name ScriptServiceGetScriptList 5294 * @summary get script list 5295 * @request GET:/v1/scripts 5296 * @secure 5297 */ 5298 scriptServiceGetScriptList: ( 5299 query?: { 5300 /** 5301 * Field on which to sort and its direction 5302 * @example "-created_at" 5303 */ 5304 sort?: string; 5305 /** 5306 * Page number of the requested result set 5307 * @format uint64 5308 * @default 1 5309 * @example 1 5310 */ 5311 page?: number; 5312 /** 5313 * The number of results returned on a page 5314 * @format uint64 5315 */ 5316 limit?: number; 5317 /** The number of results returned on a page */ 5318 "ids[]"?: number[]; 5319 query?: string; 5320 }, 5321 params: RequestParams = {}, 5322 ) => 5323 this.request< 5324 ApiGetScriptListResult, 5325 { 5326 error?: GenericErrorResponse & { 5327 code?: "UNAUTHORIZED"; 5328 }; 5329 } 5330 >({ 5331 path: `/v1/scripts`, 5332 method: "GET", 5333 query: query, 5334 secure: true, 5335 format: "json", 5336 ...params, 5337 }), 5338 5339 /** 5340 * No description 5341 * 5342 * @tags ScriptService 5343 * @name ScriptServiceSearchScript 5344 * @summary search script by name 5345 * @request GET:/v1/scripts/search 5346 * @secure 5347 */ 5348 scriptServiceSearchScript: ( 5349 query?: { 5350 query?: string; 5351 /** @format int64 */ 5352 offset?: number; 5353 /** @format int64 */ 5354 limit?: number; 5355 }, 5356 params: RequestParams = {}, 5357 ) => 5358 this.request< 5359 ApiSearchScriptListResult, 5360 { 5361 error?: GenericErrorResponse & { 5362 code?: "UNAUTHORIZED"; 5363 }; 5364 } 5365 >({ 5366 path: `/v1/scripts/search`, 5367 method: "GET", 5368 query: query, 5369 secure: true, 5370 format: "json", 5371 ...params, 5372 }), 5373 5374 /** 5375 * No description 5376 * 5377 * @tags ScriptService 5378 * @name ScriptServiceGetStatistic 5379 * @summary get statistic 5380 * @request GET:/v1/scripts/statistic 5381 * @secure 5382 */ 5383 scriptServiceGetStatistic: (params: RequestParams = {}) => 5384 this.request< 5385 ApiStatistics, 5386 { 5387 error?: GenericErrorResponse & { 5388 code?: "UNAUTHORIZED"; 5389 }; 5390 } 5391 >({ 5392 path: `/v1/scripts/statistic`, 5393 method: "GET", 5394 secure: true, 5395 format: "json", 5396 ...params, 5397 }), 5398 5399 /** 5400 * No description 5401 * 5402 * @tags TagService 5403 * @name TagServiceSearchTag 5404 * @summary search tag by name 5405 * @request GET:/v1/tags/search 5406 * @secure 5407 */ 5408 tagServiceSearchTag: ( 5409 query?: { 5410 query?: string; 5411 /** @format int64 */ 5412 offset?: number; 5413 /** @format int64 */ 5414 limit?: number; 5415 }, 5416 params: RequestParams = {}, 5417 ) => 5418 this.request< 5419 ApiSearchTagListResult, 5420 { 5421 error?: GenericErrorResponse & { 5422 code?: "UNAUTHORIZED"; 5423 }; 5424 } 5425 >({ 5426 path: `/v1/tags/search`, 5427 method: "GET", 5428 query: query, 5429 secure: true, 5430 format: "json", 5431 ...params, 5432 }), 5433 5434 /** 5435 * No description 5436 * 5437 * @tags TagService 5438 * @name TagServiceGetTagList 5439 * @summary get tag list 5440 * @request GET:/v1/tags 5441 * @secure 5442 */ 5443 tagServiceGetTagList: ( 5444 query?: { 5445 /** 5446 * Field on which to sort and its direction 5447 * @example "-created_at" 5448 */ 5449 sort?: string; 5450 /** 5451 * Page number of the requested result set 5452 * @format uint64 5453 * @default 1 5454 * @example 1 5455 */ 5456 page?: number; 5457 /** 5458 * The number of results returned on a page 5459 * @format uint64 5460 */ 5461 limit?: number; 5462 query?: string; 5463 "tags[]"?: string[]; 5464 }, 5465 params: RequestParams = {}, 5466 ) => 5467 this.request< 5468 ApiGetTagListResult, 5469 { 5470 error?: GenericErrorResponse & { 5471 code?: "UNAUTHORIZED"; 5472 }; 5473 } 5474 >({ 5475 path: `/v1/tags`, 5476 method: "GET", 5477 query: query, 5478 secure: true, 5479 format: "json", 5480 ...params, 5481 }), 5482 5483 /** 5484 * No description 5485 * 5486 * @tags TagService 5487 * @name TagServiceGetTagById 5488 * @summary get tag by id 5489 * @request GET:/v1/tag/{id} 5490 * @secure 5491 */ 5492 tagServiceGetTagById: (id: number, params: RequestParams = {}) => 5493 this.request< 5494 ApiTag, 5495 | { 5496 error?: GenericErrorResponse & { 5497 code?: "UNAUTHORIZED"; 5498 }; 5499 } 5500 | { 5501 error?: GenericErrorResponse; 5502 } 5503 >({ 5504 path: `/v1/tag/${id}`, 5505 method: "GET", 5506 secure: true, 5507 format: "json", 5508 ...params, 5509 }), 5510 5511 /** 5512 * No description 5513 * 5514 * @tags TagService 5515 * @name TagServiceUpdateTagById 5516 * @summary update tag 5517 * @request PUT:/v1/tag/{id} 5518 * @secure 5519 */ 5520 tagServiceUpdateTagById: ( 5521 id: number, 5522 data: { 5523 name: string; 5524 }, 5525 params: RequestParams = {}, 5526 ) => 5527 this.request< 5528 ApiTag, 5529 | { 5530 error?: GenericErrorResponse; 5531 } 5532 | { 5533 error?: GenericErrorResponse & { 5534 code?: "UNAUTHORIZED"; 5535 }; 5536 } 5537 >({ 5538 path: `/v1/tag/${id}`, 5539 method: "PUT", 5540 body: data, 5541 secure: true, 5542 type: ContentType.Json, 5543 format: "json", 5544 ...params, 5545 }), 5546 5547 /** 5548 * No description 5549 * 5550 * @tags TagService 5551 * @name TagServiceDeleteTagById 5552 * @summary delete tag by id 5553 * @request DELETE:/v1/tag/{id} 5554 * @secure 5555 */ 5556 tagServiceDeleteTagById: (id: number, params: RequestParams = {}) => 5557 this.request< 5558 ApiDisablePluginResult, 5559 | { 5560 error?: GenericErrorResponse & { 5561 code?: "UNAUTHORIZED"; 5562 }; 5563 } 5564 | { 5565 error?: GenericErrorResponse; 5566 } 5567 >({ 5568 path: `/v1/tag/${id}`, 5569 method: "DELETE", 5570 secure: true, 5571 format: "json", 5572 ...params, 5573 }), 5574 5575 /** 5576 * No description 5577 * 5578 * @tags AuthService 5579 * @name AuthServiceSignin 5580 * @summary sign in user 5581 * @request POST:/v1/signin 5582 * @secure 5583 */ 5584 authServiceSignin: (params: RequestParams = {}) => 5585 this.request< 5586 ApiSigninResponse, 5587 | { 5588 error?: GenericErrorResponse; 5589 } 5590 | { 5591 error?: GenericErrorResponse & { 5592 code?: "UNAUTHORIZED"; 5593 }; 5594 } 5595 >({ 5596 path: `/v1/signin`, 5597 method: "POST", 5598 secure: true, 5599 format: "json", 5600 ...params, 5601 }), 5602 5603 /** 5604 * No description 5605 * 5606 * @tags AuthService 5607 * @name AuthServiceSignout 5608 * @summary sign out user 5609 * @request POST:/v1/signout 5610 * @secure 5611 */ 5612 authServiceSignout: (params: RequestParams = {}) => 5613 this.request< 5614 ApiDisablePluginResult, 5615 | { 5616 error?: GenericErrorResponse; 5617 } 5618 | { 5619 error?: GenericErrorResponse & { 5620 code?: "UNAUTHORIZED"; 5621 }; 5622 } 5623 >({ 5624 path: `/v1/signout`, 5625 method: "POST", 5626 secure: true, 5627 format: "json", 5628 ...params, 5629 }), 5630 5631 /** 5632 * No description 5633 * 5634 * @tags AutomationService 5635 * @name AutomationServiceAddTask 5636 * @summary add new task 5637 * @request POST:/v1/task 5638 * @secure 5639 */ 5640 automationServiceAddTask: (data: ApiNewTaskRequest, params: RequestParams = {}) => 5641 this.request< 5642 ApiTask, 5643 | { 5644 error?: GenericErrorResponse; 5645 } 5646 | { 5647 error?: GenericErrorResponse & { 5648 code?: "UNAUTHORIZED"; 5649 }; 5650 } 5651 >({ 5652 path: `/v1/task`, 5653 method: "POST", 5654 body: data, 5655 secure: true, 5656 type: ContentType.Json, 5657 format: "json", 5658 ...params, 5659 }), 5660 5661 /** 5662 * No description 5663 * 5664 * @tags AutomationService 5665 * @name AutomationServiceGetTask 5666 * @summary get task 5667 * @request GET:/v1/task/{id} 5668 * @secure 5669 */ 5670 automationServiceGetTask: (id: number, params: RequestParams = {}) => 5671 this.request< 5672 ApiTask, 5673 | { 5674 error?: GenericErrorResponse & { 5675 code?: "UNAUTHORIZED"; 5676 }; 5677 } 5678 | { 5679 error?: GenericErrorResponse; 5680 } 5681 >({ 5682 path: `/v1/task/${id}`, 5683 method: "GET", 5684 secure: true, 5685 format: "json", 5686 ...params, 5687 }), 5688 5689 /** 5690 * No description 5691 * 5692 * @tags AutomationService 5693 * @name AutomationServiceUpdateTask 5694 * @summary update task 5695 * @request PUT:/v1/task/{id} 5696 * @secure 5697 */ 5698 automationServiceUpdateTask: ( 5699 id: number, 5700 data: { 5701 name: string; 5702 description: string; 5703 enabled: boolean; 5704 condition: string; 5705 triggerIds: number[]; 5706 conditionIds: number[]; 5707 actionIds: number[]; 5708 /** @format int64 */ 5709 areaId?: number; 5710 }, 5711 params: RequestParams = {}, 5712 ) => 5713 this.request< 5714 ApiTask, 5715 | { 5716 error?: GenericErrorResponse; 5717 } 5718 | { 5719 error?: GenericErrorResponse & { 5720 code?: "UNAUTHORIZED"; 5721 }; 5722 } 5723 >({ 5724 path: `/v1/task/${id}`, 5725 method: "PUT", 5726 body: data, 5727 secure: true, 5728 type: ContentType.Json, 5729 format: "json", 5730 ...params, 5731 }), 5732 5733 /** 5734 * No description 5735 * 5736 * @tags AutomationService 5737 * @name AutomationServiceDeleteTask 5738 * @summary delete task 5739 * @request DELETE:/v1/task/{id} 5740 * @secure 5741 */ 5742 automationServiceDeleteTask: (id: number, params: RequestParams = {}) => 5743 this.request< 5744 ApiDisablePluginResult, 5745 | { 5746 error?: GenericErrorResponse & { 5747 code?: "UNAUTHORIZED"; 5748 }; 5749 } 5750 | { 5751 error?: GenericErrorResponse; 5752 } 5753 >({ 5754 path: `/v1/task/${id}`, 5755 method: "DELETE", 5756 secure: true, 5757 format: "json", 5758 ...params, 5759 }), 5760 5761 /** 5762 * No description 5763 * 5764 * @tags AutomationService 5765 * @name AutomationServiceDisableTask 5766 * @summary disable task 5767 * @request POST:/v1/task/{id}/disable 5768 * @secure 5769 */ 5770 automationServiceDisableTask: (id: number, params: RequestParams = {}) => 5771 this.request< 5772 ApiDisablePluginResult, 5773 | { 5774 error?: GenericErrorResponse; 5775 } 5776 | { 5777 error?: GenericErrorResponse & { 5778 code?: "UNAUTHORIZED"; 5779 }; 5780 } 5781 >({ 5782 path: `/v1/task/${id}/disable`, 5783 method: "POST", 5784 secure: true, 5785 format: "json", 5786 ...params, 5787 }), 5788 5789 /** 5790 * No description 5791 * 5792 * @tags AutomationService 5793 * @name AutomationServiceEnableTask 5794 * @summary enable task 5795 * @request POST:/v1/task/{id}/enable 5796 * @secure 5797 */ 5798 automationServiceEnableTask: (id: number, params: RequestParams = {}) => 5799 this.request< 5800 ApiDisablePluginResult, 5801 | { 5802 error?: GenericErrorResponse; 5803 } 5804 | { 5805 error?: GenericErrorResponse & { 5806 code?: "UNAUTHORIZED"; 5807 }; 5808 } 5809 >({ 5810 path: `/v1/task/${id}/enable`, 5811 method: "POST", 5812 secure: true, 5813 format: "json", 5814 ...params, 5815 }), 5816 5817 /** 5818 * No description 5819 * 5820 * @tags AutomationService 5821 * @name AutomationServiceGetTaskList 5822 * @summary get task list 5823 * @request GET:/v1/tasks 5824 * @secure 5825 */ 5826 automationServiceGetTaskList: ( 5827 query?: { 5828 /** 5829 * Field on which to sort and its direction 5830 * @example "-created_at" 5831 */ 5832 sort?: string; 5833 /** 5834 * Page number of the requested result set 5835 * @format uint64 5836 * @default 1 5837 * @example 1 5838 */ 5839 page?: number; 5840 /** 5841 * The number of results returned on a page 5842 * @format uint64 5843 */ 5844 limit?: number; 5845 }, 5846 params: RequestParams = {}, 5847 ) => 5848 this.request< 5849 ApiGetTaskListResult, 5850 { 5851 error?: GenericErrorResponse & { 5852 code?: "UNAUTHORIZED"; 5853 }; 5854 } 5855 >({ 5856 path: `/v1/tasks`, 5857 method: "GET", 5858 query: query, 5859 secure: true, 5860 format: "json", 5861 ...params, 5862 }), 5863 5864 /** 5865 * No description 5866 * 5867 * @tags AutomationService 5868 * @name AutomationServiceImportTask 5869 * @summary import task 5870 * @request POST:/v1/tasks/import 5871 * @secure 5872 */ 5873 automationServiceImportTask: (data: ApiTask, params: RequestParams = {}) => 5874 this.request< 5875 ApiDisablePluginResult, 5876 | { 5877 error?: GenericErrorResponse; 5878 } 5879 | { 5880 error?: GenericErrorResponse & { 5881 code?: "UNAUTHORIZED"; 5882 }; 5883 } 5884 >({ 5885 path: `/v1/tasks/import`, 5886 method: "POST", 5887 body: data, 5888 secure: true, 5889 type: ContentType.Json, 5890 format: "json", 5891 ...params, 5892 }), 5893 5894 /** 5895 * No description 5896 * 5897 * @tags TriggerService 5898 * @name TriggerServiceAddTrigger 5899 * @summary add new trigger 5900 * @request POST:/v1/trigger 5901 * @secure 5902 */ 5903 triggerServiceAddTrigger: (data: ApiNewTriggerRequest, params: RequestParams = {}) => 5904 this.request< 5905 ApiTrigger, 5906 | { 5907 error?: GenericErrorResponse; 5908 } 5909 | { 5910 error?: GenericErrorResponse & { 5911 code?: "UNAUTHORIZED"; 5912 }; 5913 } 5914 >({ 5915 path: `/v1/trigger`, 5916 method: "POST", 5917 body: data, 5918 secure: true, 5919 type: ContentType.Json, 5920 format: "json", 5921 ...params, 5922 }), 5923 5924 /** 5925 * No description 5926 * 5927 * @tags TriggerService 5928 * @name TriggerServiceGetTriggerById 5929 * @summary get trigger by id 5930 * @request GET:/v1/trigger/{id} 5931 * @secure 5932 */ 5933 triggerServiceGetTriggerById: (id: number, params: RequestParams = {}) => 5934 this.request< 5935 ApiTrigger, 5936 | { 5937 error?: GenericErrorResponse & { 5938 code?: "UNAUTHORIZED"; 5939 }; 5940 } 5941 | { 5942 error?: GenericErrorResponse; 5943 } 5944 >({ 5945 path: `/v1/trigger/${id}`, 5946 method: "GET", 5947 secure: true, 5948 format: "json", 5949 ...params, 5950 }), 5951 5952 /** 5953 * No description 5954 * 5955 * @tags TriggerService 5956 * @name TriggerServiceUpdateTrigger 5957 * @summary update trigger 5958 * @request PUT:/v1/trigger/{id} 5959 * @secure 5960 */ 5961 triggerServiceUpdateTrigger: ( 5962 id: number, 5963 data: { 5964 name: string; 5965 description: string; 5966 entityIds: string[]; 5967 script?: ApiScript; 5968 /** @format int64 */ 5969 scriptId?: number; 5970 /** @format int64 */ 5971 areaId?: number; 5972 pluginName: string; 5973 attributes: Record<string, ApiAttribute>; 5974 enabled: boolean; 5975 }, 5976 params: RequestParams = {}, 5977 ) => 5978 this.request< 5979 ApiTrigger, 5980 | { 5981 error?: GenericErrorResponse; 5982 } 5983 | { 5984 error?: GenericErrorResponse & { 5985 code?: "UNAUTHORIZED"; 5986 }; 5987 } 5988 >({ 5989 path: `/v1/trigger/${id}`, 5990 method: "PUT", 5991 body: data, 5992 secure: true, 5993 type: ContentType.Json, 5994 format: "json", 5995 ...params, 5996 }), 5997 5998 /** 5999 * No description 6000 * 6001 * @tags TriggerService 6002 * @name TriggerServiceDeleteTrigger 6003 * @summary delete trigger 6004 * @request DELETE:/v1/trigger/{id} 6005 * @secure 6006 */ 6007 triggerServiceDeleteTrigger: (id: number, params: RequestParams = {}) => 6008 this.request< 6009 ApiDisablePluginResult, 6010 | { 6011 error?: GenericErrorResponse & { 6012 code?: "UNAUTHORIZED"; 6013 }; 6014 } 6015 | { 6016 error?: GenericErrorResponse; 6017 } 6018 >({ 6019 path: `/v1/trigger/${id}`, 6020 method: "DELETE", 6021 secure: true, 6022 format: "json", 6023 ...params, 6024 }), 6025 6026 /** 6027 * No description 6028 * 6029 * @tags TriggerService 6030 * @name TriggerServiceGetTriggerList 6031 * @summary get trigger list 6032 * @request GET:/v1/triggers 6033 * @secure 6034 */ 6035 triggerServiceGetTriggerList: ( 6036 query?: { 6037 /** 6038 * Field on which to sort and its direction 6039 * @example "-created_at" 6040 */ 6041 sort?: string; 6042 /** 6043 * Page number of the requested result set 6044 * @format uint64 6045 * @default 1 6046 * @example 1 6047 */ 6048 page?: number; 6049 /** 6050 * The number of results returned on a page 6051 * @format uint64 6052 */ 6053 limit?: number; 6054 /** The number of results returned on a page */ 6055 "ids[]"?: number[]; 6056 }, 6057 params: RequestParams = {}, 6058 ) => 6059 this.request< 6060 ApiGetTriggerListResult, 6061 { 6062 error?: GenericErrorResponse & { 6063 code?: "UNAUTHORIZED"; 6064 }; 6065 } 6066 >({ 6067 path: `/v1/triggers`, 6068 method: "GET", 6069 query: query, 6070 secure: true, 6071 format: "json", 6072 ...params, 6073 }), 6074 6075 /** 6076 * No description 6077 * 6078 * @tags TriggerService 6079 * @name TriggerServiceSearchTrigger 6080 * @summary search trigger 6081 * @request GET:/v1/triggers/search 6082 * @secure 6083 */ 6084 triggerServiceSearchTrigger: ( 6085 query?: { 6086 query?: string; 6087 /** @format int64 */ 6088 offset?: number; 6089 /** @format int64 */ 6090 limit?: number; 6091 }, 6092 params: RequestParams = {}, 6093 ) => 6094 this.request< 6095 ApiSearchTriggerResult, 6096 { 6097 error?: GenericErrorResponse & { 6098 code?: "UNAUTHORIZED"; 6099 }; 6100 } 6101 >({ 6102 path: `/v1/triggers/search`, 6103 method: "GET", 6104 query: query, 6105 secure: true, 6106 format: "json", 6107 ...params, 6108 }), 6109 6110 /** 6111 * No description 6112 * 6113 * @tags TriggerService 6114 * @name TriggerServiceDisableTrigger 6115 * @summary disable triggers 6116 * @request POST:/v1/triggers/{id}/disable 6117 * @secure 6118 */ 6119 triggerServiceDisableTrigger: (id: number, params: RequestParams = {}) => 6120 this.request< 6121 ApiDisablePluginResult, 6122 | { 6123 error?: GenericErrorResponse; 6124 } 6125 | { 6126 error?: GenericErrorResponse & { 6127 code?: "UNAUTHORIZED"; 6128 }; 6129 } 6130 >({ 6131 path: `/v1/triggers/${id}/disable`, 6132 method: "POST", 6133 secure: true, 6134 format: "json", 6135 ...params, 6136 }), 6137 6138 /** 6139 * No description 6140 * 6141 * @tags TriggerService 6142 * @name TriggerServiceEnableTrigger 6143 * @summary enable triggers 6144 * @request POST:/v1/triggers/{id}/enable 6145 * @secure 6146 */ 6147 triggerServiceEnableTrigger: (id: number, params: RequestParams = {}) => 6148 this.request< 6149 ApiDisablePluginResult, 6150 | { 6151 error?: GenericErrorResponse; 6152 } 6153 | { 6154 error?: GenericErrorResponse & { 6155 code?: "UNAUTHORIZED"; 6156 }; 6157 } 6158 >({ 6159 path: `/v1/triggers/${id}/enable`, 6160 method: "POST", 6161 secure: true, 6162 format: "json", 6163 ...params, 6164 }), 6165 6166 /** 6167 * No description 6168 * 6169 * @tags UserService 6170 * @name UserServiceAddUser 6171 * @summary add new user 6172 * @request POST:/v1/user 6173 * @secure 6174 */ 6175 userServiceAddUser: (data: ApiNewtUserRequest, params: RequestParams = {}) => 6176 this.request< 6177 ApiUserFull, 6178 | { 6179 error?: GenericErrorResponse; 6180 } 6181 | { 6182 error?: GenericErrorResponse & { 6183 code?: "UNAUTHORIZED"; 6184 }; 6185 } 6186 >({ 6187 path: `/v1/user`, 6188 method: "POST", 6189 body: data, 6190 secure: true, 6191 type: ContentType.Json, 6192 format: "json", 6193 ...params, 6194 }), 6195 6196 /** 6197 * No description 6198 * 6199 * @tags UserService 6200 * @name UserServiceGetUserById 6201 * @summary get user by id 6202 * @request GET:/v1/user/{id} 6203 * @secure 6204 */ 6205 userServiceGetUserById: (id: number, params: RequestParams = {}) => 6206 this.request< 6207 ApiUserFull, 6208 | { 6209 error?: GenericErrorResponse & { 6210 code?: "UNAUTHORIZED"; 6211 }; 6212 } 6213 | { 6214 error?: GenericErrorResponse; 6215 } 6216 >({ 6217 path: `/v1/user/${id}`, 6218 method: "GET", 6219 secure: true, 6220 format: "json", 6221 ...params, 6222 }), 6223 6224 /** 6225 * No description 6226 * 6227 * @tags UserService 6228 * @name UserServiceUpdateUserById 6229 * @summary update user by id 6230 * @request PUT:/v1/user/{id} 6231 * @secure 6232 */ 6233 userServiceUpdateUserById: ( 6234 id: number, 6235 data: { 6236 nickname: string; 6237 firstName: string; 6238 lastName?: string; 6239 password: string; 6240 passwordRepeat: string; 6241 email: string; 6242 status: string; 6243 lang: string; 6244 /** @format int64 */ 6245 imageId?: number; 6246 roleName: string; 6247 meta?: ApiUserMeta[]; 6248 }, 6249 params: RequestParams = {}, 6250 ) => 6251 this.request< 6252 ApiUserFull, 6253 | { 6254 error?: GenericErrorResponse; 6255 } 6256 | { 6257 error?: GenericErrorResponse & { 6258 code?: "UNAUTHORIZED"; 6259 }; 6260 } 6261 >({ 6262 path: `/v1/user/${id}`, 6263 method: "PUT", 6264 body: data, 6265 secure: true, 6266 type: ContentType.Json, 6267 format: "json", 6268 ...params, 6269 }), 6270 6271 /** 6272 * No description 6273 * 6274 * @tags UserService 6275 * @name UserServiceDeleteUserById 6276 * @summary delete user by id 6277 * @request DELETE:/v1/user/{id} 6278 * @secure 6279 */ 6280 userServiceDeleteUserById: (id: number, params: RequestParams = {}) => 6281 this.request< 6282 ApiDisablePluginResult, 6283 | { 6284 error?: GenericErrorResponse & { 6285 code?: "UNAUTHORIZED"; 6286 }; 6287 } 6288 | { 6289 error?: GenericErrorResponse; 6290 } 6291 >({ 6292 path: `/v1/user/${id}`, 6293 method: "DELETE", 6294 secure: true, 6295 format: "json", 6296 ...params, 6297 }), 6298 6299 /** 6300 * No description 6301 * 6302 * @tags UserService 6303 * @name UserServiceGetUserList 6304 * @summary get user list 6305 * @request GET:/v1/users 6306 * @secure 6307 */ 6308 userServiceGetUserList: ( 6309 query?: { 6310 /** 6311 * Field on which to sort and its direction 6312 * @example "-created_at" 6313 */ 6314 sort?: string; 6315 /** 6316 * Page number of the requested result set 6317 * @format uint64 6318 * @default 1 6319 * @example 1 6320 */ 6321 page?: number; 6322 /** 6323 * The number of results returned on a page 6324 * @format uint64 6325 */ 6326 limit?: number; 6327 }, 6328 params: RequestParams = {}, 6329 ) => 6330 this.request< 6331 ApiGetUserListResult, 6332 { 6333 error?: GenericErrorResponse & { 6334 code?: "UNAUTHORIZED"; 6335 }; 6336 } 6337 >({ 6338 path: `/v1/users`, 6339 method: "GET", 6340 query: query, 6341 secure: true, 6342 format: "json", 6343 ...params, 6344 }), 6345 6346 /** 6347 * No description 6348 * 6349 * @tags VariableService 6350 * @name VariableServiceAddVariable 6351 * @summary add new variable 6352 * @request POST:/v1/variable 6353 * @secure 6354 */ 6355 variableServiceAddVariable: (data: ApiNewVariableRequest, params: RequestParams = {}) => 6356 this.request< 6357 ApiVariable, 6358 | { 6359 error?: GenericErrorResponse; 6360 } 6361 | { 6362 error?: GenericErrorResponse & { 6363 code?: "UNAUTHORIZED"; 6364 }; 6365 } 6366 >({ 6367 path: `/v1/variable`, 6368 method: "POST", 6369 body: data, 6370 secure: true, 6371 type: ContentType.Json, 6372 format: "json", 6373 ...params, 6374 }), 6375 6376 /** 6377 * No description 6378 * 6379 * @tags VariableService 6380 * @name VariableServiceGetVariableByName 6381 * @summary get variable by name 6382 * @request GET:/v1/variable/{name} 6383 * @secure 6384 */ 6385 variableServiceGetVariableByName: (name: string, params: RequestParams = {}) => 6386 this.request< 6387 ApiVariable, 6388 | { 6389 error?: GenericErrorResponse & { 6390 code?: "UNAUTHORIZED"; 6391 }; 6392 } 6393 | { 6394 error?: GenericErrorResponse; 6395 } 6396 >({ 6397 path: `/v1/variable/${name}`, 6398 method: "GET", 6399 secure: true, 6400 format: "json", 6401 ...params, 6402 }), 6403 6404 /** 6405 * No description 6406 * 6407 * @tags VariableService 6408 * @name VariableServiceUpdateVariable 6409 * @summary update variable 6410 * @request PUT:/v1/variable/{name} 6411 * @secure 6412 */ 6413 variableServiceUpdateVariable: ( 6414 name: string, 6415 data: { 6416 value: string; 6417 tags: string[]; 6418 }, 6419 params: RequestParams = {}, 6420 ) => 6421 this.request< 6422 ApiVariable, 6423 | { 6424 error?: GenericErrorResponse; 6425 } 6426 | { 6427 error?: GenericErrorResponse & { 6428 code?: "UNAUTHORIZED"; 6429 }; 6430 } 6431 >({ 6432 path: `/v1/variable/${name}`, 6433 method: "PUT", 6434 body: data, 6435 secure: true, 6436 type: ContentType.Json, 6437 format: "json", 6438 ...params, 6439 }), 6440 6441 /** 6442 * No description 6443 * 6444 * @tags VariableService 6445 * @name VariableServiceDeleteVariable 6446 * @summary delete variable 6447 * @request DELETE:/v1/variable/{name} 6448 * @secure 6449 */ 6450 variableServiceDeleteVariable: (name: string, params: RequestParams = {}) => 6451 this.request< 6452 ApiDisablePluginResult, 6453 | { 6454 error?: GenericErrorResponse & { 6455 code?: "UNAUTHORIZED"; 6456 }; 6457 } 6458 | { 6459 error?: GenericErrorResponse; 6460 } 6461 >({ 6462 path: `/v1/variable/${name}`, 6463 method: "DELETE", 6464 secure: true, 6465 format: "json", 6466 ...params, 6467 }), 6468 6469 /** 6470 * No description 6471 * 6472 * @tags VariableService 6473 * @name VariableServiceGetVariableList 6474 * @summary get variable list 6475 * @request GET:/v1/variables 6476 * @secure 6477 */ 6478 variableServiceGetVariableList: ( 6479 query?: { 6480 /** 6481 * Field on which to sort and its direction 6482 * @example "-created_at" 6483 */ 6484 sort?: string; 6485 /** 6486 * Page number of the requested result set 6487 * @format uint64 6488 * @default 1 6489 * @example 1 6490 */ 6491 page?: number; 6492 /** 6493 * The number of results returned on a page 6494 * @format uint64 6495 */ 6496 limit?: number; 6497 }, 6498 params: RequestParams = {}, 6499 ) => 6500 this.request< 6501 ApiGetVariableListResult, 6502 { 6503 error?: GenericErrorResponse & { 6504 code?: "UNAUTHORIZED"; 6505 }; 6506 } 6507 >({ 6508 path: `/v1/variables`, 6509 method: "GET", 6510 query: query, 6511 secure: true, 6512 format: "json", 6513 ...params, 6514 }), 6515 6516 /** 6517 * No description 6518 * 6519 * @tags VariableService 6520 * @name VariableServiceSearchVariable 6521 * @summary search trigger 6522 * @request GET:/v1/variables/search 6523 * @secure 6524 */ 6525 variableServiceSearchVariable: ( 6526 query?: { 6527 query?: string; 6528 /** @format int64 */ 6529 offset?: number; 6530 /** @format int64 */ 6531 limit?: number; 6532 }, 6533 params: RequestParams = {}, 6534 ) => 6535 this.request< 6536 ApiSearchVariableResult, 6537 { 6538 error?: GenericErrorResponse & { 6539 code?: "UNAUTHORIZED"; 6540 }; 6541 } 6542 >({ 6543 path: `/v1/variables/search`, 6544 method: "GET", 6545 query: query, 6546 secure: true, 6547 format: "json", 6548 ...params, 6549 }), 6550 6551 /** 6552 * No description 6553 * 6554 * @tags Zigbee2mqttService 6555 * @name Zigbee2MqttServiceGetBridgeList 6556 * @summary get bridge list 6557 * @request GET:/v1/zigbee2mqtt/bridge 6558 * @secure 6559 */ 6560 zigbee2MqttServiceGetBridgeList: ( 6561 query?: { 6562 /** 6563 * Field on which to sort and its direction 6564 * @example "-created_at" 6565 */ 6566 sort?: string; 6567 /** 6568 * Page number of the requested result set 6569 * @format uint64 6570 * @default 1 6571 * @example 1 6572 */ 6573 page?: number; 6574 /** 6575 * The number of results returned on a page 6576 * @format uint64 6577 */ 6578 limit?: number; 6579 }, 6580 params: RequestParams = {}, 6581 ) => 6582 this.request< 6583 ApiGetBridgeListResult, 6584 { 6585 error?: GenericErrorResponse & { 6586 code?: "UNAUTHORIZED"; 6587 }; 6588 } 6589 >({ 6590 path: `/v1/zigbee2mqtt/bridge`, 6591 method: "GET", 6592 query: query, 6593 secure: true, 6594 format: "json", 6595 ...params, 6596 }), 6597 6598 /** 6599 * No description 6600 * 6601 * @tags Zigbee2mqttService 6602 * @name Zigbee2MqttServiceAddZigbee2MqttBridge 6603 * @summary add new bridge 6604 * @request POST:/v1/zigbee2mqtt/bridge 6605 * @secure 6606 */ 6607 zigbee2MqttServiceAddZigbee2MqttBridge: (data: ApiNewZigbee2MqttRequest, params: RequestParams = {}) => 6608 this.request< 6609 ApiZigbee2Mqtt, 6610 | { 6611 error?: GenericErrorResponse; 6612 } 6613 | { 6614 error?: GenericErrorResponse & { 6615 code?: "UNAUTHORIZED"; 6616 }; 6617 } 6618 >({ 6619 path: `/v1/zigbee2mqtt/bridge`, 6620 method: "POST", 6621 body: data, 6622 secure: true, 6623 type: ContentType.Json, 6624 format: "json", 6625 ...params, 6626 }), 6627 6628 /** 6629 * No description 6630 * 6631 * @tags Zigbee2mqttService 6632 * @name Zigbee2MqttServiceGetZigbee2MqttBridge 6633 * @summary get bridge 6634 * @request GET:/v1/zigbee2mqtt/bridge/{id} 6635 * @secure 6636 */ 6637 zigbee2MqttServiceGetZigbee2MqttBridge: (id: number, params: RequestParams = {}) => 6638 this.request< 6639 ApiZigbee2Mqtt, 6640 | { 6641 error?: GenericErrorResponse & { 6642 code?: "UNAUTHORIZED"; 6643 }; 6644 } 6645 | { 6646 error?: GenericErrorResponse; 6647 } 6648 >({ 6649 path: `/v1/zigbee2mqtt/bridge/${id}`, 6650 method: "GET", 6651 secure: true, 6652 format: "json", 6653 ...params, 6654 }), 6655 6656 /** 6657 * No description 6658 * 6659 * @tags Zigbee2mqttService 6660 * @name Zigbee2MqttServiceDeleteBridgeById 6661 * @summary delete bridge by id 6662 * @request DELETE:/v1/zigbee2mqtt/bridge/{id} 6663 * @secure 6664 */ 6665 zigbee2MqttServiceDeleteBridgeById: (id: number, params: RequestParams = {}) => 6666 this.request< 6667 ApiDisablePluginResult, 6668 | { 6669 error?: GenericErrorResponse & { 6670 code?: "UNAUTHORIZED"; 6671 }; 6672 } 6673 | { 6674 error?: GenericErrorResponse; 6675 } 6676 >({ 6677 path: `/v1/zigbee2mqtt/bridge/${id}`, 6678 method: "DELETE", 6679 secure: true, 6680 format: "json", 6681 ...params, 6682 }), 6683 6684 /** 6685 * No description 6686 * 6687 * @tags Zigbee2mqttService 6688 * @name Zigbee2MqttServiceUpdateBridgeById 6689 * @summary update bridge by id 6690 * @request PUT:/v1/zigbee2mqtt/bridge/{id}/bridge 6691 * @secure 6692 */ 6693 zigbee2MqttServiceUpdateBridgeById: ( 6694 id: number, 6695 data: { 6696 name: string; 6697 login: string; 6698 password?: string; 6699 permitJoin: boolean; 6700 baseTopic: string; 6701 }, 6702 params: RequestParams = {}, 6703 ) => 6704 this.request< 6705 ApiZigbee2Mqtt, 6706 | { 6707 error?: GenericErrorResponse; 6708 } 6709 | { 6710 error?: GenericErrorResponse & { 6711 code?: "UNAUTHORIZED"; 6712 }; 6713 } 6714 >({ 6715 path: `/v1/zigbee2mqtt/bridge/${id}/bridge`, 6716 method: "PUT", 6717 body: data, 6718 secure: true, 6719 type: ContentType.Json, 6720 format: "json", 6721 ...params, 6722 }), 6723 6724 /** 6725 * No description 6726 * 6727 * @tags Zigbee2mqttService 6728 * @name Zigbee2MqttServiceDeviceList 6729 * @summary list device 6730 * @request GET:/v1/zigbee2mqtt/bridge/{id}/devices 6731 * @secure 6732 */ 6733 zigbee2MqttServiceDeviceList: ( 6734 id: number, 6735 query?: { 6736 /** 6737 * Field on which to sort and its direction 6738 * @example "-created_at" 6739 */ 6740 sort?: string; 6741 /** 6742 * Page number of the requested result set 6743 * @format uint64 6744 * @default 1 6745 * @example 1 6746 */ 6747 page?: number; 6748 /** 6749 * The number of results returned on a page 6750 * @format uint64 6751 */ 6752 limit?: number; 6753 }, 6754 params: RequestParams = {}, 6755 ) => 6756 this.request< 6757 ApiDeviceListResult, 6758 | { 6759 error?: GenericErrorResponse & { 6760 code?: "UNAUTHORIZED"; 6761 }; 6762 } 6763 | { 6764 error?: GenericErrorResponse; 6765 } 6766 >({ 6767 path: `/v1/zigbee2mqtt/bridge/${id}/devices`, 6768 method: "GET", 6769 query: query, 6770 secure: true, 6771 format: "json", 6772 ...params, 6773 }), 6774 6775 /** 6776 * No description 6777 * 6778 * @tags Zigbee2mqttService 6779 * @name Zigbee2MqttServiceNetworkmap 6780 * @summary networkmap 6781 * @request GET:/v1/zigbee2mqtt/bridge/{id}/networkmap 6782 * @secure 6783 */ 6784 zigbee2MqttServiceNetworkmap: (id: number, params: RequestParams = {}) => 6785 this.request< 6786 ApiNetworkmapResponse, 6787 | { 6788 error?: GenericErrorResponse & { 6789 code?: "UNAUTHORIZED"; 6790 }; 6791 } 6792 | { 6793 error?: GenericErrorResponse; 6794 } 6795 >({ 6796 path: `/v1/zigbee2mqtt/bridge/${id}/networkmap`, 6797 method: "GET", 6798 secure: true, 6799 format: "json", 6800 ...params, 6801 }), 6802 6803 /** 6804 * No description 6805 * 6806 * @tags Zigbee2mqttService 6807 * @name Zigbee2MqttServiceUpdateNetworkmap 6808 * @summary update networkmap 6809 * @request POST:/v1/zigbee2mqtt/bridge/{id}/networkmap 6810 * @secure 6811 */ 6812 zigbee2MqttServiceUpdateNetworkmap: (id: number, params: RequestParams = {}) => 6813 this.request< 6814 ApiDisablePluginResult, 6815 | { 6816 error?: GenericErrorResponse; 6817 } 6818 | { 6819 error?: GenericErrorResponse & { 6820 code?: "UNAUTHORIZED"; 6821 }; 6822 } 6823 >({ 6824 path: `/v1/zigbee2mqtt/bridge/${id}/networkmap`, 6825 method: "POST", 6826 secure: true, 6827 format: "json", 6828 ...params, 6829 }), 6830 6831 /** 6832 * No description 6833 * 6834 * @tags Zigbee2mqttService 6835 * @name Zigbee2MqttServiceResetBridgeById 6836 * @summary reset bridge by id 6837 * @request POST:/v1/zigbee2mqtt/bridge/{id}/reset 6838 * @secure 6839 */ 6840 zigbee2MqttServiceResetBridgeById: (id: number, params: RequestParams = {}) => 6841 this.request< 6842 ApiDisablePluginResult, 6843 | { 6844 error?: GenericErrorResponse; 6845 } 6846 | { 6847 error?: GenericErrorResponse & { 6848 code?: "UNAUTHORIZED"; 6849 }; 6850 } 6851 >({ 6852 path: `/v1/zigbee2mqtt/bridge/${id}/reset`, 6853 method: "POST", 6854 secure: true, 6855 format: "json", 6856 ...params, 6857 }), 6858 6859 /** 6860 * No description 6861 * 6862 * @tags Zigbee2mqttService 6863 * @name Zigbee2MqttServiceDeviceBan 6864 * @summary device ban 6865 * @request POST:/v1/zigbee2mqtt/device_ban 6866 * @secure 6867 */ 6868 zigbee2MqttServiceDeviceBan: (data: ApiDeviceBanRequest, params: RequestParams = {}) => 6869 this.request< 6870 ApiDisablePluginResult, 6871 | { 6872 error?: GenericErrorResponse; 6873 } 6874 | { 6875 error?: GenericErrorResponse & { 6876 code?: "UNAUTHORIZED"; 6877 }; 6878 } 6879 >({ 6880 path: `/v1/zigbee2mqtt/device_ban`, 6881 method: "POST", 6882 body: data, 6883 secure: true, 6884 type: ContentType.Json, 6885 format: "json", 6886 ...params, 6887 }), 6888 6889 /** 6890 * No description 6891 * 6892 * @tags Zigbee2mqttService 6893 * @name Zigbee2MqttServiceDeviceRename 6894 * @summary device rename 6895 * @request POST:/v1/zigbee2mqtt/device_rename 6896 * @secure 6897 */ 6898 zigbee2MqttServiceDeviceRename: (data: ApiDeviceRenameRequest, params: RequestParams = {}) => 6899 this.request< 6900 ApiDisablePluginResult, 6901 | { 6902 error?: GenericErrorResponse; 6903 } 6904 | { 6905 error?: GenericErrorResponse & { 6906 code?: "UNAUTHORIZED"; 6907 }; 6908 } 6909 >({ 6910 path: `/v1/zigbee2mqtt/device_rename`, 6911 method: "POST", 6912 body: data, 6913 secure: true, 6914 type: ContentType.Json, 6915 format: "json", 6916 ...params, 6917 }), 6918 6919 /** 6920 * No description 6921 * 6922 * @tags Zigbee2mqttService 6923 * @name Zigbee2MqttServiceDeviceWhitelist 6924 * @summary device whitelist 6925 * @request POST:/v1/zigbee2mqtt/device_whitelist 6926 * @secure 6927 */ 6928 zigbee2MqttServiceDeviceWhitelist: (data: ApiDeviceWhitelistRequest, params: RequestParams = {}) => 6929 this.request< 6930 ApiDisablePluginResult, 6931 | { 6932 error?: GenericErrorResponse; 6933 } 6934 | { 6935 error?: GenericErrorResponse & { 6936 code?: "UNAUTHORIZED"; 6937 }; 6938 } 6939 >({ 6940 path: `/v1/zigbee2mqtt/device_whitelist`, 6941 method: "POST", 6942 body: data, 6943 secure: true, 6944 type: ContentType.Json, 6945 format: "json", 6946 ...params, 6947 }), 6948 6949 /** 6950 * No description 6951 * 6952 * @tags Zigbee2mqttService 6953 * @name Zigbee2MqttServiceSearchDevice 6954 * @summary search device 6955 * @request GET:/v1/zigbee2mqtt/search_device 6956 * @secure 6957 */ 6958 zigbee2MqttServiceSearchDevice: ( 6959 query?: { 6960 query?: string; 6961 /** @format int64 */ 6962 offset?: number; 6963 /** @format int64 */ 6964 limit?: number; 6965 }, 6966 params: RequestParams = {}, 6967 ) => 6968 this.request< 6969 ApiSearchDeviceResult, 6970 { 6971 error?: GenericErrorResponse & { 6972 code?: "UNAUTHORIZED"; 6973 }; 6974 } 6975 >({ 6976 path: `/v1/zigbee2mqtt/search_device`, 6977 method: "GET", 6978 query: query, 6979 secure: true, 6980 format: "json", 6981 ...params, 6982 }), 6983 6984 /** 6985 * No description 6986 * 6987 * @tags StreamService 6988 * @name StreamServiceSubscribe 6989 * @request GET:/v1/ws 6990 * @secure 6991 */ 6992 streamServiceSubscribe: (params: RequestParams = {}) => 6993 this.request< 6994 ApiResponse, 6995 { 6996 error?: GenericErrorResponse & { 6997 code?: "UNAUTHORIZED"; 6998 }; 6999 } 7000 >({ 7001 path: `/v1/ws`, 7002 method: "GET", 7003 secure: true, 7004 format: "json", 7005 ...params, 7006 }), 7007 }; 7008 }