@sippulse/niva-sdk 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/{chunk-wx0m9ra5.js → chunk-3w2v383z.js} +112 -111
- package/dts/src/generated/client.d.ts +6 -6
- package/dts/src/generated/meta.d.ts +1 -1
- package/dts/src/generated/operations.d.ts +157 -49
- package/index.bun.js +1 -1
- package/index.default.js +1 -1
- package/index.deno.js +1 -1
- package/index.node.js +1 -1
- package/package.json +2 -2
|
@@ -591,7 +591,7 @@ function buildNivaClient(call) {
|
|
|
591
591
|
}
|
|
592
592
|
|
|
593
593
|
// src/generated/meta.ts
|
|
594
|
-
var SDK_VERSION = "0.2.
|
|
594
|
+
var SDK_VERSION = "0.2.1";
|
|
595
595
|
var SUPPORTED_NIVA = { min: "2.0.0", max: null };
|
|
596
596
|
var PROTOCOL_VERSION = 1;
|
|
597
597
|
var COMPAT_TABLE = [
|
|
@@ -614,6 +614,7 @@ var ERROR_CODES2 = [
|
|
|
614
614
|
"ARCHIVE_RESTORE_CONFLICT",
|
|
615
615
|
"ATTENDANT_ALREADY_EXISTS",
|
|
616
616
|
"ATTENDANT_BUSY",
|
|
617
|
+
"ATTENDANT_LIMIT_REACHED",
|
|
617
618
|
"ATTENDANT_NOT_FOUND",
|
|
618
619
|
"ATTENDANT_NOT_SIP_EXTENSION",
|
|
619
620
|
"AUDIO_FILE_CONTENT_MISSING",
|
|
@@ -768,99 +769,99 @@ var ERROR_CODES2 = [
|
|
|
768
769
|
];
|
|
769
770
|
var COMMON_ERROR_CODES2 = [];
|
|
770
771
|
var ERROR_CODE_SETS2 = [
|
|
771
|
-
[
|
|
772
|
-
[
|
|
773
|
-
[
|
|
774
|
-
[
|
|
775
|
-
[
|
|
776
|
-
[
|
|
777
|
-
[
|
|
778
|
-
[
|
|
779
|
-
[
|
|
780
|
-
[8,
|
|
781
|
-
[
|
|
782
|
-
[
|
|
783
|
-
[
|
|
784
|
-
[
|
|
785
|
-
[
|
|
786
|
-
[
|
|
787
|
-
[
|
|
788
|
-
[
|
|
789
|
-
[
|
|
790
|
-
[
|
|
791
|
-
[
|
|
792
|
-
[
|
|
793
|
-
[
|
|
794
|
-
[
|
|
795
|
-
[
|
|
796
|
-
[
|
|
797
|
-
[
|
|
798
|
-
[
|
|
799
|
-
[
|
|
800
|
-
[
|
|
801
|
-
[
|
|
802
|
-
[
|
|
803
|
-
[
|
|
804
|
-
[
|
|
805
|
-
[
|
|
806
|
-
[
|
|
807
|
-
[
|
|
808
|
-
[
|
|
809
|
-
[
|
|
810
|
-
[
|
|
811
|
-
[
|
|
812
|
-
[
|
|
813
|
-
[1,
|
|
814
|
-
[13,
|
|
815
|
-
[
|
|
816
|
-
[3, 4, 5,
|
|
817
|
-
[
|
|
818
|
-
[
|
|
819
|
-
[
|
|
820
|
-
[7, 8,
|
|
821
|
-
[
|
|
822
|
-
[
|
|
823
|
-
[
|
|
824
|
-
[
|
|
825
|
-
[
|
|
826
|
-
[
|
|
827
|
-
[
|
|
828
|
-
[
|
|
829
|
-
[
|
|
830
|
-
[
|
|
831
|
-
[
|
|
832
|
-
[0,
|
|
833
|
-
[
|
|
834
|
-
[3, 4, 5,
|
|
835
|
-
[3, 4, 5,
|
|
836
|
-
[
|
|
837
|
-
[
|
|
838
|
-
[
|
|
839
|
-
[
|
|
840
|
-
[
|
|
841
|
-
[
|
|
842
|
-
[
|
|
843
|
-
[
|
|
844
|
-
[
|
|
845
|
-
[
|
|
846
|
-
[
|
|
847
|
-
[2,
|
|
848
|
-
[
|
|
849
|
-
[
|
|
850
|
-
[
|
|
851
|
-
[2, 12,
|
|
852
|
-
[3, 4, 5,
|
|
853
|
-
[
|
|
854
|
-
[
|
|
855
|
-
[6,
|
|
856
|
-
[
|
|
857
|
-
[
|
|
858
|
-
[
|
|
859
|
-
[
|
|
860
|
-
[4,
|
|
861
|
-
[2,
|
|
862
|
-
[
|
|
863
|
-
[
|
|
772
|
+
[49, 157, 158],
|
|
773
|
+
[52, 157, 158],
|
|
774
|
+
[87, 110, 111, 156],
|
|
775
|
+
[50, 51, 100, 157, 158],
|
|
776
|
+
[32, 33, 87, 110, 111, 156],
|
|
777
|
+
[87, 93, 94, 110, 111, 156],
|
|
778
|
+
[35, 87, 93, 94, 110, 111, 156],
|
|
779
|
+
[36, 87, 93, 94, 110, 111, 156],
|
|
780
|
+
[58, 87, 93, 94, 110, 111, 156],
|
|
781
|
+
[8, 87, 93, 94, 110, 111, 156],
|
|
782
|
+
[81, 87, 93, 94, 110, 111, 156],
|
|
783
|
+
[87, 91, 93, 94, 110, 111, 156],
|
|
784
|
+
[87, 93, 94, 110, 111, 112, 156],
|
|
785
|
+
[87, 93, 94, 110, 111, 141, 156],
|
|
786
|
+
[87, 93, 94, 110, 111, 142, 156],
|
|
787
|
+
[87, 93, 94, 110, 111, 156, 159],
|
|
788
|
+
[87, 93, 94, 110, 111, 156, 160],
|
|
789
|
+
[87, 93, 94, 95, 110, 111, 156],
|
|
790
|
+
[87, 93, 94, 96, 110, 111, 156],
|
|
791
|
+
[87, 93, 94, 97, 110, 111, 156],
|
|
792
|
+
[15, 87, 93, 94, 110, 111, 112, 156],
|
|
793
|
+
[17, 20, 87, 93, 94, 110, 111, 156],
|
|
794
|
+
[18, 22, 87, 93, 94, 110, 111, 156],
|
|
795
|
+
[31, 87, 93, 94, 110, 111, 112, 156],
|
|
796
|
+
[35, 49, 87, 93, 94, 110, 111, 156],
|
|
797
|
+
[53, 87, 93, 94, 110, 111, 112, 156],
|
|
798
|
+
[54, 87, 93, 94, 110, 111, 112, 156],
|
|
799
|
+
[55, 87, 93, 94, 110, 111, 112, 156],
|
|
800
|
+
[79, 87, 93, 94, 110, 111, 112, 156],
|
|
801
|
+
[79, 87, 93, 94, 96, 110, 111, 156],
|
|
802
|
+
[81, 87, 93, 94, 110, 111, 112, 156],
|
|
803
|
+
[87, 89, 91, 93, 94, 110, 111, 156],
|
|
804
|
+
[87, 90, 91, 93, 94, 110, 111, 156],
|
|
805
|
+
[87, 91, 93, 94, 97, 110, 111, 156],
|
|
806
|
+
[87, 92, 93, 94, 110, 111, 112, 156],
|
|
807
|
+
[87, 93, 94, 109, 110, 111, 125, 156],
|
|
808
|
+
[87, 93, 94, 110, 111, 112, 131, 156],
|
|
809
|
+
[87, 93, 94, 110, 111, 112, 156, 163],
|
|
810
|
+
[87, 93, 94, 110, 111, 112, 156, 164],
|
|
811
|
+
[87, 93, 94, 110, 111, 116, 117, 156],
|
|
812
|
+
[87, 93, 94, 110, 111, 156, 161, 162],
|
|
813
|
+
[87, 93, 94, 98, 110, 111, 142, 156],
|
|
814
|
+
[1, 77, 87, 88, 93, 94, 110, 111, 156],
|
|
815
|
+
[13, 15, 87, 93, 94, 110, 111, 112, 156],
|
|
816
|
+
[15, 87, 93, 94, 110, 111, 112, 131, 156],
|
|
817
|
+
[3, 4, 5, 87, 93, 94, 110, 111, 156],
|
|
818
|
+
[49, 55, 87, 93, 94, 110, 111, 112, 156],
|
|
819
|
+
[53, 65, 87, 93, 94, 110, 111, 112, 156],
|
|
820
|
+
[66, 67, 87, 93, 94, 110, 111, 112, 156],
|
|
821
|
+
[7, 8, 87, 93, 94, 110, 111, 143, 156],
|
|
822
|
+
[78, 81, 83, 87, 93, 94, 110, 111, 156],
|
|
823
|
+
[80, 81, 82, 87, 93, 94, 110, 111, 156],
|
|
824
|
+
[86, 87, 93, 94, 110, 111, 112, 154, 156],
|
|
825
|
+
[87, 89, 91, 93, 94, 97, 110, 111, 156],
|
|
826
|
+
[87, 91, 93, 94, 95, 98, 110, 111, 156],
|
|
827
|
+
[87, 93, 94, 110, 111, 112, 122, 123, 156],
|
|
828
|
+
[87, 93, 94, 110, 111, 112, 126, 127, 156],
|
|
829
|
+
[87, 93, 94, 110, 111, 112, 126, 148, 156],
|
|
830
|
+
[87, 93, 94, 110, 111, 112, 129, 131, 156],
|
|
831
|
+
[87, 93, 94, 110, 111, 112, 139, 140, 156],
|
|
832
|
+
[87, 93, 94, 98, 110, 111, 141, 142, 156],
|
|
833
|
+
[0, 37, 87, 93, 94, 109, 110, 111, 125, 156],
|
|
834
|
+
[20, 87, 93, 94, 110, 111, 112, 130, 131, 156],
|
|
835
|
+
[3, 4, 5, 87, 93, 94, 110, 111, 112, 156],
|
|
836
|
+
[3, 4, 5, 87, 93, 94, 110, 111, 155, 156],
|
|
837
|
+
[35, 87, 93, 94, 110, 111, 134, 135, 136, 156],
|
|
838
|
+
[38, 87, 93, 94, 99, 109, 110, 111, 125, 156],
|
|
839
|
+
[39, 87, 93, 94, 99, 109, 110, 111, 125, 156],
|
|
840
|
+
[53, 60, 67, 87, 93, 94, 110, 111, 112, 156],
|
|
841
|
+
[60, 67, 68, 87, 93, 94, 110, 111, 112, 156],
|
|
842
|
+
[70, 87, 93, 94, 110, 111, 112, 126, 148, 156],
|
|
843
|
+
[71, 72, 87, 93, 94, 110, 111, 112, 131, 156],
|
|
844
|
+
[78, 81, 83, 87, 93, 94, 110, 111, 112, 156],
|
|
845
|
+
[80, 81, 82, 87, 93, 94, 110, 111, 112, 156],
|
|
846
|
+
[87, 91, 93, 94, 95, 98, 110, 111, 142, 156],
|
|
847
|
+
[15, 87, 93, 94, 110, 111, 112, 123, 124, 156, 165],
|
|
848
|
+
[2, 15, 16, 57, 87, 93, 94, 110, 111, 112, 156],
|
|
849
|
+
[53, 63, 64, 67, 87, 93, 94, 110, 111, 112, 156],
|
|
850
|
+
[73, 87, 93, 94, 110, 111, 112, 126, 128, 148, 156],
|
|
851
|
+
[59, 60, 61, 62, 69, 87, 93, 94, 110, 111, 112, 156],
|
|
852
|
+
[2, 12, 15, 57, 84, 85, 87, 93, 94, 110, 111, 112, 156],
|
|
853
|
+
[3, 4, 5, 19, 20, 21, 87, 93, 94, 110, 111, 155, 156],
|
|
854
|
+
[37, 38, 87, 93, 94, 99, 109, 110, 111, 125, 137, 138, 156],
|
|
855
|
+
[59, 60, 61, 62, 69, 87, 93, 94, 110, 111, 112, 126, 156],
|
|
856
|
+
[6, 75, 87, 93, 94, 110, 111, 113, 125, 137, 138, 152, 156],
|
|
857
|
+
[87, 93, 94, 101, 102, 103, 104, 105, 106, 107, 110, 111, 156],
|
|
858
|
+
[23, 24, 25, 26, 27, 28, 29, 30, 87, 93, 94, 110, 111, 156],
|
|
859
|
+
[77, 86, 87, 93, 94, 110, 111, 112, 118, 119, 120, 121, 126, 156],
|
|
860
|
+
[9, 10, 11, 14, 48, 87, 93, 94, 108, 110, 111, 112, 125, 156],
|
|
861
|
+
[4, 34, 87, 93, 94, 110, 111, 112, 114, 115, 132, 133, 136, 153, 156],
|
|
862
|
+
[2, 40, 41, 42, 43, 44, 45, 46, 47, 48, 74, 87, 93, 94, 110, 111, 112, 156],
|
|
863
|
+
[35, 56, 76, 87, 93, 94, 110, 111, 112, 126, 144, 145, 146, 147, 148, 149, 150, 151, 156],
|
|
864
|
+
[2, 6, 12, 14, 15, 57, 84, 85, 87, 93, 94, 109, 110, 111, 112, 125, 137, 138, 152, 156]
|
|
864
865
|
];
|
|
865
866
|
var OPERATIONS2 = {
|
|
866
867
|
"ai.getBudget": {
|
|
@@ -1050,7 +1051,7 @@ var OPERATIONS2 = {
|
|
|
1050
1051
|
queryParams: ["search", "page", "limit", "sort_by", "sort_order", "entity_type"],
|
|
1051
1052
|
bodyKind: "none",
|
|
1052
1053
|
responseKind: "json",
|
|
1053
|
-
codes:
|
|
1054
|
+
codes: 88
|
|
1054
1055
|
},
|
|
1055
1056
|
"archive.purge": {
|
|
1056
1057
|
method: "DELETE",
|
|
@@ -1059,7 +1060,7 @@ var OPERATIONS2 = {
|
|
|
1059
1060
|
queryParams: [],
|
|
1060
1061
|
bodyKind: "none",
|
|
1061
1062
|
responseKind: "json",
|
|
1062
|
-
codes:
|
|
1063
|
+
codes: 88
|
|
1063
1064
|
},
|
|
1064
1065
|
"archive.restore": {
|
|
1065
1066
|
method: "POST",
|
|
@@ -1068,7 +1069,7 @@ var OPERATIONS2 = {
|
|
|
1068
1069
|
queryParams: [],
|
|
1069
1070
|
bodyKind: "none",
|
|
1070
1071
|
responseKind: "json",
|
|
1071
|
-
codes:
|
|
1072
|
+
codes: 88
|
|
1072
1073
|
},
|
|
1073
1074
|
"archive.summary": {
|
|
1074
1075
|
method: "GET",
|
|
@@ -1077,7 +1078,7 @@ var OPERATIONS2 = {
|
|
|
1077
1078
|
queryParams: [],
|
|
1078
1079
|
bodyKind: "none",
|
|
1079
1080
|
responseKind: "json",
|
|
1080
|
-
codes:
|
|
1081
|
+
codes: 88
|
|
1081
1082
|
},
|
|
1082
1083
|
"attendants.create": {
|
|
1083
1084
|
method: "POST",
|
|
@@ -1086,7 +1087,7 @@ var OPERATIONS2 = {
|
|
|
1086
1087
|
queryParams: [],
|
|
1087
1088
|
bodyKind: "json",
|
|
1088
1089
|
responseKind: "json",
|
|
1089
|
-
codes:
|
|
1090
|
+
codes: 92
|
|
1090
1091
|
},
|
|
1091
1092
|
"attendants.delete": {
|
|
1092
1093
|
method: "DELETE",
|
|
@@ -1203,7 +1204,7 @@ var OPERATIONS2 = {
|
|
|
1203
1204
|
queryParams: [],
|
|
1204
1205
|
bodyKind: "json",
|
|
1205
1206
|
responseKind: "binary",
|
|
1206
|
-
codes:
|
|
1207
|
+
codes: 86
|
|
1207
1208
|
},
|
|
1208
1209
|
"audioFiles.regenerateTts": {
|
|
1209
1210
|
method: "POST",
|
|
@@ -1607,7 +1608,7 @@ var OPERATIONS2 = {
|
|
|
1607
1608
|
queryParams: [],
|
|
1608
1609
|
bodyKind: "json",
|
|
1609
1610
|
responseKind: "json",
|
|
1610
|
-
codes:
|
|
1611
|
+
codes: 87
|
|
1611
1612
|
},
|
|
1612
1613
|
"capabilities.get": {
|
|
1613
1614
|
method: "GET",
|
|
@@ -2462,7 +2463,7 @@ var OPERATIONS2 = {
|
|
|
2462
2463
|
queryParams: [],
|
|
2463
2464
|
bodyKind: "json",
|
|
2464
2465
|
responseKind: "json",
|
|
2465
|
-
codes:
|
|
2466
|
+
codes: 85
|
|
2466
2467
|
},
|
|
2467
2468
|
"license.activation": {
|
|
2468
2469
|
method: "GET",
|
|
@@ -2498,7 +2499,7 @@ var OPERATIONS2 = {
|
|
|
2498
2499
|
queryParams: [],
|
|
2499
2500
|
bodyKind: "none",
|
|
2500
2501
|
responseKind: "json",
|
|
2501
|
-
codes:
|
|
2502
|
+
codes: 85
|
|
2502
2503
|
},
|
|
2503
2504
|
"license.status": {
|
|
2504
2505
|
method: "GET",
|
|
@@ -2588,7 +2589,7 @@ var OPERATIONS2 = {
|
|
|
2588
2589
|
queryParams: [],
|
|
2589
2590
|
bodyKind: "json",
|
|
2590
2591
|
responseKind: "json",
|
|
2591
|
-
codes:
|
|
2592
|
+
codes: 12
|
|
2592
2593
|
},
|
|
2593
2594
|
"queues.addMembers": {
|
|
2594
2595
|
method: "POST",
|
|
@@ -2921,7 +2922,7 @@ var OPERATIONS2 = {
|
|
|
2921
2922
|
queryParams: ["locale"],
|
|
2922
2923
|
bodyKind: "none",
|
|
2923
2924
|
responseKind: "json",
|
|
2924
|
-
codes:
|
|
2925
|
+
codes: 91
|
|
2925
2926
|
},
|
|
2926
2927
|
"signals.create": {
|
|
2927
2928
|
method: "POST",
|
|
@@ -2930,7 +2931,7 @@ var OPERATIONS2 = {
|
|
|
2930
2931
|
queryParams: [],
|
|
2931
2932
|
bodyKind: "json",
|
|
2932
2933
|
responseKind: "json",
|
|
2933
|
-
codes:
|
|
2934
|
+
codes: 91
|
|
2934
2935
|
},
|
|
2935
2936
|
"signals.delete": {
|
|
2936
2937
|
method: "DELETE",
|
|
@@ -2939,7 +2940,7 @@ var OPERATIONS2 = {
|
|
|
2939
2940
|
queryParams: [],
|
|
2940
2941
|
bodyKind: "none",
|
|
2941
2942
|
responseKind: "json",
|
|
2942
|
-
codes:
|
|
2943
|
+
codes: 91
|
|
2943
2944
|
},
|
|
2944
2945
|
"signals.get": {
|
|
2945
2946
|
method: "GET",
|
|
@@ -2948,7 +2949,7 @@ var OPERATIONS2 = {
|
|
|
2948
2949
|
queryParams: [],
|
|
2949
2950
|
bodyKind: "none",
|
|
2950
2951
|
responseKind: "json",
|
|
2951
|
-
codes:
|
|
2952
|
+
codes: 91
|
|
2952
2953
|
},
|
|
2953
2954
|
"signals.list": {
|
|
2954
2955
|
method: "GET",
|
|
@@ -2984,7 +2985,7 @@ var OPERATIONS2 = {
|
|
|
2984
2985
|
queryParams: [],
|
|
2985
2986
|
bodyKind: "json",
|
|
2986
2987
|
responseKind: "json",
|
|
2987
|
-
codes:
|
|
2988
|
+
codes: 91
|
|
2988
2989
|
},
|
|
2989
2990
|
"signals.update": {
|
|
2990
2991
|
method: "PATCH",
|
|
@@ -2993,7 +2994,7 @@ var OPERATIONS2 = {
|
|
|
2993
2994
|
queryParams: [],
|
|
2994
2995
|
bodyKind: "json",
|
|
2995
2996
|
responseKind: "json",
|
|
2996
|
-
codes:
|
|
2997
|
+
codes: 91
|
|
2997
2998
|
},
|
|
2998
2999
|
"signals.upsertBySlug": {
|
|
2999
3000
|
method: "PUT",
|
|
@@ -3002,7 +3003,7 @@ var OPERATIONS2 = {
|
|
|
3002
3003
|
queryParams: [],
|
|
3003
3004
|
bodyKind: "json",
|
|
3004
3005
|
responseKind: "json",
|
|
3005
|
-
codes:
|
|
3006
|
+
codes: 91
|
|
3006
3007
|
},
|
|
3007
3008
|
"tts.listModels": {
|
|
3008
3009
|
method: "GET",
|
|
@@ -147,7 +147,7 @@ export interface NivaClient {
|
|
|
147
147
|
/**
|
|
148
148
|
* archive.restore operation.
|
|
149
149
|
*
|
|
150
|
-
* Restores a soft-deleted item back to active use. Requires the target entity's own delete permission (e.g. `visual_plan:delete`) and, for API-key callers, the `archive:write` scope — a read-only key is rejected with 403 INSUFFICIENT_SCOPE. Restoring a role also requires being able to grant every permission it carries (403 PERMISSION_CEILING_EXCEEDED otherwise) and room under the custom-role limit (409 MAX_CUSTOM_ROLES_REACHED). Returns 404 ARCHIVE_ITEM_NOT_FOUND when the item is absent and 409 ARCHIVE_RESTORE_CONFLICT when the item would collide with a live one (the message names the field) or a restored channel's connector is unavailable.
|
|
150
|
+
* Restores a soft-deleted item back to active use. Requires the target entity's own delete permission (e.g. `visual_plan:delete`) and, for API-key callers, the `archive:write` scope — a read-only key is rejected with 403 INSUFFICIENT_SCOPE. Restoring an attendant is refused with 409 ATTENDANT_LIMIT_REACHED (with `limit` and `current`) when the license no longer allows another one. Restoring a role also requires being able to grant every permission it carries (403 PERMISSION_CEILING_EXCEEDED otherwise) and room under the custom-role limit (409 MAX_CUSTOM_ROLES_REACHED). Returns 404 ARCHIVE_ITEM_NOT_FOUND when the item is absent and 409 ARCHIVE_RESTORE_CONFLICT when the item would collide with a live one (the message names the field) or a restored channel's connector is unavailable.
|
|
151
151
|
*/
|
|
152
152
|
restore(input: ArchiveRestoreInput, options?: NivaRequestOptions): NivaCall<ArchiveRestoreOutput, ArchiveRestoreErrorCode>;
|
|
153
153
|
/**
|
|
@@ -161,7 +161,7 @@ export interface NivaClient {
|
|
|
161
161
|
/**
|
|
162
162
|
* attendants.create operation.
|
|
163
163
|
*
|
|
164
|
-
* Makes an organization member an attendant: send `user_id` of an existing member, or `new_member` (`email`, `name`, `password`) to create the person too - user, membership with the built-in attendant role and attendant are written in one step, all or nothing, and `new_member` also needs the user:invite scope. `endpoint` is `webrtc` (the browser softphone, default) or `sip_extension` (an external softphone, which needs `extension` and receives a managed SIP credential in `sip_credential`, readable only in this response). Missing PUBLIC_BASE_URL or the encryption key makes a `sip_extension` creation fail (409 DESK_PUBLIC_URL_MISSING, 500 AI_ENCRYPTION_KEY_MISSING) instead of creating an attendant nobody could register. Returns 404 MEMBER_NOT_FOUND when the user is not a member, 409 ATTENDANT_ALREADY_EXISTS when they already are an attendant, 409 EXTENSION_IN_USE when another attendant holds the extension, and for `new_member` 409 ALREADY_MEMBER, 403 PERMISSION_CEILING_EXCEEDED (the caller must hold what the attendant role holds) and 403 SSO_REQUIRED on a company-login domain. Requires the attendant:create scope.
|
|
164
|
+
* Makes an organization member an attendant: send `user_id` of an existing member, or `new_member` (`email`, `name`, `password`) to create the person too - user, membership with the built-in attendant role and attendant are written in one step, all or nothing, and `new_member` also needs the user:invite scope. `endpoint` is `webrtc` (the browser softphone, default) or `sip_extension` (an external softphone, which needs `extension` and receives a managed SIP credential in `sip_credential`, readable only in this response). Missing PUBLIC_BASE_URL or the encryption key makes a `sip_extension` creation fail (409 DESK_PUBLIC_URL_MISSING, 500 AI_ENCRYPTION_KEY_MISSING) instead of creating an attendant nobody could register. Returns 404 MEMBER_NOT_FOUND when the user is not a member, 409 ATTENDANT_ALREADY_EXISTS when they already are an attendant, 409 EXTENSION_IN_USE when another attendant holds the extension, 409 ATTENDANT_LIMIT_REACHED (with `limit` and `current`) when the license refuses more attendants - only a license whose grant carries a rule above the attendant limit does, otherwise attendants never refuse - and for `new_member` 409 ALREADY_MEMBER, 403 PERMISSION_CEILING_EXCEEDED (the caller must hold what the attendant role holds) and 403 SSO_REQUIRED on a company-login domain. Requires the attendant:create scope.
|
|
165
165
|
*/
|
|
166
166
|
create(input?: AttendantsCreateInput, options?: NivaRequestOptions): NivaCall<AttendantsCreateOutput, AttendantsCreateErrorCode>;
|
|
167
167
|
/**
|
|
@@ -752,7 +752,7 @@ export interface NivaClient {
|
|
|
752
752
|
/**
|
|
753
753
|
* dialerCampaigns.create operation.
|
|
754
754
|
*
|
|
755
|
-
* Creates a campaign in draft status bound to an existing visual plan. The plan need not be published at creation time (only at start); an unknown plan_id returns 404 PLAN_NOT_FOUND. Requires the dialer_campaign:create scope.
|
|
755
|
+
* Creates a campaign in draft status bound to an existing visual plan. The plan need not be published at creation time (only at start); an unknown plan_id returns 404 PLAN_NOT_FOUND. Requires the dialer_campaign:create scope. Answering-machine detection (amd_enabled) and the call-screening reply (screening_reply_enabled) belong to the classifier module: without it they read false in every response and turning one on returns 403 MODULE_DISABLED.
|
|
756
756
|
*/
|
|
757
757
|
create(input: DialerCampaignsCreateInput, options?: NivaRequestOptions): NivaCall<DialerCampaignsCreateOutput, DialerCampaignsCreateErrorCode>;
|
|
758
758
|
/**
|
|
@@ -800,7 +800,7 @@ export interface NivaClient {
|
|
|
800
800
|
/**
|
|
801
801
|
* dialerCampaigns.update operation.
|
|
802
802
|
*
|
|
803
|
-
* Partially updates a campaign's configuration. Only an archived campaign is immutable and returns 409 DIALER_CAMPAIGN_INVALID_TRANSITION - a finished one is editable, since it can be reopened and nothing it stores takes effect until somebody starts it. Clearing auto_start_at on a scheduled campaign reverts it to draft. An unknown id returns 404. Requires the dialer_campaign:update scope.
|
|
803
|
+
* Partially updates a campaign's configuration. Only an archived campaign is immutable and returns 409 DIALER_CAMPAIGN_INVALID_TRANSITION - a finished one is editable, since it can be reopened and nothing it stores takes effect until somebody starts it. Clearing auto_start_at on a scheduled campaign reverts it to draft. An unknown id returns 404. Requires the dialer_campaign:update scope. Answering-machine detection (amd_enabled) and the call-screening reply (screening_reply_enabled) belong to the classifier module: without it they read false in every response and turning one on returns 403 MODULE_DISABLED. Without the module both are left as stored, so they come back with it.
|
|
804
804
|
*/
|
|
805
805
|
update(input: DialerCampaignsUpdateInput, options?: NivaRequestOptions): NivaCall<DialerCampaignsUpdateOutput, DialerCampaignsUpdateErrorCode>;
|
|
806
806
|
};
|
|
@@ -1122,13 +1122,13 @@ export interface NivaClient {
|
|
|
1122
1122
|
/**
|
|
1123
1123
|
* orgSettings.getDialer operation.
|
|
1124
1124
|
*
|
|
1125
|
-
* Returns the organization's dialer operational settings — reserved inbound channels, default trunk, default country, the daily attempt cap per number and the answering-machine detection defaults. Returns null when no settings row exists yet.
|
|
1125
|
+
* Returns the organization's dialer operational settings — reserved inbound channels, default trunk, default country, the daily attempt cap per number and the answering-machine detection defaults. Returns null when no settings row exists yet. Without the classifier module dialer_amd_enabled reads false.
|
|
1126
1126
|
*/
|
|
1127
1127
|
getDialer(options?: NivaRequestOptions): NivaCall<OrgSettingsGetDialerOutput, OrgSettingsGetDialerErrorCode>;
|
|
1128
1128
|
/**
|
|
1129
1129
|
* orgSettings.upsertDialer operation.
|
|
1130
1130
|
*
|
|
1131
|
-
* Creates or updates the organization's dialer operational settings and returns the persisted values. The change is broadcast to running engines and recorded in the audit log.
|
|
1131
|
+
* Creates or updates the organization's dialer operational settings and returns the persisted values. The change is broadcast to running engines and recorded in the audit log. dialer_amd_enabled belongs to the classifier module: without it, it reads false, true returns 403 MODULE_DISABLED and false leaves the stored default as it is.
|
|
1132
1132
|
*/
|
|
1133
1133
|
upsertDialer(input?: OrgSettingsUpsertDialerInput, options?: NivaRequestOptions): NivaCall<OrgSettingsUpsertDialerOutput, OrgSettingsUpsertDialerErrorCode>;
|
|
1134
1134
|
};
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* (NIVA-258). Source: GET /api/v1/spec.json via generateOpenApiSpec().
|
|
4
4
|
*/
|
|
5
5
|
/** SDK package version (from packages/sdk/package.json). */
|
|
6
|
-
export declare const SDK_VERSION = "0.2.
|
|
6
|
+
export declare const SDK_VERSION = "0.2.1";
|
|
7
7
|
/** Lowest NIVA product version this SDK operates against. */
|
|
8
8
|
export declare const SUPPORTED_NIVA: {
|
|
9
9
|
min: string;
|
|
@@ -1195,7 +1195,7 @@ export interface ArchiveListDeletedOutput {
|
|
|
1195
1195
|
*
|
|
1196
1196
|
* Lists archived (soft-deleted) items in a paginated envelope, newest deletion first. Without `entity_type` it lists every type the organization can see; with it, only that type (403 MODULE_DISABLED when the type's module is off).
|
|
1197
1197
|
*/
|
|
1198
|
-
export type ArchiveListDeletedErrorCode = "ARCHIVE_ITEM_IN_USE" | "ARCHIVE_ITEM_NOT_FOUND" | "ARCHIVE_RESTORE_CONFLICT" | "CHANNEL_WHATSAPP_NUMBER_NOT_IN_CONNECTOR" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MAX_CUSTOM_ROLES_REACHED" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PERMISSION_CEILING_EXCEEDED" | "UNAUTHORIZED";
|
|
1198
|
+
export type ArchiveListDeletedErrorCode = "ARCHIVE_ITEM_IN_USE" | "ARCHIVE_ITEM_NOT_FOUND" | "ARCHIVE_RESTORE_CONFLICT" | "ATTENDANT_LIMIT_REACHED" | "CHANNEL_WHATSAPP_NUMBER_NOT_IN_CONNECTOR" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MAX_CUSTOM_ROLES_REACHED" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PERMISSION_CEILING_EXCEEDED" | "UNAUTHORIZED";
|
|
1199
1199
|
/**
|
|
1200
1200
|
* archive.purge input.
|
|
1201
1201
|
*
|
|
@@ -1224,11 +1224,11 @@ export interface ArchivePurgeOutput {
|
|
|
1224
1224
|
*
|
|
1225
1225
|
* Permanently purges an archived item; this is irreversible. Requires the `archive:purge` permission. Returns 404 ARCHIVE_ITEM_NOT_FOUND when the item does not exist and 409 ARCHIVE_ITEM_IN_USE when the item is still referenced by calls or other records.
|
|
1226
1226
|
*/
|
|
1227
|
-
export type ArchivePurgeErrorCode = "ARCHIVE_ITEM_IN_USE" | "ARCHIVE_ITEM_NOT_FOUND" | "ARCHIVE_RESTORE_CONFLICT" | "CHANNEL_WHATSAPP_NUMBER_NOT_IN_CONNECTOR" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MAX_CUSTOM_ROLES_REACHED" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PERMISSION_CEILING_EXCEEDED" | "UNAUTHORIZED";
|
|
1227
|
+
export type ArchivePurgeErrorCode = "ARCHIVE_ITEM_IN_USE" | "ARCHIVE_ITEM_NOT_FOUND" | "ARCHIVE_RESTORE_CONFLICT" | "ATTENDANT_LIMIT_REACHED" | "CHANNEL_WHATSAPP_NUMBER_NOT_IN_CONNECTOR" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MAX_CUSTOM_ROLES_REACHED" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PERMISSION_CEILING_EXCEEDED" | "UNAUTHORIZED";
|
|
1228
1228
|
/**
|
|
1229
1229
|
* archive.restore input.
|
|
1230
1230
|
*
|
|
1231
|
-
* Restores a soft-deleted item back to active use. Requires the target entity's own delete permission (e.g. `visual_plan:delete`) and, for API-key callers, the `archive:write` scope — a read-only key is rejected with 403 INSUFFICIENT_SCOPE. Restoring a role also requires being able to grant every permission it carries (403 PERMISSION_CEILING_EXCEEDED otherwise) and room under the custom-role limit (409 MAX_CUSTOM_ROLES_REACHED). Returns 404 ARCHIVE_ITEM_NOT_FOUND when the item is absent and 409 ARCHIVE_RESTORE_CONFLICT when the item would collide with a live one (the message names the field) or a restored channel's connector is unavailable.
|
|
1231
|
+
* Restores a soft-deleted item back to active use. Requires the target entity's own delete permission (e.g. `visual_plan:delete`) and, for API-key callers, the `archive:write` scope — a read-only key is rejected with 403 INSUFFICIENT_SCOPE. Restoring an attendant is refused with 409 ATTENDANT_LIMIT_REACHED (with `limit` and `current`) when the license no longer allows another one. Restoring a role also requires being able to grant every permission it carries (403 PERMISSION_CEILING_EXCEEDED otherwise) and room under the custom-role limit (409 MAX_CUSTOM_ROLES_REACHED). Returns 404 ARCHIVE_ITEM_NOT_FOUND when the item is absent and 409 ARCHIVE_RESTORE_CONFLICT when the item would collide with a live one (the message names the field) or a restored channel's connector is unavailable.
|
|
1232
1232
|
*/
|
|
1233
1233
|
export interface ArchiveRestoreInput {
|
|
1234
1234
|
/**
|
|
@@ -1243,7 +1243,7 @@ export interface ArchiveRestoreInput {
|
|
|
1243
1243
|
/**
|
|
1244
1244
|
* archive.restore output.
|
|
1245
1245
|
*
|
|
1246
|
-
* Restores a soft-deleted item back to active use. Requires the target entity's own delete permission (e.g. `visual_plan:delete`) and, for API-key callers, the `archive:write` scope — a read-only key is rejected with 403 INSUFFICIENT_SCOPE. Restoring a role also requires being able to grant every permission it carries (403 PERMISSION_CEILING_EXCEEDED otherwise) and room under the custom-role limit (409 MAX_CUSTOM_ROLES_REACHED). Returns 404 ARCHIVE_ITEM_NOT_FOUND when the item is absent and 409 ARCHIVE_RESTORE_CONFLICT when the item would collide with a live one (the message names the field) or a restored channel's connector is unavailable.
|
|
1246
|
+
* Restores a soft-deleted item back to active use. Requires the target entity's own delete permission (e.g. `visual_plan:delete`) and, for API-key callers, the `archive:write` scope — a read-only key is rejected with 403 INSUFFICIENT_SCOPE. Restoring an attendant is refused with 409 ATTENDANT_LIMIT_REACHED (with `limit` and `current`) when the license no longer allows another one. Restoring a role also requires being able to grant every permission it carries (403 PERMISSION_CEILING_EXCEEDED otherwise) and room under the custom-role limit (409 MAX_CUSTOM_ROLES_REACHED). Returns 404 ARCHIVE_ITEM_NOT_FOUND when the item is absent and 409 ARCHIVE_RESTORE_CONFLICT when the item would collide with a live one (the message names the field) or a restored channel's connector is unavailable.
|
|
1247
1247
|
*/
|
|
1248
1248
|
export interface ArchiveRestoreOutput {
|
|
1249
1249
|
deleted_at: string | null;
|
|
@@ -1253,9 +1253,9 @@ export interface ArchiveRestoreOutput {
|
|
|
1253
1253
|
/**
|
|
1254
1254
|
* archive.restore error codes.
|
|
1255
1255
|
*
|
|
1256
|
-
* Restores a soft-deleted item back to active use. Requires the target entity's own delete permission (e.g. `visual_plan:delete`) and, for API-key callers, the `archive:write` scope — a read-only key is rejected with 403 INSUFFICIENT_SCOPE. Restoring a role also requires being able to grant every permission it carries (403 PERMISSION_CEILING_EXCEEDED otherwise) and room under the custom-role limit (409 MAX_CUSTOM_ROLES_REACHED). Returns 404 ARCHIVE_ITEM_NOT_FOUND when the item is absent and 409 ARCHIVE_RESTORE_CONFLICT when the item would collide with a live one (the message names the field) or a restored channel's connector is unavailable.
|
|
1256
|
+
* Restores a soft-deleted item back to active use. Requires the target entity's own delete permission (e.g. `visual_plan:delete`) and, for API-key callers, the `archive:write` scope — a read-only key is rejected with 403 INSUFFICIENT_SCOPE. Restoring an attendant is refused with 409 ATTENDANT_LIMIT_REACHED (with `limit` and `current`) when the license no longer allows another one. Restoring a role also requires being able to grant every permission it carries (403 PERMISSION_CEILING_EXCEEDED otherwise) and room under the custom-role limit (409 MAX_CUSTOM_ROLES_REACHED). Returns 404 ARCHIVE_ITEM_NOT_FOUND when the item is absent and 409 ARCHIVE_RESTORE_CONFLICT when the item would collide with a live one (the message names the field) or a restored channel's connector is unavailable.
|
|
1257
1257
|
*/
|
|
1258
|
-
export type ArchiveRestoreErrorCode = "ARCHIVE_ITEM_IN_USE" | "ARCHIVE_ITEM_NOT_FOUND" | "ARCHIVE_RESTORE_CONFLICT" | "CHANNEL_WHATSAPP_NUMBER_NOT_IN_CONNECTOR" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MAX_CUSTOM_ROLES_REACHED" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PERMISSION_CEILING_EXCEEDED" | "UNAUTHORIZED";
|
|
1258
|
+
export type ArchiveRestoreErrorCode = "ARCHIVE_ITEM_IN_USE" | "ARCHIVE_ITEM_NOT_FOUND" | "ARCHIVE_RESTORE_CONFLICT" | "ATTENDANT_LIMIT_REACHED" | "CHANNEL_WHATSAPP_NUMBER_NOT_IN_CONNECTOR" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MAX_CUSTOM_ROLES_REACHED" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PERMISSION_CEILING_EXCEEDED" | "UNAUTHORIZED";
|
|
1259
1259
|
/**
|
|
1260
1260
|
* archive.summary input.
|
|
1261
1261
|
*
|
|
@@ -1276,11 +1276,11 @@ export type ArchiveSummaryOutput = {
|
|
|
1276
1276
|
*
|
|
1277
1277
|
* Returns per-entity-type counts of archived (soft-deleted) items for the organization.
|
|
1278
1278
|
*/
|
|
1279
|
-
export type ArchiveSummaryErrorCode = "ARCHIVE_ITEM_IN_USE" | "ARCHIVE_ITEM_NOT_FOUND" | "ARCHIVE_RESTORE_CONFLICT" | "CHANNEL_WHATSAPP_NUMBER_NOT_IN_CONNECTOR" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MAX_CUSTOM_ROLES_REACHED" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PERMISSION_CEILING_EXCEEDED" | "UNAUTHORIZED";
|
|
1279
|
+
export type ArchiveSummaryErrorCode = "ARCHIVE_ITEM_IN_USE" | "ARCHIVE_ITEM_NOT_FOUND" | "ARCHIVE_RESTORE_CONFLICT" | "ATTENDANT_LIMIT_REACHED" | "CHANNEL_WHATSAPP_NUMBER_NOT_IN_CONNECTOR" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MAX_CUSTOM_ROLES_REACHED" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PERMISSION_CEILING_EXCEEDED" | "UNAUTHORIZED";
|
|
1280
1280
|
/**
|
|
1281
1281
|
* attendants.create input.
|
|
1282
1282
|
*
|
|
1283
|
-
* Makes an organization member an attendant: send `user_id` of an existing member, or `new_member` (`email`, `name`, `password`) to create the person too - user, membership with the built-in attendant role and attendant are written in one step, all or nothing, and `new_member` also needs the user:invite scope. `endpoint` is `webrtc` (the browser softphone, default) or `sip_extension` (an external softphone, which needs `extension` and receives a managed SIP credential in `sip_credential`, readable only in this response). Missing PUBLIC_BASE_URL or the encryption key makes a `sip_extension` creation fail (409 DESK_PUBLIC_URL_MISSING, 500 AI_ENCRYPTION_KEY_MISSING) instead of creating an attendant nobody could register. Returns 404 MEMBER_NOT_FOUND when the user is not a member, 409 ATTENDANT_ALREADY_EXISTS when they already are an attendant, 409 EXTENSION_IN_USE when another attendant holds the extension, and for `new_member` 409 ALREADY_MEMBER, 403 PERMISSION_CEILING_EXCEEDED (the caller must hold what the attendant role holds) and 403 SSO_REQUIRED on a company-login domain. Requires the attendant:create scope.
|
|
1283
|
+
* Makes an organization member an attendant: send `user_id` of an existing member, or `new_member` (`email`, `name`, `password`) to create the person too - user, membership with the built-in attendant role and attendant are written in one step, all or nothing, and `new_member` also needs the user:invite scope. `endpoint` is `webrtc` (the browser softphone, default) or `sip_extension` (an external softphone, which needs `extension` and receives a managed SIP credential in `sip_credential`, readable only in this response). Missing PUBLIC_BASE_URL or the encryption key makes a `sip_extension` creation fail (409 DESK_PUBLIC_URL_MISSING, 500 AI_ENCRYPTION_KEY_MISSING) instead of creating an attendant nobody could register. Returns 404 MEMBER_NOT_FOUND when the user is not a member, 409 ATTENDANT_ALREADY_EXISTS when they already are an attendant, 409 EXTENSION_IN_USE when another attendant holds the extension, 409 ATTENDANT_LIMIT_REACHED (with `limit` and `current`) when the license refuses more attendants - only a license whose grant carries a rule above the attendant limit does, otherwise attendants never refuse - and for `new_member` 409 ALREADY_MEMBER, 403 PERMISSION_CEILING_EXCEEDED (the caller must hold what the attendant role holds) and 403 SSO_REQUIRED on a company-login domain. Requires the attendant:create scope.
|
|
1284
1284
|
*/
|
|
1285
1285
|
export interface AttendantsCreateInput {
|
|
1286
1286
|
auto_answer?: boolean;
|
|
@@ -1324,7 +1324,7 @@ export interface AttendantsCreateInput {
|
|
|
1324
1324
|
/**
|
|
1325
1325
|
* attendants.create output.
|
|
1326
1326
|
*
|
|
1327
|
-
* Makes an organization member an attendant: send `user_id` of an existing member, or `new_member` (`email`, `name`, `password`) to create the person too - user, membership with the built-in attendant role and attendant are written in one step, all or nothing, and `new_member` also needs the user:invite scope. `endpoint` is `webrtc` (the browser softphone, default) or `sip_extension` (an external softphone, which needs `extension` and receives a managed SIP credential in `sip_credential`, readable only in this response). Missing PUBLIC_BASE_URL or the encryption key makes a `sip_extension` creation fail (409 DESK_PUBLIC_URL_MISSING, 500 AI_ENCRYPTION_KEY_MISSING) instead of creating an attendant nobody could register. Returns 404 MEMBER_NOT_FOUND when the user is not a member, 409 ATTENDANT_ALREADY_EXISTS when they already are an attendant, 409 EXTENSION_IN_USE when another attendant holds the extension, and for `new_member` 409 ALREADY_MEMBER, 403 PERMISSION_CEILING_EXCEEDED (the caller must hold what the attendant role holds) and 403 SSO_REQUIRED on a company-login domain. Requires the attendant:create scope.
|
|
1327
|
+
* Makes an organization member an attendant: send `user_id` of an existing member, or `new_member` (`email`, `name`, `password`) to create the person too - user, membership with the built-in attendant role and attendant are written in one step, all or nothing, and `new_member` also needs the user:invite scope. `endpoint` is `webrtc` (the browser softphone, default) or `sip_extension` (an external softphone, which needs `extension` and receives a managed SIP credential in `sip_credential`, readable only in this response). Missing PUBLIC_BASE_URL or the encryption key makes a `sip_extension` creation fail (409 DESK_PUBLIC_URL_MISSING, 500 AI_ENCRYPTION_KEY_MISSING) instead of creating an attendant nobody could register. Returns 404 MEMBER_NOT_FOUND when the user is not a member, 409 ATTENDANT_ALREADY_EXISTS when they already are an attendant, 409 EXTENSION_IN_USE when another attendant holds the extension, 409 ATTENDANT_LIMIT_REACHED (with `limit` and `current`) when the license refuses more attendants - only a license whose grant carries a rule above the attendant limit does, otherwise attendants never refuse - and for `new_member` 409 ALREADY_MEMBER, 403 PERMISSION_CEILING_EXCEEDED (the caller must hold what the attendant role holds) and 403 SSO_REQUIRED on a company-login domain. Requires the attendant:create scope.
|
|
1328
1328
|
*/
|
|
1329
1329
|
export interface AttendantsCreateOutput {
|
|
1330
1330
|
auto_answer: boolean;
|
|
@@ -1391,9 +1391,9 @@ export interface AttendantsCreateOutput {
|
|
|
1391
1391
|
/**
|
|
1392
1392
|
* attendants.create error codes.
|
|
1393
1393
|
*
|
|
1394
|
-
* Makes an organization member an attendant: send `user_id` of an existing member, or `new_member` (`email`, `name`, `password`) to create the person too - user, membership with the built-in attendant role and attendant are written in one step, all or nothing, and `new_member` also needs the user:invite scope. `endpoint` is `webrtc` (the browser softphone, default) or `sip_extension` (an external softphone, which needs `extension` and receives a managed SIP credential in `sip_credential`, readable only in this response). Missing PUBLIC_BASE_URL or the encryption key makes a `sip_extension` creation fail (409 DESK_PUBLIC_URL_MISSING, 500 AI_ENCRYPTION_KEY_MISSING) instead of creating an attendant nobody could register. Returns 404 MEMBER_NOT_FOUND when the user is not a member, 409 ATTENDANT_ALREADY_EXISTS when they already are an attendant, 409 EXTENSION_IN_USE when another attendant holds the extension, and for `new_member` 409 ALREADY_MEMBER, 403 PERMISSION_CEILING_EXCEEDED (the caller must hold what the attendant role holds) and 403 SSO_REQUIRED on a company-login domain. Requires the attendant:create scope.
|
|
1394
|
+
* Makes an organization member an attendant: send `user_id` of an existing member, or `new_member` (`email`, `name`, `password`) to create the person too - user, membership with the built-in attendant role and attendant are written in one step, all or nothing, and `new_member` also needs the user:invite scope. `endpoint` is `webrtc` (the browser softphone, default) or `sip_extension` (an external softphone, which needs `extension` and receives a managed SIP credential in `sip_credential`, readable only in this response). Missing PUBLIC_BASE_URL or the encryption key makes a `sip_extension` creation fail (409 DESK_PUBLIC_URL_MISSING, 500 AI_ENCRYPTION_KEY_MISSING) instead of creating an attendant nobody could register. Returns 404 MEMBER_NOT_FOUND when the user is not a member, 409 ATTENDANT_ALREADY_EXISTS when they already are an attendant, 409 EXTENSION_IN_USE when another attendant holds the extension, 409 ATTENDANT_LIMIT_REACHED (with `limit` and `current`) when the license refuses more attendants - only a license whose grant carries a rule above the attendant limit does, otherwise attendants never refuse - and for `new_member` 409 ALREADY_MEMBER, 403 PERMISSION_CEILING_EXCEEDED (the caller must hold what the attendant role holds) and 403 SSO_REQUIRED on a company-login domain. Requires the attendant:create scope.
|
|
1395
1395
|
*/
|
|
1396
|
-
export type AttendantsCreateErrorCode = "AI_ENCRYPTION_KEY_MISSING" | "ALREADY_MEMBER" | "ATTENDANT_ALREADY_EXISTS" | "ATTENDANT_NOT_FOUND" | "DESK_PUBLIC_URL_MISSING" | "EXTENSION_IN_USE" | "EXTENSION_REQUIRED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_NOT_FOUND" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PERMISSION_CEILING_EXCEEDED" | "ROLE_NOT_FOUND" | "ROLE_SCOPE_MISMATCH" | "SSO_REQUIRED" | "UNAUTHORIZED";
|
|
1396
|
+
export type AttendantsCreateErrorCode = "AI_ENCRYPTION_KEY_MISSING" | "ALREADY_MEMBER" | "ATTENDANT_ALREADY_EXISTS" | "ATTENDANT_LIMIT_REACHED" | "ATTENDANT_NOT_FOUND" | "DESK_PUBLIC_URL_MISSING" | "EXTENSION_IN_USE" | "EXTENSION_REQUIRED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_NOT_FOUND" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PERMISSION_CEILING_EXCEEDED" | "ROLE_NOT_FOUND" | "ROLE_SCOPE_MISMATCH" | "SSO_REQUIRED" | "UNAUTHORIZED";
|
|
1397
1397
|
/**
|
|
1398
1398
|
* attendants.delete input.
|
|
1399
1399
|
*
|
|
@@ -4962,7 +4962,7 @@ export type CallsHangupCallErrorCode = "ACTIVE_CALL_NOT_FOUND" | "ESL_CONNECTION
|
|
|
4962
4962
|
*/
|
|
4963
4963
|
export interface CallsOriginateInput {
|
|
4964
4964
|
/**
|
|
4965
|
-
* Beta: optional recognitions after answer. machine_type enables AMD implicitly
|
|
4965
|
+
* Beta: optional recognitions after answer. machine_type enables AMD implicitly. Both require the classifier module (403 MODULE_DISABLED without it).
|
|
4966
4966
|
*/
|
|
4967
4967
|
answer_recognition?: {
|
|
4968
4968
|
/**
|
|
@@ -5059,7 +5059,7 @@ export interface CallsOriginateOutput {
|
|
|
5059
5059
|
*
|
|
5060
5060
|
* Places an outbound call that executes a published visual plan and returns its synchronous outcome. A 200 response does not mean the call was answered: read status. When the destination (or the carrier dialect) decides the outcome - any SIP 4xx or 6xx except 401, 403, 407 and 488 - the call answers 200 with status failed plus hangup_cause and sip_code. When the failure is ours - any SIP 5xx, the four codes above, or a failure without a SIP code - it answers 502 ORIGINATE_FAILED; with FreeSWITCH unreachable, 503. The legacy POST /originate/calls shape is deprecated, frozen, and keeps the old allowlist classification. Requires the call:originate scope.
|
|
5061
5061
|
*/
|
|
5062
|
-
export type CallsOriginateErrorCode = "ESL_CONNECTION_ERROR" | "FEATURE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "ORIGINATE_CAPACITY_EXCEEDED" | "ORIGINATE_DESTINATION_NOT_ROUTABLE" | "ORIGINATE_FAILED" | "ORIGINATE_PLAN_NOT_PUBLISHED" | "PLAN_NOT_FOUND" | "UNAUTHORIZED";
|
|
5062
|
+
export type CallsOriginateErrorCode = "ESL_CONNECTION_ERROR" | "FEATURE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "ORIGINATE_CAPACITY_EXCEEDED" | "ORIGINATE_DESTINATION_NOT_ROUTABLE" | "ORIGINATE_FAILED" | "ORIGINATE_PLAN_NOT_PUBLISHED" | "PLAN_NOT_FOUND" | "UNAUTHORIZED";
|
|
5063
5063
|
/**
|
|
5064
5064
|
* capabilities.get input.
|
|
5065
5065
|
*
|
|
@@ -6176,7 +6176,7 @@ export interface DashboardCapacityStatusOutput {
|
|
|
6176
6176
|
*/
|
|
6177
6177
|
active: number;
|
|
6178
6178
|
/**
|
|
6179
|
-
* Licensed attendants; -1 = unlimited. Going over warns,
|
|
6179
|
+
* Licensed attendants; -1 = unlimited. Going over warns, unless the license carries a rule above the limit (see `GET /license/usage`).
|
|
6180
6180
|
*/
|
|
6181
6181
|
limit: number;
|
|
6182
6182
|
} | null;
|
|
@@ -6254,7 +6254,7 @@ export interface DashboardWatchDashboardMetricsEvent {
|
|
|
6254
6254
|
*/
|
|
6255
6255
|
active: number;
|
|
6256
6256
|
/**
|
|
6257
|
-
* Licensed attendants; -1 = unlimited. Going over warns,
|
|
6257
|
+
* Licensed attendants; -1 = unlimited. Going over warns, unless the license carries a rule above the limit (see `GET /license/usage`).
|
|
6258
6258
|
*/
|
|
6259
6259
|
limit: number;
|
|
6260
6260
|
} | null;
|
|
@@ -7719,7 +7719,7 @@ export type DialerCampaignsControlErrorCode = "DIALER_CAMPAIGN_INVALID_TRANSITIO
|
|
|
7719
7719
|
/**
|
|
7720
7720
|
* dialerCampaigns.create input.
|
|
7721
7721
|
*
|
|
7722
|
-
* Creates a campaign in draft status bound to an existing visual plan. The plan need not be published at creation time (only at start); an unknown plan_id returns 404 PLAN_NOT_FOUND. Requires the dialer_campaign:create scope.
|
|
7722
|
+
* Creates a campaign in draft status bound to an existing visual plan. The plan need not be published at creation time (only at start); an unknown plan_id returns 404 PLAN_NOT_FOUND. Requires the dialer_campaign:create scope. Answering-machine detection (amd_enabled) and the call-screening reply (screening_reply_enabled) belong to the classifier module: without it they read false in every response and turning one on returns 403 MODULE_DISABLED.
|
|
7723
7723
|
*/
|
|
7724
7724
|
export interface DialerCampaignsCreateInput {
|
|
7725
7725
|
amd_action_announcement?: "retry" | "no_retry" | "block" | null;
|
|
@@ -7861,7 +7861,7 @@ export interface DialerCampaignsCreateInput {
|
|
|
7861
7861
|
/**
|
|
7862
7862
|
* dialerCampaigns.create output.
|
|
7863
7863
|
*
|
|
7864
|
-
* Creates a campaign in draft status bound to an existing visual plan. The plan need not be published at creation time (only at start); an unknown plan_id returns 404 PLAN_NOT_FOUND. Requires the dialer_campaign:create scope.
|
|
7864
|
+
* Creates a campaign in draft status bound to an existing visual plan. The plan need not be published at creation time (only at start); an unknown plan_id returns 404 PLAN_NOT_FOUND. Requires the dialer_campaign:create scope. Answering-machine detection (amd_enabled) and the call-screening reply (screening_reply_enabled) belong to the classifier module: without it they read false in every response and turning one on returns 403 MODULE_DISABLED.
|
|
7865
7865
|
*/
|
|
7866
7866
|
export interface DialerCampaignsCreateOutput {
|
|
7867
7867
|
amd_action_announcement: "retry" | "no_retry" | "block" | null;
|
|
@@ -8053,7 +8053,7 @@ export interface DialerCampaignsCreateOutput {
|
|
|
8053
8053
|
/**
|
|
8054
8054
|
* dialerCampaigns.create error codes.
|
|
8055
8055
|
*
|
|
8056
|
-
* Creates a campaign in draft status bound to an existing visual plan. The plan need not be published at creation time (only at start); an unknown plan_id returns 404 PLAN_NOT_FOUND. Requires the dialer_campaign:create scope.
|
|
8056
|
+
* Creates a campaign in draft status bound to an existing visual plan. The plan need not be published at creation time (only at start); an unknown plan_id returns 404 PLAN_NOT_FOUND. Requires the dialer_campaign:create scope. Answering-machine detection (amd_enabled) and the call-screening reply (screening_reply_enabled) belong to the classifier module: without it they read false in every response and turning one on returns 403 MODULE_DISABLED.
|
|
8057
8057
|
*/
|
|
8058
8058
|
export type DialerCampaignsCreateErrorCode = "DIALER_CAMPAIGN_INVALID_TRANSITION" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_CAMPAIGN_NO_CONTACTS" | "DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED" | "DIALER_MODULE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "PLAN_NOT_FOUND" | "UNAUTHORIZED";
|
|
8059
8059
|
/**
|
|
@@ -8748,7 +8748,7 @@ export type DialerCampaignsSummaryErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMIS
|
|
|
8748
8748
|
/**
|
|
8749
8749
|
* dialerCampaigns.update input.
|
|
8750
8750
|
*
|
|
8751
|
-
* Partially updates a campaign's configuration. Only an archived campaign is immutable and returns 409 DIALER_CAMPAIGN_INVALID_TRANSITION - a finished one is editable, since it can be reopened and nothing it stores takes effect until somebody starts it. Clearing auto_start_at on a scheduled campaign reverts it to draft. An unknown id returns 404. Requires the dialer_campaign:update scope.
|
|
8751
|
+
* Partially updates a campaign's configuration. Only an archived campaign is immutable and returns 409 DIALER_CAMPAIGN_INVALID_TRANSITION - a finished one is editable, since it can be reopened and nothing it stores takes effect until somebody starts it. Clearing auto_start_at on a scheduled campaign reverts it to draft. An unknown id returns 404. Requires the dialer_campaign:update scope. Answering-machine detection (amd_enabled) and the call-screening reply (screening_reply_enabled) belong to the classifier module: without it they read false in every response and turning one on returns 403 MODULE_DISABLED. Without the module both are left as stored, so they come back with it.
|
|
8752
8752
|
*/
|
|
8753
8753
|
export interface DialerCampaignsUpdateInput {
|
|
8754
8754
|
/**
|
|
@@ -8890,7 +8890,7 @@ export interface DialerCampaignsUpdateInput {
|
|
|
8890
8890
|
/**
|
|
8891
8891
|
* dialerCampaigns.update output.
|
|
8892
8892
|
*
|
|
8893
|
-
* Partially updates a campaign's configuration. Only an archived campaign is immutable and returns 409 DIALER_CAMPAIGN_INVALID_TRANSITION - a finished one is editable, since it can be reopened and nothing it stores takes effect until somebody starts it. Clearing auto_start_at on a scheduled campaign reverts it to draft. An unknown id returns 404. Requires the dialer_campaign:update scope.
|
|
8893
|
+
* Partially updates a campaign's configuration. Only an archived campaign is immutable and returns 409 DIALER_CAMPAIGN_INVALID_TRANSITION - a finished one is editable, since it can be reopened and nothing it stores takes effect until somebody starts it. Clearing auto_start_at on a scheduled campaign reverts it to draft. An unknown id returns 404. Requires the dialer_campaign:update scope. Answering-machine detection (amd_enabled) and the call-screening reply (screening_reply_enabled) belong to the classifier module: without it they read false in every response and turning one on returns 403 MODULE_DISABLED. Without the module both are left as stored, so they come back with it.
|
|
8894
8894
|
*/
|
|
8895
8895
|
export interface DialerCampaignsUpdateOutput {
|
|
8896
8896
|
amd_action_announcement: "retry" | "no_retry" | "block" | null;
|
|
@@ -9082,7 +9082,7 @@ export interface DialerCampaignsUpdateOutput {
|
|
|
9082
9082
|
/**
|
|
9083
9083
|
* dialerCampaigns.update error codes.
|
|
9084
9084
|
*
|
|
9085
|
-
* Partially updates a campaign's configuration. Only an archived campaign is immutable and returns 409 DIALER_CAMPAIGN_INVALID_TRANSITION - a finished one is editable, since it can be reopened and nothing it stores takes effect until somebody starts it. Clearing auto_start_at on a scheduled campaign reverts it to draft. An unknown id returns 404. Requires the dialer_campaign:update scope.
|
|
9085
|
+
* Partially updates a campaign's configuration. Only an archived campaign is immutable and returns 409 DIALER_CAMPAIGN_INVALID_TRANSITION - a finished one is editable, since it can be reopened and nothing it stores takes effect until somebody starts it. Clearing auto_start_at on a scheduled campaign reverts it to draft. An unknown id returns 404. Requires the dialer_campaign:update scope. Answering-machine detection (amd_enabled) and the call-screening reply (screening_reply_enabled) belong to the classifier module: without it they read false in every response and turning one on returns 403 MODULE_DISABLED. Without the module both are left as stored, so they come back with it.
|
|
9086
9086
|
*/
|
|
9087
9087
|
export type DialerCampaignsUpdateErrorCode = "DIALER_CAMPAIGN_INVALID_TRANSITION" | "DIALER_CAMPAIGN_NOT_FOUND" | "DIALER_CAMPAIGN_NO_CONTACTS" | "DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED" | "DIALER_MODULE_DISABLED" | "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
9088
9088
|
/**
|
|
@@ -11334,9 +11334,27 @@ export interface LicenseStatusOutput {
|
|
|
11334
11334
|
*/
|
|
11335
11335
|
active: number;
|
|
11336
11336
|
/**
|
|
11337
|
-
* Licensed attendants; -1 = unlimited.
|
|
11337
|
+
* Licensed attendants; -1 = unlimited. Without a rule in `overage`, going over warns and never refuses.
|
|
11338
11338
|
*/
|
|
11339
11339
|
limit: number;
|
|
11340
|
+
overage: {
|
|
11341
|
+
/**
|
|
11342
|
+
* minimum: -9007199254740991
|
|
11343
|
+
* maximum: 9007199254740991
|
|
11344
|
+
*/
|
|
11345
|
+
cap: number | null;
|
|
11346
|
+
/**
|
|
11347
|
+
* minimum: -9007199254740991
|
|
11348
|
+
* maximum: 9007199254740991
|
|
11349
|
+
*/
|
|
11350
|
+
refuses_at: number | null;
|
|
11351
|
+
rule: "none" | "tolerate" | "tolerate_charge" | null;
|
|
11352
|
+
/**
|
|
11353
|
+
* minimum: -9007199254740991
|
|
11354
|
+
* maximum: 9007199254740991
|
|
11355
|
+
*/
|
|
11356
|
+
tolerance_percent: number | null;
|
|
11357
|
+
};
|
|
11340
11358
|
};
|
|
11341
11359
|
days_until_expiry: number | null;
|
|
11342
11360
|
expires_at: string | null;
|
|
@@ -11358,9 +11376,27 @@ export interface LicenseStatusOutput {
|
|
|
11358
11376
|
*/
|
|
11359
11377
|
active: number;
|
|
11360
11378
|
/**
|
|
11361
|
-
* Licensed organizations; -1 = unlimited.
|
|
11379
|
+
* Licensed organizations; -1 = unlimited. Without a rule in `overage`, creating one past it is refused.
|
|
11362
11380
|
*/
|
|
11363
11381
|
limit: number;
|
|
11382
|
+
overage: {
|
|
11383
|
+
/**
|
|
11384
|
+
* minimum: -9007199254740991
|
|
11385
|
+
* maximum: 9007199254740991
|
|
11386
|
+
*/
|
|
11387
|
+
cap: number | null;
|
|
11388
|
+
/**
|
|
11389
|
+
* minimum: -9007199254740991
|
|
11390
|
+
* maximum: 9007199254740991
|
|
11391
|
+
*/
|
|
11392
|
+
refuses_at: number | null;
|
|
11393
|
+
rule: "none" | "tolerate" | "tolerate_charge" | null;
|
|
11394
|
+
/**
|
|
11395
|
+
* minimum: -9007199254740991
|
|
11396
|
+
* maximum: 9007199254740991
|
|
11397
|
+
*/
|
|
11398
|
+
tolerance_percent: number | null;
|
|
11399
|
+
};
|
|
11364
11400
|
};
|
|
11365
11401
|
serial: string;
|
|
11366
11402
|
source: "yaml" | "suite" | "suite-v3" | "cache";
|
|
@@ -11435,6 +11471,24 @@ export interface LicenseUsageOutput {
|
|
|
11435
11471
|
* Licensed limit; -1 = unlimited.
|
|
11436
11472
|
*/
|
|
11437
11473
|
limit: number;
|
|
11474
|
+
overage: {
|
|
11475
|
+
/**
|
|
11476
|
+
* minimum: -9007199254740991
|
|
11477
|
+
* maximum: 9007199254740991
|
|
11478
|
+
*/
|
|
11479
|
+
cap: number | null;
|
|
11480
|
+
/**
|
|
11481
|
+
* minimum: -9007199254740991
|
|
11482
|
+
* maximum: 9007199254740991
|
|
11483
|
+
*/
|
|
11484
|
+
refuses_at: number | null;
|
|
11485
|
+
rule: "none" | "tolerate" | "tolerate_charge" | null;
|
|
11486
|
+
/**
|
|
11487
|
+
* minimum: -9007199254740991
|
|
11488
|
+
* maximum: 9007199254740991
|
|
11489
|
+
*/
|
|
11490
|
+
tolerance_percent: number | null;
|
|
11491
|
+
};
|
|
11438
11492
|
peak_month: number | null;
|
|
11439
11493
|
};
|
|
11440
11494
|
/**
|
|
@@ -11449,6 +11503,24 @@ export interface LicenseUsageOutput {
|
|
|
11449
11503
|
* Licensed limit; -1 = unlimited.
|
|
11450
11504
|
*/
|
|
11451
11505
|
limit: number;
|
|
11506
|
+
overage: {
|
|
11507
|
+
/**
|
|
11508
|
+
* minimum: -9007199254740991
|
|
11509
|
+
* maximum: 9007199254740991
|
|
11510
|
+
*/
|
|
11511
|
+
cap: number | null;
|
|
11512
|
+
/**
|
|
11513
|
+
* minimum: -9007199254740991
|
|
11514
|
+
* maximum: 9007199254740991
|
|
11515
|
+
*/
|
|
11516
|
+
refuses_at: number | null;
|
|
11517
|
+
rule: "none" | "tolerate" | "tolerate_charge" | null;
|
|
11518
|
+
/**
|
|
11519
|
+
* minimum: -9007199254740991
|
|
11520
|
+
* maximum: 9007199254740991
|
|
11521
|
+
*/
|
|
11522
|
+
tolerance_percent: number | null;
|
|
11523
|
+
};
|
|
11452
11524
|
peak_month: number | null;
|
|
11453
11525
|
};
|
|
11454
11526
|
/**
|
|
@@ -11467,6 +11539,24 @@ export interface LicenseUsageOutput {
|
|
|
11467
11539
|
* Licensed limit; -1 = unlimited.
|
|
11468
11540
|
*/
|
|
11469
11541
|
limit: number;
|
|
11542
|
+
overage: {
|
|
11543
|
+
/**
|
|
11544
|
+
* minimum: -9007199254740991
|
|
11545
|
+
* maximum: 9007199254740991
|
|
11546
|
+
*/
|
|
11547
|
+
cap: number | null;
|
|
11548
|
+
/**
|
|
11549
|
+
* minimum: -9007199254740991
|
|
11550
|
+
* maximum: 9007199254740991
|
|
11551
|
+
*/
|
|
11552
|
+
refuses_at: number | null;
|
|
11553
|
+
rule: "none" | "tolerate" | "tolerate_charge" | null;
|
|
11554
|
+
/**
|
|
11555
|
+
* minimum: -9007199254740991
|
|
11556
|
+
* maximum: 9007199254740991
|
|
11557
|
+
*/
|
|
11558
|
+
tolerance_percent: number | null;
|
|
11559
|
+
};
|
|
11470
11560
|
peak_month: number | null;
|
|
11471
11561
|
};
|
|
11472
11562
|
plan: {
|
|
@@ -11485,6 +11575,24 @@ export interface LicenseUsageOutput {
|
|
|
11485
11575
|
* Licensed limit; -1 = unlimited.
|
|
11486
11576
|
*/
|
|
11487
11577
|
limit: number;
|
|
11578
|
+
overage: {
|
|
11579
|
+
/**
|
|
11580
|
+
* minimum: -9007199254740991
|
|
11581
|
+
* maximum: 9007199254740991
|
|
11582
|
+
*/
|
|
11583
|
+
cap: number | null;
|
|
11584
|
+
/**
|
|
11585
|
+
* minimum: -9007199254740991
|
|
11586
|
+
* maximum: 9007199254740991
|
|
11587
|
+
*/
|
|
11588
|
+
refuses_at: number | null;
|
|
11589
|
+
rule: "none" | "tolerate" | "tolerate_charge" | null;
|
|
11590
|
+
/**
|
|
11591
|
+
* minimum: -9007199254740991
|
|
11592
|
+
* maximum: 9007199254740991
|
|
11593
|
+
*/
|
|
11594
|
+
tolerance_percent: number | null;
|
|
11595
|
+
};
|
|
11488
11596
|
peak_month: number | null;
|
|
11489
11597
|
};
|
|
11490
11598
|
}
|
|
@@ -11833,13 +11941,13 @@ export type OauthGrantsUsageErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS"
|
|
|
11833
11941
|
/**
|
|
11834
11942
|
* orgSettings.getDialer input.
|
|
11835
11943
|
*
|
|
11836
|
-
* Returns the organization's dialer operational settings — reserved inbound channels, default trunk, default country, the daily attempt cap per number and the answering-machine detection defaults. Returns null when no settings row exists yet.
|
|
11944
|
+
* Returns the organization's dialer operational settings — reserved inbound channels, default trunk, default country, the daily attempt cap per number and the answering-machine detection defaults. Returns null when no settings row exists yet. Without the classifier module dialer_amd_enabled reads false.
|
|
11837
11945
|
*/
|
|
11838
11946
|
export type OrgSettingsGetDialerInput = void;
|
|
11839
11947
|
/**
|
|
11840
11948
|
* orgSettings.getDialer output.
|
|
11841
11949
|
*
|
|
11842
|
-
* Returns the organization's dialer operational settings — reserved inbound channels, default trunk, default country, the daily attempt cap per number and the answering-machine detection defaults. Returns null when no settings row exists yet.
|
|
11950
|
+
* Returns the organization's dialer operational settings — reserved inbound channels, default trunk, default country, the daily attempt cap per number and the answering-machine detection defaults. Returns null when no settings row exists yet. Without the classifier module dialer_amd_enabled reads false.
|
|
11843
11951
|
*/
|
|
11844
11952
|
export type OrgSettingsGetDialerOutput = {
|
|
11845
11953
|
/**
|
|
@@ -11875,13 +11983,13 @@ export type OrgSettingsGetDialerOutput = {
|
|
|
11875
11983
|
/**
|
|
11876
11984
|
* orgSettings.getDialer error codes.
|
|
11877
11985
|
*
|
|
11878
|
-
* Returns the organization's dialer operational settings — reserved inbound channels, default trunk, default country, the daily attempt cap per number and the answering-machine detection defaults. Returns null when no settings row exists yet.
|
|
11986
|
+
* Returns the organization's dialer operational settings — reserved inbound channels, default trunk, default country, the daily attempt cap per number and the answering-machine detection defaults. Returns null when no settings row exists yet. Without the classifier module dialer_amd_enabled reads false.
|
|
11879
11987
|
*/
|
|
11880
11988
|
export type OrgSettingsGetDialerErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
11881
11989
|
/**
|
|
11882
11990
|
* orgSettings.upsertDialer input.
|
|
11883
11991
|
*
|
|
11884
|
-
* Creates or updates the organization's dialer operational settings and returns the persisted values. The change is broadcast to running engines and recorded in the audit log.
|
|
11992
|
+
* Creates or updates the organization's dialer operational settings and returns the persisted values. The change is broadcast to running engines and recorded in the audit log. dialer_amd_enabled belongs to the classifier module: without it, it reads false, true returns 403 MODULE_DISABLED and false leaves the stored default as it is.
|
|
11885
11993
|
*/
|
|
11886
11994
|
export interface OrgSettingsUpsertDialerInput {
|
|
11887
11995
|
/**
|
|
@@ -11919,7 +12027,7 @@ export interface OrgSettingsUpsertDialerInput {
|
|
|
11919
12027
|
/**
|
|
11920
12028
|
* orgSettings.upsertDialer output.
|
|
11921
12029
|
*
|
|
11922
|
-
* Creates or updates the organization's dialer operational settings and returns the persisted values. The change is broadcast to running engines and recorded in the audit log.
|
|
12030
|
+
* Creates or updates the organization's dialer operational settings and returns the persisted values. The change is broadcast to running engines and recorded in the audit log. dialer_amd_enabled belongs to the classifier module: without it, it reads false, true returns 403 MODULE_DISABLED and false leaves the stored default as it is.
|
|
11923
12031
|
*/
|
|
11924
12032
|
export interface OrgSettingsUpsertDialerOutput {
|
|
11925
12033
|
/**
|
|
@@ -11955,9 +12063,9 @@ export interface OrgSettingsUpsertDialerOutput {
|
|
|
11955
12063
|
/**
|
|
11956
12064
|
* orgSettings.upsertDialer error codes.
|
|
11957
12065
|
*
|
|
11958
|
-
* Creates or updates the organization's dialer operational settings and returns the persisted values. The change is broadcast to running engines and recorded in the audit log.
|
|
12066
|
+
* Creates or updates the organization's dialer operational settings and returns the persisted values. The change is broadcast to running engines and recorded in the audit log. dialer_amd_enabled belongs to the classifier module: without it, it reads false, true returns 403 MODULE_DISABLED and false leaves the stored default as it is.
|
|
11959
12067
|
*/
|
|
11960
|
-
export type OrgSettingsUpsertDialerErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
12068
|
+
export type OrgSettingsUpsertDialerErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "MODULE_DISABLED" | "UNAUTHORIZED";
|
|
11961
12069
|
/**
|
|
11962
12070
|
* queues.addMembers input.
|
|
11963
12071
|
*
|
|
@@ -18798,11 +18906,11 @@ export type WebhooksEventsListOutput = {
|
|
|
18798
18906
|
*/
|
|
18799
18907
|
export type WebhooksEventsListErrorCode = "FORBIDDEN" | "INSUFFICIENT_PERMISSIONS" | "INSUFFICIENT_SCOPE" | "MEMBER_SUSPENDED" | "MFA_SETUP_REQUIRED" | "UNAUTHORIZED";
|
|
18800
18908
|
/** Every distinct declared error code, referenced by index from OPERATIONS. */
|
|
18801
|
-
export declare const ERROR_CODES: readonly ["ACCOUNT_TARGET_FORBIDDEN", "ACTIVE_CALL_NOT_FOUND", "AI_ENCRYPTION_KEY_MISSING", "AI_INVALID_API_KEY", "AI_NOT_CONFIGURED", "AI_UNREACHABLE", "ALREADY_MEMBER", "API_KEY_EXPIRED", "API_KEY_NOT_FOUND", "ARCHIVE_ITEM_IN_USE", "ARCHIVE_ITEM_NOT_FOUND", "ARCHIVE_RESTORE_CONFLICT", "ATTENDANT_ALREADY_EXISTS", "ATTENDANT_BUSY", "ATTENDANT_NOT_FOUND", "ATTENDANT_NOT_SIP_EXTENSION", "AUDIO_FILE_CONTENT_MISSING", "AUDIO_FILE_INVALID_FORMAT", "AUDIO_FILE_IN_USE", "AUDIO_FILE_NOT_FOUND", "AUDIO_FILE_NOT_TTS", "AUDIO_FILE_TOO_LARGE", "AUDIO_URL_BLOCKED", "AUDIO_URL_DECODE_FAILED", "AUDIO_URL_HTTP_ERROR", "AUDIO_URL_INVALID", "AUDIO_URL_TIMEOUT", "AUDIO_URL_TOO_LARGE", "AUDIO_URL_UNREACHABLE", "AUDIO_URL_UNSUPPORTED_FORMAT", "AUDIT_CURSOR_INVALID", "BUG_REPORTING_DISABLED", "BUG_REPORT_DELIVERY_FAILED", "CALL_HAS_NO_TRANSCRIPTION_WINDOW", "CALL_NOT_FOUND", "CALL_RECORD_CURSOR_INVALID", "CANNOT_MANAGE_OWN_ACCOUNT", "CANNOT_REMOVE_SELF", "CANNOT_SUSPEND_SELF", "CHANNEL_ALREADY_ASSIGNED", "CHANNEL_CONNECTOR_NOT_ALLOWED", "CHANNEL_CONNECTOR_REQUIRED", "CHANNEL_CONNECTOR_UNAVAILABLE", "CHANNEL_INVALID_CREDENTIALS", "CHANNEL_NOT_FOUND", "CHANNEL_VOICE_NOT_SUPPORTED", "CHANNEL_WEBCHAT_IDENTITY_SECRET_REQUIRED", "CHANNEL_WHATSAPP_NUMBER_NOT_IN_CONNECTOR", "CHAT_MEDIA_NOT_FOUND", "CHAT_MEDIA_TOO_LARGE", "CHAT_MEDIA_UNSUPPORTED", "CHAT_SESSION_NOT_FOUND", "CONTACT_NOT_FOUND", "CONVERSATION_CURSOR_INVALID", "CONVERSATION_NOT_FOUND", "DECISIONS_UNAVAILABLE", "DESK_PUBLIC_URL_MISSING", "DESTINATION_NOT_FOUND", "DIALER_CAMPAIGN_INVALID_TRANSITION", "DIALER_CAMPAIGN_NOT_FOUND", "DIALER_CAMPAIGN_NO_CONTACTS", "DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED", "DIALER_CONTACT_DUPLICATE", "DIALER_CONTACT_NOT_EDITABLE", "DIALER_CONTACT_NOT_REQUEUEABLE", "DIALER_DNC_DUPLICATE", "DIALER_IMPORT_INVALID", "DIALER_IMPORT_JOB_NOT_FOUND", "DIALER_MODULE_DISABLED", "DIALER_PLAN_IN_USE", "DISPOSITION_DUPLICATE", "DISPOSITION_NOT_FOUND", "DRAFT_STALE", "DUPLICATE_CHANNEL", "DUPLICATE_EMAIL", "DUPLICATE_SIGNAL_SLUG", "ESL_CONNECTION_ERROR", "EXPORT_JOB_EXPIRED", "EXPORT_JOB_LIMIT_REACHED", "EXPORT_JOB_NOT_CANCELLABLE", "EXPORT_JOB_NOT_FOUND", "EXPORT_JOB_NOT_OWNER", "EXPORT_JOB_NOT_READY", "EXTENSION_IN_USE", "EXTENSION_REQUIRED", "FEATURE_DISABLED", "FORBIDDEN", "HANGUP_FAILED", "HOLIDAY_CALENDAR_ENTRY_NOT_FOUND", "HOLIDAY_CALENDAR_IN_USE", "HOLIDAY_CALENDAR_NOT_FOUND", "INSIGHT_PERIOD_TOO_LONG", "INSUFFICIENT_PERMISSIONS", "INSUFFICIENT_SCOPE", "INVALID_CATALOG_CODE", "INVALID_EXPORT_COLUMNS", "INVALID_HOLIDAY_WINDOW", "INVALID_SCHEDULE_INPUT", "LAST_ADMINISTRATOR", "LENGTH_REQUIRED", "LICENSE_SUITE_BAD_REQUEST", "LICENSE_SUITE_CONFLICT", "LICENSE_SUITE_FORBIDDEN", "LICENSE_SUITE_RATE_LIMITED", "LICENSE_SUITE_UNAVAILABLE", "LICENSE_SUITE_UNREACHABLE", "LICENSE_V3_NOT_CONFIGURED", "MAX_CUSTOM_ROLES_REACHED", "MEMBER_NOT_FOUND", "MEMBER_SUSPENDED", "MFA_SETUP_REQUIRED", "MODULE_DISABLED", "NEW_USER_REQUIRES_PASSWORD", "NODE_NOT_IN_TRACE", "NODE_RANGE_INVALID", "OAUTH_GRANT_FORBIDDEN", "OAUTH_GRANT_NOT_FOUND", "ORIGINATE_CAPACITY_EXCEEDED", "ORIGINATE_DESTINATION_NOT_ROUTABLE", "ORIGINATE_FAILED", "ORIGINATE_PLAN_NOT_PUBLISHED", "PAUSE_REASON_DUPLICATE", "PAUSE_REASON_NOT_FOUND", "PAUSE_REASON_REQUIRED", "PERMISSION_CEILING_EXCEEDED", "PLAN_NOT_FOUND", "PLAN_NOT_PUBLISHED", "PLAN_VALIDATION_FAILED", "QUEUE_IN_USE", "QUEUE_NAME_TAKEN", "QUEUE_NOT_FOUND", "RANGE_HAS_NO_AUDIO", "RANGE_NOT_APPLICABLE", "RANGE_NOT_SATISFIABLE", "RECORDING_CONTENT_MISSING", "RECORDING_NOT_FOUND", "ROLE_NOT_FOUND", "ROLE_SCOPE_MISMATCH", "SAVED_REPLY_NOT_FOUND", "SAVED_REPLY_SHORTCUT_TAKEN", "SCHEDULE_EXCEPTION_NOT_FOUND", "SCHEDULE_NOT_FOUND", "SELF_ROTATION_FORBIDDEN", "SIGNAL_ALERT_OPTION_REMOVED", "SIGNAL_ARCHIVED", "SIGNAL_DEFINITION_INVALID", "SIGNAL_KIND_IMMUTABLE", "SIGNAL_NOT_FOUND", "SIGNAL_TEST_NO_TRANSCRIPTION", "SIGNAL_TEST_SOURCE_INVALID", "SIGNAL_VERSION_CONFLICT", "SSO_REQUIRED", "TRANSCRIPTION_CAPACITY_EXCEEDED", "TRANSCRIPTION_NOT_FOUND", "TTS_VOICE_UNAVAILABLE", "UNAUTHORIZED", "WEBCHAT_ORIGIN_DENIED", "WEBCHAT_SESSION_INVALID", "WEBHOOK_DELIVERY_AGGREGATE_NOT_FOUND", "WEBHOOK_DELIVERY_CURSOR_INVALID", "WEBHOOK_DELIVERY_NOT_RETRYABLE", "WEBHOOK_DELIVERY_RETENTION_EXPIRED", "WEBHOOK_ENDPOINT_NOT_FOUND", "WINDOW_TOO_LONG", "WRAP_UP_PENDING"];
|
|
18909
|
+
export declare const ERROR_CODES: readonly ["ACCOUNT_TARGET_FORBIDDEN", "ACTIVE_CALL_NOT_FOUND", "AI_ENCRYPTION_KEY_MISSING", "AI_INVALID_API_KEY", "AI_NOT_CONFIGURED", "AI_UNREACHABLE", "ALREADY_MEMBER", "API_KEY_EXPIRED", "API_KEY_NOT_FOUND", "ARCHIVE_ITEM_IN_USE", "ARCHIVE_ITEM_NOT_FOUND", "ARCHIVE_RESTORE_CONFLICT", "ATTENDANT_ALREADY_EXISTS", "ATTENDANT_BUSY", "ATTENDANT_LIMIT_REACHED", "ATTENDANT_NOT_FOUND", "ATTENDANT_NOT_SIP_EXTENSION", "AUDIO_FILE_CONTENT_MISSING", "AUDIO_FILE_INVALID_FORMAT", "AUDIO_FILE_IN_USE", "AUDIO_FILE_NOT_FOUND", "AUDIO_FILE_NOT_TTS", "AUDIO_FILE_TOO_LARGE", "AUDIO_URL_BLOCKED", "AUDIO_URL_DECODE_FAILED", "AUDIO_URL_HTTP_ERROR", "AUDIO_URL_INVALID", "AUDIO_URL_TIMEOUT", "AUDIO_URL_TOO_LARGE", "AUDIO_URL_UNREACHABLE", "AUDIO_URL_UNSUPPORTED_FORMAT", "AUDIT_CURSOR_INVALID", "BUG_REPORTING_DISABLED", "BUG_REPORT_DELIVERY_FAILED", "CALL_HAS_NO_TRANSCRIPTION_WINDOW", "CALL_NOT_FOUND", "CALL_RECORD_CURSOR_INVALID", "CANNOT_MANAGE_OWN_ACCOUNT", "CANNOT_REMOVE_SELF", "CANNOT_SUSPEND_SELF", "CHANNEL_ALREADY_ASSIGNED", "CHANNEL_CONNECTOR_NOT_ALLOWED", "CHANNEL_CONNECTOR_REQUIRED", "CHANNEL_CONNECTOR_UNAVAILABLE", "CHANNEL_INVALID_CREDENTIALS", "CHANNEL_NOT_FOUND", "CHANNEL_VOICE_NOT_SUPPORTED", "CHANNEL_WEBCHAT_IDENTITY_SECRET_REQUIRED", "CHANNEL_WHATSAPP_NUMBER_NOT_IN_CONNECTOR", "CHAT_MEDIA_NOT_FOUND", "CHAT_MEDIA_TOO_LARGE", "CHAT_MEDIA_UNSUPPORTED", "CHAT_SESSION_NOT_FOUND", "CONTACT_NOT_FOUND", "CONVERSATION_CURSOR_INVALID", "CONVERSATION_NOT_FOUND", "DECISIONS_UNAVAILABLE", "DESK_PUBLIC_URL_MISSING", "DESTINATION_NOT_FOUND", "DIALER_CAMPAIGN_INVALID_TRANSITION", "DIALER_CAMPAIGN_NOT_FOUND", "DIALER_CAMPAIGN_NO_CONTACTS", "DIALER_CAMPAIGN_PLAN_NOT_PUBLISHED", "DIALER_CONTACT_DUPLICATE", "DIALER_CONTACT_NOT_EDITABLE", "DIALER_CONTACT_NOT_REQUEUEABLE", "DIALER_DNC_DUPLICATE", "DIALER_IMPORT_INVALID", "DIALER_IMPORT_JOB_NOT_FOUND", "DIALER_MODULE_DISABLED", "DIALER_PLAN_IN_USE", "DISPOSITION_DUPLICATE", "DISPOSITION_NOT_FOUND", "DRAFT_STALE", "DUPLICATE_CHANNEL", "DUPLICATE_EMAIL", "DUPLICATE_SIGNAL_SLUG", "ESL_CONNECTION_ERROR", "EXPORT_JOB_EXPIRED", "EXPORT_JOB_LIMIT_REACHED", "EXPORT_JOB_NOT_CANCELLABLE", "EXPORT_JOB_NOT_FOUND", "EXPORT_JOB_NOT_OWNER", "EXPORT_JOB_NOT_READY", "EXTENSION_IN_USE", "EXTENSION_REQUIRED", "FEATURE_DISABLED", "FORBIDDEN", "HANGUP_FAILED", "HOLIDAY_CALENDAR_ENTRY_NOT_FOUND", "HOLIDAY_CALENDAR_IN_USE", "HOLIDAY_CALENDAR_NOT_FOUND", "INSIGHT_PERIOD_TOO_LONG", "INSUFFICIENT_PERMISSIONS", "INSUFFICIENT_SCOPE", "INVALID_CATALOG_CODE", "INVALID_EXPORT_COLUMNS", "INVALID_HOLIDAY_WINDOW", "INVALID_SCHEDULE_INPUT", "LAST_ADMINISTRATOR", "LENGTH_REQUIRED", "LICENSE_SUITE_BAD_REQUEST", "LICENSE_SUITE_CONFLICT", "LICENSE_SUITE_FORBIDDEN", "LICENSE_SUITE_RATE_LIMITED", "LICENSE_SUITE_UNAVAILABLE", "LICENSE_SUITE_UNREACHABLE", "LICENSE_V3_NOT_CONFIGURED", "MAX_CUSTOM_ROLES_REACHED", "MEMBER_NOT_FOUND", "MEMBER_SUSPENDED", "MFA_SETUP_REQUIRED", "MODULE_DISABLED", "NEW_USER_REQUIRES_PASSWORD", "NODE_NOT_IN_TRACE", "NODE_RANGE_INVALID", "OAUTH_GRANT_FORBIDDEN", "OAUTH_GRANT_NOT_FOUND", "ORIGINATE_CAPACITY_EXCEEDED", "ORIGINATE_DESTINATION_NOT_ROUTABLE", "ORIGINATE_FAILED", "ORIGINATE_PLAN_NOT_PUBLISHED", "PAUSE_REASON_DUPLICATE", "PAUSE_REASON_NOT_FOUND", "PAUSE_REASON_REQUIRED", "PERMISSION_CEILING_EXCEEDED", "PLAN_NOT_FOUND", "PLAN_NOT_PUBLISHED", "PLAN_VALIDATION_FAILED", "QUEUE_IN_USE", "QUEUE_NAME_TAKEN", "QUEUE_NOT_FOUND", "RANGE_HAS_NO_AUDIO", "RANGE_NOT_APPLICABLE", "RANGE_NOT_SATISFIABLE", "RECORDING_CONTENT_MISSING", "RECORDING_NOT_FOUND", "ROLE_NOT_FOUND", "ROLE_SCOPE_MISMATCH", "SAVED_REPLY_NOT_FOUND", "SAVED_REPLY_SHORTCUT_TAKEN", "SCHEDULE_EXCEPTION_NOT_FOUND", "SCHEDULE_NOT_FOUND", "SELF_ROTATION_FORBIDDEN", "SIGNAL_ALERT_OPTION_REMOVED", "SIGNAL_ARCHIVED", "SIGNAL_DEFINITION_INVALID", "SIGNAL_KIND_IMMUTABLE", "SIGNAL_NOT_FOUND", "SIGNAL_TEST_NO_TRANSCRIPTION", "SIGNAL_TEST_SOURCE_INVALID", "SIGNAL_VERSION_CONFLICT", "SSO_REQUIRED", "TRANSCRIPTION_CAPACITY_EXCEEDED", "TRANSCRIPTION_NOT_FOUND", "TTS_VOICE_UNAVAILABLE", "UNAUTHORIZED", "WEBCHAT_ORIGIN_DENIED", "WEBCHAT_SESSION_INVALID", "WEBHOOK_DELIVERY_AGGREGATE_NOT_FOUND", "WEBHOOK_DELIVERY_CURSOR_INVALID", "WEBHOOK_DELIVERY_NOT_RETRYABLE", "WEBHOOK_DELIVERY_RETENTION_EXPIRED", "WEBHOOK_ENDPOINT_NOT_FOUND", "WINDOW_TOO_LONG", "WRAP_UP_PENDING"];
|
|
18802
18910
|
/** Declared codes shared by every operation (indexes into ERROR_CODES). */
|
|
18803
18911
|
export declare const COMMON_ERROR_CODES: readonly [];
|
|
18804
18912
|
/** Distinct per-operation code sets beyond COMMON_ERROR_CODES, as indexes into ERROR_CODES. */
|
|
18805
|
-
export declare const ERROR_CODE_SETS: readonly [readonly [
|
|
18913
|
+
export declare const ERROR_CODE_SETS: readonly [readonly [49, 157, 158], readonly [52, 157, 158], readonly [87, 110, 111, 156], readonly [50, 51, 100, 157, 158], readonly [32, 33, 87, 110, 111, 156], readonly [87, 93, 94, 110, 111, 156], readonly [35, 87, 93, 94, 110, 111, 156], readonly [36, 87, 93, 94, 110, 111, 156], readonly [58, 87, 93, 94, 110, 111, 156], readonly [8, 87, 93, 94, 110, 111, 156], readonly [81, 87, 93, 94, 110, 111, 156], readonly [87, 91, 93, 94, 110, 111, 156], readonly [87, 93, 94, 110, 111, 112, 156], readonly [87, 93, 94, 110, 111, 141, 156], readonly [87, 93, 94, 110, 111, 142, 156], readonly [87, 93, 94, 110, 111, 156, 159], readonly [87, 93, 94, 110, 111, 156, 160], readonly [87, 93, 94, 95, 110, 111, 156], readonly [87, 93, 94, 96, 110, 111, 156], readonly [87, 93, 94, 97, 110, 111, 156], readonly [15, 87, 93, 94, 110, 111, 112, 156], readonly [17, 20, 87, 93, 94, 110, 111, 156], readonly [18, 22, 87, 93, 94, 110, 111, 156], readonly [31, 87, 93, 94, 110, 111, 112, 156], readonly [35, 49, 87, 93, 94, 110, 111, 156], readonly [53, 87, 93, 94, 110, 111, 112, 156], readonly [54, 87, 93, 94, 110, 111, 112, 156], readonly [55, 87, 93, 94, 110, 111, 112, 156], readonly [79, 87, 93, 94, 110, 111, 112, 156], readonly [79, 87, 93, 94, 96, 110, 111, 156], readonly [81, 87, 93, 94, 110, 111, 112, 156], readonly [87, 89, 91, 93, 94, 110, 111, 156], readonly [87, 90, 91, 93, 94, 110, 111, 156], readonly [87, 91, 93, 94, 97, 110, 111, 156], readonly [87, 92, 93, 94, 110, 111, 112, 156], readonly [87, 93, 94, 109, 110, 111, 125, 156], readonly [87, 93, 94, 110, 111, 112, 131, 156], readonly [87, 93, 94, 110, 111, 112, 156, 163], readonly [87, 93, 94, 110, 111, 112, 156, 164], readonly [87, 93, 94, 110, 111, 116, 117, 156], readonly [87, 93, 94, 110, 111, 156, 161, 162], readonly [87, 93, 94, 98, 110, 111, 142, 156], readonly [1, 77, 87, 88, 93, 94, 110, 111, 156], readonly [13, 15, 87, 93, 94, 110, 111, 112, 156], readonly [15, 87, 93, 94, 110, 111, 112, 131, 156], readonly [3, 4, 5, 87, 93, 94, 110, 111, 156], readonly [49, 55, 87, 93, 94, 110, 111, 112, 156], readonly [53, 65, 87, 93, 94, 110, 111, 112, 156], readonly [66, 67, 87, 93, 94, 110, 111, 112, 156], readonly [7, 8, 87, 93, 94, 110, 111, 143, 156], readonly [78, 81, 83, 87, 93, 94, 110, 111, 156], readonly [80, 81, 82, 87, 93, 94, 110, 111, 156], readonly [86, 87, 93, 94, 110, 111, 112, 154, 156], readonly [87, 89, 91, 93, 94, 97, 110, 111, 156], readonly [87, 91, 93, 94, 95, 98, 110, 111, 156], readonly [87, 93, 94, 110, 111, 112, 122, 123, 156], readonly [87, 93, 94, 110, 111, 112, 126, 127, 156], readonly [87, 93, 94, 110, 111, 112, 126, 148, 156], readonly [87, 93, 94, 110, 111, 112, 129, 131, 156], readonly [87, 93, 94, 110, 111, 112, 139, 140, 156], readonly [87, 93, 94, 98, 110, 111, 141, 142, 156], readonly [0, 37, 87, 93, 94, 109, 110, 111, 125, 156], readonly [20, 87, 93, 94, 110, 111, 112, 130, 131, 156], readonly [3, 4, 5, 87, 93, 94, 110, 111, 112, 156], readonly [3, 4, 5, 87, 93, 94, 110, 111, 155, 156], readonly [35, 87, 93, 94, 110, 111, 134, 135, 136, 156], readonly [38, 87, 93, 94, 99, 109, 110, 111, 125, 156], readonly [39, 87, 93, 94, 99, 109, 110, 111, 125, 156], readonly [53, 60, 67, 87, 93, 94, 110, 111, 112, 156], readonly [60, 67, 68, 87, 93, 94, 110, 111, 112, 156], readonly [70, 87, 93, 94, 110, 111, 112, 126, 148, 156], readonly [71, 72, 87, 93, 94, 110, 111, 112, 131, 156], readonly [78, 81, 83, 87, 93, 94, 110, 111, 112, 156], readonly [80, 81, 82, 87, 93, 94, 110, 111, 112, 156], readonly [87, 91, 93, 94, 95, 98, 110, 111, 142, 156], readonly [15, 87, 93, 94, 110, 111, 112, 123, 124, 156, 165], readonly [2, 15, 16, 57, 87, 93, 94, 110, 111, 112, 156], readonly [53, 63, 64, 67, 87, 93, 94, 110, 111, 112, 156], readonly [73, 87, 93, 94, 110, 111, 112, 126, 128, 148, 156], readonly [59, 60, 61, 62, 69, 87, 93, 94, 110, 111, 112, 156], readonly [2, 12, 15, 57, 84, 85, 87, 93, 94, 110, 111, 112, 156], readonly [3, 4, 5, 19, 20, 21, 87, 93, 94, 110, 111, 155, 156], readonly [37, 38, 87, 93, 94, 99, 109, 110, 111, 125, 137, 138, 156], readonly [59, 60, 61, 62, 69, 87, 93, 94, 110, 111, 112, 126, 156], readonly [6, 75, 87, 93, 94, 110, 111, 113, 125, 137, 138, 152, 156], readonly [87, 93, 94, 101, 102, 103, 104, 105, 106, 107, 110, 111, 156], readonly [23, 24, 25, 26, 27, 28, 29, 30, 87, 93, 94, 110, 111, 156], readonly [77, 86, 87, 93, 94, 110, 111, 112, 118, 119, 120, 121, 126, 156], readonly [9, 10, 11, 14, 48, 87, 93, 94, 108, 110, 111, 112, 125, 156], readonly [4, 34, 87, 93, 94, 110, 111, 112, 114, 115, 132, 133, 136, 153, 156], readonly [2, 40, 41, 42, 43, 44, 45, 46, 47, 48, 74, 87, 93, 94, 110, 111, 112, 156], readonly [35, 56, 76, 87, 93, 94, 110, 111, 112, 126, 144, 145, 146, 147, 148, 149, 150, 151, 156], readonly [2, 6, 12, 14, 15, 57, 84, 85, 87, 93, 94, 109, 110, 111, 112, 125, 137, 138, 152, 156]];
|
|
18806
18914
|
/** Data-only operation table: transport metadata, no types. */
|
|
18807
18915
|
export declare const OPERATIONS: {
|
|
18808
18916
|
readonly "ai.getBudget": {
|
|
@@ -18992,7 +19100,7 @@ export declare const OPERATIONS: {
|
|
|
18992
19100
|
readonly queryParams: readonly ["search", "page", "limit", "sort_by", "sort_order", "entity_type"];
|
|
18993
19101
|
readonly bodyKind: "none";
|
|
18994
19102
|
readonly responseKind: "json";
|
|
18995
|
-
readonly codes:
|
|
19103
|
+
readonly codes: 88;
|
|
18996
19104
|
};
|
|
18997
19105
|
readonly "archive.purge": {
|
|
18998
19106
|
readonly method: "DELETE";
|
|
@@ -19001,7 +19109,7 @@ export declare const OPERATIONS: {
|
|
|
19001
19109
|
readonly queryParams: readonly [];
|
|
19002
19110
|
readonly bodyKind: "none";
|
|
19003
19111
|
readonly responseKind: "json";
|
|
19004
|
-
readonly codes:
|
|
19112
|
+
readonly codes: 88;
|
|
19005
19113
|
};
|
|
19006
19114
|
readonly "archive.restore": {
|
|
19007
19115
|
readonly method: "POST";
|
|
@@ -19010,7 +19118,7 @@ export declare const OPERATIONS: {
|
|
|
19010
19118
|
readonly queryParams: readonly [];
|
|
19011
19119
|
readonly bodyKind: "none";
|
|
19012
19120
|
readonly responseKind: "json";
|
|
19013
|
-
readonly codes:
|
|
19121
|
+
readonly codes: 88;
|
|
19014
19122
|
};
|
|
19015
19123
|
readonly "archive.summary": {
|
|
19016
19124
|
readonly method: "GET";
|
|
@@ -19019,7 +19127,7 @@ export declare const OPERATIONS: {
|
|
|
19019
19127
|
readonly queryParams: readonly [];
|
|
19020
19128
|
readonly bodyKind: "none";
|
|
19021
19129
|
readonly responseKind: "json";
|
|
19022
|
-
readonly codes:
|
|
19130
|
+
readonly codes: 88;
|
|
19023
19131
|
};
|
|
19024
19132
|
readonly "attendants.create": {
|
|
19025
19133
|
readonly method: "POST";
|
|
@@ -19028,7 +19136,7 @@ export declare const OPERATIONS: {
|
|
|
19028
19136
|
readonly queryParams: readonly [];
|
|
19029
19137
|
readonly bodyKind: "json";
|
|
19030
19138
|
readonly responseKind: "json";
|
|
19031
|
-
readonly codes:
|
|
19139
|
+
readonly codes: 92;
|
|
19032
19140
|
};
|
|
19033
19141
|
readonly "attendants.delete": {
|
|
19034
19142
|
readonly method: "DELETE";
|
|
@@ -19145,7 +19253,7 @@ export declare const OPERATIONS: {
|
|
|
19145
19253
|
readonly queryParams: readonly [];
|
|
19146
19254
|
readonly bodyKind: "json";
|
|
19147
19255
|
readonly responseKind: "binary";
|
|
19148
|
-
readonly codes:
|
|
19256
|
+
readonly codes: 86;
|
|
19149
19257
|
};
|
|
19150
19258
|
readonly "audioFiles.regenerateTts": {
|
|
19151
19259
|
readonly method: "POST";
|
|
@@ -19424,7 +19532,7 @@ export declare const OPERATIONS: {
|
|
|
19424
19532
|
readonly queryParams: readonly [];
|
|
19425
19533
|
readonly bodyKind: "json";
|
|
19426
19534
|
readonly responseKind: "json";
|
|
19427
|
-
readonly codes:
|
|
19535
|
+
readonly codes: 87;
|
|
19428
19536
|
};
|
|
19429
19537
|
readonly "capabilities.get": {
|
|
19430
19538
|
readonly method: "GET";
|
|
@@ -20252,7 +20360,7 @@ export declare const OPERATIONS: {
|
|
|
20252
20360
|
readonly queryParams: readonly [];
|
|
20253
20361
|
readonly bodyKind: "json";
|
|
20254
20362
|
readonly responseKind: "json";
|
|
20255
|
-
readonly codes:
|
|
20363
|
+
readonly codes: 85;
|
|
20256
20364
|
};
|
|
20257
20365
|
readonly "license.activation": {
|
|
20258
20366
|
readonly method: "GET";
|
|
@@ -20288,7 +20396,7 @@ export declare const OPERATIONS: {
|
|
|
20288
20396
|
readonly queryParams: readonly [];
|
|
20289
20397
|
readonly bodyKind: "none";
|
|
20290
20398
|
readonly responseKind: "json";
|
|
20291
|
-
readonly codes:
|
|
20399
|
+
readonly codes: 85;
|
|
20292
20400
|
};
|
|
20293
20401
|
readonly "license.status": {
|
|
20294
20402
|
readonly method: "GET";
|
|
@@ -20378,7 +20486,7 @@ export declare const OPERATIONS: {
|
|
|
20378
20486
|
readonly queryParams: readonly [];
|
|
20379
20487
|
readonly bodyKind: "json";
|
|
20380
20488
|
readonly responseKind: "json";
|
|
20381
|
-
readonly codes:
|
|
20489
|
+
readonly codes: 12;
|
|
20382
20490
|
};
|
|
20383
20491
|
readonly "queues.addMembers": {
|
|
20384
20492
|
readonly method: "POST";
|
|
@@ -20711,7 +20819,7 @@ export declare const OPERATIONS: {
|
|
|
20711
20819
|
readonly queryParams: readonly ["locale"];
|
|
20712
20820
|
readonly bodyKind: "none";
|
|
20713
20821
|
readonly responseKind: "json";
|
|
20714
|
-
readonly codes:
|
|
20822
|
+
readonly codes: 91;
|
|
20715
20823
|
};
|
|
20716
20824
|
readonly "signals.create": {
|
|
20717
20825
|
readonly method: "POST";
|
|
@@ -20720,7 +20828,7 @@ export declare const OPERATIONS: {
|
|
|
20720
20828
|
readonly queryParams: readonly [];
|
|
20721
20829
|
readonly bodyKind: "json";
|
|
20722
20830
|
readonly responseKind: "json";
|
|
20723
|
-
readonly codes:
|
|
20831
|
+
readonly codes: 91;
|
|
20724
20832
|
};
|
|
20725
20833
|
readonly "signals.delete": {
|
|
20726
20834
|
readonly method: "DELETE";
|
|
@@ -20729,7 +20837,7 @@ export declare const OPERATIONS: {
|
|
|
20729
20837
|
readonly queryParams: readonly [];
|
|
20730
20838
|
readonly bodyKind: "none";
|
|
20731
20839
|
readonly responseKind: "json";
|
|
20732
|
-
readonly codes:
|
|
20840
|
+
readonly codes: 91;
|
|
20733
20841
|
};
|
|
20734
20842
|
readonly "signals.get": {
|
|
20735
20843
|
readonly method: "GET";
|
|
@@ -20738,7 +20846,7 @@ export declare const OPERATIONS: {
|
|
|
20738
20846
|
readonly queryParams: readonly [];
|
|
20739
20847
|
readonly bodyKind: "none";
|
|
20740
20848
|
readonly responseKind: "json";
|
|
20741
|
-
readonly codes:
|
|
20849
|
+
readonly codes: 91;
|
|
20742
20850
|
};
|
|
20743
20851
|
readonly "signals.list": {
|
|
20744
20852
|
readonly method: "GET";
|
|
@@ -20774,7 +20882,7 @@ export declare const OPERATIONS: {
|
|
|
20774
20882
|
readonly queryParams: readonly [];
|
|
20775
20883
|
readonly bodyKind: "json";
|
|
20776
20884
|
readonly responseKind: "json";
|
|
20777
|
-
readonly codes:
|
|
20885
|
+
readonly codes: 91;
|
|
20778
20886
|
};
|
|
20779
20887
|
readonly "signals.update": {
|
|
20780
20888
|
readonly method: "PATCH";
|
|
@@ -20783,7 +20891,7 @@ export declare const OPERATIONS: {
|
|
|
20783
20891
|
readonly queryParams: readonly [];
|
|
20784
20892
|
readonly bodyKind: "json";
|
|
20785
20893
|
readonly responseKind: "json";
|
|
20786
|
-
readonly codes:
|
|
20894
|
+
readonly codes: 91;
|
|
20787
20895
|
};
|
|
20788
20896
|
readonly "signals.upsertBySlug": {
|
|
20789
20897
|
readonly method: "PUT";
|
|
@@ -20792,7 +20900,7 @@ export declare const OPERATIONS: {
|
|
|
20792
20900
|
readonly queryParams: readonly [];
|
|
20793
20901
|
readonly bodyKind: "json";
|
|
20794
20902
|
readonly responseKind: "json";
|
|
20795
|
-
readonly codes:
|
|
20903
|
+
readonly codes: 91;
|
|
20796
20904
|
};
|
|
20797
20905
|
readonly "tts.listModels": {
|
|
20798
20906
|
readonly method: "GET";
|
package/index.bun.js
CHANGED
package/index.default.js
CHANGED
package/index.deno.js
CHANGED
package/index.node.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sippulse/niva-sdk",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "NIVA SDK - typed client and webhook receiver for the NIVA IVR platform",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"homepage": "https://niva.sippulse.com",
|
|
@@ -31,8 +31,8 @@
|
|
|
31
31
|
"files": [
|
|
32
32
|
"chat.js",
|
|
33
33
|
"chat.d.ts",
|
|
34
|
+
"chunk-3w2v383z.js",
|
|
34
35
|
"chunk-50ad2r7x.js",
|
|
35
|
-
"chunk-wx0m9ra5.js",
|
|
36
36
|
"index.bun.js",
|
|
37
37
|
"index.default.js",
|
|
38
38
|
"index.deno.js",
|