diff --git a/swagger/api.json b/swagger/api.json index 0d1a057..10652c9 100644 --- a/swagger/api.json +++ b/swagger/api.json @@ -323,9 +323,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -354,9 +354,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -420,9 +420,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -458,9 +458,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -484,7 +484,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CalendarServiceUpdateCalendarBody" + "$ref": "#/definitions/engineUpdateCalendarRequest" } } ], @@ -496,9 +496,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -532,9 +532,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -639,6 +639,7 @@ }, { "type": "boolean", + "format": "boolean", "name": "is_supervisor", "in": "query" }, @@ -664,6 +665,7 @@ }, { "type": "boolean", + "format": "boolean", "name": "not_supervisor", "in": "query" }, @@ -715,9 +717,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -746,9 +748,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -829,9 +831,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -940,6 +942,7 @@ }, { "type": "boolean", + "format": "boolean", "name": "has_call", "in": "query" }, @@ -992,9 +995,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1035,9 +1038,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1110,9 +1113,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1134,6 +1137,7 @@ }, { "type": "boolean", + "format": "boolean", "name": "allow_change", "in": "query" } @@ -1146,9 +1150,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1229,9 +1233,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1255,7 +1259,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentSkillServiceCreateAgentSkillBody" + "$ref": "#/definitions/engineCreateAgentSkillRequest" } } ], @@ -1267,9 +1271,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1316,9 +1320,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1341,7 +1345,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentSkillServicePatchAgentSkillsBody" + "$ref": "#/definitions/enginePatchAgentSkillsRequest" } } ], @@ -1353,9 +1357,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1380,7 +1384,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentSkillServiceCreateAgentSkillsBody" + "$ref": "#/definitions/engineCreateAgentSkillsRequest" } } ], @@ -1392,9 +1396,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1437,9 +1441,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1470,7 +1474,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentSkillServiceUpdateAgentSkillBody" + "$ref": "#/definitions/engineUpdateAgentSkillRequest" } } ], @@ -1482,9 +1486,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1525,9 +1529,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1557,7 +1561,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentSkillServicePatchAgentSkillBody" + "$ref": "#/definitions/enginePatchAgentSkillRequest" } } ], @@ -1569,9 +1573,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1635,9 +1639,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1662,7 +1666,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentServiceAgentSetStateBody" + "$ref": "#/definitions/engineAgentSetStateRequest" } } ], @@ -1674,9 +1678,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1711,9 +1715,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1751,9 +1755,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1789,9 +1793,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1815,7 +1819,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentServiceUpdateAgentBody" + "$ref": "#/definitions/engineUpdateAgentRequest" } } ], @@ -1827,9 +1831,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1863,9 +1867,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1889,7 +1893,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentServicePatchAgentBody" + "$ref": "#/definitions/enginePatchAgentRequest" } } ], @@ -1901,9 +1905,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1963,9 +1967,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -1991,7 +1995,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentServiceUpdateAgentStatusBody" + "$ref": "#/definitions/engineAgentStatusRequest" } } ], @@ -2003,9 +2007,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2058,9 +2062,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2085,7 +2089,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServiceAttemptCallbackBody" + "$ref": "#/definitions/engineAttemptCallbackRequest" } } ], @@ -2097,9 +2101,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2165,12 +2169,14 @@ }, { "type": "boolean", + "format": "boolean", "name": "enabled", "in": "query" }, { "type": "boolean", - "description": "bool archive = 9;\n\nbool active = 11; // not archive", + "format": "boolean", + "description": "bool archive = 9;.", "name": "editable", "in": "query" }, @@ -2188,9 +2194,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2218,9 +2224,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2321,9 +2327,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2352,9 +2358,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2377,7 +2383,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AuditFormServiceUpdateAuditFormBody" + "$ref": "#/definitions/engineUpdateAuditFormRequest" } } ], @@ -2389,9 +2395,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2418,9 +2424,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2443,7 +2449,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AuditFormServicePatchAuditFormBody" + "$ref": "#/definitions/enginePatchAuditFormRequest" } } ], @@ -2455,9 +2461,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2487,9 +2493,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2518,9 +2524,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2584,9 +2590,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2615,9 +2621,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2653,9 +2659,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2679,7 +2685,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/BucketServiceUpdateBucketBody" + "$ref": "#/definitions/engineUpdateBucketRequest" } } ], @@ -2691,9 +2697,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2727,9 +2733,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2801,6 +2807,7 @@ }, { "type": "boolean", + "format": "boolean", "name": "default", "in": "query" } @@ -2813,9 +2820,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2844,9 +2851,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2882,9 +2889,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2908,7 +2915,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CommunicationTypeServiceUpdateCommunicationTypeBody" + "$ref": "#/definitions/engineUpdateCommunicationTypeRequest" } } ], @@ -2920,9 +2927,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2956,9 +2963,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -2981,7 +2988,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CommunicationTypeServicePatchCommunicationTypeBody" + "$ref": "#/definitions/enginePatchCommunicationTypeRequest" } } ], @@ -2993,9 +3000,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3059,9 +3066,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3090,9 +3097,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3128,9 +3135,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3154,7 +3161,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/ListServiceUpdateListBody" + "$ref": "#/definitions/engineUpdateListRequest" } } ], @@ -3166,9 +3173,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3202,9 +3209,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3287,9 +3294,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3313,7 +3320,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/ListServiceCreateListCommunicationBody" + "$ref": "#/definitions/engineCreateListCommunicationRequest" } } ], @@ -3325,9 +3332,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3370,9 +3377,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3403,7 +3410,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/ListServiceUpdateListCommunicationBody" + "$ref": "#/definitions/engineUpdateListCommunicationRequest" } } ], @@ -3415,9 +3422,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3458,9 +3465,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3513,9 +3520,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3561,9 +3568,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3724,9 +3731,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3751,7 +3758,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServicePatchMemberOneBody" + "$ref": "#/definitions/enginePatchMemberOneRequest" } } ], @@ -3763,9 +3770,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3828,9 +3835,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3858,9 +3865,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3889,9 +3896,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3914,7 +3921,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentPauseCauseServiceUpdateAgentPauseCauseBody" + "$ref": "#/definitions/engineUpdateAgentPauseCauseRequest" } } ], @@ -3926,9 +3933,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3955,9 +3962,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -3980,7 +3987,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentPauseCauseServicePatchAgentPauseCauseBody" + "$ref": "#/definitions/enginePatchAgentPauseCauseRequest" } } ], @@ -3992,9 +3999,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -4070,9 +4077,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -4100,9 +4107,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -4131,9 +4138,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -4156,7 +4163,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/PresetQueryServiceUpdatePresetQueryBody" + "$ref": "#/definitions/engineUpdatePresetQueryRequest" } } ], @@ -4168,9 +4175,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -4197,9 +4204,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -4222,7 +4229,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/PresetQueryServicePatchPresetQueryBody" + "$ref": "#/definitions/enginePatchPresetQueryRequest" } } ], @@ -4234,9 +4241,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -4321,6 +4328,7 @@ }, { "type": "boolean", + "format": "boolean", "name": "enabled", "in": "query" } @@ -4333,9 +4341,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -4364,9 +4372,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -4527,9 +4535,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -4690,9 +4698,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -4717,7 +4725,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServiceAttemptsRenewalResultBody" + "$ref": "#/definitions/engineAttemptRenewalResultRequest" } } ], @@ -4729,9 +4737,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -4832,9 +4840,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -4888,9 +4896,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -4926,9 +4934,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -4952,7 +4960,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueServiceUpdateQueueBody" + "$ref": "#/definitions/engineUpdateQueueRequest" } } ], @@ -4964,9 +4972,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5000,9 +5008,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5026,7 +5034,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueServicePatchQueueBody" + "$ref": "#/definitions/enginePatchQueueRequest" } } ], @@ -5038,9 +5046,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5111,9 +5119,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5137,7 +5145,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueBucketServiceCreateQueueBucketBody" + "$ref": "#/definitions/engineCreateQueueBucketRequest" } } ], @@ -5149,9 +5157,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5188,9 +5196,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5221,7 +5229,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueBucketServiceUpdateQueueBucketBody" + "$ref": "#/definitions/engineUpdateQueueBucketRequest" } } ], @@ -5233,9 +5241,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5270,9 +5278,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5302,7 +5310,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueBucketServicePatchQueueBucketBody" + "$ref": "#/definitions/enginePatchQueueBucketRequest" } } ], @@ -5314,9 +5322,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5405,9 +5413,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5430,7 +5438,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueHookServiceCreateQueueHookBody" + "$ref": "#/definitions/engineCreateQueueHookRequest" } } ], @@ -5442,9 +5450,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5480,9 +5488,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5512,7 +5520,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueHookServiceUpdateQueueHookBody" + "$ref": "#/definitions/engineUpdateQueueHookRequest" } } ], @@ -5524,9 +5532,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5560,9 +5568,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5592,7 +5600,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueHookServicePatchQueueHookBody" + "$ref": "#/definitions/enginePatchQueueHookRequest" } } ], @@ -5604,9 +5612,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5754,12 +5762,6 @@ "collectionFormat": "multi", "name": "agent_id", "in": "query" - }, - { - "type": "string", - "description": "This is a request variable of the map type. The query format is \"map_name[key]=value\", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age[\"bob\"]=18", - "name": "variables[string]", - "in": "query" } ], "responses": { @@ -5770,9 +5772,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5796,7 +5798,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServiceCreateMemberBody" + "$ref": "#/definitions/engineCreateMemberRequest" } } ], @@ -5808,9 +5810,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5834,7 +5836,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServiceDeleteMembersBody" + "$ref": "#/definitions/engineDeleteMembersRequest" } } ], @@ -5846,9 +5848,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5874,7 +5876,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServiceCreateMemberBulkBody" + "$ref": "#/definitions/engineCreateMemberBulkRequest" } } ], @@ -5886,9 +5888,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5914,7 +5916,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServiceResetMembersBody" + "$ref": "#/definitions/engineResetMembersRequest" } } ], @@ -5926,9 +5928,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -5971,9 +5973,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -6004,7 +6006,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServiceUpdateMemberBody" + "$ref": "#/definitions/engineUpdateMemberRequest" } } ], @@ -6016,9 +6018,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -6059,9 +6061,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -6092,7 +6094,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServicePatchMemberBody" + "$ref": "#/definitions/enginePatchMemberRequest" } } ], @@ -6104,9 +6106,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -6149,9 +6151,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -6182,7 +6184,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServiceCreateAttemptBody" + "$ref": "#/definitions/engineCreateAttemptRequest" } } ], @@ -6194,9 +6196,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -6235,7 +6237,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServiceAttemptResultBody" + "$ref": "#/definitions/engineAttemptResultRequest" } } ], @@ -6247,9 +6249,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -6320,9 +6322,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -6346,7 +6348,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueResourcesServiceCreateQueueResourceGroupBody" + "$ref": "#/definitions/engineCreateQueueResourceGroupRequest" } } ], @@ -6358,9 +6360,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -6403,9 +6405,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -6436,7 +6438,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueResourcesServiceUpdateQueueResourceGroupBody" + "$ref": "#/definitions/engineUpdateQueueResourceGroupRequest" } } ], @@ -6448,9 +6450,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -6491,9 +6493,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -6606,6 +6608,7 @@ }, { "type": "boolean", + "format": "boolean", "name": "enabled", "in": "query" } @@ -6618,9 +6621,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -6643,7 +6646,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueSkillServiceCreateQueueSkillBody" + "$ref": "#/definitions/engineCreateQueueSkillRequest" } } ], @@ -6655,9 +6658,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -6693,9 +6696,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -6725,7 +6728,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueSkillServiceUpdateQueueSkillBody" + "$ref": "#/definitions/engineUpdateQueueSkillRequest" } } ], @@ -6737,9 +6740,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -6773,9 +6776,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -6805,7 +6808,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueSkillServicePatchQueueSkillBody" + "$ref": "#/definitions/enginePatchQueueSkillRequest" } } ], @@ -6817,21 +6820,20 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } } }, - "/call_center/resource_group": { + "/call_center/quick_replies": { "get": { "tags": [ - "OutboundResourceGroupService" + "QuickRepliesService" ], - "summary": "List of OutboundResourceGroup", - "operationId": "SearchOutboundResourceGroup", + "operationId": "SearchQuickReplies", "parameters": [ { "type": "integer", @@ -6879,30 +6881,29 @@ "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/engineListOutboundResourceGroup" + "$ref": "#/definitions/engineListQuickReplies" } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } }, "post": { "tags": [ - "OutboundResourceGroupService" + "QuickRepliesService" ], - "summary": "Create OutboundResourceGroup", - "operationId": "CreateOutboundResourceGroup", + "operationId": "CreateQuickReply", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/engineCreateOutboundResourceGroupRequest" + "$ref": "#/definitions/engineCreateQuickReplyRequest" } } ], @@ -6910,30 +6911,261 @@ "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/engineOutboundResourceGroup" + "$ref": "#/definitions/engineQuickReply" } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } } }, - "/call_center/resource_group/{group_id}/resource": { + "/call_center/quick_replies/{id}": { "get": { "tags": [ - "OutboundResourceGroupService" + "QuickRepliesService" ], - "summary": "List of OutboundResourceInGroup", - "operationId": "SearchOutboundResourceInGroup", + "operationId": "ReadQuickReply", "parameters": [ { - "type": "string", + "type": "integer", "format": "int64", - "name": "group_id", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/engineQuickReply" + } + }, + "default": { + "description": "Server error", + "schema": { + "$ref": "#/definitions/engineApiError" + } + } + } + }, + "put": { + "tags": [ + "QuickRepliesService" + ], + "operationId": "UpdateQuickReply", + "parameters": [ + { + "type": "integer", + "format": "int64", + "name": "id", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/engineUpdateQuickReplyRequest" + } + } + ], + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/engineQuickReply" + } + }, + "default": { + "description": "Server error", + "schema": { + "$ref": "#/definitions/engineApiError" + } + } + } + }, + "delete": { + "tags": [ + "QuickRepliesService" + ], + "operationId": "DeleteQuickReply", + "parameters": [ + { + "type": "integer", + "format": "int64", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/engineQuickReply" + } + }, + "default": { + "description": "Server error", + "schema": { + "$ref": "#/definitions/engineApiError" + } + } + } + }, + "patch": { + "tags": [ + "QuickRepliesService" + ], + "operationId": "PatchQuickReply", + "parameters": [ + { + "type": "integer", + "format": "int64", + "name": "id", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/enginePatchQuickReplyRequest" + } + } + ], + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/engineQuickReply" + } + }, + "default": { + "description": "Server error", + "schema": { + "$ref": "#/definitions/engineApiError" + } + } + } + } + }, + "/call_center/resource_group": { + "get": { + "tags": [ + "OutboundResourceGroupService" + ], + "summary": "List of OutboundResourceGroup", + "operationId": "SearchOutboundResourceGroup", + "parameters": [ + { + "type": "integer", + "format": "int32", + "name": "page", + "in": "query" + }, + { + "type": "integer", + "format": "int32", + "name": "size", + "in": "query" + }, + { + "type": "string", + "name": "q", + "in": "query" + }, + { + "type": "string", + "name": "sort", + "in": "query" + }, + { + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "name": "fields", + "in": "query" + }, + { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + }, + "collectionFormat": "multi", + "name": "id", + "in": "query" + } + ], + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/engineListOutboundResourceGroup" + } + }, + "default": { + "description": "Server error", + "schema": { + "$ref": "#/definitions/engineApiError" + } + } + } + }, + "post": { + "tags": [ + "OutboundResourceGroupService" + ], + "summary": "Create OutboundResourceGroup", + "operationId": "CreateOutboundResourceGroup", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/engineCreateOutboundResourceGroupRequest" + } + } + ], + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/engineOutboundResourceGroup" + } + }, + "default": { + "description": "Server error", + "schema": { + "$ref": "#/definitions/engineApiError" + } + } + } + } + }, + "/call_center/resource_group/{group_id}/resource": { + "get": { + "tags": [ + "OutboundResourceGroupService" + ], + "summary": "List of OutboundResourceInGroup", + "operationId": "SearchOutboundResourceInGroup", + "parameters": [ + { + "type": "string", + "format": "int64", + "name": "group_id", "in": "path", "required": true }, @@ -6987,9 +7219,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7013,7 +7245,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OutboundResourceGroupServiceCreateOutboundResourceInGroupBody" + "$ref": "#/definitions/engineCreateOutboundResourceInGroupRequest" } } ], @@ -7025,9 +7257,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7070,9 +7302,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7103,7 +7335,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OutboundResourceGroupServiceUpdateOutboundResourceInGroupBody" + "$ref": "#/definitions/engineUpdateOutboundResourceInGroupRequest" } } ], @@ -7115,9 +7347,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7158,9 +7390,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7196,9 +7428,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7222,7 +7454,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OutboundResourceGroupServiceUpdateOutboundResourceGroupBody" + "$ref": "#/definitions/engineUpdateOutboundResourceGroupRequest" } } ], @@ -7234,9 +7466,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7270,9 +7502,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7336,9 +7568,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7367,9 +7599,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7405,9 +7637,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7431,7 +7663,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OutboundResourceServiceUpdateOutboundResourceBody" + "$ref": "#/definitions/engineUpdateOutboundResourceRequest" } } ], @@ -7443,9 +7675,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7479,9 +7711,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7505,7 +7737,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OutboundResourceServicePatchOutboundResourceBody" + "$ref": "#/definitions/enginePatchOutboundResourceRequest" } } ], @@ -7517,9 +7749,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7590,9 +7822,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7616,7 +7848,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OutboundResourceServiceCreateOutboundResourceDisplayBody" + "$ref": "#/definitions/engineCreateOutboundResourceDisplayRequest" } } ], @@ -7628,9 +7860,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7668,9 +7900,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7696,7 +7928,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OutboundResourceServiceCreateOutboundResourceDisplayBulkBody" + "$ref": "#/definitions/engineCreateOutboundResourceDisplayBulkRequest" } } ], @@ -7708,9 +7940,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7753,9 +7985,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7786,7 +8018,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OutboundResourceServiceUpdateOutboundResourceDisplayBody" + "$ref": "#/definitions/engineUpdateOutboundResourceDisplayRequest" } } ], @@ -7798,9 +8030,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7841,9 +8073,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7907,9 +8139,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7938,9 +8170,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -7976,9 +8208,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8002,7 +8234,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/SkillServiceUpdateSkillBody" + "$ref": "#/definitions/engineUpdateSkillRequest" } } ], @@ -8014,9 +8246,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8050,9 +8282,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8133,9 +8365,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8158,7 +8390,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/SkillServiceCreateSkillAgentBody" + "$ref": "#/definitions/engineCreateSkillAgentRequest" } } ], @@ -8170,9 +8402,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8195,7 +8427,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/SkillServiceDeleteSkillAgentBody" + "$ref": "#/definitions/engineDeleteSkillAgentRequest" } } ], @@ -8207,9 +8439,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8232,7 +8464,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/SkillServicePatchSkillAgentBody" + "$ref": "#/definitions/enginePatchSkillAgentRequest" } } ], @@ -8244,9 +8476,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8329,9 +8561,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8360,9 +8592,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8414,6 +8646,7 @@ }, { "type": "boolean", + "format": "boolean", "name": "enabled", "in": "query" }, @@ -8446,9 +8679,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8473,7 +8706,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TeamTriggerServiceRunTeamTriggerBody" + "$ref": "#/definitions/engineRunTeamTriggerRequest" } } ], @@ -8485,9 +8718,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8523,9 +8756,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8549,7 +8782,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentTeamServiceUpdateAgentTeamBody" + "$ref": "#/definitions/engineUpdateAgentTeamRequest" } } ], @@ -8561,9 +8794,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8597,9 +8830,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8692,9 +8925,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8717,7 +8950,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TeamHookServiceCreateTeamHookBody" + "$ref": "#/definitions/engineCreateTeamHookRequest" } } ], @@ -8729,9 +8962,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8767,9 +9000,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8799,7 +9032,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TeamHookServiceUpdateTeamHookBody" + "$ref": "#/definitions/engineUpdateTeamHookRequest" } } ], @@ -8811,9 +9044,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8847,9 +9080,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8879,7 +9112,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TeamHookServicePatchTeamHookBody" + "$ref": "#/definitions/enginePatchTeamHookRequest" } } ], @@ -8891,9 +9124,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -8946,6 +9179,7 @@ }, { "type": "boolean", + "format": "boolean", "name": "enabled", "in": "query" }, @@ -8978,9 +9212,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -9003,7 +9237,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TeamTriggerServiceCreateTeamTriggerBody" + "$ref": "#/definitions/engineCreateTeamTriggerRequest" } } ], @@ -9015,9 +9249,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -9053,9 +9287,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -9085,7 +9319,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TeamTriggerServiceUpdateTeamTriggerBody" + "$ref": "#/definitions/engineUpdateTeamTriggerRequest" } } ], @@ -9097,9 +9331,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -9133,9 +9367,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -9165,7 +9399,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TeamTriggerServicePatchTeamTriggerBody" + "$ref": "#/definitions/enginePatchTeamTriggerRequest" } } ], @@ -9177,9 +9411,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -9233,9 +9467,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -9265,9 +9499,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -9397,6 +9631,7 @@ }, { "type": "boolean", + "format": "boolean", "name": "skip_parent", "in": "query" }, @@ -9416,6 +9651,7 @@ }, { "type": "boolean", + "format": "boolean", "name": "exists_file", "in": "query" }, @@ -9453,6 +9689,7 @@ }, { "type": "boolean", + "format": "boolean", "name": "missed", "in": "query" }, @@ -9496,9 +9733,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -9533,9 +9770,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -9557,7 +9794,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceHangupCallBody" + "$ref": "#/definitions/engineHangupCallRequest" } } ], @@ -9569,9 +9806,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -9600,9 +9837,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -9626,7 +9863,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceDtmfCallBody" + "$ref": "#/definitions/engineDtmfCallRequest" } } ], @@ -9638,9 +9875,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -9664,7 +9901,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceEavesdropCallBody" + "$ref": "#/definitions/engineEavesdropCallRequest" } } ], @@ -9676,9 +9913,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -9702,7 +9939,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceHoldCallBody" + "$ref": "#/definitions/engineUserCallRequest" } } ], @@ -9714,9 +9951,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -9740,7 +9977,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceBlindTransferCallBody" + "$ref": "#/definitions/engineBlindTransferCallRequest" } } ], @@ -9752,9 +9989,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -9778,7 +10015,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceUnHoldCallBody" + "$ref": "#/definitions/engineUserCallRequest" } } ], @@ -9790,9 +10027,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -9816,7 +10053,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceSetVariablesCallBody" + "$ref": "#/definitions/engineSetVariablesCallRequest" } } ], @@ -9828,9 +10065,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -9961,6 +10198,7 @@ }, { "type": "boolean", + "format": "boolean", "name": "skip_parent", "in": "query" }, @@ -9980,6 +10218,7 @@ }, { "type": "boolean", + "format": "boolean", "name": "has_file", "in": "query" }, @@ -10013,6 +10252,7 @@ }, { "type": "boolean", + "format": "boolean", "name": "missed", "in": "query" }, @@ -10069,12 +10309,6 @@ "name": "tags", "in": "query" }, - { - "type": "string", - "description": "This is a request variable of the map type. The query format is \"map_name[key]=value\", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age[\"bob\"]=18", - "name": "variables[string]", - "in": "query" - }, { "type": "array", "items": { @@ -10100,6 +10334,7 @@ }, { "type": "boolean", + "format": "boolean", "name": "has_transcript", "in": "query" }, @@ -10151,6 +10386,7 @@ }, { "type": "boolean", + "format": "boolean", "name": "rated", "in": "query" }, @@ -10220,11 +10456,13 @@ }, { "type": "boolean", + "format": "boolean", "name": "has_transfer", "in": "query" }, { "type": "boolean", + "format": "boolean", "name": "timeline", "in": "query" } @@ -10237,9 +10475,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -10268,9 +10506,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -10300,9 +10538,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -10326,7 +10564,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceCreateCallAnnotationBody" + "$ref": "#/definitions/engineCreateCallAnnotationRequest" } } ], @@ -10338,9 +10576,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -10371,7 +10609,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceUpdateCallAnnotationBody" + "$ref": "#/definitions/engineUpdateCallAnnotationRequest" } } ], @@ -10383,9 +10621,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -10418,9 +10656,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -10444,7 +10682,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceRedialCallBody" + "$ref": "#/definitions/engineRedialCallRequest" } } ], @@ -10456,9 +10694,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -10482,7 +10720,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServicePatchHistoryCallBody" + "$ref": "#/definitions/enginePatchHistoryCallRequest" } } ], @@ -10494,9 +10732,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -14240,7 +14478,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/ChatHelperServiceBroadcastBody" + "$ref": "#/definitions/engineBroadcastRequest" } } ], @@ -14252,41 +14490,9 @@ } }, "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/rpcStatus" - } - } - } - } - }, - "/chat/broadcast": { - "post": { - "tags": [ - "ChatHelperService" - ], - "operationId": "BroadcastV2", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/chatBroadcastMessageRequest" - } - } - ], - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "$ref": "#/definitions/chatBroadcastMessageResponse" - } - }, - "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -21020,9 +21226,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -21051,9 +21257,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -21083,9 +21289,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -21109,7 +21315,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/EmailProfileServiceUpdateEmailProfileBody" + "$ref": "#/definitions/engineUpdateEmailProfileRequest" } } ], @@ -21121,9 +21327,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -21151,9 +21357,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -21176,7 +21382,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/EmailProfileServicePatchEmailProfileBody" + "$ref": "#/definitions/enginePatchEmailProfileRequest" } } ], @@ -21188,9 +21394,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -21219,9 +21425,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -21250,9 +21456,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -21282,9 +21488,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -21348,9 +21554,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -21379,9 +21585,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -21411,9 +21617,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -21437,7 +21643,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/WebHookServiceUpdateWebHookBody" + "$ref": "#/definitions/engineUpdateWebHookRequest" } } ], @@ -21449,9 +21655,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -21479,9 +21685,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -21505,7 +21711,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/WebHookServicePatchWebHookBody" + "$ref": "#/definitions/enginePatchWebHookRequest" } } ], @@ -21517,9 +21723,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -24429,9 +24635,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -24459,9 +24665,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -24490,9 +24696,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -24515,7 +24721,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RegionServiceUpdateRegionBody" + "$ref": "#/definitions/engineUpdateRegionRequest" } } ], @@ -24527,9 +24733,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -24556,9 +24762,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -24581,7 +24787,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RegionServicePatchRegionBody" + "$ref": "#/definitions/enginePatchRegionRequest" } } ], @@ -24593,9 +24799,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25129,9 +25335,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25160,9 +25366,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25195,7 +25401,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RoutingOutboundCallServiceMovePositionRoutingOutboundCallBody" + "$ref": "#/definitions/engineMovePositionRoutingOutboundCallRequest" } } ], @@ -25207,9 +25413,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25245,9 +25451,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25271,7 +25477,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RoutingOutboundCallServiceUpdateRoutingOutboundCallBody" + "$ref": "#/definitions/engineUpdateRoutingOutboundCallRequest" } } ], @@ -25283,9 +25489,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25319,9 +25525,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25345,7 +25551,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RoutingOutboundCallServicePatchRoutingOutboundCallBody" + "$ref": "#/definitions/enginePatchRoutingOutboundCallRequest" } } ], @@ -25357,9 +25563,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25420,6 +25626,7 @@ }, { "type": "boolean", + "format": "boolean", "name": "enabled", "in": "query" } @@ -25432,9 +25639,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25462,9 +25669,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25493,9 +25700,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25518,7 +25725,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RoutingChatPlanServiceUpdateChatPlanBody" + "$ref": "#/definitions/engineUpdateChatPlanRequest" } } ], @@ -25530,9 +25737,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25559,9 +25766,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25584,7 +25791,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RoutingChatPlanServicePatchChatPlanBody" + "$ref": "#/definitions/enginePatchChatPlanRequest" } } ], @@ -25596,9 +25803,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25676,6 +25883,7 @@ }, { "type": "boolean", + "format": "boolean", "name": "editor", "in": "query" }, @@ -25697,9 +25905,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25728,9 +25936,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25800,9 +26008,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25855,9 +26063,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25885,9 +26093,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25916,9 +26124,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25941,7 +26149,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/SchemaVariablesServiceUpdateSchemaVariableBody" + "$ref": "#/definitions/engineUpdateSchemaVariableRequest" } } ], @@ -25953,9 +26161,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -25982,9 +26190,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -26007,7 +26215,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/SchemaVariablesServicePatchSchemaVariableBody" + "$ref": "#/definitions/enginePatchSchemaVariableRequest" } } ], @@ -26019,9 +26227,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -26057,9 +26265,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -26083,7 +26291,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RoutingSchemaServiceUpdateRoutingSchemaBody" + "$ref": "#/definitions/engineUpdateRoutingSchemaRequest" } } ], @@ -26095,9 +26303,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -26131,9 +26339,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -26157,7 +26365,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RoutingSchemaServicePatchRoutingSchemaBody" + "$ref": "#/definitions/enginePatchRoutingSchemaRequest" } } ], @@ -26169,9 +26377,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -26231,9 +26439,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -26274,9 +26482,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -26305,9 +26513,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -26343,9 +26551,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -26369,7 +26577,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RoutingVariableServiceUpdateRoutingVariableBody" + "$ref": "#/definitions/engineUpdateRoutingVariableRequest" } } ], @@ -26381,9 +26589,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -26417,9 +26625,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -26478,12 +26686,13 @@ "chat_ai_connection", "password_reg_exp", "password_validation_text", - "autolink_call_to_contact" + "autolink_call_to_contact", + "period_to_playback_records" ], "type": "string" }, "collectionFormat": "multi", - "description": "Filter by setting names", + "description": "Filter by setting names.", "name": "name", "in": "query" } @@ -26496,9 +26705,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -26526,9 +26735,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -26581,9 +26790,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -26612,9 +26821,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -26637,7 +26846,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/SystemSettingServiceUpdateSystemSettingBody" + "$ref": "#/definitions/engineUpdateSystemSettingRequest" } } ], @@ -26649,9 +26858,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -26678,9 +26887,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -26703,7 +26912,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/SystemSettingServicePatchSystemSettingBody" + "$ref": "#/definitions/enginePatchSystemSettingRequest" } } ], @@ -26715,9 +26924,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -29545,9 +29754,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -29576,9 +29785,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -29608,9 +29817,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -29634,7 +29843,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TriggerServiceUpdateTriggerBody" + "$ref": "#/definitions/engineUpdateTriggerRequest" } } ], @@ -29646,9 +29855,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -29676,9 +29885,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -29701,7 +29910,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TriggerServicePatchTriggerBody" + "$ref": "#/definitions/enginePatchTriggerRequest" } } ], @@ -29713,9 +29922,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -29826,9 +30035,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -29851,7 +30060,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TriggerServiceCreateTriggerJobBody" + "$ref": "#/definitions/engineCreateTriggerJobRequest" } } ], @@ -29863,9 +30072,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -29927,9 +30136,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -30017,9 +30226,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } } @@ -32881,8021 +33090,9264 @@ } } }, - "AgentPauseCauseServicePatchAgentPauseCauseBody": { + "AggregateRequestGroup": { "type": "object", "properties": { - "allow_admin": { - "type": "boolean" + "aggregate": { + "type": "string" }, - "allow_agent": { - "type": "boolean" + "desc": { + "type": "boolean", + "format": "boolean" }, - "allow_supervisor": { - "type": "boolean" + "field": { + "type": "string" }, - "description": { + "id": { "type": "string" }, - "fields": { - "type": "array", - "items": { - "type": "string" - } + "interval": { + "type": "string" }, - "limit_min": { + "top": { "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" + "format": "int32" } } }, - "AgentPauseCauseServiceUpdateAgentPauseCauseBody": { + "CloseReasonsCreateCloseReasonBody": { "type": "object", + "title": "CreateCloseReasonRequest message for creating a new close reason", + "required": [ + "name", + "lookup_id" + ], "properties": { - "allow_admin": { - "type": "boolean" - }, - "allow_agent": { - "type": "boolean" - }, - "allow_supervisor": { - "type": "boolean" - }, "description": { "type": "string" }, - "limit_min": { - "type": "integer", - "format": "int64" - }, "name": { "type": "string" } } }, - "AgentServiceAgentSetStateBody": { - "type": "object" + "CreateAgentsAbsencesBulkRequestabsentType": { + "type": "object", + "properties": { + "absent_at_from": { + "type": "string", + "format": "int64" + }, + "absent_at_to": { + "type": "string", + "format": "int64" + }, + "type_id": { + "$ref": "#/definitions/wfmAgentAbsenceType" + } + } }, - "AgentServicePatchAgentBody": { + "CreateCallRequestCallSettings": { "type": "object", "properties": { - "allow_channels": { - "type": "array", - "items": { - "type": "string" - } + "audio": { + "type": "boolean", + "format": "boolean" }, - "auditor": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } + "cancel_distribute": { + "type": "boolean", + "format": "boolean" }, - "chat_count": { - "type": "integer", - "format": "int64" + "disable_auto_answer": { + "type": "boolean", + "format": "boolean" }, - "description": { + "disable_stun": { + "type": "boolean", + "format": "boolean" + }, + "display": { "type": "string" }, - "fields": { - "type": "array", - "items": { - "type": "string" - } + "hide_number": { + "type": "boolean", + "format": "boolean" }, - "greeting_media": { - "$ref": "#/definitions/engineLookup" + "is_online": { + "type": "boolean", + "format": "boolean" }, - "is_supervisor": { - "type": "boolean" + "record": { + "type": "boolean", + "format": "boolean" }, - "progressive_count": { + "screen": { + "type": "boolean", + "format": "boolean" + }, + "timeout": { "type": "integer", "format": "int32" }, - "region": { - "$ref": "#/definitions/engineLookup" - }, - "supervisor": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" } }, - "team": { - "$ref": "#/definitions/engineLookup" - }, - "user": { - "$ref": "#/definitions/engineLookup" + "video": { + "type": "boolean", + "format": "boolean" } } }, - "AgentServiceUpdateAgentBody": { + "DefaultDeviceConfigResponseSipDeviceConfig": { "type": "object", "properties": { - "allow_channels": { - "type": "array", - "items": { - "type": "string" - } - }, - "auditor": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } - }, - "chat_count": { - "type": "integer", - "format": "int64" + "auth": { + "type": "string" }, - "description": { + "domain": { "type": "string" }, - "domain_id": { - "type": "string", - "format": "int64" + "extension": { + "type": "string" }, - "greeting_media": { - "$ref": "#/definitions/engineLookup" + "password": { + "type": "string" }, - "is_supervisor": { - "type": "boolean" + "proxy": { + "type": "string" + } + } + }, + "DefaultDeviceConfigResponseWebRTCDeviceConfig": { + "type": "object", + "properties": { + "authorization_user": { + "type": "string" }, - "progressive_count": { - "type": "integer", - "format": "int32" + "display_name": { + "type": "string" }, - "region": { - "$ref": "#/definitions/engineLookup" + "extension": { + "type": "string" }, - "supervisor": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } + "ha1": { + "type": "string" }, - "task_count": { - "type": "integer", - "format": "int64" + "realm": { + "type": "string" }, - "team": { - "$ref": "#/definitions/engineLookup" + "server": { + "type": "string" }, - "user": { - "$ref": "#/definitions/engineLookup" + "uri": { + "type": "string" } } }, - "AgentServiceUpdateAgentStatusBody": { + "EmailProfileParamsOAuth2": { "type": "object", "properties": { - "channels": { - "type": "array", - "items": { - "type": "string" - } - }, - "domain_id": { - "type": "string", - "format": "int64" - }, - "on_demand": { - "type": "boolean" + "client_id": { + "type": "string" }, - "payload": { + "client_secret": { "type": "string" }, - "status": { - "type": "string", - "title": "FIXME enumerate" + "redirect_url": { + "type": "string" } } }, - "AgentSkillServiceCreateAgentSkillBody": { + "HistoryCallBlindTransfer": { "type": "object", "properties": { - "capacity": { - "type": "integer", - "format": "int32" + "number": { + "type": "string" }, - "domain_id": { + "time": { "type": "string", "format": "int64" }, - "enabled": { - "type": "boolean" - }, - "skill": { + "user": { "$ref": "#/definitions/engineLookup" } } }, - "AgentSkillServiceCreateAgentSkillsBody": { + "HistoryFileJobHistoryFileJobAction": { + "type": "string", + "default": "undefined", + "enum": [ + "undefined", + "STT", + "delete" + ] + }, + "HistoryFileJobHistoryFileJobState": { + "type": "string", + "default": "idle", + "enum": [ + "idle", + "active", + "finished", + "error" + ] + }, + "ListSkillAgentListSkillAgg": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineCreateAgentSkillBulkItem" - } + "enabled": { + "type": "boolean", + "format": "boolean" } } }, - "AgentSkillServicePatchAgentSkillBody": { + "QuestionOption": { "type": "object", "properties": { - "capacity": { - "type": "integer", - "format": "int32" - }, - "domain_id": { - "type": "string", - "format": "int64" - }, - "enabled": { - "type": "boolean" - }, - "fields": { - "type": "array", - "items": { - "type": "string" - } + "name": { + "type": "string" }, - "skill": { - "$ref": "#/definitions/engineLookup" + "score": { + "type": "number", + "format": "float" } } }, - "AgentSkillServicePatchAgentSkillsBody": { + "SLAConditionsCreateSLAConditionBody": { "type": "object", + "title": "CreateSLAConditionRequest message for creating a new SLACondition", + "required": [ + "name", + "priorities", + "reaction_time", + "resolution_time" + ], "properties": { - "capacity": { - "type": "integer", - "format": "int32" - }, - "enabled": { - "type": "boolean" + "name": { + "type": "string" }, - "fields": { + "priorities": { "type": "array", + "title": "List of priority IDs for creation [FROM Priority Dictionary]", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/generalLookup" } }, - "id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "reaction_time": { + "type": "string", + "format": "int64" }, - "skill_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "resolution_time": { + "type": "string", + "format": "int64" } } }, - "AgentSkillServiceUpdateAgentSkillBody": { + "SafeUploadFileResponsePart": { "type": "object", "properties": { - "capacity": { - "type": "integer", - "format": "int32" - }, - "domain_id": { + "size": { "type": "string", "format": "int64" }, - "enabled": { - "type": "boolean" - }, - "skill": { - "$ref": "#/definitions/engineLookup" + "upload_id": { + "type": "string" } } }, - "AgentTeamServiceUpdateAgentTeamBody": { + "SafeUploadFileResponseProgress": { "type": "object", "properties": { - "admin": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } - }, - "call_timeout": { - "type": "integer", - "format": "int32" - }, - "description": { - "type": "string" - }, - "domain_id": { + "uploaded": { "type": "string", "format": "int64" - }, - "forecast_calculation": { - "$ref": "#/definitions/engineLookup" - }, - "invite_chat_timeout": { - "type": "integer", - "format": "int32" - }, - "max_no_answer": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string" - }, - "no_answer_delay_time": { - "type": "integer", - "format": "int32" - }, - "strategy": { - "type": "string" - }, - "task_accept_timeout": { - "type": "integer", - "format": "int32" - }, - "wrap_up_time": { - "type": "integer", - "format": "int32" } } }, - "AggregateRequestGroup": { + "StartFileTranscriptResponseTranscriptJob": { "type": "object", "properties": { - "aggregate": { + "action": { "type": "string" }, - "desc": { - "type": "boolean" + "created_at": { + "type": "string", + "format": "int64" }, - "field": { - "type": "string" + "file_id": { + "type": "string", + "format": "int64" }, "id": { - "type": "string" + "type": "string", + "format": "int64" }, - "interval": { + "state": { "type": "string" - }, - "top": { - "type": "integer", - "format": "int32" } } }, - "AuditFormServicePatchAuditFormBody": { + "StatusConditionsCreateStatusConditionBody": { "type": "object", + "title": "CreateStatusConditionRequest message for creating a new status", + "required": [ + "name", + "lookup_id" + ], "properties": { "description": { "type": "string" }, - "enabled": { - "type": "boolean" - }, - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, "name": { "type": "string" - }, - "questions": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineQuestion" - } - }, - "teams": { - "type": "array", - "title": "bool archive = 8;", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } } } }, - "AuditFormServiceUpdateAuditFormBody": { + "UserStatusUserPresence": { "type": "object", "properties": { - "description": { - "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "name": { + "status": { "type": "string" - }, - "questions": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineQuestion" - } - }, - "teams": { - "type": "array", - "title": "bool archive = 7;", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } } } }, - "BucketServiceUpdateBucketBody": { + "api.AccessRule": { "type": "object", "properties": { - "description": { - "type": "string" - }, - "domain_id": { + "granted": { "type": "string", - "format": "int64" + "title": "[WHAT]: full: [xrwdxrwd]; privileges: [----xrwd]; grantable: [xrwd----]" }, - "name": { - "type": "string" + "grantee": { + "title": "[WHOM]: required; NEED to be rechecked !!!", + "$ref": "#/definitions/api.RoleId" + }, + "grantor": { + "description": "[WHO]: operational; current user NEED to be rechecked !!!", + "title": "ObjectId object = 1;", + "$ref": "#/definitions/api.RoleId" } } }, - "CalendarServiceUpdateCalendarBody": { + "api.AccessStore.ToggleDefaultAccessBody": { "type": "object", "properties": { - "accepts": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAcceptOfDay" - } - }, - "description": { - "type": "string" - }, - "domain_id": { - "type": "string", - "format": "int64" - }, - "end_at": { - "type": "string", - "format": "int64" - }, - "excepts": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineExceptDate" - } - }, - "name": { - "type": "string" - }, - "specials": { + "list": { + "description": "list of changes ...\n\n[TO] (GRANT/REVOKE)", "type": "array", "items": { "type": "object", - "$ref": "#/definitions/engineAcceptOfDay" + "$ref": "#/definitions/api.GrantAccessRequestV1" } }, - "start_at": { - "type": "string", - "format": "int64" - }, - "timezone": { - "$ref": "#/definitions/engineLookup" + "object": { + "type": "object", + "title": "[ON] objclass (either: by entity .id -or- class .name)" } } }, - "CallServiceBlindTransferCallBody": { + "api.AccessToken": { "type": "object", + "title": "OAuth 2.0 Access Token Response compatible", "properties": { - "app_id": { - "type": "string" - }, - "destination": { + "access_token": { + "description": "REQUIRED. The access token issued by the authorization server.", "type": "string" }, - "domain_id": { - "type": "string", - "format": "int64" - } - } - }, - "CallServiceCreateCallAnnotationBody": { - "type": "object", - "properties": { - "end_sec": { + "expires_in": { + "description": "RECOMMENDED. The lifetime in seconds of the access token.", "type": "integer", "format": "int32" }, - "note": { + "refresh_token": { + "description": "OPTIONAL. The refresh token, which can be used to obtain\nnew access tokens using the same authorization grant.", "type": "string" }, - "start_sec": { - "type": "integer", - "format": "int32" + "state": { + "description": "OPTIONAL, if identical to the scope requested by the client;\notherwise, REQUIRED. The scope of the access token.\nrepeated string scope = 5 [ json_name = \"scope\" ];\nREQUIRED if the \"state\" parameter was present in the client\nauthorization request. The exact value received from the client.", + "type": "string" + }, + "token_type": { + "description": "REQUIRED. The type of the token issued. Value is case insensitive.", + "type": "string" } } }, - "CallServiceDtmfCallBody": { + "api.Claim": { "type": "object", "properties": { - "app_id": { + "type": { "type": "string" }, - "digit": { + "value": { "type": "string" - }, - "domain_id": { - "type": "string", - "format": "int64" } } }, - "CallServiceEavesdropCallBody": { + "api.Classes.UpdateClassBody": { "type": "object", "properties": { - "app_id": { - "type": "string" - }, - "control": { - "type": "boolean" - }, - "from": { - "$ref": "#/definitions/engineEavesdropCallRequestEndpointRequest" - }, - "listen_a": { - "type": "boolean" - }, - "listen_b": { - "type": "boolean" + "class": { + "type": "object", + "properties": { + "abac": { + "type": "boolean", + "title": "[a]ttribute-[b]ased [a]ccess [c]ontrol" + }, + "class": { + "type": "string", + "title": "(class::object).name" + }, + "obac": { + "type": "boolean", + "title": "[o]peration-[b]ased [a]ccess [c]ontrol (from::collection.dal)" + }, + "rbac": { + "type": "boolean", + "title": "[r]ecord-[b]ased [a]ccess [c]ontrol (from::resource.acl)" + } + } }, - "whisper_a": { - "type": "boolean" + "domain": { + "type": "string", + "title": "TO BE REMOVED // bound to session.domain.id" }, - "whisper_b": { - "type": "boolean" + "fields": { + "type": "array", + "title": "PATCH: partial update", + "items": { + "type": "string" + } } } }, - "CallServiceHangupCallBody": { + "api.CreateDeviceResponse": { "type": "object", "properties": { - "app_id": { - "type": "string" - }, - "cause": { - "type": "string" - }, - "domain_id": { - "type": "string", - "format": "int64" + "device": { + "$ref": "#/definitions/api.Device" } } }, - "CallServiceHoldCallBody": { + "api.CreateDomainRequest": { "type": "object", + "title": "POST /domains", "properties": { - "app_id": { + "organization": { + "$ref": "#/definitions/api.Organization" + }, + "password": { "type": "string" }, - "domain_id": { - "type": "string", - "format": "int64" + "superuser": { + "type": "string" } } }, - "CallServicePatchHistoryCallBody": { + "api.CreateDomainResponse": { + "type": "object" + }, + "api.CreateRoleRequest": { "type": "object", "properties": { - "hide_missed": { - "type": "boolean" + "copy_id": { + "type": "string", + "format": "int64", + "title": "----- Query parameters -----\nOptional. Source role unique identifier\nto copy access (+default) control list from" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "role": { + "title": "entity to be created", + "$ref": "#/definitions/api.Role" } } }, - "CallServiceRedialCallBody": { - "type": "object" - }, - "CallServiceSetVariablesCallBody": { + "api.CreateRoleResponse": { "type": "object", "properties": { - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "created": { + "title": "entity to be created", + "$ref": "#/definitions/api.Role" } } }, - "CallServiceUnHoldCallBody": { + "api.CreateUserRequest": { "type": "object", "properties": { - "app_id": { - "type": "string" + "confirm_password": { + "type": "string", + "title": "cleartext passphrase" }, - "domain_id": { + "user": { + "title": "user entity to be created", + "$ref": "#/definitions/api.User" + }, + "user_password": { "type": "string", - "format": "int64" + "title": "cleartext passphrase" } } }, - "CallServiceUpdateCallAnnotationBody": { + "api.CreateUserResponse": { "type": "object", "properties": { - "end_sec": { - "type": "integer", - "format": "int32" - }, - "note": { - "type": "string" - }, - "start_sec": { - "type": "integer", - "format": "int32" + "user": { + "$ref": "#/definitions/api.User" } } }, - "ChatHelperServiceBroadcastBody": { + "api.Customer": { "type": "object", "properties": { - "buttons": { + "created_at": { + "description": "local created ms", + "type": "string", + "format": "int64", + "title": "string version = 2; // version\nlocal store details" + }, + "dnsrv": { "type": "array", + "title": "[optional] domains", "items": { "type": "object", - "$ref": "#/definitions/engineBroadcastButtons" + "$ref": "#/definitions/api.ObjectId" } }, - "file": { - "description": "Message Media. Attachment.", - "$ref": "#/definitions/engineBroadcastFile" + "id": { + "type": "string", + "title": "serial number assigned (global::Customer-ID)" }, - "peer": { + "issued_at": { + "description": "[required] issuer(CA) created at", + "type": "string", + "format": "int64", + "title": "validity boundaries" + }, + "license": { + "description": "grants issued", "type": "array", + "title": "int32 competitive = 13; // zero-based competitive sessions limit ?", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/api.LicenseV1" } }, - "text": { - "type": "string" + "limit": { + "description": "defines map[class]limit usage", + "type": "object", + "title": "extensions granted", + "additionalProperties": { + "type": "integer", + "format": "int32" + } + }, + "next_update": { + "type": "string", + "format": "int64", + "title": "[optional]: signature expires; update required after" + }, + "not_after": { + "type": "string", + "format": "int64", + "title": "[required] valid till" + }, + "not_before": { + "type": "string", + "format": "int64", + "title": "[optional] valid from" + }, + "organization": { + "type": "string", + "title": "registration name" + }, + "revoked_at": { + "type": "string", + "format": "int64", + "title": "local revoked ms" + }, + "this_update": { + "description": "[optional]: issuer(CA) signed at", + "type": "string", + "format": "int64", + "title": "signature validity" + }, + "updated_at": { + "type": "string", + "format": "int64", + "title": "last uploaded ms" + }, + "verify": { + "description": "[optional] validation results", + "title": "Verification status", + "$ref": "#/definitions/api.Verification" } } }, - "CloseReasonsCreateCloseReasonBody": { + "api.DeleteDeviceResponse": { "type": "object", - "title": "CreateCloseReasonRequest message for creating a new close reason", - "required": [ - "name", - "lookup_id" - ], "properties": { - "description": { - "type": "string" - }, - "name": { - "type": "string" + "deleted": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/api.Device" + } } } }, - "CommunicationTypeServicePatchCommunicationTypeBody": { + "api.DeleteDomainResponse": { + "type": "object" + }, + "api.DeleteLDAPRequest": { "type": "object", "properties": { - "channel": { - "$ref": "#/definitions/engineCommunicationChannels" - }, - "code": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": "string" + "id": { + "type": "string", + "format": "int64", + "title": "catalog id" }, - "fields": { + "related_objects": { + "type": "boolean", + "title": "WITH objects bound to ?" + } + } + }, + "api.DeleteOAuthServiceRequest": { + "type": "object", + "properties": { + "id": { "type": "array", "items": { - "type": "string" + "type": "string", + "format": "int64" } }, - "name": { - "type": "string" + "permanent": { + "type": "boolean" } } }, - "CommunicationTypeServiceUpdateCommunicationTypeBody": { + "api.DeleteOAuthServiceResponse": { + "type": "object" + }, + "api.DeleteRoleResponse": { "type": "object", "properties": { - "channel": { - "$ref": "#/definitions/engineCommunicationChannels" - }, - "code": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": "string" - }, - "name": { - "type": "string" + "deleted": { + "$ref": "#/definitions/api.Role" } } }, - "CreateAgentsAbsencesBulkRequestabsentType": { + "api.DeleteUsersResponse": { "type": "object", "properties": { - "absent_at_from": { - "type": "string", - "format": "int64" - }, - "absent_at_to": { - "type": "string", - "format": "int64" - }, - "type_id": { - "$ref": "#/definitions/wfmAgentAbsenceType" + "deleted": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/api.User" + } } } }, - "CreateCallRequestCallSettings": { + "api.Device": { "type": "object", + "title": "Device profile", "properties": { - "audio": { - "type": "boolean" + "account": { + "description": "username", + "type": "string", + "title": "credentials" }, - "cancel_distribute": { - "type": "boolean" + "brand": { + "description": "vendor brand name", + "type": "string", + "title": "provision" }, - "disable_auto_answer": { - "type": "boolean" + "created_at": { + "type": "string", + "format": "int64", + "title": "unix" }, - "disable_stun": { - "type": "boolean" + "created_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" }, - "display": { + "deleted_at": { + "type": "string", + "format": "int64", + "title": "unix" + }, + "deleted_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" + }, + "hotdesk": { + "description": "act as a hotdesk", + "type": "boolean", + "title": "Hotdesk: this workstation aliases" + }, + "hotdesks": { + "type": "array", + "title": "associated aliases", + "items": { + "type": "string" + } + }, + "id": { + "type": "string", + "format": "int64", + "title": "object id" + }, + "ip": { "type": "string" }, - "hide_number": { - "type": "boolean" + "logged_in": { + "type": "string", + "format": "int64", + "title": "caller profile\n webitel.adt.caller caller = 4;" }, - "is_online": { - "type": "boolean" + "mac": { + "type": "string", + "title": "static" }, - "record": { - "type": "boolean" + "model": { + "type": "string" }, - "screen": { - "type": "boolean" + "name": { + "description": "display name", + "type": "string", + "title": "kind of\nDeviceType type = 19;" }, - "timeout": { - "type": "integer", - "format": "int32" + "password": { + "type": "string", + "title": "password" }, - "variables": { + "provision": { "type": "object", + "title": "provision extra data", "additionalProperties": { "type": "string" } }, - "video": { - "type": "boolean" + "reged": { + "type": "boolean", + "title": "TODO: something like PresenceStatus instead of Registration\n repeated Registration contacts = 16;" + }, + "updated_at": { + "type": "string", + "format": "int64", + "title": "unix" + }, + "updated_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" + }, + "user": { + "title": "[optional] The user that 'owns' the device;", + "$ref": "#/definitions/api.UserId" } } }, - "DefaultDeviceConfigResponseSipDeviceConfig": { + "api.DeviceAudit": { "type": "object", + "title": "Device login audit", "properties": { - "auth": { - "type": "string" + "device": { + "title": "/users/:id/audit related", + "$ref": "#/definitions/api.DeviceId" }, - "domain": { + "hotdesk": { "type": "string" }, - "extension": { - "type": "string" + "logged_in": { + "type": "string", + "format": "int64" }, - "password": { - "type": "string" - }, - "proxy": { - "type": "string" - } - } - }, - "DefaultDeviceConfigResponseWebRTCDeviceConfig": { - "type": "object", - "properties": { - "authorization_user": { - "type": "string" - }, - "display_name": { - "type": "string" - }, - "extension": { - "type": "string" - }, - "ha1": { - "type": "string" - }, - "realm": { - "type": "string" - }, - "server": { - "type": "string" - }, - "uri": { - "type": "string" - } - } - }, - "EmailProfileParamsOAuth2": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "client_secret": { - "type": "string" + "logged_out": { + "type": "string", + "format": "int64" }, - "redirect_url": { - "type": "string" + "user": { + "title": "/devices/:id/audit related", + "$ref": "#/definitions/api.UserId" } } }, - "EmailProfileServicePatchEmailProfileBody": { + "api.DeviceAuditResponse": { "type": "object", "properties": { - "description": { - "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "fetch_interval": { - "type": "integer", - "format": "int32" - }, - "fields": { + "items": { "type": "array", + "title": "audit_logs", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/api.DeviceAudit" } }, - "imap_host": { - "type": "string" + "next": { + "type": "boolean", + "title": "search: has {next} page ?" }, - "imap_port": { + "page": { "type": "integer", - "format": "int32" - }, - "listen": { - "type": "boolean" - }, - "login": { - "type": "string" - }, - "mailbox": { - "type": "string" - }, - "name": { - "type": "string" - }, - "password": { - "type": "string" - }, - "schema": { - "$ref": "#/definitions/engineLookup" - }, - "smtp_host": { - "type": "string" + "format": "int32", + "title": "select: offset {page}" }, - "smtp_port": { + "size": { "type": "integer", - "format": "int32" + "format": "int32", + "title": "search: limit {size}" } } }, - "EmailProfileServiceUpdateEmailProfileBody": { + "api.DeviceId": { "type": "object", + "title": "DeviceId lookup value", "properties": { - "auth_type": { - "$ref": "#/definitions/engineEmailAuthType" - }, - "description": { - "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "fetch_interval": { - "type": "integer", - "format": "int32" - }, - "imap_host": { - "type": "string" - }, - "imap_port": { - "type": "integer", - "format": "int32" - }, - "listen": { - "type": "boolean" - }, - "login": { - "type": "string" - }, - "mailbox": { - "type": "string" + "id": { + "type": "string", + "format": "int64", + "title": "Object ID" }, "name": { - "type": "string" - }, - "params": { - "$ref": "#/definitions/engineEmailProfileParams" - }, - "password": { - "type": "string" - }, - "schema": { - "$ref": "#/definitions/engineLookup" - }, - "smtp_host": { - "type": "string" - }, - "smtp_port": { - "type": "integer", - "format": "int32" + "type": "string", + "title": "Display Name" } } }, - "HistoryCallBlindTransfer": { + "api.Domains.UpdateDomainBody": { "type": "object", + "title": "PUT /domain/{domain.dc}", "properties": { - "number": { - "type": "string" - }, - "time": { - "type": "string", - "format": "int64" - }, - "user": { - "$ref": "#/definitions/engineLookup" + "domain": { + "type": "object", + "properties": { + "country": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "int64", + "title": "unix" + }, + "createdBy": { + "type": "string", + "title": "user" + }, + "domain": { + "type": "string", + "title": "FQDN" + }, + "email": { + "type": "string" + }, + "locality": { + "type": "string" + }, + "organization": { + "type": "string" + }, + "postalAddress": { + "type": "string" + }, + "postalCode": { + "type": "string" + }, + "stateOrProvince": { + "type": "string" + }, + "streetAddress": { + "type": "string" + }, + "telephoneNumber": { + "type": "string" + }, + "updatedAt": { + "type": "string", + "format": "int64", + "title": "unix" + }, + "updatedBy": { + "type": "string", + "title": "user" + } + } } } }, - "HistoryFileJobHistoryFileJobAction": { - "type": "string", - "default": "undefined", - "enum": [ - "undefined", - "STT", - "delete" - ] - }, - "HistoryFileJobHistoryFileJobState": { - "type": "string", - "title": "- error: TODO", - "default": "idle", - "enum": [ - "idle", - "active", - "finished", - "error" - ] - }, - "ListServiceCreateListCommunicationBody": { + "api.GenerateTfaKeysForNecessaryUsersResponse": { "type": "object", "properties": { - "description": { - "type": "string" - }, - "expire_at": { + "affected": { "type": "string", "format": "int64" - }, - "number": { - "type": "string" } } }, - "ListServiceUpdateListBody": { + "api.GenerateUserTfaKeyResponse": { "type": "object", "properties": { - "description": { - "type": "string" - }, - "domain_id": { - "type": "string", - "format": "int64" - }, - "name": { - "type": "string" + "totp": { + "$ref": "#/definitions/api.TfaUrl" } } }, - "ListServiceUpdateListCommunicationBody": { + "api.GetCustomerResponse": { "type": "object", "properties": { - "description": { - "type": "string" - }, - "expire_at": { - "type": "string", - "format": "int64" - }, - "number": { - "type": "string" + "customer": { + "$ref": "#/definitions/api.Customer" } } }, - "ListSkillAgentListSkillAgg": { + "api.GetUserTfaKeyResponse": { "type": "object", "properties": { - "enabled": { - "type": "boolean" + "totp": { + "$ref": "#/definitions/api.TfaUrl" } } }, - "MemberServiceAttemptCallbackBody": { + "api.GrantAccessRequestV1": { "type": "object", "properties": { - "agent_id": { - "type": "integer", - "format": "int32" - }, - "description": { - "type": "string" - }, - "display": { - "type": "boolean" - }, - "exclude_current_communication": { - "type": "boolean" - }, - "expire_at": { + "grantee": { "type": "string", - "format": "int64" + "format": "int64", + "title": "grantee.role.id" }, - "min_offering_at": { + "grants": { "type": "string", - "format": "int64" - }, - "status": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "title": "repeated string privileges = 5; // [\"SEARCH\",\"MODIFY\",\"DELETE\",\"CREATE\"]\nbool grantable = 6; // WITH GRANT OPTION" }, - "wait_between_retries": { - "type": "integer", - "format": "int32" + "object": { + "title": "string class = 2;\nint64 object = 3; // class.object.id", + "$ref": "#/definitions/api.ObjectId" } } }, - "MemberServiceAttemptResultBody": { + "api.GrantRoleResponse": { + "type": "object" + }, + "api.LDAP.CreateLDAPTemplateBody": { "type": "object", + "title": "LDAPTemplate is an LDAP search entries to webitel objects transformation template", "properties": { - "agent_id": { - "type": "integer", - "format": "int32" - }, - "description": { - "type": "string" + "agent": { + "type": "object", + "title": "OPTIONAL. Agent objclass fields mapping" }, - "display": { - "type": "boolean" + "base_dn": { + "type": "string", + "title": "Optional. LDAP Search base entry DN" }, - "exclude_current_communication": { - "type": "boolean" + "catalog": { + "type": "object", + "title": "LDAPCatalog belongs to", + "properties": { + "name": { + "type": "string", + "title": "display name" + } + } }, - "expire_at": { + "created_at": { + "description": "unix", "type": "string", - "format": "int64" + "format": "int64", + "title": "READONLY. Operational attributes" }, - "min_offering_at": { - "type": "string", - "format": "int64" + "created_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" }, - "next_member_id": { - "type": "string", - "format": "int64" + "device": { + "type": "object", + "title": "OPTIONAL. Device objclass fields mapping" }, - "status": { - "type": "string" + "enabled": { + "type": "boolean", + "title": "Optional. This Template is activated ?" }, - "transfer_queue_id": { + "id": { "type": "string", - "format": "int64" + "format": "int64", + "title": "ID unique" }, - "variables": { + "name": { + "type": "string", + "title": "Name this template" + }, + "role": { "type": "object", - "additionalProperties": { - "type": "string" - } + "title": "OPTIONAL. Role objclass fields mapping (Not implemented yet)" }, - "wait_between_retries": { - "type": "integer", - "format": "int32" - } - } - }, - "MemberServiceAttemptsRenewalResultBody": { - "type": "object", - "properties": { - "renewal": { - "type": "integer", - "format": "int64" - } - } - }, - "MemberServiceCreateAttemptBody": { - "type": "object", - "properties": { - "agent_id": { + "search": { "type": "string", - "format": "int64" + "title": "Required. LDAP Search filter string" }, - "domain_id": { + "updated_at": { "type": "string", - "format": "int64" + "format": "int64", + "title": "unix" + }, + "updated_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" + }, + "user": { + "type": "object", + "title": "OPTIONAL. User objclass fields mapping" } } }, - "MemberServiceCreateMemberBody": { + "api.LDAP.DeleteLDAPTemplateBody": { "type": "object", "properties": { - "agent": { - "$ref": "#/definitions/engineLookup" + "base_dn": { + "type": "string" }, - "bucket": { - "$ref": "#/definitions/engineLookup" + "disabled": { + "type": "boolean" }, - "communications": { + "enabled": { + "type": "boolean" + }, + "fields": { "type": "array", + "title": "attributes list", "items": { - "type": "object", - "$ref": "#/definitions/engineMemberCommunicationCreateRequest" + "type": "string" } }, - "domain_id": { - "type": "string", - "format": "int64" - }, - "expire_at": { - "type": "string", - "format": "int64" - }, - "min_offering_at": { - "type": "string", - "format": "int64" + "id": { + "type": "array", + "title": "----- Search Basic Filters ---------------------------\nOPTIONAL. Search templates by .id", + "items": { + "type": "string", + "format": "int64" + } }, "name": { "type": "string" }, - "priority": { - "type": "integer", - "format": "int32" + "objclass": { + "type": "string" }, - "skill": { - "$ref": "#/definitions/engineLookup" + "page": { + "description": "default: 1", + "type": "integer", + "format": "int32", + "title": "----- Select Options -------------------------" }, - "timezone": { - "$ref": "#/definitions/engineLookup" + "q": { + "type": "string", + "title": "OPTIONAL. Filter(s) SET" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "MemberServiceCreateMemberBulkBody": { - "type": "object", - "properties": { - "file_name": { - "type": "string" + "size": { + "type": "integer", + "format": "int32", + "title": "default: 16" }, - "items": { + "sort": { "type": "array", + "title": "e.g.: \"updated_at\" - ASC; \"!updated_at\" - DESC;", "items": { - "type": "object", - "$ref": "#/definitions/engineCreateMemberBulkItem" + "type": "string" } } } }, - "MemberServiceDeleteMembersBody": { + "api.LDAP.LDAPSearchBody": { "type": "object", + "title": "https://datatracker.ietf.org/doc/html/rfc4511#section-4.5.1", "properties": { - "agent_id": { + "attributes": { "type": "array", + "title": "AttributeSelection", "items": { - "type": "integer", - "format": "int32" + "type": "string" } }, - "attempts": { - "$ref": "#/definitions/engineFilterBetween" + "baseObject": { + "type": "string", + "title": "----- SearchRequest -----\nbaseObject [D]istinguished[N]ame" }, - "bucket_id": { + "bind": { + "description": "authorization method e.g.: SIMPLE, SAML, NTLM, etc.", + "type": "string", + "title": "----- BIND: Authorization -----" + }, + "controls": { "type": "array", + "title": "----- LDAPMessage -----\nControls NOT implemented yet !", "items": { - "type": "integer", - "format": "int32" + "type": "object", + "$ref": "#/definitions/api.LDAPControl" + } + }, + "derefAliases": { + "type": "integer", + "format": "int32", + "title": "neverDerefAliases (0),\nderefInSearching (1),\nderefFindingBaseObj (2),\nderefAlways (3)" + }, + "filter": { + "type": "string", + "title": "Filter," + }, + "password": { + "type": "string", + "title": "password" + }, + "scope": { + "type": "integer", + "format": "int32", + "title": "baseObject (0),\nsingleLevel (1),\nwholeSubtree (2)" + }, + "sizeLimit": { + "type": "string", + "format": "int64", + "title": "INTEGER (0 .. maxInt)," + }, + "timeLimit": { + "type": "string", + "format": "int64", + "title": "INTEGER (0 .. maxInt)," + }, + "tls": { + "$ref": "#/definitions/api.LDAPSearchRequest.TLSConfig" + }, + "typesOnly": { + "type": "boolean", + "title": "BOOLEAN," + }, + "url": { + "description": "URL e.g.: [(ldap|ldapi|ldaps)://]host[:port]", + "type": "string", + "title": "Optional. URL to establish connection to LDAP catalog" + }, + "username": { + "type": "string", + "title": "bind_dn" + } + } + }, + "api.LDAP.ResyncLDAPCatalogBody": { + "type": "object", + "properties": { + "options": { + "title": "Options", + "$ref": "#/definitions/api.LDAProcessOptions" + } + } + }, + "api.LDAP.UpdateLDAPCatalogBody": { + "type": "object", + "properties": { + "catalog": { + "description": "LDAP Catalog changes.", + "type": "object", + "title": "LDAP Catalog changes.", + "properties": { + "base_dn": { + "type": "string", + "title": "base_dn, aka domain e.g.: 'dc=example,dc=org'" + }, + "bind": { + "description": "authorization method e.g.: SIMPLE, SAML, NTLM, etc.", + "type": "string", + "title": "----- BIND: Authorization -----" + }, + "created_at": { + "description": "unix", + "type": "string", + "format": "int64", + "title": "basic: last operation details" + }, + "created_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" + }, + "cron": { + "description": "[CRON]OS SPEC ! github.com/robfig/cron/v3", + "type": "string", + "title": "----- RSYNC Processing -----\nint32 priority = 4;" + }, + "entry_modify": { + "type": "string", + "title": "last modification timestamp attribute type" + }, + "entry_uuid": { + "description": "entry unique id (except DN which may be updated)", + "type": "string", + "title": "----- DOMAIN: Entry model -----" + }, + "name": { + "type": "string", + "title": "Meaningfull title name" + }, + "password": { + "type": "string", + "title": "password" + }, + "process": { + "title": "Last OR Current SYNC process details", + "$ref": "#/definitions/api.LDAProcess" + }, + "sync": { + "$ref": "#/definitions/api.LDAProcessOptions" + }, + "templates": { + "type": "array", + "title": "// // ----- MAP: user(s) settings -----\nLDAPUsersMap users = 26; // DEPRECATED: Use Template(s) instead\nSYNC Object's search and mappings", + "items": { + "type": "object", + "$ref": "#/definitions/api.LDAPTemplate" + } + }, + "tls": { + "$ref": "#/definitions/api.LDAPCatalog.TLSConfig" + }, + "updated_at": { + "type": "string", + "format": "int64", + "title": "unix" + }, + "updated_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" + }, + "url": { + "description": "URL e.g.: [(ldap|ldapi|ldaps)://]host[:port]", + "type": "string", + "title": "----- Connection Options -----" + }, + "username": { + "type": "string", + "title": "bind_dn" + } + } + }, + "fields": { + "type": "array", + "title": "Fields for partial update. PATCH", + "items": { + "type": "string" + } + } + } + }, + "api.LDAP.UpdateLDAPTemplateBody": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "title": "OPTIONAL. Fields for partial update. PATCH", + "items": { + "type": "string" + } + }, + "template": { + "description": "Template changes.", + "type": "object", + "title": "Template changes.", + "properties": { + "agent": { + "type": "object", + "title": "OPTIONAL. Agent objclass fields mapping" + }, + "base_dn": { + "type": "string", + "title": "Optional. LDAP Search base entry DN" + }, + "catalog": { + "type": "object", + "title": "LDAPCatalog belongs to", + "properties": { + "name": { + "type": "string", + "title": "display name" + } + } + }, + "created_at": { + "description": "unix", + "type": "string", + "format": "int64", + "title": "READONLY. Operational attributes" + }, + "created_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" + }, + "device": { + "type": "object", + "title": "OPTIONAL. Device objclass fields mapping" + }, + "enabled": { + "type": "boolean", + "title": "Optional. This Template is activated ?" + }, + "name": { + "type": "string", + "title": "Name this template" + }, + "role": { + "type": "object", + "title": "OPTIONAL. Role objclass fields mapping (Not implemented yet)" + }, + "search": { + "type": "string", + "title": "Required. LDAP Search filter string" + }, + "updated_at": { + "type": "string", + "format": "int64", + "title": "unix" + }, + "updated_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" + }, + "user": { + "type": "object", + "title": "OPTIONAL. User objclass fields mapping" + } + } + } + } + }, + "api.LDAPCatalog": { + "type": "object", + "title": "LDAPCatalog profile", + "properties": { + "base_dn": { + "type": "string", + "title": "base_dn, aka domain e.g.: 'dc=example,dc=org'" + }, + "bind": { + "description": "authorization method e.g.: SIMPLE, SAML, NTLM, etc.", + "type": "string", + "title": "----- BIND: Authorization -----" + }, + "created_at": { + "description": "unix", + "type": "string", + "format": "int64", + "title": "basic: last operation details" + }, + "created_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" + }, + "cron": { + "description": "[CRON]OS SPEC ! github.com/robfig/cron/v3", + "type": "string", + "title": "----- RSYNC Processing -----\nint32 priority = 4;" + }, + "entry_modify": { + "type": "string", + "title": "last modification timestamp attribute type" + }, + "entry_uuid": { + "description": "entry unique id (except DN which may be updated)", + "type": "string", + "title": "----- DOMAIN: Entry model -----" + }, + "id": { + "type": "string", + "format": "int64", + "title": "identity\nint64 dc = 1;" + }, + "name": { + "type": "string", + "title": "Meaningfull title name" + }, + "password": { + "type": "string", + "title": "password" + }, + "process": { + "title": "Last OR Current SYNC process details", + "$ref": "#/definitions/api.LDAProcess" + }, + "sync": { + "$ref": "#/definitions/api.LDAProcessOptions" + }, + "templates": { + "type": "array", + "title": "// // ----- MAP: user(s) settings -----\nLDAPUsersMap users = 26; // DEPRECATED: Use Template(s) instead\nSYNC Object's search and mappings", + "items": { + "type": "object", + "$ref": "#/definitions/api.LDAPTemplate" + } + }, + "tls": { + "$ref": "#/definitions/api.LDAPCatalog.TLSConfig" + }, + "updated_at": { + "type": "string", + "format": "int64", + "title": "unix" + }, + "updated_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" + }, + "url": { + "description": "URL e.g.: [(ldap|ldapi|ldaps)://]host[:port]", + "type": "string", + "title": "----- Connection Options -----" + }, + "username": { + "type": "string", + "title": "bind_dn" + } + } + }, + "api.LDAPCatalog.TLSConfig": { + "type": "object", + "title": "TLS configuration options", + "properties": { + "ca": { + "type": "string", + "format": "byte", + "title": "PEM: base64" + }, + "cert": { + "description": "PEM: base64", + "type": "string", + "format": "byte", + "title": "TODO: (!)" + }, + "key": { + "type": "string", + "format": "byte", + "title": "PEM: base64" + } + } + }, + "api.LDAPControl": { + "type": "object", + "title": "https://datatracker.ietf.org/doc/html/rfc4511#section-4.1.11", + "properties": { + "controlType": { + "type": "string", + "title": "LDAPOID," + }, + "controlValue": { + "type": "string", + "title": "OCTET STRING OPTIONAL" + }, + "criticality": { + "type": "boolean", + "title": "BOOLEAN DEFAULT FALSE," + } + } + }, + "api.LDAPObjentry": { + "type": "object", + "title": "LDAP entry object associatetions performed", + "properties": { + "class": { + "type": "string", + "title": "Internal object class been associated with this LDAP .entry" + }, + "entry": { + "description": "map\u003cstring, string\u003e entry = 1;", + "type": "object", + "title": "LDAP Entry Attributes fetched" + }, + "errs": { + "type": "array", + "title": "FATAL Error(s). NON empty indicates that this process failed", + "items": { + "type": "string" + } + }, + "object": { + "type": "object", + "title": "Internal object state; DUMP" + }, + "proc": { + "type": "string", + "title": "Operation been performed: create|update|delete" + }, + "warn": { + "type": "array", + "title": "An error(s) if any occured\nNON-FATAL Warnings", + "items": { + "type": "string" + } + } + } + }, + "api.LDAPSearchRequest": { + "type": "object", + "title": "https://datatracker.ietf.org/doc/html/rfc4511#section-4.5.1", + "properties": { + "attributes": { + "type": "array", + "title": "AttributeSelection", + "items": { + "type": "string" + } + }, + "baseObject": { + "type": "string", + "title": "----- SearchRequest -----\nbaseObject [D]istinguished[N]ame" + }, + "bind": { + "description": "authorization method e.g.: SIMPLE, SAML, NTLM, etc.", + "type": "string", + "title": "----- BIND: Authorization -----" + }, + "catalog_id": { + "type": "string", + "format": "int64", + "title": "----- connection -----\nOptional. ID of the preconfigured LDAP catalog" + }, + "controls": { + "type": "array", + "title": "----- LDAPMessage -----\nControls NOT implemented yet !", + "items": { + "type": "object", + "$ref": "#/definitions/api.LDAPControl" + } + }, + "derefAliases": { + "type": "integer", + "format": "int32", + "title": "neverDerefAliases (0),\nderefInSearching (1),\nderefFindingBaseObj (2),\nderefAlways (3)" + }, + "filter": { + "type": "string", + "title": "Filter," + }, + "password": { + "type": "string", + "title": "password" + }, + "scope": { + "type": "integer", + "format": "int32", + "title": "baseObject (0),\nsingleLevel (1),\nwholeSubtree (2)" + }, + "sizeLimit": { + "type": "string", + "format": "int64", + "title": "INTEGER (0 .. maxInt)," + }, + "timeLimit": { + "type": "string", + "format": "int64", + "title": "INTEGER (0 .. maxInt)," + }, + "tls": { + "$ref": "#/definitions/api.LDAPSearchRequest.TLSConfig" + }, + "typesOnly": { + "type": "boolean", + "title": "BOOLEAN," + }, + "url": { + "description": "URL e.g.: [(ldap|ldapi|ldaps)://]host[:port]", + "type": "string", + "title": "Optional. URL to establish connection to LDAP catalog" + }, + "username": { + "type": "string", + "title": "bind_dn" + } + } + }, + "api.LDAPSearchRequest.TLSConfig": { + "type": "object", + "title": "TLS configuration options", + "properties": { + "PEM": { + "description": "base64", + "type": "string", + "format": "byte", + "title": "TODO: (!)" + } + } + }, + "api.LDAPSearchResponse": { + "type": "object", + "title": "https://datatracker.ietf.org/doc/html/rfc4511#section-4.5.2", + "properties": { + "controls": { + "type": "array", + "title": "----- LDAPMessage -----", + "items": { + "type": "object", + "$ref": "#/definitions/api.LDAPControl" + } + }, + "diagnosticMessage": { + "type": "string", + "title": "LDAPString," + }, + "entries": { + "type": "array", + "title": "----- SearchResult (Entry|Reference) -----", + "items": { + "type": "object" + } + }, + "matchedDN": { + "type": "string", + "title": "LDAPDN," + }, + "referral": { + "type": "array", + "title": "[3] Referral OPTIONAL", + "items": { + "type": "string" + } + }, + "resultCode": { + "type": "integer", + "format": "int32", + "title": "----- LDAPResult -----" + } + } + }, + "api.LDAPTemplate": { + "type": "object", + "title": "LDAPTemplate is an LDAP search entries to webitel objects transformation template", + "properties": { + "agent": { + "type": "object", + "title": "OPTIONAL. Agent objclass fields mapping" + }, + "base_dn": { + "type": "string", + "title": "Optional. LDAP Search base entry DN" + }, + "catalog": { + "title": "LDAPCatalog belongs to", + "$ref": "#/definitions/api.ObjectId" + }, + "created_at": { + "description": "unix", + "type": "string", + "format": "int64", + "title": "READONLY. Operational attributes" + }, + "created_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" + }, + "device": { + "type": "object", + "title": "OPTIONAL. Device objclass fields mapping" + }, + "enabled": { + "type": "boolean", + "title": "Optional. This Template is activated ?" + }, + "id": { + "type": "string", + "format": "int64", + "title": "ID unique" + }, + "name": { + "type": "string", + "title": "Name this template" + }, + "role": { + "type": "object", + "title": "OPTIONAL. Role objclass fields mapping (Not implemented yet)" + }, + "search": { + "type": "string", + "title": "Required. LDAP Search filter string" + }, + "updated_at": { + "type": "string", + "format": "int64", + "title": "unix" + }, + "updated_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" + }, + "user": { + "type": "object", + "title": "OPTIONAL. User objclass fields mapping" + } + } + }, + "api.LDAPTemplateResponse": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/api.LDAPTemplate" } }, - "created_at": { - "$ref": "#/definitions/engineFilterBetween" + "next": { + "type": "boolean", + "title": "result: has {next} page ?" }, - "destination": { - "type": "string" + "page": { + "type": "integer", + "format": "int32", + "title": "result: {page} number" + } + } + }, + "api.LDAProcess": { + "type": "object", + "title": "LDAP synchronization process details", + "properties": { + "complete_at": { + "description": "Optional. If not \u003czero\u003e indicates that this process is completed.", + "type": "string", + "format": "int64" + }, + "execute_at": { + "type": "string", + "format": "int64", + "title": "Readonly. Process start timestamp" + }, + "execute_by": { + "title": "Optional. Start manually by the user or role", + "$ref": "#/definitions/api.RoleId" }, "id": { + "type": "string", + "format": "int64", + "title": "Readonly. Process unique identifier" + }, + "options": { + "title": "Readonly. Executed with options", + "$ref": "#/definitions/api.LDAProcessOptions" + }, + "progress": { "type": "array", + "title": "Optional. List of entries been already processed", "items": { - "type": "string", - "format": "int64" + "type": "object", + "$ref": "#/definitions/api.LDAPObjentry" } }, - "ids": { + "status": { + "type": "string", + "title": "Optional. Status description or an error if any occured" + } + } + }, + "api.LDAProcessOptions": { + "type": "object", + "properties": { + "link_existing_objects": { + "type": "boolean", + "title": "Allows to create links\nwith fetched LDAP entries\nfor manually created objects" + }, + "reassign_device_users": { + "type": "boolean", + "title": "Allows to reassign device's owner user\ndue to preconfigured mapping LDAP template" + }, + "test": { + "type": "boolean", + "title": "Will NOT perform any operations on storage.\nTo review potential processing only" + }, + "timeout": { + "type": "string", + "format": "int64", + "title": "Operation timeout. Not implemented yet" + } + } + }, + "api.LDAProcessResponse": { + "type": "object", + "properties": { + "items": { "type": "array", - "title": "deprecated", "items": { - "type": "string", - "format": "int64" + "type": "object", + "$ref": "#/definitions/api.LDAProcess" } }, - "name": { - "type": "string" + "next": { + "type": "boolean", + "title": "result: has {next} page ?" }, - "numbers": { + "page": { + "type": "integer", + "format": "int32", + "title": "result: {page} number" + } + } + }, + "api.LicenseUsageResponse": { + "type": "object", + "properties": { + "items": { + "type": "array", + "title": "size = (.next ? len(items) : undef (\u003e len(size)))\n----- Result entries ----- //", + "items": { + "type": "object", + "$ref": "#/definitions/api.LicenseV1" + } + }, + "next": { + "type": "boolean", + "title": "next page exists ? more results ?" + }, + "page": { + "description": "this page number !", + "type": "integer", + "format": "int32", + "title": "----- Result paging ----- //" + } + } + }, + "api.LicenseUser": { + "type": "object", + "title": "USAGE details", + "properties": { + "expires_at": { + "type": "string", + "format": "int64", + "title": "not after" + }, + "id": { + "type": "string", + "title": "license.id" + }, + "issued_at": { + "type": "string", + "format": "int64", + "title": "not before" + }, + "prod": { + "type": "string", + "title": "license.prod" + }, + "scope": { "type": "array", + "title": "setof objclass grants", "items": { "type": "string" } }, - "offering_at": { - "$ref": "#/definitions/engineFilterBetween" + "user": { + "title": "grant to::user", + "$ref": "#/definitions/api.ObjectId" + } + } + }, + "api.LicenseUsersResponse": { + "type": "object", + "properties": { + "items": { + "type": "array", + "title": "size = (.next ? len(items) : undef (\u003e len(size)))\n----- Result entries ----- //", + "items": { + "type": "object", + "$ref": "#/definitions/api.ProductUser" + } }, - "priority": { - "$ref": "#/definitions/engineFilterBetween" + "next": { + "type": "boolean", + "title": "next page exists ? more results ?" }, - "q": { - "type": "string" + "page": { + "description": "this page number !", + "type": "integer", + "format": "int32", + "title": "----- Result paging ----- //" + } + } + }, + "api.LicenseV1": { + "type": "object", + "properties": { + "competitive": { + "type": "boolean" }, - "size": { + "id": { + "type": "string", + "title": "serial number assigned (global::License-ID)" + }, + "limit": { "type": "integer", - "format": "int32" + "format": "int32", + "title": "required: limit count (maximum allowed usage quantity)" }, - "sort": { - "type": "string" + "not_after": { + "type": "string", + "format": "int64", + "title": "optional" }, - "stop_cause": { + "not_before": { + "type": "string", + "format": "int64", + "title": "optional" + }, + "product": { + "type": "string", + "title": "product name, e.g.: DEVICE, MANAGER, OPERATOR" + }, + "remain": { + "description": "available", + "type": "integer", + "format": "int32", + "title": "operational attributes ...\nremain = limit - len(users)" + }, + "scope": { + "description": "list of known classes, \u0026this product grants mandatory access to, e.g.: 'users', 'roles', 'cc_agent', 'calendars', ...", "type": "array", "items": { "type": "string" } }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" + "status": { + "$ref": "#/definitions/api.Verification" + }, + "users": { + "type": "array", + "title": "users.id (grantees)", + "items": { + "type": "object", + "$ref": "#/definitions/api.LicenseUser" + } + } + } + }, + "api.ListAccessResponseV1": { + "type": "object", + "properties": { + "items": { + "type": "array", + "title": "endregion", + "items": { + "type": "object", + "$ref": "#/definitions/api.AccessRule" } }, - "without_members": { - "type": "boolean" + "next": { + "type": "boolean", + "title": "indicate partial response: ( next || page \u003e 1 ? partial : full )" + }, + "page": { + "type": "integer", + "format": "int32", + "title": "region: paged result control response value" } } }, - "MemberServicePatchMemberBody": { + "api.ListRegistrationsResponse": { "type": "object", "properties": { - "agent": { - "$ref": "#/definitions/engineLookup" + "items": { + "type": "array", + "title": "registered", + "items": { + "type": "object", + "$ref": "#/definitions/api.Registration" + } }, - "attempts": { + "next": { + "type": "boolean", + "title": "search: has {next} page ?" + }, + "page": { "type": "integer", - "format": "int32" + "format": "int32", + "title": "select: offset {page}" }, - "bucket": { - "$ref": "#/definitions/engineLookup" + "size": { + "type": "integer", + "format": "int32", + "title": "search: limit {size}" + } + } + }, + "api.LoginResponse": { + "type": "object", + "properties": { + "authorization": { + "$ref": "#/definitions/api.AccessToken" + } + } + }, + "api.LogoutUserResponse": { + "type": "object" + }, + "api.OAuth2Federation.DeleteOAuthServiceBody": { + "type": "object", + "properties": { + "permanent": { + "type": "boolean" + } + } + }, + "api.OAuth2Federation.UpdateOAuthServiceBody": { + "type": "object", + "properties": { + "changes": { + "description": "Configuration changes.", + "type": "object", + "title": "Configuration changes.", + "properties": { + "auth_url": { + "type": "string", + "title": "OAuth 2.0 Authorization Endpoint" + }, + "claims": { + "description": "google.protobuf.Struct claims = 7;", + "type": "array", + "title": "Identity claims policy rules\nNOTE: Order matters", + "items": { + "type": "object", + "$ref": "#/definitions/api.Claim" + } + }, + "client_id": { + "type": "string" + }, + "client_secret": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "int64", + "title": "unix" + }, + "created_by": { + "title": "user", + "$ref": "#/definitions/api.ObjectId" + }, + "discovery_url": { + "type": "string", + "title": "OpenID Connect Service Discovery" + }, + "domain": { + "$ref": "#/definitions/api.ObjectId" + }, + "enabled": { + "type": "boolean" + }, + "logo": { + "type": "string" + }, + "metadata": { + "type": "object" + }, + "name": { + "type": "string", + "title": "display" + }, + "scopes": { + "type": "array", + "title": "Scopes to be requested", + "items": { + "type": "string" + } + }, + "token_url": { + "type": "string", + "title": "OAuth 2.0 Token Endpoint" + }, + "type": { + "type": "string", + "title": "well-known vendor; provider" + }, + "updated_at": { + "type": "string", + "format": "int64", + "title": "unix" + }, + "updated_by": { + "title": "user", + "$ref": "#/definitions/api.ObjectId" + }, + "userinfo_url": { + "type": "string", + "title": "OpenID Connect Userinfo Endpoint" + } + } }, - "communications": { + "fields": { + "type": "array", + "title": "Fields for partial update. PATCH", + "items": { + "type": "string" + } + } + } + }, + "api.OAuthService": { + "type": "object", + "title": "OAuth 2.0 Authentication [S]ervice [P]rovider Application Configuration", + "properties": { + "auth_url": { + "type": "string", + "title": "OAuth 2.0 Authorization Endpoint" + }, + "claims": { + "description": "google.protobuf.Struct claims = 7;", "type": "array", + "title": "Identity claims policy rules\nNOTE: Order matters", "items": { "type": "object", - "$ref": "#/definitions/engineMemberCommunicationCreateRequest" + "$ref": "#/definitions/api.Claim" } }, - "domain_id": { + "client_id": { + "type": "string" + }, + "client_secret": { + "type": "string" + }, + "created_at": { "type": "string", - "format": "int64" + "format": "int64", + "title": "unix" }, - "expire_at": { + "created_by": { + "title": "user", + "$ref": "#/definitions/api.ObjectId" + }, + "discovery_url": { + "type": "string", + "title": "OpenID Connect Service Discovery" + }, + "domain": { + "$ref": "#/definitions/api.ObjectId" + }, + "enabled": { + "type": "boolean" + }, + "id": { "type": "string", "format": "int64" }, - "fields": { + "logo": { + "type": "string" + }, + "metadata": { + "type": "object" + }, + "name": { + "type": "string", + "title": "display" + }, + "scopes": { "type": "array", + "title": "Scopes to be requested", "items": { "type": "string" } }, - "min_offering_at": { + "token_url": { + "type": "string", + "title": "OAuth 2.0 Token Endpoint" + }, + "type": { + "type": "string", + "title": "well-known vendor; provider" + }, + "updated_at": { + "type": "string", + "format": "int64", + "title": "unix" + }, + "updated_by": { + "title": "user", + "$ref": "#/definitions/api.ObjectId" + }, + "userinfo_url": { + "type": "string", + "title": "OpenID Connect Userinfo Endpoint" + } + } + }, + "api.Objclass": { + "type": "object", + "title": "AccessScope represents authorized access level\nto object class declaration within domain namespace", + "properties": { + "abac": { + "description": "[A]ttribute-[b]ased; not implemented; next releases ...", + "type": "boolean", + "title": "Is [?]-[b]ased [A]ccess [C]ontrol *model enabled ?" + }, + "access": { + "description": "flags: [ CREATE | SELECT | UPDATE | DELETE ]", + "type": "string", + "title": "Extension: discretionary access control" + }, + "class": { + "type": "string", + "title": "class: alphanumeric code name" + }, + "id": { + "description": "class: object id", + "type": "string", + "format": "int64", + "title": "Inherit::ObjectClass" + }, + "name": { + "type": "string", + "title": "class: display common name" + }, + "obac": { + "type": "boolean", + "title": "[O]peration-[b]ased; Mandatory: control access to object.class (alias: collection, section, etc.)" + }, + "rbac": { + "type": "boolean", + "title": "[R]ecord-[b]ased; Discretionary: control access to object.entry (alias: resource, record, etc.)" + } + } + }, + "api.ObjectClass": { + "type": "object", + "properties": { + "abac": { + "type": "boolean", + "title": "[a]ttribute-[b]ased [a]ccess [c]ontrol" + }, + "class": { "type": "string", - "format": "int64" - }, - "name": { - "type": "string" - }, - "priority": { - "type": "integer", - "format": "int32" - }, - "skill": { - "$ref": "#/definitions/engineLookup" + "title": "(class::object).name" }, - "stop_cause": { - "type": "string" + "id": { + "type": "string", + "format": "int64", + "title": "(class::object).id" }, - "timezone": { - "$ref": "#/definitions/engineLookup" + "obac": { + "type": "boolean", + "title": "[o]peration-[b]ased [a]ccess [c]ontrol (from::collection.dal)" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "rbac": { + "type": "boolean", + "title": "[r]ecord-[b]ased [a]ccess [c]ontrol (from::resource.acl)" } } }, - "MemberServicePatchMemberOneBody": { + "api.ObjectId": { "type": "object", "properties": { - "agent": { - "$ref": "#/definitions/engineLookup" + "id": { + "type": "string", + "format": "int64", + "title": "identifier" }, - "attempts": { - "type": "integer", - "format": "int32" + "name": { + "type": "string", + "title": "display name" + } + } + }, + "api.Organization": { + "type": "object", + "properties": { + "country": { + "type": "string" }, - "bucket": { - "$ref": "#/definitions/engineLookup" + "createdAt": { + "type": "string", + "format": "int64", + "title": "unix" }, - "communications": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineMemberCommunicationCreateRequest" - } + "createdBy": { + "type": "string", + "title": "user" }, - "domain_id": { + "dc": { "type": "string", - "format": "int64" + "format": "int64", + "title": "component" }, - "expire_at": { + "domain": { "type": "string", - "format": "int64" + "title": "FQDN" }, - "fields": { - "type": "array", - "items": { - "type": "string" - } + "email": { + "type": "string" }, - "min_offering_at": { - "type": "string", - "format": "int64" + "locality": { + "type": "string" }, - "name": { + "organization": { "type": "string" }, - "priority": { - "type": "integer", - "format": "int32" + "postalAddress": { + "type": "string" }, - "skill": { - "$ref": "#/definitions/engineLookup" + "postalCode": { + "type": "string" }, - "stop_cause": { + "stateOrProvince": { "type": "string" }, - "timezone": { - "$ref": "#/definitions/engineLookup" + "streetAddress": { + "type": "string" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "telephoneNumber": { + "type": "string" + }, + "updatedAt": { + "type": "string", + "format": "int64", + "title": "unix" + }, + "updatedBy": { + "type": "string", + "title": "user" } } }, - "MemberServiceResetMembersBody": { + "api.Permission": { "type": "object", "properties": { - "agent_id": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } - }, - "bucket_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - }, "id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - }, - "ids": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "description": "[required] e.g.: 'read', 'playback_record_file', ...", + "type": "string" }, - "numbers": { - "type": "array", - "items": { - "type": "string" - } + "name": { + "type": "string", + "title": "[optional] e.g.: 'Select Any'" }, - "stop_cause": { + "usage": { + "type": "string", + "title": "[optional] e.g.: 'Grants permission to select any objects'" + } + } + }, + "api.Presence.SetStatusBody": { + "type": "object", + "properties": { + "fields": { "type": "array", + "title": "PATCH: partial attributes", "items": { "type": "string" } }, - "variables": { + "publish": { + "description": "BODY: partial modifications", "type": "object", - "additionalProperties": { - "type": "string" + "title": "int64 id = 1; // user.id", + "properties": { + "expires": { + "type": "integer", + "format": "int32", + "title": "[optional] \u003cnote\u003e will be cleaned up after seconds" + }, + "note": { + "type": "string", + "title": "[optional] human readable comment" + }, + "status": { + "type": "string", + "title": "[optional] set of unique 'active' presentities {dnd,dlg,sip,wss}; assume {offline} if omitted" + }, + "timestamp": { + "type": "string", + "format": "int64", + "title": "[required] last activity time" + } } } } }, - "MemberServiceUpdateMemberBody": { + "api.PresenceStatus": { "type": "object", + "title": "PresenceStatus PUBLISH", "properties": { - "agent": { - "$ref": "#/definitions/engineLookup" + "app": { + "type": "string", + "title": "[optional] service node identity" }, - "bucket": { - "$ref": "#/definitions/engineLookup" + "closed": { + "type": "boolean", + "title": "[optional] signify \u003cstatus\u003e tuple gone from user's presence; equls to (open == 0)" }, - "communications": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineMemberCommunicationCreateRequest" - } + "contact": { + "type": "string", + "title": "[optional] communication \u003curl\u003e" }, "domain_id": { "type": "string", - "format": "int64" + "format": "int64", + "title": "[hidden] for cluster purpose" }, - "expire_at": { + "expires": { "type": "string", - "format": "int64" + "format": "int64", + "title": "NOTE: \u003cdnd\u003e actualy has no expires until user manualy switch it off" }, - "min_offering_at": { + "id": { + "description": "[required] tuple unique id; \u003ctrack\u003e", "type": "string", - "format": "int64" + "title": "basic:latest" }, - "name": { - "type": "string" + "note": { + "type": "string", + "title": "[optional] human readable comment" }, - "priority": { + "open": { "type": "integer", - "format": "int32" - }, - "skill": { - "$ref": "#/definitions/engineLookup" - }, - "stop_cause": { - "type": "string" - }, - "timezone": { - "$ref": "#/definitions/engineLookup" + "format": "int32", + "title": "[optional] positive value signify 'active'" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" + "presence": { + "description": "// FIXME: well-known types ?\r\n repeated Dialog call = 9;\r\n repeated Sipreg sip = 9;\r\n repeated Websock wss = 9;", + "type": "array", + "title": "detailed: -registered -tracking tuples", + "items": { + "type": "object", + "$ref": "#/definitions/api.PresenceStatus" } - } - } - }, - "OutboundResourceGroupServiceCreateOutboundResourceInGroupBody": { - "type": "object", - "properties": { + }, "priority": { "type": "integer", - "format": "int64" + "format": "int32", + "title": "[optional] importance level of this within presentity's" }, - "reserve_resource": { - "$ref": "#/definitions/engineLookup" + "sequence": { + "type": "string", + "format": "int64", + "title": "[optional] this tuple (document) modifications version" }, - "resource": { - "$ref": "#/definitions/engineLookup" + "status": { + "type": "string", + "title": "[optional] unique set of \u003cenum:dnd|call|sip|wss\u003e; assume \u003coffline\u003e if blank; \u003cscope\u003e on request" + }, + "timestamp": { + "type": "string", + "format": "int64", + "title": "[required] opened time" } } }, - "OutboundResourceGroupServiceUpdateOutboundResourceGroupBody": { + "api.ProductUser": { "type": "object", + "title": "ProductUser GRANT details", "properties": { - "communication": { - "$ref": "#/definitions/engineLookup" - }, - "description": { - "type": "string" + "domain": { + "title": "grant to::domain", + "$ref": "#/definitions/api.ObjectId" }, - "domain_id": { + "expires_at": { "type": "string", - "format": "int64" + "format": "int64", + "title": "not after" }, - "name": { - "type": "string" + "issued_at": { + "type": "string", + "format": "int64", + "title": "not before" }, - "strategy": { - "type": "string" + "sessions": { + "type": "integer", + "format": "int32", + "title": "User's active sessions count !" }, - "time": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineOutboundResourceTimeRange" - } + "user": { + "title": "grant to::user", + "$ref": "#/definitions/api.ObjectId" } } }, - "OutboundResourceGroupServiceUpdateOutboundResourceInGroupBody": { + "api.ReadClassResponse": { "type": "object", "properties": { - "priority": { - "type": "integer", - "format": "int64" - }, - "reserve_resource": { - "$ref": "#/definitions/engineLookup" - }, - "resource": { - "$ref": "#/definitions/engineLookup" + "class": { + "$ref": "#/definitions/api.ObjectClass" } } }, - "OutboundResourceServiceCreateOutboundResourceDisplayBody": { + "api.ReadDeviceResponse": { "type": "object", "properties": { - "display": { - "type": "string" - }, - "domain_id": { - "type": "string", - "format": "int64" + "device": { + "$ref": "#/definitions/api.Device" } } }, - "OutboundResourceServiceCreateOutboundResourceDisplayBulkBody": { + "api.ReadDomainResponse": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineCreateOutboundResourceDisplayRequest" - } + "domain": { + "$ref": "#/definitions/api.Organization" } } }, - "OutboundResourceServicePatchOutboundResourceBody": { + "api.ReadRoleResponse": { "type": "object", "properties": { - "description": { + "role": { + "$ref": "#/definitions/api.Role" + } + } + }, + "api.ReadUserResponse": { + "type": "object", + "properties": { + "user": { + "$ref": "#/definitions/api.User" + } + } + }, + "api.Registration": { + "type": "object", + "title": "REGISTER SIP status", + "properties": { + "callid": { "type": "string" }, - "enabled": { - "type": "boolean" + "contact": { + "type": "string", + "title": "binding_uri" }, - "error_ids": { - "type": "array", - "items": { - "type": "string" - } + "device": { + "$ref": "#/definitions/api.DeviceId" }, - "failure_dial_delay": { - "type": "integer", + "expires_at": { + "type": "string", "format": "int64" }, - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "gateway": { - "$ref": "#/definitions/engineLookup" - }, - "limit": { - "type": "integer", - "format": "int32" - }, - "max_successively_errors": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string" + "id": { + "type": "string", + "format": "int64" }, - "number": { - "type": "string" + "instance": { + "type": "string", + "title": "?sip.instance= register contact option" }, - "parameters": { - "$ref": "#/definitions/engineOutboundResourceParameters" + "received": { + "type": "string", + "title": "registrant: remote side (proxy)" }, - "patterns": { - "type": "array", - "items": { - "type": "string" - } + "register_at": { + "type": "string", + "format": "int64" }, - "reserve": { - "type": "boolean" + "socket": { + "type": "string", + "title": "registrar: local side (host) e.g.:" }, - "rps": { - "type": "integer", - "format": "int32" + "user": { + "$ref": "#/definitions/api.UserId" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "user_agent": { + "type": "string" } } }, - "OutboundResourceServiceUpdateOutboundResourceBody": { + "api.RevokeRoleResponse": { + "type": "object" + }, + "api.Role": { "type": "object", + "title": "Role represents group of users", "properties": { - "description": { - "type": "string" - }, - "enabled": { - "type": "boolean" + "created_at": { + "type": "string", + "format": "int64", + "title": "unix" }, - "error_ids": { - "type": "array", - "items": { - "type": "string" - } + "created_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" }, - "failure_dial_delay": { - "type": "integer", - "format": "int64" + "deleted_at": { + "type": "string", + "format": "int64", + "title": "unix" }, - "gateway": { - "$ref": "#/definitions/engineLookup" + "deleted_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" }, - "limit": { - "type": "integer", - "format": "int32" + "description": { + "type": "string", + "title": "short description" }, - "max_successively_errors": { - "type": "integer", - "format": "int32" + "id": { + "type": "string", + "format": "int64", + "title": "oid" }, - "name": { - "type": "string" + "members": { + "description": "users/roles", + "type": "array", + "title": "Caller caller = 4; // TOBE removed !!!\nmap\u003cint64, string\u003e users = 4;", + "items": { + "type": "object", + "$ref": "#/definitions/api.ObjectId" + } }, - "number": { - "type": "string" + "metadata": { + "type": "object", + "title": "Optional. Metadata bound to this role by the third party integrations\nEach attribute of this object represents separate various data\nto be able to store and merge separate keys (documents)" }, - "parameters": { - "$ref": "#/definitions/engineOutboundResourceParameters" + "name": { + "type": "string", + "title": "display common name" }, - "patterns": { + "permissions": { "type": "array", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/api.Permission" } }, - "reserve": { - "type": "boolean" + "updated_at": { + "type": "string", + "format": "int64", + "title": "unix" }, - "rps": { - "type": "integer", - "format": "int32" + "updated_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "user": { + "type": "boolean", + "title": "READONLY. Report whether this Role refers to the internal User(=true) or Group(=false)" } } }, - "OutboundResourceServiceUpdateOutboundResourceDisplayBody": { + "api.Role.Member": { "type": "object", "properties": { - "display": { - "type": "string" + "admin": { + "type": "boolean", + "title": "admin of the group ?" }, - "domain_id": { + "created_at": { "type": "string", - "format": "int64" - } - } - }, - "PresetQueryServicePatchPresetQueryBody": { - "type": "object", - "properties": { - "description": { - "type": "string" + "format": "int64", + "title": "unix" }, - "fields": { - "type": "array", - "items": { - "type": "string" - } + "created_by": { + "type": "string", + "title": "user.[id|name]" + }, + "id": { + "type": "string", + "format": "int64", + "title": "user.id" }, "name": { - "type": "string" + "type": "string", + "title": "user.name" }, - "preset": {}, - "section": { - "$ref": "#/definitions/enginePresetQuerySection" + "updated_at": { + "type": "string", + "format": "int64", + "title": "unix" + }, + "updated_by": { + "type": "string", + "title": "user" } } }, - "PresetQueryServiceUpdatePresetQueryBody": { + "api.RoleId": { + "description": "RoleId lookup value.", "type": "object", "properties": { - "description": { - "type": "string" + "id": { + "type": "string", + "format": "int64", + "title": "Unique Object IDentifier" }, "name": { - "type": "string" + "type": "string", + "title": "Display Name" }, - "preset": {}, - "section": { - "$ref": "#/definitions/enginePresetQuerySection" + "user": { + "type": "boolean", + "title": "Optional. Indicates that this role ID refers\nto the internal user as the system administrative unit" } } }, - "QuestionOption": { + "api.RoleMembersResponse": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "score": { - "type": "number", - "format": "float" + "results": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/api.Role.Member" + } } } }, - "QueueBucketServiceCreateQueueBucketBody": { + "api.RoleMetadataResponse": { "type": "object", "properties": { - "bucket": { - "$ref": "#/definitions/engineLookup" - }, - "disabled": { - "type": "boolean" - }, - "priority": { - "type": "integer", - "format": "int32" + "key": { + "type": "string", + "title": "Optional. Partial metadata document key name" }, - "ratio": { - "type": "integer", - "format": "int32" + "value": { + "title": "Metadata value" } } }, - "QueueBucketServicePatchQueueBucketBody": { + "api.Roles.UpdateRoleBody": { "type": "object", "properties": { - "bucket": { - "$ref": "#/definitions/engineLookup" - }, - "disabled": { - "type": "boolean" - }, "fields": { "type": "array", + "title": "partial changes", "items": { "type": "string" } }, - "priority": { - "type": "integer", - "format": "int32" - }, - "ratio": { - "type": "integer", - "format": "int32" + "role": { + "type": "object", + "title": "modifications", + "properties": { + "created_at": { + "type": "string", + "format": "int64", + "title": "unix" + }, + "created_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" + }, + "deleted_at": { + "type": "string", + "format": "int64", + "title": "unix" + }, + "deleted_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" + }, + "description": { + "type": "string", + "title": "short description" + }, + "members": { + "description": "users/roles", + "type": "array", + "title": "Caller caller = 4; // TOBE removed !!!\nmap\u003cint64, string\u003e users = 4;", + "items": { + "type": "object", + "$ref": "#/definitions/api.ObjectId" + } + }, + "metadata": { + "type": "object", + "title": "Optional. Metadata bound to this role by the third party integrations\nEach attribute of this object represents separate various data\nto be able to store and merge separate keys (documents)" + }, + "name": { + "type": "string", + "title": "display common name" + }, + "permissions": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/api.Permission" + } + }, + "updated_at": { + "type": "string", + "format": "int64", + "title": "unix" + }, + "updated_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" + }, + "user": { + "type": "boolean", + "title": "READONLY. Report whether this Role refers to the internal User(=true) or Group(=false)" + } + } } } }, - "QueueBucketServiceUpdateQueueBucketBody": { + "api.SearchClassesResponse": { "type": "object", "properties": { - "bucket": { - "$ref": "#/definitions/engineLookup" + "items": { + "type": "array", + "title": "list", + "items": { + "type": "object", + "$ref": "#/definitions/api.ObjectClass" + } }, - "disabled": { - "type": "boolean" + "next": { + "type": "boolean", + "title": "search: has {next} page ?" }, - "priority": { + "page": { "type": "integer", - "format": "int32" + "format": "int32", + "title": "select: offset {page}" }, - "ratio": { + "size": { "type": "integer", - "format": "int32" + "format": "int32", + "title": "search: limit {size}" } } }, - "QueueHookServiceCreateQueueHookBody": { + "api.SearchDeviceResponse": { "type": "object", "properties": { - "enabled": { - "type": "boolean" - }, - "event": { - "type": "string" - }, - "properties": { + "items": { "type": "array", + "title": "devices", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/api.Device" } }, - "schema": { - "$ref": "#/definitions/engineLookup" + "next": { + "type": "boolean", + "title": "search: has {next} page ?" + }, + "page": { + "type": "integer", + "format": "int32", + "title": "select: offset {page}" + }, + "size": { + "type": "integer", + "format": "int32", + "title": "search: limit {size}" } } }, - "QueueHookServicePatchQueueHookBody": { + "api.SearchDomainsResponse": { "type": "object", "properties": { - "enabled": { - "type": "boolean" - }, - "event": { - "type": "string" - }, - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "properties": { + "domains": { "type": "array", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/api.Organization" } - }, - "schema": { - "$ref": "#/definitions/engineLookup" } } }, - "QueueHookServiceUpdateQueueHookBody": { + "api.SearchLDAPResponse": { "type": "object", "properties": { - "enabled": { - "type": "boolean" - }, - "event": { - "type": "string" - }, - "properties": { + "items": { "type": "array", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/api.LDAPCatalog" } }, - "schema": { - "$ref": "#/definitions/engineLookup" - } - } - }, - "QueueResourcesServiceCreateQueueResourceGroupBody": { - "type": "object", - "properties": { - "domain_id": { - "type": "string", - "format": "int64" + "next": { + "type": "boolean", + "title": "result: has {next} page ?" }, - "resource_group": { - "$ref": "#/definitions/engineLookup" + "page": { + "type": "integer", + "format": "int32", + "title": "result: {page} number" } } }, - "QueueResourcesServiceUpdateQueueResourceGroupBody": { + "api.SearchOAuthServiceResponse": { "type": "object", "properties": { - "domain_id": { - "type": "string", - "format": "int64" + "items": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/api.OAuthService" + } }, - "resource_group": { - "$ref": "#/definitions/engineLookup" + "next": { + "type": "boolean", + "title": "result: has {next} page ?" + }, + "page": { + "type": "integer", + "format": "int32", + "title": "result: {page} number" } } }, - "QueueServicePatchQueueBody": { + "api.SearchPermissionResponse": { "type": "object", "properties": { - "after_schema": { - "$ref": "#/definitions/engineLookup" - }, - "calendar": { - "$ref": "#/definitions/engineLookup" - }, - "description": { - "type": "string" - }, - "dnc_list": { - "$ref": "#/definitions/engineLookup" - }, - "do_schema": { - "$ref": "#/definitions/engineLookup" - }, - "domain_id": { - "type": "string", - "format": "int64" - }, - "enabled": { - "type": "boolean" - }, - "fields": { + "items": { "type": "array", + "title": "result entries", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/api.Permission" } }, - "form_schema": { - "title": "deprecated", - "$ref": "#/definitions/engineLookup" - }, - "grantee": { - "$ref": "#/definitions/engineLookup" - }, - "name": { - "type": "string" - }, - "payload": {}, - "priority": { - "type": "integer", - "format": "int32" - }, - "processing": { + "next": { "type": "boolean", - "title": "deprecated" - }, - "processing_renewal_sec": { - "type": "integer", - "format": "int64", - "title": "deprecated" + "title": "search: has {next} page ?" }, - "processing_sec": { + "page": { "type": "integer", - "format": "int64", - "title": "deprecated" - }, - "ringtone": { - "$ref": "#/definitions/engineLookup" - }, - "schema": { - "$ref": "#/definitions/engineLookup" + "format": "int32", + "title": "select: offset {page}" }, - "sec_locate_agent": { + "size": { "type": "integer", - "format": "int32" - }, - "sticky_agent": { - "type": "boolean" - }, - "strategy": { - "type": "string" - }, - "tags": { + "format": "int32", + "title": "search: limit {size}" + } + } + }, + "api.SearchRolesResponse": { + "type": "object", + "properties": { + "items": { "type": "array", + "title": "roles", "items": { "type": "object", - "$ref": "#/definitions/engineTag" + "$ref": "#/definitions/api.Role" } }, - "task_processing": { - "$ref": "#/definitions/engineTaskProcessing" - }, - "team": { - "$ref": "#/definitions/engineLookup" + "next": { + "type": "boolean", + "title": "search: has {next} page ?" }, - "timeout": { + "page": { + "description": "select: offset {page}", "type": "integer", - "format": "int32" + "format": "int32", + "title": "pagedResultsControl response value" }, - "type": { + "size": { "type": "integer", - "format": "int32" - }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "format": "int32", + "title": "search: limit {size}" } } }, - "QueueServiceUpdateQueueBody": { + "api.SearchUsersRequest": { "type": "object", "properties": { - "after_schema": { - "$ref": "#/definitions/engineLookup" - }, - "calendar": { - "$ref": "#/definitions/engineLookup" - }, - "description": { - "type": "string" - }, - "dnc_list": { - "$ref": "#/definitions/engineLookup" + "any": { + "description": "filter: include 'deleted' ALSO ! (inactive)", + "type": "boolean", + "title": "----- View Modes -----------------------------\nNOTE: by default, search NOT 'deleted' objects ONLY" }, - "do_schema": { - "$ref": "#/definitions/engineLookup" + "deleted": { + "type": "boolean", + "title": "filter: .deleted_at NOTNULL (view: RECYCLE)" }, - "domain_id": { + "extension": { "type": "string", - "format": "int64" - }, - "enabled": { - "type": "boolean" + "title": "filter: .extension LIKE '{extension}'" }, - "form_schema": { - "title": "deprecated", - "$ref": "#/definitions/engineLookup" + "fields": { + "description": "select: output (fields,...)", + "type": "array", + "title": "// navigation filter\nrepeated int64 roles = 7;\n----- Search Options -------------------------", + "items": { + "type": "string" + } }, - "grantee": { - "$ref": "#/definitions/engineLookup" + "id": { + "description": "filter: .id = any({id}...)", + "type": "array", + "title": "----- Base Filters ---------------------------", + "items": { + "type": "string", + "format": "int64" + } }, "name": { - "type": "string" - }, - "payload": {}, - "priority": { - "type": "integer", - "format": "int32" - }, - "processing": { - "type": "boolean", - "title": "deprecated" - }, - "processing_renewal_sec": { - "type": "integer", - "format": "int64", - "title": "deprecated" - }, - "processing_sec": { - "type": "integer", - "format": "int64", - "title": "deprecated" - }, - "ringtone": { - "$ref": "#/definitions/engineLookup" - }, - "schema": { - "$ref": "#/definitions/engineLookup" - }, - "sec_locate_agent": { - "type": "integer", - "format": "int32" - }, - "sticky_agent": { - "type": "boolean" - }, - "strategy": { - "type": "string" + "type": "string", + "title": "filter: .name ILIKE '{name}'" }, - "tags": { + "not_id": { "type": "array", + "title": "filter: .id \u003c\u003e all({not_ids}...)", "items": { - "type": "object", - "$ref": "#/definitions/engineTag" + "type": "string", + "format": "int64" } }, - "task_processing": { - "$ref": "#/definitions/engineTaskProcessing" + "page": { + "type": "integer", + "format": "int32", + "title": "select: offset {page}" }, - "team": { - "$ref": "#/definitions/engineLookup" + "presence": { + "$ref": "#/definitions/api.SearchUsersRequest.Presence" }, - "timeout": { - "type": "integer", - "format": "int32" + "q": { + "description": "filter: (.name|.username|.extension|.status) ILIKE '{q}'", + "type": "string", + "title": "----- User-specific Filters ------------------" }, - "type": { + "size": { "type": "integer", - "format": "int32" + "format": "int32", + "title": "select: limit {size}" }, - "variables": { - "type": "object", - "additionalProperties": { + "sort": { + "type": "array", + "title": "select: order by (fields,...)", + "items": { "type": "string" } + }, + "status": { + "type": "string", + "title": "filter: .status ILIKE '{status}'" + }, + "username": { + "type": "string", + "title": "filter: .username ILIKE '{username}'" } } }, - "QueueSkillServiceCreateQueueSkillBody": { + "api.SearchUsersRequest.Presence": { "type": "object", + "title": "simplified presence filter params", "properties": { - "buckets": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } - }, - "enabled": { - "type": "boolean" - }, - "lvl": { - "type": "integer", - "format": "int32" - }, - "max_capacity": { - "type": "integer", - "format": "int32" - }, - "min_capacity": { - "type": "integer", - "format": "int32" + "note": { + "type": "string" }, - "skill": { - "$ref": "#/definitions/engineLookup" + "status": { + "type": "string" } } }, - "QueueSkillServicePatchQueueSkillBody": { + "api.SearchUsersResponse": { "type": "object", "properties": { - "buckets": { + "items": { "type": "array", + "title": "users", "items": { "type": "object", - "$ref": "#/definitions/engineLookup" - } - }, - "enabled": { - "type": "boolean" - }, - "fields": { - "type": "array", - "items": { - "type": "string" + "$ref": "#/definitions/api.User" } }, - "lvl": { - "type": "integer", - "format": "int32" + "next": { + "type": "boolean", + "title": "search: has {next} page ?" }, - "max_capacity": { + "page": { "type": "integer", - "format": "int32" + "format": "int32", + "title": "select: offset {page}" }, - "min_capacity": { + "size": { "type": "integer", - "format": "int32" - }, - "skill": { - "$ref": "#/definitions/engineLookup" + "format": "int32", + "title": "search: limit {size}" } } }, - "QueueSkillServiceUpdateQueueSkillBody": { + "api.ServerInfoResponse": { "type": "object", "properties": { - "buckets": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } - }, - "enabled": { - "type": "boolean" - }, - "lvl": { - "type": "integer", - "format": "int32" - }, - "max_capacity": { - "type": "integer", - "format": "int32" - }, - "min_capacity": { - "type": "integer", - "format": "int32" - }, - "skill": { - "$ref": "#/definitions/engineLookup" + "key": { + "type": "string", + "format": "byte", + "title": "int64 time = 1; // current timestamp (ms)" } } }, - "RegionServicePatchRegionBody": { + "api.SetStatusRequest": { "type": "object", "properties": { - "description": { - "type": "string" - }, "fields": { "type": "array", + "title": "PATCH: partial attributes", "items": { "type": "string" } }, - "name": { - "type": "string" - }, - "timezone": { - "$ref": "#/definitions/engineLookup" + "publish": { + "description": "BODY: partial modifications", + "title": "int64 id = 1; // user.id", + "$ref": "#/definitions/api.UserPresence" } } }, - "RegionServiceUpdateRegionBody": { + "api.SystemObjects": { + "type": "string", + "default": "contacts", + "enum": [ + "contacts", + "cc_list", + "cc_bucket", + "calendars", + "devices", + "cc_agent", + "cc_team", + "cc_resource", + "cc_resource_group", + "cc_queue", + "roles", + "users", + "cognitive_profile" + ] + }, + "api.TfaUrl": { "type": "object", "properties": { - "description": { - "type": "string" - }, - "name": { + "url": { "type": "string" }, - "timezone": { - "$ref": "#/definitions/engineLookup" + "user": { + "$ref": "#/definitions/api.UserId" } } }, - "RoutingChatPlanServicePatchChatPlanBody": { + "api.ToggleDefaultAccessResponse": { "type": "object", "properties": { - "description": { - "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "fields": { + "granted": { "type": "array", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/api.AccessRule" } }, - "name": { - "type": "string" - }, - "schema": { - "$ref": "#/definitions/engineLookup" + "revoked": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/api.AccessRule" + } } } }, - "RoutingChatPlanServiceUpdateChatPlanBody": { + "api.UpdateAccessResponseV1": { "type": "object", "properties": { - "description": { - "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "name": { - "type": "string" + "granted": { + "type": "string", + "format": "int64", + "title": "Affected rules count" }, - "schema": { - "$ref": "#/definitions/engineLookup" + "revoked": { + "type": "string", + "format": "int64" } } }, - "RoutingOutboundCallServiceMovePositionRoutingOutboundCallBody": { + "api.UpdateClassResponse": { "type": "object", "properties": { - "domain_id": { - "type": "string", - "format": "int64" + "class": { + "title": "updated", + "$ref": "#/definitions/api.ObjectClass" } } }, - "RoutingOutboundCallServicePatchRoutingOutboundCallBody": { + "api.UpdateCustomerResponse": { "type": "object", "properties": { - "description": { - "type": "string" - }, - "disabled": { - "type": "boolean" - }, - "domain_id": { - "type": "string", - "format": "int64" - }, - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "name": { - "type": "string" - }, - "pattern": { - "type": "string" - }, - "schema": { - "$ref": "#/definitions/engineLookup" + "customer": { + "title": "detailed", + "$ref": "#/definitions/api.Customer" } } }, - "RoutingOutboundCallServiceUpdateRoutingOutboundCallBody": { + "api.UpdateDeviceResponse": { "type": "object", "properties": { - "description": { + "device": { + "$ref": "#/definitions/api.Device" + } + } + }, + "api.UpdateDomainResponse": { + "type": "object", + "properties": { + "domain": { + "$ref": "#/definitions/api.Organization" + } + } + }, + "api.UpdateRoleResponse": { + "type": "object", + "properties": { + "updated": { + "$ref": "#/definitions/api.Role" + } + } + }, + "api.UpdateUserResponse": { + "type": "object", + "properties": { + "updated": { + "$ref": "#/definitions/api.User" + } + } + }, + "api.User": { + "description": "User profile.", + "type": "object", + "properties": { + "chat_name": { + "description": "The \"chat_name\" field is used to store the name displayed externally on the platform.\nFor example, \"chat_name\" is shown when an agent connects to chats with clients.", "type": "string" }, - "disabled": { - "type": "boolean" + "contact": { + "description": "[optional] contact connected to this user", + "title": "repeated Call calls = 13; // order by created_at\nrepeated Registration reged = 13; // order by register_last", + "$ref": "#/definitions/api.ObjectId" }, - "domain_id": { + "created_at": { "type": "string", - "format": "int64" - }, - "name": { - "type": "string" + "format": "int64", + "title": "unix" }, - "pattern": { - "type": "string" + "created_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" }, - "schema": { - "$ref": "#/definitions/engineLookup" - } - } - }, - "RoutingSchemaServicePatchRoutingSchemaBody": { - "type": "object", - "properties": { - "debug": { - "type": "boolean" + "deleted_at": { + "type": "string", + "format": "int64", + "title": "unix" }, - "description": { - "type": "string" + "deleted_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" }, - "editor": { - "type": "boolean" + "device": { + "title": "[optional] default device assigned ? WebRTC register ?", + "$ref": "#/definitions/api.ObjectId" }, - "fields": { + "devices": { + "description": "[editable] list of unique `regular` devices, attached to this user", "type": "array", + "title": "map\u003cint64, string\u003e devices = 13;", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/api.ObjectId" } }, - "name": { + "email": { "type": "string" }, - "note": { - "type": "string" + "extension": { + "type": "string", + "title": "Caller-ID-Number:" }, - "payload": {}, - "schema": {}, - "tags": { + "hotdesks": { "type": "array", + "title": "[readonly] list of unique `hotdesk` devices, assigned to this user", "items": { "type": "object", - "$ref": "#/definitions/engineSchemaTag" + "$ref": "#/definitions/api.ObjectId" } }, - "type": { - "$ref": "#/definitions/engineRoutingSchemaType" - } - } - }, - "RoutingSchemaServiceUpdateRoutingSchemaBody": { - "type": "object", - "properties": { - "debug": { - "type": "boolean" - }, - "description": { - "type": "string" + "id": { + "type": "string", + "format": "int64", + "title": "Object ID" }, - "editor": { - "type": "boolean" + "license": { + "type": "array", + "title": "list of unique licenses, granted to this user", + "items": { + "type": "object", + "$ref": "#/definitions/api.LicenseUser" + } }, "name": { - "type": "string" + "type": "string", + "title": "Caller-ID-Name: Display Name" }, - "note": { + "password": { "type": "string" }, - "payload": {}, - "schema": {}, - "tags": { + "permissions": { "type": "array", + "title": "set of operational permission grants", "items": { "type": "object", - "$ref": "#/definitions/engineSchemaTag" + "$ref": "#/definitions/api.Permission" } }, - "type": { - "$ref": "#/definitions/engineRoutingSchemaType" - } - } - }, - "RoutingVariableServiceUpdateRoutingVariableBody": { - "type": "object", - "properties": { - "domain_id": { - "type": "string", - "format": "int64" - }, - "key": { - "type": "string" + "presence": { + "description": "string presence = 7; // unique set of \u003cuser\u003e presentity \u003cstatus:basic\u003e tuples open[ed]\n string status = 8; // short display status (short description)", + "title": "CallerId caller = 5; // extension\nPresenceStatus presence = 8;", + "$ref": "#/definitions/api.UserPresence" }, - "value": { - "type": "string" - } - } - }, - "SLAConditionsCreateSLAConditionBody": { - "type": "object", - "title": "CreateSLAConditionRequest message for creating a new SLACondition", - "required": [ - "name", - "priorities", - "reaction_time", - "resolution_time" - ], - "properties": { - "name": { - "type": "string" + "profile": { + "type": "object", + "title": "list of variables, assigned to this user as an environment unit", + "additionalProperties": { + "type": "string" + } }, - "priorities": { + "roles": { "type": "array", - "title": "List of priority IDs for creation [FROM Priority Dictionary]", + "title": "roles, member of which is this user", "items": { "type": "object", - "$ref": "#/definitions/generalLookup" + "$ref": "#/definitions/api.ObjectId" } }, - "reaction_time": { + "totp_url": { "type": "string", - "format": "int64" + "title": "[readonly][optional] one time password if setting (2fa) is enabled" }, - "resolution_time": { + "updated_at": { "type": "string", - "format": "int64" + "format": "int64", + "title": "unix" + }, + "updated_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" + }, + "username": { + "type": "string", + "title": "alphanumeric username (login)" } } }, - "SafeUploadFileResponsePart": { + "api.UserAccessToken": { + "description": "UserId lookup value.", "type": "object", "properties": { - "size": { + "created_at": { "type": "string", - "format": "int64" + "format": "int64", + "title": "unix::ms" }, - "upload_id": { - "type": "string" - } - } - }, - "SafeUploadFileResponseProgress": { - "type": "object", - "properties": { - "uploaded": { + "created_by": { + "$ref": "#/definitions/api.ObjectId" + }, + "deleted_at": { "type": "string", - "format": "int64" - } - } - }, - "SchemaVariablesServicePatchSchemaVariableBody": { - "type": "object", - "properties": { - "encrypt": { - "type": "boolean" + "format": "int64", + "title": "[optional] disabled at" }, - "fields": { - "type": "array", - "items": { - "type": "string" - } + "deleted_by": { + "title": "[optional] disabled by", + "$ref": "#/definitions/api.ObjectId" }, - "name": { - "type": "string" + "id": { + "type": "string", + "title": "tokenKey::token_key" }, - "value": {} - } - }, - "SchemaVariablesServiceUpdateSchemaVariableBody": { - "type": "object", - "properties": { - "encrypt": { - "type": "boolean" + "token": { + "type": "string", + "title": "tokenString::access_token" + }, + "updated_at": { + "type": "string", + "format": "int64", + "title": "unix::ms" + }, + "updated_by": { + "$ref": "#/definitions/api.ObjectId" }, - "name": { - "type": "string" + "usage": { + "type": "string", + "title": "[optional] short usage description" }, - "value": {} + "user": { + "title": "[optional] output depends on API endpoint", + "$ref": "#/definitions/api.ObjectId" + } } }, - "SkillServiceCreateSkillAgentBody": { + "api.UserAccessTokenList": { "type": "object", "properties": { - "agent": { + "items": { "type": "array", "items": { "type": "object", - "$ref": "#/definitions/engineLookup" + "$ref": "#/definitions/api.UserAccessToken" } }, - "capacity": { + "next": { + "type": "boolean", + "title": "is there more results ? next page is available ?" + }, + "page": { "type": "integer", "format": "int32" }, - "enabled": { - "type": "boolean" + "size": { + "type": "string", + "format": "int64" } } }, - "SkillServiceDeleteSkillAgentBody": { + "api.UserId": { + "description": "UserId lookup value.", "type": "object", "properties": { - "agent_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - }, "id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "type": "string", + "format": "int64", + "title": "Object ID" + }, + "name": { + "type": "string", + "title": "Display Name" } } }, - "SkillServicePatchSkillAgentBody": { + "api.UserPresence": { "type": "object", "properties": { - "agent_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - }, - "capacity": { + "expires": { "type": "integer", - "format": "int32" + "format": "int32", + "title": "[optional] \u003cnote\u003e will be cleaned up after seconds" }, - "enabled": { - "type": "boolean" + "id": { + "type": "string", + "format": "int64", + "title": "[required] user identity" }, - "fields": { - "type": "array", - "items": { - "type": "string" - } + "note": { + "type": "string", + "title": "[optional] human readable comment" }, - "id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "status": { + "type": "string", + "title": "[optional] set of unique 'active' presentities {dnd,dlg,sip,wss}; assume {offline} if omitted" }, - "skill": { - "$ref": "#/definitions/engineLookup" + "timestamp": { + "type": "string", + "format": "int64", + "title": "[required] last activity time" } } }, - "SkillServiceUpdateSkillBody": { + "api.UserSetting": { "type": "object", "properties": { - "description": { + "key": { "type": "string" }, - "domain_id": { - "type": "string", - "format": "int64" - }, - "name": { - "type": "string" - } + "value": {} } }, - "StartFileTranscriptResponseTranscriptJob": { + "api.Userinfo": { "type": "object", + "title": "https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims", "properties": { - "action": { - "type": "string" - }, - "created_at": { + "dc": { "type": "string", - "format": "int64" + "format": "int64", + "title": "current domain component id" }, - "file_id": { + "domain": { "type": "string", - "format": "int64" + "title": "session domain.name" }, - "id": { + "expires_at": { "type": "string", - "format": "int64" + "format": "int64", + "title": "unix" }, - "state": { - "type": "string" - } - } - }, - "StatusConditionsCreateStatusConditionBody": { - "type": "object", - "title": "CreateStatusConditionRequest message for creating a new status", - "required": [ - "name", - "lookup_id" - ], - "properties": { - "description": { + "extension": { "type": "string" }, + "license": { + "type": "array", + "title": "map[key]details", + "items": { + "type": "object", + "$ref": "#/definitions/api.LicenseUser" + } + }, "name": { - "type": "string" - } - } - }, - "SystemSettingServicePatchSystemSettingBody": { - "type": "object", - "properties": { - "fields": { + "type": "string", + "title": "current user.id" + }, + "permissions": { "type": "array", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/api.Permission" } }, - "value": {} - } - }, - "SystemSettingServiceUpdateSystemSettingBody": { - "type": "object", - "properties": { - "value": {} - } - }, - "TeamHookServiceCreateTeamHookBody": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" + "preferred_username": { + "type": "string" }, - "event": { - "$ref": "#/definitions/engineTeamHookEvent" + "roles": { + "type": "array", + "title": "map[role]oid", + "items": { + "type": "object", + "$ref": "#/definitions/api.ObjectId" + } }, - "properties": { + "scope": { "type": "array", + "title": "map[class]dac", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/api.Objclass" } }, - "schema": { - "$ref": "#/definitions/engineLookup" + "updated_at": { + "type": "string", + "format": "int64", + "title": "user last updated" + }, + "user_id": { + "type": "string", + "format": "int64", + "title": "current user.id" + }, + "username": { + "type": "string", + "title": "session end-user login" } } }, - "TeamHookServicePatchTeamHookBody": { + "api.Users.LogoutUserBody": { + "type": "object" + }, + "api.Users.UpdateUserBody": { "type": "object", "properties": { - "enabled": { - "type": "boolean" - }, - "event": { - "$ref": "#/definitions/engineTeamHookEvent" - }, "fields": { "type": "array", + "title": "PATCH: partial update", "items": { "type": "string" } }, - "properties": { - "type": "array", - "items": { - "type": "string" + "user": { + "type": "object", + "title": "body: modifications/changes", + "properties": { + "contact": { + "description": "[optional] contact connected to this user", + "title": "repeated Call calls = 13; // order by created_at\nrepeated Registration reged = 13; // order by register_last", + "$ref": "#/definitions/api.ObjectId" + }, + "created_at": { + "type": "string", + "format": "int64", + "title": "unix" + }, + "created_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" + }, + "deleted_at": { + "type": "string", + "format": "int64", + "title": "unix" + }, + "deleted_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" + }, + "device": { + "title": "[optional] default device assigned ? WebRTC register ?", + "$ref": "#/definitions/api.ObjectId" + }, + "devices": { + "description": "[editable] list of unique `regular` devices, attached to this user", + "type": "array", + "title": "map\u003cint64, string\u003e devices = 13;", + "items": { + "type": "object", + "$ref": "#/definitions/api.ObjectId" + } + }, + "email": { + "type": "string" + }, + "extension": { + "type": "string", + "title": "Caller-ID-Number:" + }, + "hotdesks": { + "type": "array", + "title": "[readonly] list of unique `hotdesk` devices, assigned to this user", + "items": { + "type": "object", + "$ref": "#/definitions/api.ObjectId" + } + }, + "license": { + "type": "array", + "title": "list of unique licenses, granted to this user", + "items": { + "type": "object", + "$ref": "#/definitions/api.LicenseUser" + } + }, + "name": { + "type": "string", + "title": "Caller-ID-Name: Display Name" + }, + "password": { + "type": "string" + }, + "permissions": { + "type": "array", + "title": "set of operational permission grants", + "items": { + "type": "object", + "$ref": "#/definitions/api.Permission" + } + }, + "presence": { + "description": "string presence = 7; // unique set of \u003cuser\u003e presentity \u003cstatus:basic\u003e tuples open[ed]\n string status = 8; // short display status (short description)", + "title": "CallerId caller = 5; // extension\nPresenceStatus presence = 8;", + "$ref": "#/definitions/api.UserPresence" + }, + "profile": { + "type": "object", + "title": "list of variables, assigned to this user as an environment unit", + "additionalProperties": { + "type": "string" + } + }, + "roles": { + "type": "array", + "title": "roles, member of which is this user", + "items": { + "type": "object", + "$ref": "#/definitions/api.ObjectId" + } + }, + "totp_url": { + "type": "string", + "title": "[readonly][optional] one time password if setting (2fa) is enabled" + }, + "updated_at": { + "type": "string", + "format": "int64", + "title": "unix" + }, + "updated_by": { + "title": "user", + "$ref": "#/definitions/api.UserId" + }, + "username": { + "type": "string", + "title": "alphanumeric username (login)" + } } - }, - "schema": { - "$ref": "#/definitions/engineLookup" } } }, - "TeamHookServiceUpdateTeamHookBody": { + "api.Verification": { "type": "object", "properties": { - "enabled": { - "type": "boolean" - }, - "event": { - "$ref": "#/definitions/engineTeamHookEvent" - }, - "properties": { + "errors": { "type": "array", + "title": "invalid", "items": { "type": "string" } }, - "schema": { - "$ref": "#/definitions/engineLookup" + "notify": { + "type": "array", + "title": "non-fatal warnings, e.g.:", + "items": { + "type": "string" + } } } }, - "TeamTriggerServiceCreateTeamTriggerBody": { + "casesAttachment": { "type": "object", "properties": { - "description": { - "type": "string" + "id": { + "type": "string", + "format": "int64" }, - "enabled": { - "type": "boolean" + "mime": { + "type": "string" }, "name": { "type": "string" }, - "schema": { - "$ref": "#/definitions/engineLookup" + "size": { + "type": "string", + "format": "int64" + }, + "url": { + "type": "string" } } }, - "TeamTriggerServicePatchTeamTriggerBody": { + "casesCallEvent": { "type": "object", "properties": { - "description": { + "closed_at": { + "type": "string", + "format": "int64" + }, + "duration": { + "type": "string", + "format": "int64" + }, + "files": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/casesCallFile" + } + }, + "flow_scheme": { + "$ref": "#/definitions/generalLookup" + }, + "gateway": { + "$ref": "#/definitions/generalLookup" + }, + "id": { "type": "string" }, - "enabled": { + "is_detailed": { "type": "boolean" }, - "fields": { + "is_inbound": { + "type": "boolean" + }, + "is_missed": { + "type": "boolean" + }, + "participants": { "type": "array", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/generalLookup" } }, - "name": { - "type": "string" + "queue": { + "$ref": "#/definitions/generalLookup" }, - "schema": { - "$ref": "#/definitions/engineLookup" - } - } - }, - "TeamTriggerServiceRunTeamTriggerBody": { - "type": "object", - "properties": { - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" + "total_duration": { + "type": "string", + "format": "int64" + }, + "transcripts": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/casesTranscriptLookup" } } } }, - "TeamTriggerServiceUpdateTeamTriggerBody": { + "casesCallFile": { "type": "object", "properties": { - "description": { - "type": "string" + "created_at": { + "type": "string", + "format": "int64" }, - "enabled": { - "type": "boolean" + "id": { + "type": "string", + "format": "int64" + }, + "mime_type": { + "type": "string" }, "name": { "type": "string" }, - "schema": { - "$ref": "#/definitions/engineLookup" - } - } - }, - "TriggerServiceCreateTriggerJobBody": { - "type": "object", - "properties": { - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "size": { + "type": "string", + "format": "int64" } } }, - "TriggerServicePatchTriggerBody": { + "casesCase": { + "description": "Message representing a case.", "type": "object", "properties": { + "assignee": { + "description": "Assignee responsible for resolving the case.", + "$ref": "#/definitions/generalLookup" + }, + "author": { + "description": "Author or reporter of the case.", + "$ref": "#/definitions/generalLookup" + }, + "close": { + "description": "Close information (if applicable).", + "$ref": "#/definitions/casesCloseInfo" + }, + "close_reason_group": { + "description": "Close reason group, immutable once set.", + "$ref": "#/definitions/generalLookup" + }, + "comments": { + "description": "List of comments on the case.", + "$ref": "#/definitions/casesCaseCommentList" + }, + "contact_info": { + "description": "Contact information for the case.", + "type": "string" + }, + "created_at": { + "description": "Creation timestamp (in milliseconds since Unix epoch).", + "type": "string", + "format": "int64" + }, + "created_by": { + "description": "Creator of the case.", + "$ref": "#/definitions/generalLookup" + }, "description": { + "description": "Detailed description of the case.", "type": "string" }, - "enabled": { - "type": "boolean" + "etag": { + "description": "Unique etag identifier.", + "type": "string" + }, + "files": { + "description": "List of attached files.", + "$ref": "#/definitions/casesCaseFileList" + }, + "group": { + "description": "Group associated with the case.", + "$ref": "#/definitions/generalLookup" + }, + "id": { + "description": "Unique case ID.", + "type": "string", + "format": "int64" }, - "expression": { - "type": "string" + "impacted": { + "description": "Impacted contact (defaults to reporter if null).", + "$ref": "#/definitions/generalLookup" }, - "fields": { - "type": "array", - "items": { - "type": "string" - } + "links": { + "description": "List of attached links.", + "$ref": "#/definitions/casesCaseLinkList" }, "name": { + "description": "Name of the case (may serve as an ID in docs).", "type": "string" }, - "schema": { - "$ref": "#/definitions/engineLookup" + "planned_reaction_at": { + "description": "Planned reaction time (in milliseconds).", + "type": "string", + "format": "int64" }, - "timeout": { - "type": "integer", - "format": "int32" + "planned_resolve_at": { + "description": "Planned resolution time (in milliseconds).", + "type": "string", + "format": "int64" }, - "timezone": { - "$ref": "#/definitions/engineLookup" + "priority": { + "description": "Priority level of the case.", + "$ref": "#/definitions/casesPriority" }, - "type": { - "$ref": "#/definitions/engineTriggerType" + "rate": { + "description": "Rating information.", + "$ref": "#/definitions/casesRateInfo" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "TriggerServiceUpdateTriggerBody": { - "type": "object", - "properties": { - "description": { - "type": "string" + "related": { + "description": "List of related cases.", + "$ref": "#/definitions/casesRelatedCaseList" }, - "enabled": { - "type": "boolean" + "reporter": { + "description": "Reporter of the issue (null if anonymous).", + "$ref": "#/definitions/generalLookup" }, - "expression": { - "type": "string" + "service": { + "description": "Service associated with the case.", + "$ref": "#/definitions/generalLookup" }, - "name": { - "type": "string" + "sla": { + "description": "SLA associated with the case.", + "$ref": "#/definitions/generalLookup" }, - "schema": { - "$ref": "#/definitions/engineLookup" + "sla_condition": { + "description": "List of SLA conditions.", + "$ref": "#/definitions/generalLookup" }, - "timeout": { - "type": "integer", - "format": "int32" + "source": { + "description": "Source of the case.", + "$ref": "#/definitions/casesSourceTypeLookup" }, - "timezone": { - "$ref": "#/definitions/engineLookup" + "status": { + "description": "Current status of the case.", + "$ref": "#/definitions/generalLookup" }, - "type": { - "$ref": "#/definitions/engineTriggerType" + "status_condition": { + "description": "Status condition from status lookup.", + "$ref": "#/definitions/casesStatusCondition" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "UserStatusUserPresence": { - "type": "object", - "properties": { - "status": { + "subject": { + "description": "Subject of the case.", "type": "string" + }, + "timing": { + "description": "SLA timing details.", + "$ref": "#/definitions/casesTimingInfo" + }, + "updated_at": { + "description": "Last update timestamp (in milliseconds since Unix epoch).", + "type": "string", + "format": "int64" + }, + "updated_by": { + "description": "Last updater of the case.", + "$ref": "#/definitions/generalLookup" + }, + "ver": { + "description": "Version number of the case.", + "type": "integer", + "format": "int32" } } }, - "WebHookServicePatchWebHookBody": { + "casesCaseComment": { + "description": "Represents a comment associated with a case.", "type": "object", "properties": { - "authorization": { - "type": "string" - }, - "description": { - "type": "string" + "author": { + "description": "Contact-author of the comment.", + "$ref": "#/definitions/generalLookup" }, - "enabled": { + "can_edit": { + "description": "Indicates if the comment can be edited by current user.", "type": "boolean" }, - "fields": { - "type": "array", - "items": { - "type": "string" - } + "case_id": { + "description": "Optional relation to the associated case.", + "type": "string", + "format": "int64" }, - "name": { - "type": "string" + "created_at": { + "description": "Timestamp (in milliseconds) of when the comment was created.", + "type": "string", + "format": "int64" }, - "origin": { - "type": "array", - "items": { - "type": "string" - } + "created_by": { + "description": "User who created the comment.", + "$ref": "#/definitions/generalLookup" }, - "schema": { - "$ref": "#/definitions/engineLookup" - } - } - }, - "WebHookServiceUpdateWebHookBody": { - "type": "object", - "properties": { - "authorization": { - "type": "string" + "edited": { + "description": "Indicates if the comment was edited; true if created_at \u003c updated_at.", + "type": "boolean" }, - "description": { - "type": "string" + "etag": { + "type": "string", + "title": "entity tag representing id + ver" }, - "enabled": { - "type": "boolean" + "id": { + "description": "Main identifier for read, update, and delete operations.", + "type": "string", + "format": "int64" }, - "name": { + "text": { + "description": "The content of the comment.", "type": "string" }, - "origin": { - "type": "array", - "items": { - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/engineLookup" - } - } - }, - "api.AccessRule": { - "type": "object", - "properties": { - "granted": { + "updated_at": { + "description": "Timestamp (in milliseconds) of the last update.", "type": "string", - "title": "[WHAT]: full: [xrwdxrwd]; privileges: [----xrwd]; grantable: [xrwd----]" + "format": "int64" }, - "grantee": { - "title": "[WHOM]: required; NEED to be rechecked !!!", - "$ref": "#/definitions/api.RoleId" + "updated_by": { + "description": "User who last updated the comment.", + "$ref": "#/definitions/generalLookup" }, - "grantor": { - "description": "[WHO]: operational; current user NEED to be rechecked !!!", - "title": "ObjectId object = 1;", - "$ref": "#/definitions/api.RoleId" + "ver": { + "description": "Version number of the comment, used for concurrency control.", + "type": "integer", + "format": "int32" } } }, - "api.AccessStore.ToggleDefaultAccessBody": { + "casesCaseCommentList": { + "description": "Contains a paginated list of comments.", "type": "object", "properties": { - "list": { - "description": "list of changes ...\n\n[TO] (GRANT/REVOKE)", + "items": { + "description": "List of comments on the current page.", "type": "array", "items": { "type": "object", - "$ref": "#/definitions/api.GrantAccessRequestV1" + "$ref": "#/definitions/casesCaseComment" } }, - "object": { - "type": "object", - "title": "[ON] objclass (either: by entity .id -or- class .name)" + "next": { + "description": "Flag to indicate if more pages are available.", + "type": "boolean" + }, + "page": { + "description": "Current page number.", + "type": "string", + "format": "int64" } } }, - "api.AccessToken": { + "casesCaseCommunication": { + "description": "Represents a single case communication.", "type": "object", - "title": "OAuth 2.0 Access Token Response compatible", "properties": { - "access_token": { - "description": "REQUIRED. The access token issued by the authorization server.", + "communication_id": { + "description": "External communication ID.", "type": "string" }, - "expires_in": { - "description": "RECOMMENDED. The lifetime in seconds of the access token.", - "type": "integer", - "format": "int32" + "communication_type": { + "description": "Type of the communication (e.g., Chat, Call).", + "$ref": "#/definitions/casesCaseCommunicationsTypes" }, - "refresh_token": { - "description": "OPTIONAL. The refresh token, which can be used to obtain\nnew access tokens using the same authorization grant.", + "etag": { + "description": "Version of the communication record.", "type": "string" }, - "state": { - "description": "OPTIONAL, if identical to the scope requested by the client;\notherwise, REQUIRED. The scope of the access token.\nrepeated string scope = 5 [ json_name = \"scope\" ];\nREQUIRED if the \"state\" parameter was present in the client\nauthorization request. The exact value received from the client.", - "type": "string" + "id": { + "description": "Database ID of the communication.", + "type": "string", + "format": "int64" }, - "token_type": { - "description": "REQUIRED. The type of the token issued. Value is case insensitive.", - "type": "string" + "ver": { + "description": "Version of the communication record.", + "type": "integer", + "format": "int32" } } }, - "api.Claim": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "value": { - "type": "string" - } - } + "casesCaseCommunicationsTypes": { + "description": "Enum to define types of case communications.\n\n - NO_TYPE: Default value, no type specified.\n - COMMUNICATION_CHAT: Communication type: Chat.\n - COMMUNICATION_CALL: Communication type: Call.\n - COMMUNICATION_EMAIL: Communication type: Email.", + "type": "string", + "default": "NO_TYPE", + "enum": [ + "NO_TYPE", + "COMMUNICATION_CHAT", + "COMMUNICATION_CALL", + "COMMUNICATION_EMAIL" + ] }, - "api.Classes.UpdateClassBody": { + "casesCaseFileList": { + "description": "Contains a list of case files with pagination.", "type": "object", "properties": { - "class": { - "type": "object", - "properties": { - "abac": { - "type": "boolean", - "title": "[a]ttribute-[b]ased [a]ccess [c]ontrol" - }, - "class": { - "type": "string", - "title": "(class::object).name" - }, - "obac": { - "type": "boolean", - "title": "[o]peration-[b]ased [a]ccess [c]ontrol (from::collection.dal)" - }, - "rbac": { - "type": "boolean", - "title": "[r]ecord-[b]ased [a]ccess [c]ontrol (from::resource.acl)" - } - } - }, - "domain": { - "type": "string", - "title": "TO BE REMOVED // bound to session.domain.id" - }, - "fields": { + "items": { + "description": "List of case files.", "type": "array", - "title": "PATCH: partial update", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/casesFile" } - } - } - }, - "api.CreateDeviceResponse": { - "type": "object", - "properties": { - "device": { - "$ref": "#/definitions/api.Device" - } - } - }, - "api.CreateDomainRequest": { - "type": "object", - "title": "POST /domains", - "properties": { - "organization": { - "$ref": "#/definitions/api.Organization" }, - "password": { - "type": "string" + "next": { + "description": "Indicator if there is a next page.", + "type": "boolean" }, - "superuser": { - "type": "string" + "page": { + "description": "Current page number.", + "type": "string", + "format": "int64" } } }, - "api.CreateDomainResponse": { - "type": "object" - }, - "api.CreateRoleRequest": { + "casesCaseLink": { "type": "object", "properties": { - "copy_id": { + "author": { + "title": "contact-author calculated on-flight (optional)", + "$ref": "#/definitions/generalLookup" + }, + "created_at": { "type": "string", "format": "int64", - "title": "----- Query parameters -----\nOptional. Source role unique identifier\nto copy access (+default) control list from" + "title": "unixmilli" }, - "role": { - "title": "entity to be created", - "$ref": "#/definitions/api.Role" + "created_by": { + "$ref": "#/definitions/generalLookup" + }, + "etag": { + "type": "string", + "title": "main field required for read, update and delete" + }, + "id": { + "type": "string", + "format": "int64" + }, + "name": { + "type": "string", + "title": "link name (optional)" + }, + "updated_at": { + "type": "string", + "format": "int64" + }, + "updated_by": { + "$ref": "#/definitions/generalLookup" + }, + "url": { + "type": "string", + "title": "URL" + }, + "ver": { + "type": "integer", + "format": "int32" } } }, - "api.CreateRoleResponse": { + "casesCaseLinkList": { "type": "object", "properties": { - "created": { - "title": "entity to be created", - "$ref": "#/definitions/api.Role" + "items": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/casesCaseLink" + } + }, + "next": { + "type": "boolean" + }, + "page": { + "type": "string", + "format": "int64" } } }, - "api.CreateUserRequest": { + "casesCaseList": { + "description": "Response message containing a list of cases.", "type": "object", "properties": { - "confirm_password": { - "type": "string", - "title": "cleartext passphrase" + "items": { + "description": "List of cases.", + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/casesCase" + } }, - "user": { - "title": "user entity to be created", - "$ref": "#/definitions/api.User" + "next": { + "description": "Flag indicating if there are more pages.", + "type": "boolean" }, - "user_password": { + "page": { + "description": "Current page number.", "type": "string", - "title": "cleartext passphrase" + "format": "int64" } } }, - "api.CreateUserResponse": { - "type": "object", - "properties": { - "user": { - "$ref": "#/definitions/api.User" - } - } + "casesCaseTimelineEventType": { + "type": "string", + "default": "TIMELINE_CHAT", + "enum": [ + "TIMELINE_CHAT", + "TIMELINE_CALL", + "TIMELINE_EMAIL" + ] }, - "api.Customer": { + "casesCatalog": { "type": "object", + "title": "Catalog message represents the main catalog entity with metadata", "properties": { + "close_reason_group": { + "title": "Close reason group associated with the catalog", + "$ref": "#/definitions/generalLookup" + }, + "code": { + "type": "string", + "title": "Code for external integrations (optional)" + }, "created_at": { - "description": "local created ms", "type": "string", "format": "int64", - "title": "string version = 2; // version\nlocal store details" + "title": "Timestamp when the catalog was created" }, - "dnsrv": { - "type": "array", - "title": "[optional] domains", - "items": { - "type": "object", - "$ref": "#/definitions/api.ObjectId" - } + "created_by": { + "title": "User who created the catalog", + "$ref": "#/definitions/generalLookup" }, - "id": { + "description": { "type": "string", - "title": "serial number assigned (global::Customer-ID)" + "title": "Description of the catalog (optional)" }, - "issued_at": { - "description": "[required] issuer(CA) created at", + "id": { "type": "string", "format": "int64", - "title": "validity boundaries" + "title": "Unique identifier for the catalog" }, - "license": { - "description": "grants issued", + "name": { + "type": "string", + "title": "Name of the catalog" + }, + "prefix": { + "type": "string", + "title": "Prefix used for case identification (optional)" + }, + "searched": { + "type": "boolean", + "title": "flag showing whether the catalog was searched" + }, + "service": { + "type": "array", + "title": "Service associated with the catalog", + "items": { + "type": "object", + "$ref": "#/definitions/casesService" + } + }, + "skills": { "type": "array", - "title": "int32 competitive = 13; // zero-based competitive sessions limit ?", + "title": "Skills associated with the catalog", "items": { "type": "object", - "$ref": "#/definitions/api.LicenseV1" - } - }, - "limit": { - "description": "defines map[class]limit usage", - "type": "object", - "title": "extensions granted", - "additionalProperties": { - "type": "integer", - "format": "int32" + "$ref": "#/definitions/generalLookup" } }, - "next_update": { - "type": "string", - "format": "int64", - "title": "[optional]: signature expires; update required after" - }, - "not_after": { - "type": "string", - "format": "int64", - "title": "[required] valid till" - }, - "not_before": { - "type": "string", - "format": "int64", - "title": "[optional] valid from" + "sla": { + "title": "SLA associated with the catalog", + "$ref": "#/definitions/generalLookup" }, - "organization": { - "type": "string", - "title": "registration name" + "state": { + "type": "boolean", + "title": "State of the catalog (true for active, false for inactive)" }, - "revoked_at": { - "type": "string", - "format": "int64", - "title": "local revoked ms" + "status": { + "title": "Status associated with the catalog", + "$ref": "#/definitions/generalLookup" }, - "this_update": { - "description": "[optional]: issuer(CA) signed at", - "type": "string", - "format": "int64", - "title": "signature validity" + "teams": { + "type": "array", + "title": "Teams associated with the catalog", + "items": { + "type": "object", + "$ref": "#/definitions/generalLookup" + } }, "updated_at": { "type": "string", "format": "int64", - "title": "last uploaded ms" + "title": "Timestamp when the catalog was last updated" }, - "verify": { - "description": "[optional] validation results", - "title": "Verification status", - "$ref": "#/definitions/api.Verification" + "updated_by": { + "title": "User who last updated the catalog", + "$ref": "#/definitions/generalLookup" } } }, - "api.DeleteDeviceResponse": { + "casesCatalogList": { "type": "object", + "title": "CatalogList message contains a list of catalogs with pagination", "properties": { - "deleted": { + "items": { "type": "array", + "title": "List of catalog items", "items": { "type": "object", - "$ref": "#/definitions/api.Device" + "$ref": "#/definitions/casesCatalog" } - } - } - }, - "api.DeleteDomainResponse": { - "type": "object" - }, - "api.DeleteLDAPRequest": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "int64", - "title": "catalog id" }, - "related_objects": { + "next": { "type": "boolean", - "title": "WITH objects bound to ?" + "title": "Indicates if there are more pages" + }, + "page": { + "type": "integer", + "format": "int32", + "title": "Page number for pagination" } } }, - "api.DeleteOAuthServiceRequest": { + "casesChatEvent": { "type": "object", "properties": { + "closed_at": { + "type": "string", + "format": "int64" + }, + "duration": { + "type": "string", + "format": "int64" + }, + "flow_scheme": { + "$ref": "#/definitions/generalLookup" + }, + "gateway": { + "$ref": "#/definitions/generalExtendedLookup" + }, "id": { + "type": "string" + }, + "is_detailed": { + "type": "boolean" + }, + "is_inbound": { + "type": "boolean" + }, + "is_missed": { + "type": "boolean" + }, + "participants": { "type": "array", "items": { - "type": "string", - "format": "int64" + "type": "object", + "$ref": "#/definitions/generalLookup" } }, - "permanent": { - "type": "boolean" - } - } - }, - "api.DeleteOAuthServiceResponse": { - "type": "object" - }, - "api.DeleteRoleResponse": { - "type": "object", - "properties": { - "deleted": { - "$ref": "#/definitions/api.Role" + "queue": { + "$ref": "#/definitions/generalLookup" } } }, - "api.DeleteUsersResponse": { + "casesCloseInfo": { + "description": "Message representing close information for a case.", "type": "object", "properties": { - "deleted": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/api.User" - } + "close_reason": { + "description": "Lookup for the close reason.", + "$ref": "#/definitions/generalLookup" + }, + "close_result": { + "description": "Result or reason for closing the case.", + "type": "string" } } }, - "api.Device": { + "casesCloseReason": { "type": "object", - "title": "Device profile", + "title": "CloseReason message represents a close reason entity with metadata", "properties": { - "account": { - "description": "username", - "type": "string", - "title": "credentials" - }, - "brand": { - "description": "vendor brand name", + "close_reason_group_id": { "type": "string", - "title": "provision" + "format": "int64", + "title": "Close Reason Group ID of the close reason" }, "created_at": { "type": "string", "format": "int64", - "title": "unix" + "title": "CreatedAt timestamp of the close reason" }, "created_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" + "title": "CreatedBy user of the close reason", + "$ref": "#/definitions/generalLookup" }, - "deleted_at": { + "description": { "type": "string", - "format": "int64", - "title": "unix" - }, - "deleted_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" - }, - "hotdesk": { - "description": "act as a hotdesk", - "type": "boolean", - "title": "Hotdesk: this workstation aliases" - }, - "hotdesks": { - "type": "array", - "title": "associated aliases", - "items": { - "type": "string" - } + "title": "Description of the close reason" }, "id": { "type": "string", "format": "int64", - "title": "object id" + "title": "Unique identifier of the close reason" }, - "ip": { - "type": "string" + "name": { + "type": "string", + "title": "Name of the close reason" }, - "logged_in": { + "updated_at": { "type": "string", "format": "int64", - "title": "caller profile\n webitel.adt.caller caller = 4;" + "title": "UpdatedAt timestamp of the close reason" }, - "mac": { + "updated_by": { + "title": "UpdatedBy user of the close reason", + "$ref": "#/definitions/generalLookup" + } + } + }, + "casesCloseReasonGroup": { + "type": "object", + "title": "CloseReasonGroup message represents a close reason group entity with metadata", + "properties": { + "created_at": { "type": "string", - "title": "static" + "format": "int64", + "title": "CreatedAt timestamp of the close reason group" }, - "model": { - "type": "string" + "created_by": { + "title": "CreatedBy user of the close reason group", + "$ref": "#/definitions/generalLookup" }, - "name": { - "description": "display name", + "description": { "type": "string", - "title": "kind of\nDeviceType type = 19;" + "title": "Description of the close reason group" }, - "password": { + "id": { "type": "string", - "title": "password" - }, - "provision": { - "type": "object", - "title": "provision extra data", - "additionalProperties": { - "type": "string" - } + "format": "int64", + "title": "Unique identifier of the close reason group" }, - "reged": { - "type": "boolean", - "title": "TODO: something like PresenceStatus instead of Registration\n repeated Registration contacts = 16;" + "name": { + "type": "string", + "title": "Name of the close reason group" }, "updated_at": { "type": "string", "format": "int64", - "title": "unix" + "title": "UpdatedAt timestamp of the close reason group" }, "updated_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" - }, - "user": { - "title": "[optional] The user that 'owns' the device;", - "$ref": "#/definitions/api.UserId" + "title": "UpdatedBy user of the close reason group", + "$ref": "#/definitions/generalLookup" } } }, - "api.DeviceAudit": { + "casesCloseReasonGroupList": { "type": "object", - "title": "Device login audit", + "title": "CloseReasonGroupList message contains a list of CloseReasonGroup items with pagination", "properties": { - "device": { - "title": "/users/:id/audit related", - "$ref": "#/definitions/api.DeviceId" - }, - "hotdesk": { - "type": "string" - }, - "logged_in": { - "type": "string", - "format": "int64" + "items": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/casesCloseReasonGroup" + } }, - "logged_out": { - "type": "string", - "format": "int64" + "next": { + "type": "boolean" }, - "user": { - "title": "/devices/:id/audit related", - "$ref": "#/definitions/api.UserId" + "page": { + "type": "integer", + "format": "int32" } } }, - "api.DeviceAuditResponse": { + "casesCloseReasonList": { "type": "object", + "title": "CloseReasonList message contains a list of CloseReason items with pagination", "properties": { "items": { "type": "array", - "title": "audit_logs", "items": { "type": "object", - "$ref": "#/definitions/api.DeviceAudit" + "$ref": "#/definitions/casesCloseReason" } }, "next": { - "type": "boolean", - "title": "search: has {next} page ?" + "type": "boolean" }, "page": { "type": "integer", - "format": "int32", - "title": "select: offset {page}" - }, - "size": { - "type": "integer", - "format": "int32", - "title": "search: limit {size}" + "format": "int32" } } }, - "api.DeviceId": { + "casesCreateCaseCloseInput": { + "description": "Structure for close information when a case is closed.", "type": "object", - "title": "DeviceId lookup value", "properties": { - "id": { - "type": "string", - "format": "int64", - "title": "Object ID" + "close_reason": { + "description": "Close reason ID from lookup.", + "$ref": "#/definitions/generalLookup" }, - "name": { - "type": "string", - "title": "Display Name" + "close_result": { + "description": "Comment or reason for closing the case.", + "type": "string" } } }, - "api.Domains.UpdateDomainBody": { + "casesCreateCaseRelatedCaseInput": { + "description": "Structure for related cases input when creating a case.", "type": "object", - "title": "PUT /domain/{domain.dc}", "properties": { - "domain": { - "type": "object", - "properties": { - "country": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "int64", - "title": "unix" - }, - "createdBy": { - "type": "string", - "title": "user" - }, - "domain": { - "type": "string", - "title": "FQDN" - }, - "email": { - "type": "string" - }, - "locality": { - "type": "string" - }, - "organization": { - "type": "string" - }, - "postalAddress": { - "type": "string" - }, - "postalCode": { - "type": "string" - }, - "stateOrProvince": { - "type": "string" - }, - "streetAddress": { - "type": "string" - }, - "telephoneNumber": { - "type": "string" - }, - "updatedAt": { - "type": "string", - "format": "int64", - "title": "unix" - }, - "updatedBy": { - "type": "string", - "title": "user" - } - } + "etag": { + "description": "Etag of the related case.", + "type": "string" + }, + "related_to": { + "description": "Identifier of the related case.", + "type": "string" + }, + "relation_type": { + "description": "Type of relation (e.g., duplicate, linked).", + "$ref": "#/definitions/casesRelationType" } } }, - "api.GenerateTfaKeysForNecessaryUsersResponse": { + "casesCreateCatalogRequest": { "type": "object", + "title": "CreateCatalogRequest message for creating a new catalog", "properties": { - "affected": { + "close_reason_group": { + "title": "Close reason ID associated with the catalog", + "$ref": "#/definitions/generalLookup" + }, + "code": { "type": "string", - "format": "int64" - } - } - }, - "api.GenerateUserTfaKeyResponse": { - "type": "object", - "properties": { - "totp": { - "$ref": "#/definitions/api.TfaUrl" + "title": "Code for external integrations (optional)" + }, + "description": { + "type": "string", + "title": "Description of the catalog (optional)" + }, + "name": { + "type": "string", + "title": "Name of the catalog (required)" + }, + "prefix": { + "type": "string", + "title": "Prefix for case identification (optional)" + }, + "skills": { + "type": "array", + "title": "List of skill IDs associated with the catalog", + "items": { + "type": "object", + "$ref": "#/definitions/generalLookup" + } + }, + "sla": { + "title": "SLA ID associated with the catalog", + "$ref": "#/definitions/generalLookup" + }, + "state": { + "type": "boolean", + "title": "State of the catalog (true for active, false for inactive)" + }, + "status": { + "title": "Status ID associated with the catalog", + "$ref": "#/definitions/generalLookup" + }, + "teams": { + "type": "array", + "title": "List of team IDs associated with the catalog", + "items": { + "type": "object", + "$ref": "#/definitions/generalLookup" + } } } }, - "api.GetCustomerResponse": { + "casesCreateCloseReasonGroupRequest": { "type": "object", + "title": "CreateCloseReasonGroupRequest message for creating a new close reason group", + "required": [ + "name" + ], "properties": { - "customer": { - "$ref": "#/definitions/api.Customer" + "description": { + "type": "string" + }, + "name": { + "type": "string" } } }, - "api.GetUserTfaKeyResponse": { + "casesCreateInputRelatedCase": { + "description": "Input for creating a related case.", "type": "object", "properties": { - "totp": { - "$ref": "#/definitions/api.TfaUrl" + "related_case": { + "description": "Related case details.", + "$ref": "#/definitions/generalLookup" + }, + "relation_type": { + "description": "Relation type between the cases.", + "$ref": "#/definitions/casesRelationType" } } }, - "api.GrantAccessRequestV1": { + "casesCreateSLARequest": { "type": "object", + "title": "CreateSLARequest message for creating a new SLA", + "required": [ + "name", + "calendar_id", + "reaction_time", + "resolution_time" + ], "properties": { - "grantee": { + "calendar": { + "title": "Calendar ID from the \"Calendars\" dictionary", + "$ref": "#/definitions/generalLookup" + }, + "description": { + "type": "string", + "title": "Description of the SLA" + }, + "name": { + "type": "string", + "title": "InputSLA message for creating a new SLA\nName of the SLA" + }, + "reaction_time": { + "type": "string", + "format": "int64", + "title": "Reaction time" + }, + "resolution_time": { + "type": "string", + "format": "int64", + "title": "Resolution time" + }, + "valid_from": { "type": "string", "format": "int64", - "title": "grantee.role.id" + "title": "Validity period for the SLA" }, - "grants": { + "valid_to": { "type": "string", - "title": "repeated string privileges = 5; // [\"SEARCH\",\"MODIFY\",\"DELETE\",\"CREATE\"]\nbool grantable = 6; // WITH GRANT OPTION" - }, - "object": { - "title": "string class = 2;\nint64 object = 3; // class.object.id", - "$ref": "#/definitions/api.ObjectId" + "format": "int64" } } }, - "api.GrantRoleResponse": { - "type": "object" - }, - "api.LDAP.CreateLDAPTemplateBody": { + "casesCreateServiceRequest": { "type": "object", - "title": "LDAPTemplate is an LDAP search entries to webitel objects transformation template", + "title": "CreateServiceRequest message for creating a new service", "properties": { - "agent": { - "type": "object", - "title": "OPTIONAL. Agent objclass fields mapping" - }, - "base_dn": { - "type": "string", - "title": "Optional. LDAP Search base entry DN" - }, - "catalog": { - "type": "object", - "title": "LDAPCatalog belongs to", - "properties": { - "name": { - "type": "string", - "title": "display name" - } - } + "assignee": { + "title": "Assignee ID responsible for the service", + "$ref": "#/definitions/generalLookup" }, - "created_at": { - "description": "unix", + "catalog_id": { "type": "string", "format": "int64", - "title": "READONLY. Operational attributes" - }, - "created_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" - }, - "device": { - "type": "object", - "title": "OPTIONAL. Device objclass fields mapping" - }, - "enabled": { - "type": "boolean", - "title": "Optional. This Template is activated ?" + "title": "ID of the root catalog" }, - "id": { + "code": { "type": "string", - "format": "int64", - "title": "ID unique" + "title": "Code for external integrations (optional)" }, - "name": { + "description": { "type": "string", - "title": "Name this template" + "title": "Description of the service (optional)" }, - "role": { - "type": "object", - "title": "OPTIONAL. Role objclass fields mapping (Not implemented yet)" + "group": { + "title": "Group ID responsible for the service", + "$ref": "#/definitions/generalExtendedLookup" }, - "search": { + "name": { "type": "string", - "title": "Required. LDAP Search filter string" + "title": "Name of the service (required)" }, - "updated_at": { + "root_id": { "type": "string", "format": "int64", - "title": "unix" + "title": "Parent catalog ID (required)" }, - "updated_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" + "sla": { + "title": "SLA ID associated with the service", + "$ref": "#/definitions/generalLookup" }, - "user": { - "type": "object", - "title": "OPTIONAL. User objclass fields mapping" + "state": { + "type": "boolean", + "title": "State of the service (true for active, false for inactive)" } } }, - "api.LDAP.DeleteLDAPTemplateBody": { + "casesCreateSourceRequest": { + "description": "Request message for creating a new source.", "type": "object", + "required": [ + "name", + "type" + ], "properties": { - "base_dn": { + "description": { + "description": "The description of the source.", "type": "string" }, - "disabled": { - "type": "boolean" - }, - "enabled": { - "type": "boolean" - }, - "fields": { - "type": "array", - "title": "attributes list", - "items": { - "type": "string" - } - }, - "id": { - "type": "array", - "title": "----- Search Basic Filters ---------------------------\nOPTIONAL. Search templates by .id", - "items": { - "type": "string", - "format": "int64" - } - }, "name": { + "description": "The name of the source.", "type": "string" }, - "objclass": { + "type": { + "description": "The source type of the source.", + "$ref": "#/definitions/casesSourceType" + } + } + }, + "casesCreateStatusRequest": { + "type": "object", + "title": "CreateStatusRequest message for creating a new status", + "required": [ + "name" + ], + "properties": { + "description": { "type": "string" }, - "page": { - "description": "default: 1", - "type": "integer", - "format": "int32", - "title": "----- Select Options -------------------------" + "name": { + "type": "string" + } + } + }, + "casesDayTimeline": { + "type": "object", + "properties": { + "calls_count": { + "type": "string", + "format": "int64" }, - "q": { + "chats_count": { "type": "string", - "title": "OPTIONAL. Filter(s) SET" + "format": "int64" }, - "size": { - "type": "integer", - "format": "int32", - "title": "default: 16" + "day_timestamp": { + "type": "string", + "format": "int64" }, - "sort": { + "emails_count": { + "type": "string", + "format": "int64" + }, + "items": { "type": "array", - "title": "e.g.: \"updated_at\" - ASC; \"!updated_at\" - DESC;", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/casesEvent" } } } }, - "api.LDAP.LDAPSearchBody": { + "casesEmailEvent": { "type": "object", - "title": "https://datatracker.ietf.org/doc/html/rfc4511#section-4.5.1", "properties": { - "attributes": { + "attachments": { "type": "array", - "title": "AttributeSelection", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/casesAttachment" } }, - "baseObject": { - "type": "string", - "title": "----- SearchRequest -----\nbaseObject [D]istinguished[N]ame" - }, - "bind": { - "description": "authorization method e.g.: SIMPLE, SAML, NTLM, etc.", + "body": { "type": "string", - "title": "----- BIND: Authorization -----" + "title": "plain text of email" }, - "controls": { + "cc": { "type": "array", - "title": "----- LDAPMessage -----\nControls NOT implemented yet !", + "title": "array of ccs (email addresses)", "items": { - "type": "object", - "$ref": "#/definitions/api.LDAPControl" + "type": "string" } }, - "derefAliases": { - "type": "integer", - "format": "int32", - "title": "neverDerefAliases (0),\nderefInSearching (1),\nderefFindingBaseObj (2),\nderefAlways (3)" + "from": { + "type": "array", + "title": "array of senders (email addresses)", + "items": { + "type": "string" + } }, - "filter": { + "html": { "type": "string", - "title": "Filter," + "title": "html body of email" }, - "password": { - "type": "string", - "title": "password" + "id": { + "type": "string" }, - "scope": { - "type": "integer", - "format": "int32", - "title": "baseObject (0),\nsingleLevel (1),\nwholeSubtree (2)" + "is_detailed": { + "type": "boolean", + "title": "reserved for the open" }, - "sizeLimit": { - "type": "string", - "format": "int64", - "title": "INTEGER (0 .. maxInt)," + "is_inbound": { + "type": "boolean", + "title": "inbound/outbound email" }, - "timeLimit": { - "type": "string", - "format": "int64", - "title": "INTEGER (0 .. maxInt)," + "owner": { + "title": "Agent who sent/accepted", + "$ref": "#/definitions/generalLookup" }, - "tls": { - "$ref": "#/definitions/api.LDAPSearchRequest.TLSConfig" + "profile": { + "title": "email profile", + "$ref": "#/definitions/generalLookup" }, - "typesOnly": { - "type": "boolean", - "title": "BOOLEAN," + "sender": { + "type": "array", + "title": "array of receivers (email addresses)", + "items": { + "type": "string" + } }, - "url": { - "description": "URL e.g.: [(ldap|ldapi|ldaps)://]host[:port]", - "type": "string", - "title": "Optional. URL to establish connection to LDAP catalog" + "subject": { + "type": "string" }, - "username": { + "to": { + "type": "array", + "title": "array of receivers (email addresses)", + "items": { + "type": "string" + } + } + } + }, + "casesEvent": { + "type": "object", + "properties": { + "call": { + "$ref": "#/definitions/casesCallEvent" + }, + "chat": { + "$ref": "#/definitions/casesChatEvent" + }, + "created_at": { "type": "string", - "title": "bind_dn" + "format": "int64" + }, + "email": { + "$ref": "#/definitions/casesEmailEvent" + }, + "type": { + "$ref": "#/definitions/casesCaseTimelineEventType" } } }, - "api.LDAP.ResyncLDAPCatalogBody": { + "casesFile": { + "description": "Metadata for a file associated with a case.", "type": "object", "properties": { - "options": { - "title": "Options", - "$ref": "#/definitions/api.LDAProcessOptions" + "author": { + "$ref": "#/definitions/generalLookup" + }, + "created_at": { + "description": "Creation timestamp in Unix milliseconds.", + "type": "string", + "format": "int64" + }, + "created_by": { + "description": "Creator of the file.", + "$ref": "#/definitions/generalLookup" + }, + "id": { + "description": "Storage file ID.", + "type": "string", + "format": "int64" + }, + "mime": { + "description": "MIME type of the file.", + "type": "string" + }, + "name": { + "description": "File name.", + "type": "string" + }, + "size": { + "description": "File size in bytes.", + "type": "string", + "format": "int64" + }, + "url": { + "type": "string" } } }, - "api.LDAP.UpdateLDAPCatalogBody": { + "casesGetTimelineCounterResponse": { "type": "object", "properties": { - "catalog": { - "description": "LDAP Catalog changes.", - "type": "object", - "title": "LDAP Catalog changes.", - "properties": { - "base_dn": { - "type": "string", - "title": "base_dn, aka domain e.g.: 'dc=example,dc=org'" - }, - "bind": { - "description": "authorization method e.g.: SIMPLE, SAML, NTLM, etc.", - "type": "string", - "title": "----- BIND: Authorization -----" - }, - "created_at": { - "description": "unix", - "type": "string", - "format": "int64", - "title": "basic: last operation details" - }, - "created_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" - }, - "cron": { - "description": "[CRON]OS SPEC ! github.com/robfig/cron/v3", - "type": "string", - "title": "----- RSYNC Processing -----\nint32 priority = 4;" - }, - "entry_modify": { - "type": "string", - "title": "last modification timestamp attribute type" - }, - "entry_uuid": { - "description": "entry unique id (except DN which may be updated)", - "type": "string", - "title": "----- DOMAIN: Entry model -----" - }, - "name": { - "type": "string", - "title": "Meaningfull title name" - }, - "password": { - "type": "string", - "title": "password" - }, - "process": { - "title": "Last OR Current SYNC process details", - "$ref": "#/definitions/api.LDAProcess" - }, - "sync": { - "$ref": "#/definitions/api.LDAProcessOptions" - }, - "templates": { - "type": "array", - "title": "// // ----- MAP: user(s) settings -----\nLDAPUsersMap users = 26; // DEPRECATED: Use Template(s) instead\nSYNC Object's search and mappings", - "items": { - "type": "object", - "$ref": "#/definitions/api.LDAPTemplate" - } - }, - "tls": { - "$ref": "#/definitions/api.LDAPCatalog.TLSConfig" - }, - "updated_at": { - "type": "string", - "format": "int64", - "title": "unix" - }, - "updated_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" - }, - "url": { - "description": "URL e.g.: [(ldap|ldapi|ldaps)://]host[:port]", - "type": "string", - "title": "----- Connection Options -----" - }, - "username": { - "type": "string", - "title": "bind_dn" - } - } + "calls_count": { + "type": "string", + "format": "int64" }, - "fields": { - "type": "array", - "title": "Fields for partial update. PATCH", - "items": { - "type": "string" - } + "chats_count": { + "type": "string", + "format": "int64", + "title": "defined event types" + }, + "date_from": { + "type": "string", + "format": "int64", + "title": "filter dates" + }, + "date_to": { + "type": "string", + "format": "int64" + }, + "emails_count": { + "type": "string", + "format": "int64" } } }, - "api.LDAP.UpdateLDAPTemplateBody": { + "casesGetTimelineResponse": { "type": "object", "properties": { - "fields": { + "days": { "type": "array", - "title": "OPTIONAL. Fields for partial update. PATCH", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/casesDayTimeline" } }, - "template": { - "description": "Template changes.", - "type": "object", - "title": "Template changes.", - "properties": { - "agent": { - "type": "object", - "title": "OPTIONAL. Agent objclass fields mapping" - }, - "base_dn": { - "type": "string", - "title": "Optional. LDAP Search base entry DN" - }, - "catalog": { - "type": "object", - "title": "LDAPCatalog belongs to", - "properties": { - "name": { - "type": "string", - "title": "display name" - } - } - }, - "created_at": { - "description": "unix", - "type": "string", - "format": "int64", - "title": "READONLY. Operational attributes" - }, - "created_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" - }, - "device": { - "type": "object", - "title": "OPTIONAL. Device objclass fields mapping" - }, - "enabled": { - "type": "boolean", - "title": "Optional. This Template is activated ?" - }, - "name": { - "type": "string", - "title": "Name this template" - }, - "role": { - "type": "object", - "title": "OPTIONAL. Role objclass fields mapping (Not implemented yet)" - }, - "search": { - "type": "string", - "title": "Required. LDAP Search filter string" - }, - "updated_at": { - "type": "string", - "format": "int64", - "title": "unix" - }, - "updated_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" - }, - "user": { - "type": "object", - "title": "OPTIONAL. User objclass fields mapping" - } - } + "next": { + "type": "boolean" + }, + "page": { + "type": "integer", + "format": "int32" } } }, - "api.LDAPCatalog": { + "casesInputCase": { "type": "object", - "title": "LDAPCatalog profile", "properties": { - "base_dn": { - "type": "string", - "title": "base_dn, aka domain e.g.: 'dc=example,dc=org'" - }, - "bind": { - "description": "authorization method e.g.: SIMPLE, SAML, NTLM, etc.", - "type": "string", - "title": "----- BIND: Authorization -----" - }, - "created_at": { - "description": "unix", - "type": "string", - "format": "int64", - "title": "basic: last operation details" + "assignee": { + "title": "create: not required, default from service or set by UI;", + "$ref": "#/definitions/generalLookup" }, - "created_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" + "close": { + "title": "create: not required; update: required only when case status goes to the final state", + "$ref": "#/definitions/casesCloseInfo" }, - "cron": { - "description": "[CRON]OS SPEC ! github.com/robfig/cron/v3", - "type": "string", - "title": "----- RSYNC Processing -----\nint32 priority = 4;" + "close_reason": { + "title": "create: not required;", + "$ref": "#/definitions/generalLookup" }, - "entry_modify": { + "contact_info": { "type": "string", - "title": "last modification timestamp attribute type" + "title": "create: not required;" }, - "entry_uuid": { - "description": "entry unique id (except DN which may be updated)", + "description": { "type": "string", - "title": "----- DOMAIN: Entry model -----" + "title": "create: not required;" }, - "id": { - "type": "string", - "format": "int64", - "title": "identity\nint64 dc = 1;" + "etag": { + "type": "string" }, - "name": { - "type": "string", - "title": "Meaningfull title name" + "group": { + "title": "create: not required, default from service or set by UI;", + "$ref": "#/definitions/generalLookup" }, - "password": { - "type": "string", - "title": "password" + "impacted": { + "title": "create: required, default is reporter or ui (if empty recognize as anonymous);", + "$ref": "#/definitions/generalLookup" }, - "process": { - "title": "Last OR Current SYNC process details", - "$ref": "#/definitions/api.LDAProcess" + "priority": { + "title": "create: not required, default first value from priority lookup", + "$ref": "#/definitions/generalLookup" }, - "sync": { - "$ref": "#/definitions/api.LDAProcessOptions" + "rate": { + "title": "only for API, not UI", + "$ref": "#/definitions/casesRateInfo" }, - "templates": { - "type": "array", - "title": "// // ----- MAP: user(s) settings -----\nLDAPUsersMap users = 26; // DEPRECATED: Use Template(s) instead\nSYNC Object's search and mappings", - "items": { - "type": "object", - "$ref": "#/definitions/api.LDAPTemplate" - } + "reporter": { + "title": "create: required (if empty recognize as anonymous contact);", + "$ref": "#/definitions/generalLookup" }, - "tls": { - "$ref": "#/definitions/api.LDAPCatalog.TLSConfig" + "service": { + "title": "on this field base many other readonly fields on return", + "$ref": "#/definitions/generalLookup" }, - "updated_at": { - "type": "string", - "format": "int64", - "title": "unix" + "source": { + "title": "source of the case", + "$ref": "#/definitions/generalLookup" }, - "updated_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" + "status": { + "title": "create: not required, default initial value from status lookup or ui;", + "$ref": "#/definitions/generalLookup" }, - "url": { - "description": "URL e.g.: [(ldap|ldapi|ldaps)://]host[:port]", - "type": "string", - "title": "----- Connection Options -----" + "status_condition": { + "$ref": "#/definitions/casesStatusCondition" }, - "username": { + "subject": { "type": "string", - "title": "bind_dn" + "title": "create: required;" } } }, - "api.LDAPCatalog.TLSConfig": { + "casesInputCaseComment": { + "description": "Input structure for creating or updating a case comment.", "type": "object", - "title": "TLS configuration options", "properties": { - "ca": { - "type": "string", - "format": "byte", - "title": "PEM: base64" + "etag": { + "description": "Identifier for the comment.", + "type": "string" }, - "cert": { - "description": "PEM: base64", - "type": "string", - "format": "byte", - "title": "TODO: (!)" + "text": { + "description": "Content of the comment.", + "type": "string" + } + }, + "example": { + "text": "My new comment" + } + }, + "casesInputCaseCommunication": { + "description": "Represents input data for creating or linking a communication.", + "type": "object", + "properties": { + "communication_id": { + "description": "External communication ID.", + "type": "string" }, - "key": { - "type": "string", - "format": "byte", - "title": "PEM: base64" + "communication_type": { + "description": "Type of the communication.", + "$ref": "#/definitions/casesCaseCommunicationsTypes" } } }, - "api.LDAPControl": { + "casesInputCaseLink": { "type": "object", - "title": "https://datatracker.ietf.org/doc/html/rfc4511#section-4.1.11", "properties": { - "controlType": { - "type": "string", - "title": "LDAPOID," + "etag": { + "type": "string" }, - "controlValue": { - "type": "string", - "title": "OCTET STRING OPTIONAL" + "name": { + "type": "string" }, - "criticality": { - "type": "boolean", - "title": "BOOLEAN DEFAULT FALSE," + "url": { + "type": "string" } } }, - "api.LDAPObjentry": { + "casesInputCatalog": { "type": "object", - "title": "LDAP entry object associatetions performed", + "title": "InputCatalog message contains the fields for creating or updating a catalog", "properties": { - "class": { + "close_reason_group": { + "title": "Close reason group ID associated with the catalog", + "$ref": "#/definitions/generalLookup" + }, + "code": { "type": "string", - "title": "Internal object class been associated with this LDAP .entry" + "title": "Code for external integrations (optional)" }, - "entry": { - "description": "map\u003cstring, string\u003e entry = 1;", - "type": "object", - "title": "LDAP Entry Attributes fetched" + "description": { + "type": "string", + "title": "Description of the catalog (optional)" }, - "errs": { + "name": { + "type": "string", + "title": "Name of the catalog (required)" + }, + "prefix": { + "type": "string", + "title": "Prefix for case identification (optional)" + }, + "skills": { "type": "array", - "title": "FATAL Error(s). NON empty indicates that this process failed", + "title": "List of skill IDs associated with the catalog", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/generalLookup" } }, - "object": { - "type": "object", - "title": "Internal object state; DUMP" + "sla": { + "title": "SLA ID associated with the catalog", + "$ref": "#/definitions/generalLookup" }, - "proc": { - "type": "string", - "title": "Operation been performed: create|update|delete" + "state": { + "type": "boolean", + "title": "State of the catalog (true for active, false for inactive)" }, - "warn": { + "status": { + "title": "Status ID associated with the catalog", + "$ref": "#/definitions/generalLookup" + }, + "teams": { "type": "array", - "title": "An error(s) if any occured\nNON-FATAL Warnings", + "title": "List of team IDs associated with the catalog", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/generalLookup" } } } }, - "api.LDAPSearchRequest": { + "casesInputCloseReason": { "type": "object", - "title": "https://datatracker.ietf.org/doc/html/rfc4511#section-4.5.1", + "title": "InputCloseReason message for inputting close reason data", "properties": { - "attributes": { - "type": "array", - "title": "AttributeSelection", - "items": { - "type": "string" - } - }, - "baseObject": { + "description": { "type": "string", - "title": "----- SearchRequest -----\nbaseObject [D]istinguished[N]ame" + "title": "Description of the close reason" }, - "bind": { - "description": "authorization method e.g.: SIMPLE, SAML, NTLM, etc.", + "name": { "type": "string", - "title": "----- BIND: Authorization -----" + "title": "Name of the close reason" + } + } + }, + "casesInputCloseReasonGroup": { + "type": "object", + "properties": { + "description": { + "type": "string" }, - "catalog_id": { - "type": "string", - "format": "int64", - "title": "----- connection -----\nOptional. ID of the preconfigured LDAP catalog" + "name": { + "type": "string" + } + } + }, + "casesInputCreateCase": { + "description": "Input structure for creating a new case.", + "type": "object", + "properties": { + "assignee": { + "description": "Optional assignee ID.", + "$ref": "#/definitions/generalLookup" }, - "controls": { + "close": { + "description": "Optional close information.", + "$ref": "#/definitions/casesCreateCaseCloseInput" + }, + "close_reason_group": { + "description": "Optional close reason.", + "$ref": "#/definitions/generalLookup" + }, + "contact_info": { + "description": "Optional contact information.", + "type": "string" + }, + "description": { + "description": "Optional description of the case.", + "type": "string" + }, + "group": { + "description": "Optional group ID.", + "$ref": "#/definitions/generalLookup" + }, + "impacted": { + "description": "Required impacted user ID (default: reporter).", + "$ref": "#/definitions/generalLookup" + }, + "links": { + "description": "List of links attached to the case.", "type": "array", - "title": "----- LDAPMessage -----\nControls NOT implemented yet !", "items": { "type": "object", - "$ref": "#/definitions/api.LDAPControl" + "$ref": "#/definitions/casesInputCaseLink" } }, - "derefAliases": { - "type": "integer", - "format": "int32", - "title": "neverDerefAliases (0),\nderefInSearching (1),\nderefFindingBaseObj (2),\nderefAlways (3)" + "priority": { + "description": "Optional priority level.", + "$ref": "#/definitions/generalLookup" }, - "filter": { - "type": "string", - "title": "Filter," + "rate": { + "description": "API-only rating information.", + "$ref": "#/definitions/casesRateInfo" }, - "password": { - "type": "string", - "title": "password" + "related": { + "description": "List of related cases.", + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/casesCreateCaseRelatedCaseInput" + } }, - "scope": { - "type": "integer", - "format": "int32", - "title": "baseObject (0),\nsingleLevel (1),\nwholeSubtree (2)" + "reporter": { + "description": "Required reporter ID (if empty, anonymous contact).", + "$ref": "#/definitions/generalLookup" }, - "sizeLimit": { - "type": "string", - "format": "int64", - "title": "INTEGER (0 .. maxInt)," + "service": { + "description": "Service ID (affects many other readonly fields).", + "$ref": "#/definitions/generalLookup" }, - "timeLimit": { - "type": "string", - "format": "int64", - "title": "INTEGER (0 .. maxInt)," + "source": { + "description": "Source of the case.", + "$ref": "#/definitions/generalLookup" }, - "tls": { - "$ref": "#/definitions/api.LDAPSearchRequest.TLSConfig" + "status": { + "description": "Initial case status (default from lookup or UI).", + "$ref": "#/definitions/generalLookup" }, - "typesOnly": { - "type": "boolean", - "title": "BOOLEAN," + "subject": { + "description": "Required subject of the case.", + "type": "string" + } + } + }, + "casesInputPriority": { + "type": "object", + "title": "InputPriority message for creating a new priority", + "properties": { + "color": { + "type": "string", + "title": "Color of the priority" }, - "url": { - "description": "URL e.g.: [(ldap|ldapi|ldaps)://]host[:port]", + "description": { "type": "string", - "title": "Optional. URL to establish connection to LDAP catalog" + "title": "Description of the priority" }, - "username": { + "name": { "type": "string", - "title": "bind_dn" + "title": "Name of the priority" } } }, - "api.LDAPSearchRequest.TLSConfig": { + "casesInputRelatedCase": { + "description": "Input for creating or updating a related case.", "type": "object", - "title": "TLS configuration options", "properties": { - "PEM": { - "description": "base64", - "type": "string", - "format": "byte", - "title": "TODO: (!)" + "primary_case": { + "description": "Primary case details.", + "$ref": "#/definitions/generalLookup" + }, + "related_case": { + "description": "Related case details.", + "$ref": "#/definitions/generalLookup" + }, + "relation_type": { + "description": "Relation type.", + "$ref": "#/definitions/casesRelationType" } } }, - "api.LDAPSearchResponse": { + "casesInputSLA": { "type": "object", - "title": "https://datatracker.ietf.org/doc/html/rfc4511#section-4.5.2", + "title": "InputSLA message for inputting SLA data", "properties": { - "controls": { - "type": "array", - "title": "----- LDAPMessage -----", - "items": { - "type": "object", - "$ref": "#/definitions/api.LDAPControl" - } + "calendar": { + "title": "Calendar ID from the \"Calendars\" dictionary", + "$ref": "#/definitions/generalLookup" }, - "diagnosticMessage": { + "description": { "type": "string", - "title": "LDAPString," + "title": "Description of the SLA" }, - "entries": { - "type": "array", - "title": "----- SearchResult (Entry|Reference) -----", - "items": { - "type": "object" - } + "name": { + "type": "string", + "title": "Name of the SLA" }, - "matchedDN": { + "reaction_time": { "type": "string", - "title": "LDAPDN," + "format": "int64", + "title": "Reaction time" }, - "referral": { - "type": "array", - "title": "[3] Referral OPTIONAL", - "items": { - "type": "string" - } + "resolution_time": { + "type": "string", + "format": "int64", + "title": "Resolution time" }, - "resultCode": { - "type": "integer", - "format": "int32", - "title": "----- LDAPResult -----" + "valid_from": { + "type": "string", + "format": "int64", + "title": "Validity period for the SLA" + }, + "valid_to": { + "type": "string", + "format": "int64" } } }, - "api.LDAPTemplate": { + "casesInputSLACondition": { "type": "object", - "title": "LDAPTemplate is an LDAP search entries to webitel objects transformation template", + "title": "InputSLACondition message for inputting SLACondition data", "properties": { - "agent": { - "type": "object", - "title": "OPTIONAL. Agent objclass fields mapping" - }, - "base_dn": { - "type": "string", - "title": "Optional. LDAP Search base entry DN" + "name": { + "type": "string" }, - "catalog": { - "title": "LDAPCatalog belongs to", - "$ref": "#/definitions/api.ObjectId" + "priorities": { + "type": "array", + "title": "List of priority IDs for creation", + "items": { + "type": "object", + "$ref": "#/definitions/generalLookup" + } }, - "created_at": { - "description": "unix", + "reaction_time": { "type": "string", - "format": "int64", - "title": "READONLY. Operational attributes" - }, - "created_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" + "format": "int64" }, - "device": { - "type": "object", - "title": "OPTIONAL. Device objclass fields mapping" + "resolution_time": { + "type": "string", + "format": "int64" }, - "enabled": { - "type": "boolean", - "title": "Optional. This Template is activated ?" + "sla_id": { + "type": "string", + "format": "int64" + } + } + }, + "casesInputService": { + "type": "object", + "title": "InputService message contains the fields for creating or updating a service", + "properties": { + "assignee": { + "title": "Assignee ID responsible for the service", + "$ref": "#/definitions/generalLookup" }, - "id": { + "catalog_id": { "type": "string", "format": "int64", - "title": "ID unique" + "title": "The parent catalog (required)" + }, + "code": { + "type": "string", + "title": "Code for external integrations (optional)" }, - "name": { + "description": { "type": "string", - "title": "Name this template" + "title": "Description of the service (optional)" }, - "role": { - "type": "object", - "title": "OPTIONAL. Role objclass fields mapping (Not implemented yet)" + "group": { + "title": "Group ID responsible for the service", + "$ref": "#/definitions/generalExtendedLookup" }, - "search": { + "name": { "type": "string", - "title": "Required. LDAP Search filter string" + "title": "Name of the service (required)" }, - "updated_at": { + "root_id": { "type": "string", "format": "int64", - "title": "unix" + "title": "ID of the root catalog" }, - "updated_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" + "sla": { + "title": "SLA ID associated with the service", + "$ref": "#/definitions/generalLookup" }, - "user": { - "type": "object", - "title": "OPTIONAL. User objclass fields mapping" + "state": { + "type": "boolean", + "title": "State of the service (true for active, false for inactive)" } } }, - "api.LDAPTemplateResponse": { + "casesInputSource": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/api.LDAPTemplate" - } + "description": { + "description": "The description of the source.", + "type": "string" }, - "next": { - "type": "boolean", - "title": "result: has {next} page ?" + "name": { + "description": "The name of the source.", + "type": "string" }, - "page": { - "type": "integer", - "format": "int32", - "title": "result: {page} number" + "type": { + "description": "The source type of the source.", + "$ref": "#/definitions/casesSourceType" } } }, - "api.LDAProcess": { + "casesInputStatus": { "type": "object", - "title": "LDAP synchronization process details", "properties": { - "complete_at": { - "description": "Optional. If not \u003czero\u003e indicates that this process is completed.", - "type": "string", - "format": "int64" - }, - "execute_at": { - "type": "string", - "format": "int64", - "title": "Readonly. Process start timestamp" - }, - "execute_by": { - "title": "Optional. Start manually by the user or role", - "$ref": "#/definitions/api.RoleId" - }, - "id": { - "type": "string", - "format": "int64", - "title": "Readonly. Process unique identifier" - }, - "options": { - "title": "Readonly. Executed with options", - "$ref": "#/definitions/api.LDAProcessOptions" - }, - "progress": { - "type": "array", - "title": "Optional. List of entries been already processed", - "items": { - "type": "object", - "$ref": "#/definitions/api.LDAPObjentry" - } + "description": { + "type": "string" }, - "status": { - "type": "string", - "title": "Optional. Status description or an error if any occured" + "name": { + "type": "string" } } }, - "api.LDAProcessOptions": { + "casesInputStatusCondition": { "type": "object", + "title": "InputStatusCondition message for inputting status condition data", "properties": { - "link_existing_objects": { - "type": "boolean", - "title": "Allows to create links\nwith fetched LDAP entries\nfor manually created objects" + "description": { + "type": "string", + "title": "Description of the status condition" }, - "reassign_device_users": { + "final": { "type": "boolean", - "title": "Allows to reassign device's owner user\ndue to preconfigured mapping LDAP template" + "title": "Final status condition" }, - "test": { + "initial": { "type": "boolean", - "title": "Will NOT perform any operations on storage.\nTo review potential processing only" + "title": "Initial status condition" }, - "timeout": { + "name": { "type": "string", - "format": "int64", - "title": "Operation timeout. Not implemented yet" + "title": "Name of the status condition" } } }, - "api.LDAProcessResponse": { + "casesLinkCommunicationResponse": { + "description": "Response message after linking communications to a case.", "type": "object", "properties": { - "items": { + "data": { + "description": "List of linked communications.", "type": "array", "items": { "type": "object", - "$ref": "#/definitions/api.LDAProcess" + "$ref": "#/definitions/casesCaseCommunication" } - }, - "next": { - "type": "boolean", - "title": "result: has {next} page ?" - }, - "page": { - "type": "integer", - "format": "int32", - "title": "result: {page} number" } } }, - "api.LicenseUsageResponse": { + "casesListCommunicationsResponse": { + "description": "Response message for listing communications linked to a case.", "type": "object", "properties": { - "items": { + "data": { + "description": "List of communications.", "type": "array", - "title": "size = (.next ? len(items) : undef (\u003e len(size)))\n----- Result entries ----- //", "items": { "type": "object", - "$ref": "#/definitions/api.LicenseV1" + "$ref": "#/definitions/casesCaseCommunication" } }, "next": { - "type": "boolean", - "title": "next page exists ? more results ?" + "type": "boolean" }, "page": { - "description": "this page number !", + "description": "Current page number.", "type": "integer", - "format": "int32", - "title": "----- Result paging ----- //" + "format": "int32" } } }, - "api.LicenseUser": { + "casesLocateCatalogResponse": { "type": "object", - "title": "USAGE details", + "title": "LocateCatalogResponse message contains a single catalog entity", "properties": { - "expires_at": { - "type": "string", - "format": "int64", - "title": "not after" - }, - "id": { - "type": "string", - "title": "license.id" - }, - "issued_at": { - "type": "string", - "format": "int64", - "title": "not before" - }, - "prod": { - "type": "string", - "title": "license.prod" - }, - "scope": { - "type": "array", - "title": "setof objclass grants", - "items": { - "type": "string" - } - }, - "user": { - "title": "grant to::user", - "$ref": "#/definitions/api.ObjectId" + "catalog": { + "title": "The located catalog", + "$ref": "#/definitions/casesCatalog" } } }, - "api.LicenseUsersResponse": { + "casesLocateCloseReasonGroupResponse": { "type": "object", + "title": "LocateCloseReasonGroupResponse message contains a single close reason group entity", "properties": { - "items": { - "type": "array", - "title": "size = (.next ? len(items) : undef (\u003e len(size)))\n----- Result entries ----- //", - "items": { - "type": "object", - "$ref": "#/definitions/api.ProductUser" - } - }, - "next": { - "type": "boolean", - "title": "next page exists ? more results ?" - }, - "page": { - "description": "this page number !", - "type": "integer", - "format": "int32", - "title": "----- Result paging ----- //" + "close_reason_group": { + "$ref": "#/definitions/casesCloseReasonGroup" } } }, - "api.LicenseV1": { + "casesLocateCloseReasonResponse": { "type": "object", + "title": "LocateCloseReasonResponse message contains a single close reason entity", "properties": { - "competitive": { - "type": "boolean" - }, - "id": { - "type": "string", - "title": "serial number assigned (global::License-ID)" - }, - "limit": { - "type": "integer", - "format": "int32", - "title": "required: limit count (maximum allowed usage quantity)" - }, - "not_after": { - "type": "string", - "format": "int64", - "title": "optional" - }, - "not_before": { - "type": "string", - "format": "int64", - "title": "optional" - }, - "product": { - "type": "string", - "title": "product name, e.g.: DEVICE, MANAGER, OPERATOR" - }, - "remain": { - "description": "available", - "type": "integer", - "format": "int32", - "title": "operational attributes ...\nremain = limit - len(users)" - }, - "scope": { - "description": "list of known classes, \u0026this product grants mandatory access to, e.g.: 'users', 'roles', 'cc_agent', 'calendars', ...", - "type": "array", - "items": { - "type": "string" - } - }, - "status": { - "$ref": "#/definitions/api.Verification" - }, - "users": { - "type": "array", - "title": "users.id (grantees)", - "items": { - "type": "object", - "$ref": "#/definitions/api.LicenseUser" - } + "close_reason": { + "$ref": "#/definitions/casesCloseReason" } } }, - "api.ListAccessResponseV1": { + "casesLocatePriorityResponse": { "type": "object", + "title": "LocatePriorityResponse message contains a single priority entity", "properties": { - "items": { - "type": "array", - "title": "endregion", - "items": { - "type": "object", - "$ref": "#/definitions/api.AccessRule" - } - }, - "next": { - "type": "boolean", - "title": "indicate partial response: ( next || page \u003e 1 ? partial : full )" - }, - "page": { - "type": "integer", - "format": "int32", - "title": "region: paged result control response value" + "priority": { + "$ref": "#/definitions/casesPriority" } } }, - "api.ListRegistrationsResponse": { + "casesLocateSLAConditionResponse": { "type": "object", + "title": "LocateSLAConditionResponse message contains a single SLACondition entity", "properties": { - "items": { - "type": "array", - "title": "registered", - "items": { - "type": "object", - "$ref": "#/definitions/api.Registration" - } - }, - "next": { - "type": "boolean", - "title": "search: has {next} page ?" - }, - "page": { - "type": "integer", - "format": "int32", - "title": "select: offset {page}" - }, - "size": { - "type": "integer", - "format": "int32", - "title": "search: limit {size}" + "sla_condition": { + "$ref": "#/definitions/casesSLACondition" } } }, - "api.LoginResponse": { + "casesLocateSLAResponse": { "type": "object", + "title": "LocateSLAResponse message contains a single SLA entity", "properties": { - "authorization": { - "$ref": "#/definitions/api.AccessToken" + "sla": { + "$ref": "#/definitions/casesSLA" } } }, - "api.LogoutUserResponse": { - "type": "object" - }, - "api.OAuth2Federation.DeleteOAuthServiceBody": { + "casesLocateServiceResponse": { "type": "object", + "title": "LocateServiceResponse message contains a single service entity", "properties": { - "permanent": { - "type": "boolean" + "service": { + "title": "The located service", + "$ref": "#/definitions/casesService" } } }, - "api.OAuth2Federation.UpdateOAuthServiceBody": { + "casesLocateSourceResponse": { + "description": "Response message for locating a source.", "type": "object", "properties": { - "changes": { - "description": "Configuration changes.", - "type": "object", - "title": "Configuration changes.", - "properties": { - "auth_url": { - "type": "string", - "title": "OAuth 2.0 Authorization Endpoint" - }, - "claims": { - "description": "google.protobuf.Struct claims = 7;", - "type": "array", - "title": "Identity claims policy rules\nNOTE: Order matters", - "items": { - "type": "object", - "$ref": "#/definitions/api.Claim" - } - }, - "client_id": { - "type": "string" - }, - "client_secret": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "int64", - "title": "unix" - }, - "created_by": { - "title": "user", - "$ref": "#/definitions/api.ObjectId" - }, - "discovery_url": { - "type": "string", - "title": "OpenID Connect Service Discovery" - }, - "domain": { - "$ref": "#/definitions/api.ObjectId" - }, - "enabled": { - "type": "boolean" - }, - "logo": { - "type": "string" - }, - "metadata": { - "type": "object" - }, - "name": { - "type": "string", - "title": "display" - }, - "scopes": { - "type": "array", - "title": "Scopes to be requested", - "items": { - "type": "string" - } - }, - "token_url": { - "type": "string", - "title": "OAuth 2.0 Token Endpoint" - }, - "type": { - "type": "string", - "title": "well-known vendor; provider" - }, - "updated_at": { - "type": "string", - "format": "int64", - "title": "unix" - }, - "updated_by": { - "title": "user", - "$ref": "#/definitions/api.ObjectId" - }, - "userinfo_url": { - "type": "string", - "title": "OpenID Connect Userinfo Endpoint" - } - } - }, - "fields": { - "type": "array", - "title": "Fields for partial update. PATCH", - "items": { - "type": "string" - } + "source": { + "description": "The located source.", + "$ref": "#/definitions/casesSource" } } }, - "api.OAuthService": { + "casesLocateStatusConditionResponse": { "type": "object", - "title": "OAuth 2.0 Authentication [S]ervice [P]rovider Application Configuration", + "title": "LocateStatusConditionResponse message contains a single status entity", "properties": { - "auth_url": { - "type": "string", - "title": "OAuth 2.0 Authorization Endpoint" - }, - "claims": { - "description": "google.protobuf.Struct claims = 7;", - "type": "array", - "title": "Identity claims policy rules\nNOTE: Order matters", - "items": { - "type": "object", - "$ref": "#/definitions/api.Claim" - } - }, - "client_id": { - "type": "string" - }, - "client_secret": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "int64", - "title": "unix" - }, - "created_by": { - "title": "user", - "$ref": "#/definitions/api.ObjectId" - }, - "discovery_url": { - "type": "string", - "title": "OpenID Connect Service Discovery" - }, - "domain": { - "$ref": "#/definitions/api.ObjectId" - }, - "enabled": { - "type": "boolean" - }, - "id": { - "type": "string", - "format": "int64" - }, - "logo": { - "type": "string" - }, - "metadata": { - "type": "object" - }, - "name": { - "type": "string", - "title": "display" - }, - "scopes": { - "type": "array", - "title": "Scopes to be requested", - "items": { - "type": "string" - } - }, - "token_url": { - "type": "string", - "title": "OAuth 2.0 Token Endpoint" - }, - "type": { - "type": "string", - "title": "well-known vendor; provider" - }, - "updated_at": { - "type": "string", - "format": "int64", - "title": "unix" - }, - "updated_by": { - "title": "user", - "$ref": "#/definitions/api.ObjectId" - }, - "userinfo_url": { - "type": "string", - "title": "OpenID Connect Userinfo Endpoint" + "status": { + "$ref": "#/definitions/casesStatusCondition" + } + } + }, + "casesLocateStatusResponse": { + "type": "object", + "title": "LocateStatusResponse message contains a single status entity", + "properties": { + "status": { + "$ref": "#/definitions/webitelcasesStatus" } } }, - "api.Objclass": { + "casesPriority": { "type": "object", - "title": "AccessScope represents authorized access level\nto object class declaration within domain namespace", + "title": "Priority message represents a priority entity with metadata", "properties": { - "abac": { - "description": "[A]ttribute-[b]ased; not implemented; next releases ...", - "type": "boolean", - "title": "Is [?]-[b]ased [A]ccess [C]ontrol *model enabled ?" + "color": { + "type": "string", + "title": "Color of the priority" }, - "access": { - "description": "flags: [ CREATE | SELECT | UPDATE | DELETE ]", + "created_at": { "type": "string", - "title": "Extension: discretionary access control" + "format": "int64", + "title": "CreatedAt timestamp of the priority" }, - "class": { + "created_by": { + "title": "CreatedBy user of the priority", + "$ref": "#/definitions/generalLookup" + }, + "description": { "type": "string", - "title": "class: alphanumeric code name" + "title": "Description of the priority" }, "id": { - "description": "class: object id", "type": "string", "format": "int64", - "title": "Inherit::ObjectClass" + "title": "Unique identifier of the priority" }, "name": { "type": "string", - "title": "class: display common name" + "title": "Name of the priority" }, - "obac": { - "type": "boolean", - "title": "[O]peration-[b]ased; Mandatory: control access to object.class (alias: collection, section, etc.)" + "updated_at": { + "type": "string", + "format": "int64", + "title": "UpdatedAt timestamp of the priority" }, - "rbac": { - "type": "boolean", - "title": "[R]ecord-[b]ased; Discretionary: control access to object.entry (alias: resource, record, etc.)" + "updated_by": { + "title": "UpdatedBy user of the priority", + "$ref": "#/definitions/generalLookup" } } }, - "api.ObjectClass": { + "casesPriorityList": { "type": "object", + "title": "PriorityList message contains a list of Priority items with pagination", "properties": { - "abac": { - "type": "boolean", - "title": "[a]ttribute-[b]ased [a]ccess [c]ontrol" - }, - "class": { - "type": "string", - "title": "(class::object).name" - }, - "id": { - "type": "string", - "format": "int64", - "title": "(class::object).id" + "items": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/casesPriority" + } }, - "obac": { - "type": "boolean", - "title": "[o]peration-[b]ased [a]ccess [c]ontrol (from::collection.dal)" + "next": { + "type": "boolean" }, - "rbac": { - "type": "boolean", - "title": "[r]ecord-[b]ased [a]ccess [c]ontrol (from::resource.acl)" + "page": { + "type": "integer", + "format": "int32" } } }, - "api.ObjectId": { + "casesRateInfo": { + "description": "Message representing rating information.", "type": "object", "properties": { - "id": { + "rating": { + "description": "Rating value.", "type": "string", - "format": "int64", - "title": "identifier" + "format": "int64" }, - "name": { - "type": "string", - "title": "display name" + "rating_comment": { + "description": "Optional comment for the rating.", + "type": "string" } } }, - "api.Organization": { + "casesRelatedCase": { + "description": "Represents a related case with its relationship details.", "type": "object", "properties": { - "country": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "int64", - "title": "unix" - }, - "createdBy": { - "type": "string", - "title": "user" - }, - "dc": { - "type": "string", - "format": "int64", - "title": "component" - }, - "domain": { + "created_at": { + "description": "Timestamp (in milliseconds) of when the relation was created.", "type": "string", - "title": "FQDN" - }, - "email": { - "type": "string" - }, - "locality": { - "type": "string" - }, - "organization": { - "type": "string" + "format": "int64" }, - "postalAddress": { - "type": "string" + "created_by": { + "description": "User who created the relation.", + "$ref": "#/definitions/generalLookup" }, - "postalCode": { + "etag": { + "description": "Etag for the related case entity.", "type": "string" }, - "stateOrProvince": { - "type": "string" + "id": { + "description": "Unique identifier for the related case.", + "type": "string", + "format": "int64" }, - "streetAddress": { - "type": "string" + "primary_case": { + "description": "Primary case details.", + "$ref": "#/definitions/casesRelatedCaseLookup" }, - "telephoneNumber": { - "type": "string" + "related_case": { + "description": "Related case details.", + "$ref": "#/definitions/casesRelatedCaseLookup" }, - "updatedAt": { - "type": "string", - "format": "int64", - "title": "unix" + "relation_type": { + "description": "Relation type between cases.", + "$ref": "#/definitions/casesRelationType" }, - "updatedBy": { + "updated_at": { + "description": "Timestamp (in milliseconds) of the last update.", "type": "string", - "title": "user" - } - } - }, - "api.Permission": { - "type": "object", - "properties": { - "id": { - "description": "[required] e.g.: 'read', 'playback_record_file', ...", - "type": "string" + "format": "int64" }, - "name": { - "type": "string", - "title": "[optional] e.g.: 'Select Any'" + "updated_by": { + "description": "User who last updated the relation.", + "$ref": "#/definitions/generalLookup" }, - "usage": { - "type": "string", - "title": "[optional] e.g.: 'Grants permission to select any objects'" + "ver": { + "description": "Version number of the related case, used for concurrency control.", + "type": "integer", + "format": "int32" } } }, - "api.Presence.SetStatusBody": { + "casesRelatedCaseList": { + "description": "Paginated list of related cases.", "type": "object", "properties": { - "fields": { + "data": { + "description": "List of related cases on the current page.", "type": "array", - "title": "PATCH: partial attributes", "items": { - "type": "string" + "type": "object", + "$ref": "#/definitions/casesRelatedCase" } }, - "publish": { - "description": "BODY: partial modifications", - "type": "object", - "title": "int64 id = 1; // user.id", - "properties": { - "expires": { - "type": "integer", - "format": "int32", - "title": "[optional] \u003cnote\u003e will be cleaned up after seconds" - }, - "note": { - "type": "string", - "title": "[optional] human readable comment" - }, - "status": { - "type": "string", - "title": "[optional] set of unique 'active' presentities {dnd,dlg,sip,wss}; assume {offline} if omitted" - }, - "timestamp": { - "type": "string", - "format": "int64", - "title": "[required] last activity time" - } - } + "next": { + "description": "Flag to indicate if more pages are available.", + "type": "boolean" + }, + "page": { + "description": "Current page number.", + "type": "string", + "format": "int64" } } }, - "api.PresenceStatus": { + "casesRelatedCaseLookup": { + "description": "RelatedCaseLookup is created specifically to include the subject field.", "type": "object", - "title": "PresenceStatus PUBLISH", "properties": { - "app": { - "type": "string", - "title": "[optional] service node identity" - }, - "closed": { - "type": "boolean", - "title": "[optional] signify \u003cstatus\u003e tuple gone from user's presence; equls to (open == 0)" - }, - "contact": { - "type": "string", - "title": "[optional] communication \u003curl\u003e" - }, - "domain_id": { - "type": "string", - "format": "int64", - "title": "[hidden] for cluster purpose" + "etag": { + "type": "string" }, - "expires": { + "id": { "type": "string", "format": "int64", - "title": "NOTE: \u003cdnd\u003e actualy has no expires until user manualy switch it off" + "title": "id" }, - "id": { - "description": "[required] tuple unique id; \u003ctrack\u003e", + "name": { "type": "string", - "title": "basic:latest" + "title": "name" }, - "note": { + "subject": { "type": "string", - "title": "[optional] human readable comment" + "title": "subject" }, - "open": { + "ver": { "type": "integer", "format": "int32", - "title": "[optional] positive value signify 'active'" + "title": "ver" + } + } + }, + "casesRelationType": { + "description": "Enum for relation types between cases.", + "type": "string", + "default": "RELATION_TYPE_UNSPECIFIED", + "enum": [ + "RELATION_TYPE_UNSPECIFIED", + "DUPLICATES", + "IS_DUPLICATED_BY", + "BLOCKS", + "IS_BLOCKED_BY", + "CAUSES", + "IS_CAUSED_BY", + "IS_CHILD_OF", + "IS_PARENT_OF", + "RELATES_TO" + ] + }, + "casesSLA": { + "type": "object", + "title": "SLA message represents an SLA entity with metadata", + "properties": { + "calendar": { + "title": "Calendar ID from the \"Calendars\" dictionary - required", + "$ref": "#/definitions/generalLookup" }, - "presence": { - "description": "// FIXME: well-known types ?\r\n repeated Dialog call = 9;\r\n repeated Sipreg sip = 9;\r\n repeated Websock wss = 9;", - "type": "array", - "title": "detailed: -registered -tracking tuples", - "items": { - "type": "object", - "$ref": "#/definitions/api.PresenceStatus" - } + "created_at": { + "type": "string", + "format": "int64", + "title": "CreatedAt timestamp of the SLA" }, - "priority": { - "type": "integer", - "format": "int32", - "title": "[optional] importance level of this within presentity's" + "created_by": { + "title": "CreatedBy user of the SLA", + "$ref": "#/definitions/generalLookup" }, - "sequence": { + "description": { + "type": "string", + "title": "Description of the SLA - optional" + }, + "id": { "type": "string", "format": "int64", - "title": "[optional] this tuple (document) modifications version" + "title": "Unique identifier of the SLA" }, - "status": { + "name": { "type": "string", - "title": "[optional] unique set of \u003cenum:dnd|call|sip|wss\u003e; assume \u003coffline\u003e if blank; \u003cscope\u003e on request" + "title": "Name of the SLA - required" }, - "timestamp": { + "reaction_time": { "type": "string", "format": "int64", - "title": "[required] opened time" - } - } - }, - "api.ProductUser": { - "type": "object", - "title": "ProductUser GRANT details", - "properties": { - "domain": { - "title": "grant to::domain", - "$ref": "#/definitions/api.ObjectId" + "title": "Reaction time - required" }, - "expires_at": { + "resolution_time": { "type": "string", "format": "int64", - "title": "not after" + "title": "Resolution time - required" }, - "issued_at": { + "updated_at": { "type": "string", "format": "int64", - "title": "not before" + "title": "UpdatedAt timestamp of the SLA" }, - "sessions": { - "type": "integer", - "format": "int32", - "title": "User's active sessions count !" + "updated_by": { + "title": "UpdatedBy user of the SLA", + "$ref": "#/definitions/generalLookup" }, - "user": { - "title": "grant to::user", - "$ref": "#/definitions/api.ObjectId" - } - } - }, - "api.ReadClassResponse": { - "type": "object", - "properties": { - "class": { - "$ref": "#/definitions/api.ObjectClass" - } - } - }, - "api.ReadDeviceResponse": { - "type": "object", - "properties": { - "device": { - "$ref": "#/definitions/api.Device" - } - } - }, - "api.ReadDomainResponse": { - "type": "object", - "properties": { - "domain": { - "$ref": "#/definitions/api.Organization" - } - } - }, - "api.ReadRoleResponse": { - "type": "object", - "properties": { - "role": { - "$ref": "#/definitions/api.Role" - } - } - }, - "api.ReadUserResponse": { - "type": "object", - "properties": { - "user": { - "$ref": "#/definitions/api.User" + "valid_from": { + "type": "string", + "format": "int64", + "title": "Validity period for the SLA - optional" + }, + "valid_to": { + "type": "string", + "format": "int64" } } }, - "api.Registration": { + "casesSLACondition": { "type": "object", - "title": "REGISTER SIP status", + "title": "SLACondition message represents an SLACondition entity with metadata", "properties": { - "callid": { - "type": "string" - }, - "contact": { + "created_at": { "type": "string", - "title": "binding_uri" + "format": "int64", + "title": "CreatedAt timestamp of the SLACondition" }, - "device": { - "$ref": "#/definitions/api.DeviceId" + "created_by": { + "title": "CreatedBy user of the SLACondition", + "$ref": "#/definitions/generalLookup" }, - "expires_at": { + "id": { "type": "string", - "format": "int64" + "format": "int64", + "title": "Unique identifier of the SLACondition" }, - "id": { + "name": { "type": "string", - "format": "int64" + "title": "Name of the SLACondition - required" }, - "instance": { + "priorities": { + "type": "array", + "title": "Priorities associated with the SLACondition - fetched as Lookup entities [ Priority name + ID ]", + "items": { + "type": "object", + "$ref": "#/definitions/generalLookup" + } + }, + "reaction_time": { "type": "string", - "title": "?sip.instance= register contact option" + "format": "int64", + "title": "Reaction time - required" }, - "received": { + "resolution_time": { "type": "string", - "title": "registrant: remote side (proxy)" + "format": "int64", + "title": "Resolution time - required" }, - "register_at": { + "sla_id": { "type": "string", - "format": "int64" + "format": "int64", + "title": "SLA ID associated with the SLACondition" }, - "socket": { + "updated_at": { "type": "string", - "title": "registrar: local side (host) e.g.:" + "format": "int64", + "title": "UpdatedAt timestamp of the SLACondition" }, - "user": { - "$ref": "#/definitions/api.UserId" + "updated_by": { + "title": "UpdatedBy user of the SLACondition", + "$ref": "#/definitions/generalLookup" + } + } + }, + "casesSLAConditionList": { + "type": "object", + "title": "SLAConditionList message contains a list of SLACondition items with pagination", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/casesSLACondition" + } }, - "user_agent": { - "type": "string" + "next": { + "type": "boolean" + }, + "page": { + "type": "integer", + "format": "int32" } } }, - "api.RevokeRoleResponse": { - "type": "object" + "casesSLAList": { + "type": "object", + "title": "SLAList message contains a list of SLA items with pagination", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/casesSLA" + } + }, + "next": { + "type": "boolean" + }, + "page": { + "type": "integer", + "format": "int32" + } + } }, - "api.Role": { + "casesService": { "type": "object", - "title": "Role represents group of users", + "title": "Service message represents a service entity within a catalog", "properties": { - "created_at": { + "assignee": { + "title": "Assignee responsible for the service", + "$ref": "#/definitions/generalLookup" + }, + "catalog_id": { "type": "string", "format": "int64", - "title": "unix" + "title": "Catalogs associated with the service" }, - "created_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" + "code": { + "type": "string", + "title": "Code for external integrations (optional)" }, - "deleted_at": { + "created_at": { "type": "string", "format": "int64", - "title": "unix" + "title": "Timestamp when the service was created" }, - "deleted_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" + "created_by": { + "title": "User who created the service", + "$ref": "#/definitions/generalLookup" }, "description": { "type": "string", - "title": "short description" + "title": "Description of the service (optional)" + }, + "group": { + "title": "Group responsible for the service", + "$ref": "#/definitions/generalExtendedLookup" }, "id": { "type": "string", "format": "int64", - "title": "oid" - }, - "members": { - "description": "users/roles", - "type": "array", - "title": "Caller caller = 4; // TOBE removed !!!\nmap\u003cint64, string\u003e users = 4;", - "items": { - "type": "object", - "$ref": "#/definitions/api.ObjectId" - } - }, - "metadata": { - "type": "object", - "title": "Optional. Metadata bound to this role by the third party integrations\nEach attribute of this object represents separate various data\nto be able to store and merge separate keys (documents)" + "title": "Unique identifier for the service" }, "name": { "type": "string", - "title": "display common name" + "title": "Name of the service" }, - "permissions": { + "root_id": { + "type": "string", + "format": "int64", + "title": "ID of the parent catalog" + }, + "searched": { + "type": "boolean", + "title": "flag showing whether the catalog was searched" + }, + "service": { "type": "array", + "title": "Service associated with the service", "items": { "type": "object", - "$ref": "#/definitions/api.Permission" + "$ref": "#/definitions/casesService" } }, + "sla": { + "title": "SLA associated with the service", + "$ref": "#/definitions/generalLookup" + }, + "state": { + "type": "boolean", + "title": "State of the service (true for active, false for inactive)" + }, "updated_at": { "type": "string", "format": "int64", - "title": "unix" + "title": "Timestamp when the service was last updated" }, "updated_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" - }, - "user": { - "type": "boolean", - "title": "READONLY. Report whether this Role refers to the internal User(=true) or Group(=false)" + "title": "User who last updated the service", + "$ref": "#/definitions/generalLookup" } } }, - "api.Role.Member": { + "casesServiceList": { "type": "object", + "title": "ServiceList message contains a list of services with pagination", "properties": { - "admin": { + "items": { + "type": "array", + "title": "List of service items", + "items": { + "type": "object", + "$ref": "#/definitions/casesService" + } + }, + "next": { "type": "boolean", - "title": "admin of the group ?" + "title": "Indicates if there are more pages" }, + "page": { + "type": "integer", + "format": "int32", + "title": "Page number for pagination" + } + } + }, + "casesSource": { + "description": "Represents a source entity in the contact system.", + "type": "object", + "properties": { "created_at": { "type": "string", "format": "int64", - "title": "unix" + "title": "CreatedAt timestamp of the source" }, "created_by": { + "title": "CreatedBy user of the source", + "$ref": "#/definitions/generalLookup" + }, + "description": { "type": "string", - "title": "user.[id|name]" + "title": "Description of the source" }, "id": { "type": "string", "format": "int64", - "title": "user.id" + "title": "Unique identifier of the source" }, "name": { "type": "string", - "title": "user.name" + "title": "Name of the source" + }, + "type": { + "title": "Source type of the source", + "$ref": "#/definitions/casesSourceType" }, "updated_at": { "type": "string", "format": "int64", - "title": "unix" + "title": "UpdatedAt timestamp of the source" }, "updated_by": { - "type": "string", - "title": "user" - } - } - }, - "api.RoleId": { - "description": "RoleId lookup value.", - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "int64", - "title": "Unique Object IDentifier" - }, - "name": { - "type": "string", - "title": "Display Name" - }, - "user": { - "type": "boolean", - "title": "Optional. Indicates that this role ID refers\nto the internal user as the system administrative unit" + "title": "UpdatedBy user of the source", + "$ref": "#/definitions/generalLookup" } } }, - "api.RoleMembersResponse": { + "casesSourceList": { + "description": "A list of sources.", "type": "object", "properties": { - "results": { + "items": { + "description": "List of sources.", "type": "array", "items": { "type": "object", - "$ref": "#/definitions/api.Role.Member" + "$ref": "#/definitions/casesSource" } + }, + "next": { + "description": "Have more records.", + "type": "boolean" + }, + "page": { + "description": "Page number of the partial result.", + "type": "integer", + "format": "int32" } } }, - "api.RoleMetadataResponse": { + "casesSourceType": { + "description": "Represents a source type for the source entity.\n\n - TYPE_UNSPECIFIED: Unspecified source type.\n - CALL: Phone call source type.\n - CHAT: Chat source type.\n - SOCIAL_MEDIA: Social media source type.\n - EMAIL: Email source type.\n - API: API source type.\n - MANUAL: Manual source type.", + "type": "string", + "default": "TYPE_UNSPECIFIED", + "enum": [ + "TYPE_UNSPECIFIED", + "CALL", + "CHAT", + "SOCIAL_MEDIA", + "EMAIL", + "API", + "MANUAL" + ] + }, + "casesSourceTypeLookup": { "type": "object", "properties": { - "key": { + "id": { "type": "string", - "title": "Optional. Partial metadata document key name" + "format": "int64" }, - "value": { - "title": "Metadata value" + "name": { + "type": "string" + }, + "type": { + "$ref": "#/definitions/casesSourceType" } } }, - "api.Roles.UpdateRoleBody": { + "casesStatusCondition": { "type": "object", + "title": "StatusCondition message represents a status entity with metadata", "properties": { - "fields": { - "type": "array", - "title": "partial changes", - "items": { - "type": "string" - } + "created_at": { + "type": "string", + "format": "int64", + "title": "CreatedAt timestamp of the status condition" }, - "role": { - "type": "object", - "title": "modifications", - "properties": { - "created_at": { - "type": "string", - "format": "int64", - "title": "unix" - }, - "created_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" - }, - "deleted_at": { - "type": "string", - "format": "int64", - "title": "unix" - }, - "deleted_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" - }, - "description": { - "type": "string", - "title": "short description" - }, - "members": { - "description": "users/roles", - "type": "array", - "title": "Caller caller = 4; // TOBE removed !!!\nmap\u003cint64, string\u003e users = 4;", - "items": { - "type": "object", - "$ref": "#/definitions/api.ObjectId" - } - }, - "metadata": { - "type": "object", - "title": "Optional. Metadata bound to this role by the third party integrations\nEach attribute of this object represents separate various data\nto be able to store and merge separate keys (documents)" - }, - "name": { - "type": "string", - "title": "display common name" - }, - "permissions": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/api.Permission" - } - }, - "updated_at": { - "type": "string", - "format": "int64", - "title": "unix" - }, - "updated_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" - }, - "user": { - "type": "boolean", - "title": "READONLY. Report whether this Role refers to the internal User(=true) or Group(=false)" - } - } + "created_by": { + "title": "CreatedBy user of the status condition", + "$ref": "#/definitions/generalLookup" + }, + "description": { + "type": "string", + "title": "Description of the status condition" + }, + "final": { + "type": "boolean", + "title": "Final status condition" + }, + "id": { + "type": "string", + "format": "int64", + "title": "Unique identifier of the status condition" + }, + "initial": { + "type": "boolean", + "title": "Initial status condition" + }, + "name": { + "type": "string", + "title": "Name of the status condition" + }, + "status_id": { + "type": "string", + "format": "int64", + "title": "Status ID of the status condition" + }, + "updated_at": { + "type": "string", + "format": "int64", + "title": "UpdatedAt timestamp of the status condition" + }, + "updated_by": { + "title": "UpdatedBy user of the status condition", + "$ref": "#/definitions/generalLookup" } } }, - "api.SearchClassesResponse": { + "casesStatusConditionList": { "type": "object", + "title": "StatusConditionList message contains a list of StatusCondition items with pagination", "properties": { "items": { "type": "array", - "title": "list", "items": { "type": "object", - "$ref": "#/definitions/api.ObjectClass" + "$ref": "#/definitions/casesStatusCondition" } }, "next": { - "type": "boolean", - "title": "search: has {next} page ?" + "type": "boolean" }, "page": { "type": "integer", - "format": "int32", - "title": "select: offset {page}" - }, - "size": { - "type": "integer", - "format": "int32", - "title": "search: limit {size}" + "format": "int32" } } }, - "api.SearchDeviceResponse": { + "casesStatusList": { "type": "object", + "title": "StatusList message contains a list of Status items with pagination", "properties": { "items": { "type": "array", - "title": "devices", "items": { "type": "object", - "$ref": "#/definitions/api.Device" + "$ref": "#/definitions/webitelcasesStatus" } }, "next": { - "type": "boolean", - "title": "search: has {next} page ?" + "type": "boolean" }, "page": { "type": "integer", - "format": "int32", - "title": "select: offset {page}" + "format": "int32" + } + } + }, + "casesTimingInfo": { + "description": "Message representing SLA timing information.", + "type": "object", + "properties": { + "difference_in_reaction": { + "description": "Difference between actual and planned reaction time.", + "type": "string", + "format": "int64" }, - "size": { - "type": "integer", - "format": "int32", - "title": "search: limit {size}" + "difference_in_resolve": { + "description": "Difference between actual and planned resolution time.", + "type": "string", + "format": "int64" + }, + "reacted_at": { + "description": "Actual reaction timestamp (in milliseconds).", + "type": "string", + "format": "int64" + }, + "resolved_at": { + "description": "Actual resolution timestamp (in milliseconds).", + "type": "string", + "format": "int64" } } }, - "api.SearchDomainsResponse": { + "casesTranscriptLookup": { "type": "object", "properties": { - "domains": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/api.Organization" - } + "file": { + "$ref": "#/definitions/generalLookup" + }, + "id": { + "type": "string", + "format": "int64" + }, + "locale": { + "type": "string" } } }, - "api.SearchLDAPResponse": { + "casesUnlinkCommunicationResponse": { + "description": "Response message after unlinking a communication from a case.", "type": "object", "properties": { - "items": { + "affected": { + "description": "Affected rows.", + "type": "string", + "format": "int64" + } + } + }, + "engineAcceptOfDay": { + "type": "object", + "properties": { + "day": { + "type": "integer", + "format": "int32" + }, + "disabled": { + "type": "boolean", + "format": "boolean" + }, + "end_time_of_day": { + "type": "integer", + "format": "int32" + }, + "start_time_of_day": { + "type": "integer", + "format": "int32" + } + } + }, + "engineActiveCall": { + "type": "object", + "properties": { + "agent": { + "$ref": "#/definitions/engineLookup" + }, + "answered_at": { + "type": "string", + "format": "int64" + }, + "app_id": { + "type": "string" + }, + "bill_sec": { + "type": "integer", + "format": "int32" + }, + "blind_transfer": { + "type": "string" + }, + "bridged_at": { + "type": "string", + "format": "int64" + }, + "bridged_id": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "int64" + }, + "destination": { + "type": "string" + }, + "direction": { + "type": "string" + }, + "display": { + "type": "string" + }, + "duration": { + "type": "integer", + "format": "int32" + }, + "extension": { + "type": "string" + }, + "from": { + "$ref": "#/definitions/engineEndpoint" + }, + "gateway": { + "$ref": "#/definitions/engineLookup" + }, + "hold_sec": { + "type": "integer", + "format": "int32" + }, + "id": { + "type": "string" + }, + "joined_at": { + "type": "string", + "format": "int64" + }, + "leaving_at": { + "type": "string", + "format": "int64" + }, + "member": { + "$ref": "#/definitions/engineLookup" + }, + "parent_id": { + "type": "string" + }, + "queue": { + "$ref": "#/definitions/engineLookup" + }, + "queue_bridged_at": { + "type": "string", + "format": "int64" + }, + "queue_duration_sec": { + "type": "integer", + "format": "int32" + }, + "queue_wait_sec": { + "type": "integer", + "format": "int32" + }, + "reporting_at": { + "type": "string", + "format": "int64" + }, + "reporting_sec": { + "type": "integer", + "format": "int32" + }, + "state": { + "type": "string" + }, + "supervisor": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/api.LDAPCatalog" + "$ref": "#/definitions/engineLookup" } }, - "next": { - "type": "boolean", - "title": "result: has {next} page ?" + "team": { + "$ref": "#/definitions/engineLookup" }, - "page": { + "timestamp": { + "type": "string", + "format": "int64" + }, + "to": { + "$ref": "#/definitions/engineEndpoint" + }, + "type": { + "type": "string" + }, + "user": { + "$ref": "#/definitions/engineLookup" + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "wait_sec": { "type": "integer", - "format": "int32", - "title": "result: {page} number" + "format": "int32" } } }, - "api.SearchOAuthServiceResponse": { + "engineActivityWorkspaceWidgetResponse": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/api.OAuthService" - } + "available": { + "type": "integer", + "format": "int32" }, - "next": { - "type": "boolean", - "title": "result: has {next} page ?" + "avg_hold_sec": { + "type": "number", + "format": "float" }, - "page": { + "avg_talk_sec": { + "type": "number", + "format": "float" + }, + "call_abandoned": { "type": "integer", - "format": "int32", - "title": "result: {page} number" - } - } - }, - "api.SearchPermissionResponse": { - "type": "object", - "properties": { - "items": { - "type": "array", - "title": "result entries", - "items": { - "type": "object", - "$ref": "#/definitions/api.Permission" - } + "format": "int32" }, - "next": { - "type": "boolean", - "title": "search: has {next} page ?" + "call_handled": { + "type": "integer", + "format": "int32" }, - "page": { + "call_inbound": { "type": "integer", - "format": "int32", - "title": "select: offset {page}" + "format": "int32" }, - "size": { + "call_missed": { "type": "integer", - "format": "int32", - "title": "search: limit {size}" - } - } - }, - "api.SearchRolesResponse": { - "type": "object", - "properties": { - "items": { - "type": "array", - "title": "roles", - "items": { - "type": "object", - "$ref": "#/definitions/api.Role" - } + "format": "int32" }, - "next": { - "type": "boolean", - "title": "search: has {next} page ?" + "chat_accepts": { + "type": "integer", + "format": "int32" }, - "page": { - "description": "select: offset {page}", + "chat_aht": { + "type": "number", + "format": "float" + }, + "occupancy": { + "type": "number", + "format": "float" + }, + "online": { "type": "integer", - "format": "int32", - "title": "pagedResultsControl response value" + "format": "int32" }, - "size": { + "processing": { "type": "integer", - "format": "int32", - "title": "search: limit {size}" + "format": "int32" + }, + "queue_talk_sec": { + "type": "integer", + "format": "int32" + }, + "score_count": { + "type": "string", + "format": "int64" + }, + "score_optional_avg": { + "type": "number", + "format": "float" + }, + "score_optional_sum": { + "type": "number", + "format": "float" + }, + "score_required_avg": { + "type": "number", + "format": "float" + }, + "score_required_sum": { + "type": "number", + "format": "float" + }, + "sum_talk_sec": { + "type": "string", + "format": "int64" + }, + "task_accepts": { + "type": "integer", + "format": "int32" + }, + "utilization": { + "type": "number", + "format": "float" + }, + "voice_mail": { + "type": "integer", + "format": "int32" } } }, - "api.SearchUsersRequest": { + "engineAgent": { "type": "object", "properties": { - "any": { - "description": "filter: include 'deleted' ALSO ! (inactive)", - "type": "boolean", - "title": "----- View Modes -----------------------------\nNOTE: by default, search NOT 'deleted' objects ONLY" - }, - "deleted": { - "type": "boolean", - "title": "filter: .deleted_at NOTNULL (view: RECYCLE)" - }, - "extension": { - "type": "string", - "title": "filter: .extension LIKE '{extension}'" - }, - "fields": { - "description": "select: output (fields,...)", + "allow_channels": { "type": "array", - "title": "// navigation filter\nrepeated int64 roles = 7;\n----- Search Options -------------------------", "items": { "type": "string" } }, - "id": { - "description": "filter: .id = any({id}...)", + "auditor": { "type": "array", - "title": "----- Base Filters ---------------------------", "items": { - "type": "string", - "format": "int64" + "$ref": "#/definitions/engineLookup" } }, - "name": { - "type": "string", - "title": "filter: .name ILIKE '{name}'" - }, - "not_id": { + "channel": { "type": "array", - "title": "filter: .id \u003c\u003e all({not_ids}...)", "items": { - "type": "string", - "format": "int64" + "$ref": "#/definitions/engineAgentChannel" } }, - "page": { + "chat_count": { "type": "integer", - "format": "int32", - "title": "select: offset {page}" + "format": "int64" }, - "presence": { - "$ref": "#/definitions/api.SearchUsersRequest.Presence" + "description": { + "type": "string" }, - "q": { - "description": "filter: (.name|.username|.extension|.status) ILIKE '{q}'", + "extension": { + "type": "string" + }, + "greeting_media": { + "$ref": "#/definitions/engineLookup" + }, + "id": { "type": "string", - "title": "----- User-specific Filters ------------------" + "format": "int64" }, - "size": { + "is_supervisor": { + "type": "boolean", + "format": "boolean" + }, + "last_status_change": { + "type": "string", + "format": "int64" + }, + "name": { + "type": "string" + }, + "progressive_count": { "type": "integer", - "format": "int32", - "title": "select: limit {size}" + "format": "int32" }, - "sort": { + "region": { + "$ref": "#/definitions/engineLookup" + }, + "skills": { "type": "array", - "title": "select: order by (fields,...)", "items": { - "type": "string" + "$ref": "#/definitions/engineLookup" } }, "status": { - "type": "string", - "title": "filter: .status ILIKE '{status}'" + "type": "string" }, - "username": { + "status_duration": { "type": "string", - "title": "filter: .username ILIKE '{username}'" + "format": "int64" + }, + "supervisor": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } + }, + "task_count": { + "type": "integer", + "format": "int64" + }, + "team": { + "$ref": "#/definitions/engineLookup" + }, + "user": { + "$ref": "#/definitions/engineLookup" } } }, - "api.SearchUsersRequest.Presence": { + "engineAgentCallStatistics": { "type": "object", - "title": "simplified presence filter params", "properties": { - "note": { - "type": "string" + "abandoned": { + "type": "integer", + "format": "int32" }, - "status": { + "avg_hold_sec": { + "type": "number", + "format": "float" + }, + "avg_talk_sec": { + "type": "number", + "format": "float" + }, + "chat_accepts": { + "type": "integer", + "format": "int32" + }, + "chat_aht": { + "type": "integer", + "format": "int32" + }, + "count": { + "type": "integer", + "format": "int32" + }, + "handles": { + "type": "integer", + "format": "int32" + }, + "max_hold_sec": { + "type": "number", + "format": "float" + }, + "max_talk_sec": { + "type": "number", + "format": "float" + }, + "min_hold_sec": { + "type": "number", + "format": "float" + }, + "min_talk_sec": { + "type": "number", + "format": "float" + }, + "name": { "type": "string" + }, + "occupancy": { + "type": "number", + "format": "float" + }, + "sum_hold_sec": { + "type": "number", + "format": "float" + }, + "sum_talk_sec": { + "type": "number", + "format": "float" + }, + "utilization": { + "type": "number", + "format": "float" } } }, - "api.SearchUsersResponse": { + "engineAgentCallStatisticsList": { "type": "object", "properties": { "items": { "type": "array", - "title": "users", "items": { - "type": "object", - "$ref": "#/definitions/api.User" + "$ref": "#/definitions/engineAgentCallStatistics" } }, "next": { "type": "boolean", - "title": "search: has {next} page ?" - }, - "page": { - "type": "integer", - "format": "int32", - "title": "select: offset {page}" - }, - "size": { - "type": "integer", - "format": "int32", - "title": "search: limit {size}" + "format": "boolean" } } }, - "api.ServerInfoResponse": { + "engineAgentChannel": { "type": "object", "properties": { - "key": { + "channel": { + "type": "string" + }, + "joined_at": { "type": "string", - "format": "byte", - "title": "int64 time = 1; // current timestamp (ms)" + "format": "int64" + }, + "state": { + "type": "string" + }, + "timeout": { + "type": "string", + "format": "int64" } } }, - "api.SetStatusRequest": { + "engineAgentInQueue": { "type": "object", "properties": { - "fields": { - "type": "array", - "title": "PATCH: partial attributes", - "items": { - "type": "string" - } + "active_members": { + "type": "integer", + "format": "int32" }, - "publish": { - "description": "BODY: partial modifications", - "title": "int64 id = 1; // user.id", - "$ref": "#/definitions/api.UserPresence" + "agents": { + "$ref": "#/definitions/AgentInQueueAgentsInQueue" + }, + "count_members": { + "type": "integer", + "format": "int32" + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "priority": { + "type": "integer", + "format": "int32" + }, + "queue": { + "$ref": "#/definitions/engineLookup" + }, + "strategy": { + "type": "string" + }, + "type": { + "type": "integer", + "format": "int32" + }, + "waiting_members": { + "type": "integer", + "format": "int32" } } }, - "api.SystemObjects": { - "type": "string", - "default": "contacts", - "enum": [ - "contacts", - "cc_list", - "cc_bucket", - "calendars", - "devices", - "cc_agent", - "cc_team", - "cc_resource", - "cc_resource_group", - "cc_queue", - "roles", - "users", - "cognitive_profile" - ] - }, - "api.TfaUrl": { + "engineAgentInQueueStatistics": { "type": "object", "properties": { - "url": { - "type": "string" + "queue": { + "$ref": "#/definitions/engineLookup" }, - "user": { - "$ref": "#/definitions/api.UserId" + "statistics": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentInQueueStatisticsAgentInQueueStatisticsItem" + } } } }, - "api.ToggleDefaultAccessResponse": { + "engineAgentInQueueStatisticsList": { "type": "object", "properties": { - "granted": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/api.AccessRule" - } - }, - "revoked": { + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/api.AccessRule" + "$ref": "#/definitions/engineAgentInQueueStatistics" } } } }, - "api.UpdateAccessResponseV1": { + "engineAgentInTeam": { "type": "object", "properties": { - "granted": { - "type": "string", - "format": "int64", - "title": "Affected rules count" + "strategy": { + "type": "string" }, - "revoked": { - "type": "string", - "format": "int64" + "team": { + "$ref": "#/definitions/engineLookup" } } }, - "api.UpdateClassResponse": { + "engineAgentPauseCause": { "type": "object", "properties": { - "class": { - "title": "updated", - "$ref": "#/definitions/api.ObjectClass" + "allow_admin": { + "type": "boolean", + "format": "boolean" + }, + "allow_agent": { + "type": "boolean", + "format": "boolean" + }, + "allow_supervisor": { + "type": "boolean", + "format": "boolean" + }, + "created_at": { + "type": "string", + "format": "int64" + }, + "created_by": { + "$ref": "#/definitions/engineLookup" + }, + "description": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "limit_min": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "int64" + }, + "updated_by": { + "$ref": "#/definitions/engineLookup" } } }, - "api.UpdateCustomerResponse": { + "engineAgentSetStateRequest": { "type": "object", "properties": { - "customer": { - "title": "detailed", - "$ref": "#/definitions/api.Customer" + "agent_id": { + "type": "integer", + "format": "int32" } } }, - "api.UpdateDeviceResponse": { - "type": "object", - "properties": { - "device": { - "$ref": "#/definitions/api.Device" - } - } + "engineAgentSetStateResponse": { + "type": "object" }, - "api.UpdateDomainResponse": { + "engineAgentSkill": { "type": "object", "properties": { - "domain": { - "$ref": "#/definitions/api.Organization" + "agent": { + "$ref": "#/definitions/engineLookup" + }, + "capacity": { + "type": "integer", + "format": "int32" + }, + "created_at": { + "type": "string", + "format": "int64" + }, + "created_by": { + "$ref": "#/definitions/engineLookup" + }, + "domain_id": { + "type": "string", + "format": "int64" + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "id": { + "type": "string", + "format": "int64" + }, + "skill": { + "$ref": "#/definitions/engineLookup" + }, + "updated_at": { + "type": "string", + "format": "int64" + }, + "updated_by": { + "$ref": "#/definitions/engineLookup" } } }, - "api.UpdateRoleResponse": { + "engineAgentSkillItem": { "type": "object", "properties": { - "updated": { - "$ref": "#/definitions/api.Role" + "capacity": { + "type": "integer", + "format": "int32" + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "id": { + "type": "string", + "format": "int64" + }, + "skill": { + "$ref": "#/definitions/engineLookup" } } }, - "api.UpdateUserResponse": { + "engineAgentState": { "type": "object", "properties": { - "updated": { - "$ref": "#/definitions/api.User" + "agent": { + "$ref": "#/definitions/engineLookup" + }, + "channel": { + "type": "string" + }, + "duration": { + "type": "string", + "format": "int64" + }, + "id": { + "type": "string", + "format": "int64" + }, + "joined_at": { + "type": "string", + "format": "int64" + }, + "pause_cause": { + "type": "string" + }, + "payload": { + "type": "string" + }, + "queue": { + "$ref": "#/definitions/engineLookup" + }, + "state": { + "type": "string" } } }, - "api.User": { - "description": "User profile.", + "engineAgentStatsStatistic": { "type": "object", "properties": { - "chat_name": { - "description": "The \"chat_name\" field is used to store the name displayed externally on the platform.\nFor example, \"chat_name\" is shown when an agent connects to chats with clients.", + "active_call_id": { "type": "string" }, - "contact": { - "description": "[optional] contact connected to this user", - "title": "repeated Call calls = 13; // order by created_at\nrepeated Registration reged = 13; // order by register_last", - "$ref": "#/definitions/api.ObjectId" + "agent_id": { + "type": "integer", + "format": "int32" }, - "created_at": { + "auditor": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } + }, + "call_time": { "type": "string", - "format": "int64", - "title": "unix" + "format": "int64" }, - "created_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" + "chat_count": { + "type": "integer", + "format": "int32" }, - "deleted_at": { - "type": "string", - "format": "int64", - "title": "unix" + "extension": { + "type": "string" }, - "deleted_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" + "handles": { + "type": "integer", + "format": "int32" }, - "device": { - "title": "[optional] default device assigned ? WebRTC register ?", - "$ref": "#/definitions/api.ObjectId" + "max_bridged_at": { + "type": "string", + "format": "int64" }, - "devices": { - "description": "[editable] list of unique `regular` devices, attached to this user", - "type": "array", - "title": "map\u003cint64, string\u003e devices = 13;", - "items": { - "type": "object", - "$ref": "#/definitions/api.ObjectId" - } + "max_offering_at": { + "type": "string", + "format": "int64" }, - "email": { + "missed": { + "type": "integer", + "format": "int32" + }, + "name": { "type": "string" }, - "extension": { + "occupancy": { + "type": "number", + "format": "float" + }, + "offline": { "type": "string", - "title": "Caller-ID-Number:" + "format": "int64" }, - "hotdesks": { - "type": "array", - "title": "[readonly] list of unique `hotdesk` devices, assigned to this user", - "items": { - "type": "object", - "$ref": "#/definitions/api.ObjectId" - } + "online": { + "type": "string", + "format": "int64" }, - "id": { + "pause": { "type": "string", - "format": "int64", - "title": "Object ID" + "format": "int64" }, - "license": { + "pause_cause": { + "type": "string" + }, + "queues": { "type": "array", - "title": "list of unique licenses, granted to this user", "items": { - "type": "object", - "$ref": "#/definitions/api.LicenseUser" + "$ref": "#/definitions/engineLookup" } }, - "name": { - "type": "string", - "title": "Caller-ID-Name: Display Name" + "skills": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } }, - "password": { + "status": { "type": "string" }, - "permissions": { + "status_duration": { + "type": "string", + "format": "int64" + }, + "supervisor": { "type": "array", - "title": "set of operational permission grants", "items": { - "type": "object", - "$ref": "#/definitions/api.Permission" + "$ref": "#/definitions/engineLookup" } }, - "presence": { - "description": "string presence = 7; // unique set of \u003cuser\u003e presentity \u003cstatus:basic\u003e tuples open[ed]\n string status = 8; // short display status (short description)", - "title": "CallerId caller = 5; // extension\nPresenceStatus presence = 8;", - "$ref": "#/definitions/api.UserPresence" + "team": { + "$ref": "#/definitions/engineLookup" }, - "profile": { - "type": "object", - "title": "list of variables, assigned to this user as an environment unit", - "additionalProperties": { - "type": "string" - } + "transferred": { + "type": "integer", + "format": "int64" }, - "roles": { + "user": { + "$ref": "#/definitions/engineLookup" + }, + "utilization": { + "type": "number", + "format": "float" + } + } + }, + "engineAgentStatusRequest": { + "type": "object", + "properties": { + "channels": { "type": "array", - "title": "roles, member of which is this user", "items": { - "type": "object", - "$ref": "#/definitions/api.ObjectId" + "type": "string" } }, - "totp_url": { + "domain_id": { "type": "string", - "title": "[readonly][optional] one time password if setting (2fa) is enabled" + "format": "int64" }, - "updated_at": { + "id": { "type": "string", - "format": "int64", - "title": "unix" + "format": "int64" }, - "updated_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" + "on_demand": { + "type": "boolean", + "format": "boolean" }, - "username": { - "type": "string", - "title": "alphanumeric username (login)" + "payload": { + "type": "string" + }, + "status": { + "type": "string" } } }, - "api.UserAccessToken": { - "description": "UserId lookup value.", + "engineAgentStatusStatisticItem": { "type": "object", "properties": { - "created_at": { - "type": "string", - "format": "int64", - "title": "unix::ms" + "agent_id": { + "type": "integer", + "format": "int32" }, - "created_by": { - "$ref": "#/definitions/api.ObjectId" + "auditor": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } }, - "deleted_at": { - "type": "string", - "format": "int64", - "title": "[optional] disabled at" + "chat_count": { + "type": "integer", + "format": "int64" }, - "deleted_by": { - "title": "[optional] disabled by", - "$ref": "#/definitions/api.ObjectId" + "extension": { + "type": "string" }, - "id": { + "name": { + "type": "string" + }, + "offline": { "type": "string", - "title": "tokenKey::token_key" + "format": "int64" }, - "token": { + "online": { "type": "string", - "title": "tokenString::access_token" + "format": "int64" }, - "updated_at": { + "pause": { "type": "string", - "format": "int64", - "title": "unix::ms" + "format": "int64" }, - "updated_by": { - "$ref": "#/definitions/api.ObjectId" + "pause_cause": { + "type": "string" }, - "usage": { + "progressive_count": { + "type": "integer", + "format": "int64" + }, + "region": { + "$ref": "#/definitions/engineLookup" + }, + "score_count": { "type": "string", - "title": "[optional] short usage description" + "format": "int64" + }, + "score_optional_avg": { + "type": "number", + "format": "float" + }, + "score_required_avg": { + "type": "number", + "format": "float" + }, + "status": { + "type": "string" + }, + "status_duration": { + "type": "string", + "format": "int64" + }, + "supervisor": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } + }, + "team": { + "$ref": "#/definitions/engineLookup" }, "user": { - "title": "[optional] output depends on API endpoint", - "$ref": "#/definitions/api.ObjectId" + "$ref": "#/definitions/engineLookup" } } }, - "api.UserAccessTokenList": { + "engineAgentTeam": { "type": "object", "properties": { - "items": { + "admin": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/api.UserAccessToken" + "$ref": "#/definitions/engineLookup" } }, - "next": { - "type": "boolean", - "title": "is there more results ? next page is available ?" + "call_timeout": { + "type": "integer", + "format": "int32" }, - "page": { + "description": { + "type": "string" + }, + "domain_id": { + "type": "string", + "format": "int64" + }, + "forecast_calculation": { + "$ref": "#/definitions/engineLookup" + }, + "id": { + "type": "string", + "format": "int64" + }, + "invite_chat_timeout": { "type": "integer", "format": "int32" }, - "size": { + "max_no_answer": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string" + }, + "no_answer_delay_time": { + "type": "integer", + "format": "int32" + }, + "strategy": { + "type": "string" + }, + "task_accept_timeout": { + "type": "integer", + "format": "int32" + }, + "updated_at": { "type": "string", "format": "int64" + }, + "wrap_up_time": { + "type": "integer", + "format": "int32" } } }, - "api.UserId": { - "description": "UserId lookup value.", + "engineAgentTodayStatisticsResponse": { "type": "object", "properties": { - "id": { + "available": { + "type": "integer", + "format": "int32" + }, + "avg_hold_sec": { + "type": "number", + "format": "float" + }, + "avg_talk_sec": { + "type": "number", + "format": "float" + }, + "call_abandoned": { + "type": "integer", + "format": "int32" + }, + "call_handled": { + "type": "integer", + "format": "int32" + }, + "call_inbound": { + "type": "integer", + "format": "int32" + }, + "call_missed": { + "type": "integer", + "format": "int32" + }, + "chat_accepts": { + "type": "integer", + "format": "int32" + }, + "chat_aht": { + "type": "number", + "format": "float" + }, + "occupancy": { + "type": "number", + "format": "float" + }, + "online": { + "type": "integer", + "format": "int32" + }, + "processing": { + "type": "integer", + "format": "int32" + }, + "queue_talk_sec": { + "type": "integer", + "format": "int32" + }, + "score_count": { "type": "string", - "format": "int64", - "title": "Object ID" + "format": "int64" }, - "name": { + "score_optional_avg": { + "type": "number", + "format": "float" + }, + "score_optional_sum": { + "type": "number", + "format": "float" + }, + "score_required_avg": { + "type": "number", + "format": "float" + }, + "score_required_sum": { + "type": "number", + "format": "float" + }, + "sum_talk_sec": { "type": "string", - "title": "Display Name" + "format": "int64" + }, + "task_accepts": { + "type": "integer", + "format": "int32" + }, + "utilization": { + "type": "number", + "format": "float" + }, + "voice_mail": { + "type": "integer", + "format": "int32" } } }, - "api.UserPresence": { + "engineAgentUser": { "type": "object", "properties": { - "expires": { - "type": "integer", - "format": "int32", - "title": "[optional] \u003cnote\u003e will be cleaned up after seconds" - }, "id": { "type": "string", - "format": "int64", - "title": "[required] user identity" - }, - "note": { - "type": "string", - "title": "[optional] human readable comment" - }, - "status": { - "type": "string", - "title": "[optional] set of unique 'active' presentities {dnd,dlg,sip,wss}; assume {offline} if omitted" + "format": "int64" }, - "timestamp": { - "type": "string", - "format": "int64", - "title": "[required] last activity time" + "name": { + "type": "string" } } }, - "api.UserSetting": { + "engineAggregateHistoryCallRequest": { "type": "object", "properties": { - "key": { + "agent_description": { "type": "string" }, - "value": {} - } - }, - "api.Userinfo": { - "type": "object", - "title": "https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims", - "properties": { - "dc": { - "type": "string", - "format": "int64", - "title": "current domain component id" + "agent_id": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } }, - "domain": { - "type": "string", - "title": "session domain.name" + "aggs": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAggregateRequest" + } }, - "expires_at": { - "type": "string", - "format": "int64", - "title": "unix" + "amd_result": { + "type": "array", + "items": { + "type": "string" + } }, - "extension": { + "answered_at": { + "$ref": "#/definitions/engineFilterBetween" + }, + "cause": { + "type": "array", + "items": { + "type": "string" + } + }, + "contact_id": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } + }, + "created_at": { + "$ref": "#/definitions/engineFilterBetween" + }, + "dependency_id": { "type": "string" }, - "license": { + "direction": { + "type": "string" + }, + "directions": { "type": "array", - "title": "map[key]details", "items": { - "type": "object", - "$ref": "#/definitions/api.LicenseUser" + "type": "string" } }, - "name": { + "domain_id": { "type": "string", - "title": "current user.id" + "format": "int64" }, - "permissions": { + "duration": { + "$ref": "#/definitions/engineFilterBetween" + }, + "fts": { + "type": "string" + }, + "gateway_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/api.Permission" + "type": "string", + "format": "int64" } }, - "preferred_username": { - "type": "string" + "has_file": { + "type": "boolean", + "format": "boolean" }, - "roles": { + "has_transcript": { + "type": "boolean", + "format": "boolean" + }, + "id": { "type": "array", - "title": "map[role]oid", "items": { - "type": "object", - "$ref": "#/definitions/api.ObjectId" + "type": "string" } }, - "scope": { + "member_id": { "type": "array", - "title": "map[class]dac", "items": { - "type": "object", - "$ref": "#/definitions/api.Objclass" + "type": "string", + "format": "int64" } }, - "updated_at": { - "type": "string", - "format": "int64", - "title": "user last updated" + "missed": { + "type": "boolean", + "format": "boolean" }, - "user_id": { - "type": "string", - "format": "int64", - "title": "current user.id" + "number": { + "type": "string" }, - "username": { - "type": "string", - "title": "session end-user login" - } - } - }, - "api.Users.LogoutUserBody": { - "type": "object" - }, - "api.Users.UpdateUserBody": { - "type": "object", - "properties": { - "fields": { + "page": { + "type": "integer", + "format": "int32" + }, + "parent_id": { + "type": "string" + }, + "q": { + "type": "string" + }, + "queue_id": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } + }, + "size": { + "type": "integer", + "format": "int32" + }, + "skip_parent": { + "type": "boolean", + "format": "boolean" + }, + "stored_at": { + "$ref": "#/definitions/engineFilterBetween" + }, + "tags": { "type": "array", - "title": "PATCH: partial update", "items": { "type": "string" } }, - "user": { - "type": "object", - "title": "body: modifications/changes", - "properties": { - "contact": { - "description": "[optional] contact connected to this user", - "title": "repeated Call calls = 13; // order by created_at\nrepeated Registration reged = 13; // order by register_last", - "$ref": "#/definitions/api.ObjectId" - }, - "created_at": { - "type": "string", - "format": "int64", - "title": "unix" - }, - "created_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" - }, - "deleted_at": { - "type": "string", - "format": "int64", - "title": "unix" - }, - "deleted_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" - }, - "device": { - "title": "[optional] default device assigned ? WebRTC register ?", - "$ref": "#/definitions/api.ObjectId" - }, - "devices": { - "description": "[editable] list of unique `regular` devices, attached to this user", - "type": "array", - "title": "map\u003cint64, string\u003e devices = 13;", - "items": { - "type": "object", - "$ref": "#/definitions/api.ObjectId" - } - }, - "email": { - "type": "string" - }, - "extension": { - "type": "string", - "title": "Caller-ID-Number:" - }, - "hotdesks": { - "type": "array", - "title": "[readonly] list of unique `hotdesk` devices, assigned to this user", - "items": { - "type": "object", - "$ref": "#/definitions/api.ObjectId" - } - }, - "license": { - "type": "array", - "title": "list of unique licenses, granted to this user", - "items": { - "type": "object", - "$ref": "#/definitions/api.LicenseUser" - } - }, - "name": { - "type": "string", - "title": "Caller-ID-Name: Display Name" - }, - "password": { - "type": "string" - }, - "permissions": { - "type": "array", - "title": "set of operational permission grants", - "items": { - "type": "object", - "$ref": "#/definitions/api.Permission" - } - }, - "presence": { - "description": "string presence = 7; // unique set of \u003cuser\u003e presentity \u003cstatus:basic\u003e tuples open[ed]\n string status = 8; // short display status (short description)", - "title": "CallerId caller = 5; // extension\nPresenceStatus presence = 8;", - "$ref": "#/definitions/api.UserPresence" - }, - "profile": { - "type": "object", - "title": "list of variables, assigned to this user as an environment unit", - "additionalProperties": { - "type": "string" - } - }, - "roles": { - "type": "array", - "title": "roles, member of which is this user", - "items": { - "type": "object", - "$ref": "#/definitions/api.ObjectId" - } - }, - "totp_url": { - "type": "string", - "title": "[readonly][optional] one time password if setting (2fa) is enabled" - }, - "updated_at": { - "type": "string", - "format": "int64", - "title": "unix" - }, - "updated_by": { - "title": "user", - "$ref": "#/definitions/api.UserId" - }, - "username": { - "type": "string", - "title": "alphanumeric username (login)" - } + "team_id": { + "type": "array", + "items": { + "type": "string", + "format": "int64" } - } - } - }, - "api.Verification": { - "type": "object", - "properties": { - "errors": { + }, + "transfer_from": { "type": "array", - "title": "invalid", "items": { "type": "string" } }, - "notify": { + "transfer_to": { "type": "array", - "title": "non-fatal warnings, e.g.:", "items": { "type": "string" } - } - } - }, - "casesAttachment": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "int64" - }, - "mime": { - "type": "string" }, - "name": { - "type": "string" - }, - "size": { - "type": "string", - "format": "int64" + "user_id": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } }, - "url": { - "type": "string" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, - "casesCallEvent": { + "engineAggregateRequest": { "type": "object", "properties": { - "closed_at": { - "type": "string", - "format": "int64" - }, - "duration": { - "type": "string", - "format": "int64" - }, - "files": { + "avg": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/casesCallFile" + "type": "string" } }, - "flow_scheme": { - "$ref": "#/definitions/generalLookup" - }, - "gateway": { - "$ref": "#/definitions/generalLookup" - }, - "id": { - "type": "string" + "count": { + "type": "array", + "items": { + "type": "string" + } }, - "is_detailed": { - "type": "boolean" + "group": { + "type": "array", + "items": { + "$ref": "#/definitions/AggregateRequestGroup" + } }, - "is_inbound": { - "type": "boolean" + "limit": { + "type": "integer", + "format": "int32" }, - "is_missed": { - "type": "boolean" + "max": { + "type": "array", + "items": { + "type": "string" + } }, - "participants": { + "min": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/generalLookup" + "type": "string" } }, - "queue": { - "$ref": "#/definitions/generalLookup" + "name": { + "type": "string" }, - "total_duration": { - "type": "string", - "format": "int64" + "sort": { + "type": "array", + "items": { + "type": "string" + } }, - "transcripts": { + "sum": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/casesTranscriptLookup" + "type": "string" } } } }, - "casesCallFile": { + "engineAggregateResult": { "type": "object", "properties": { - "created_at": { - "type": "string", - "format": "int64" - }, - "id": { - "type": "string", - "format": "int64" - }, - "mime_type": { - "type": "string" + "data": { + "type": "object" }, "name": { "type": "string" - }, - "size": { - "type": "string", - "format": "int64" } } }, - "casesCase": { - "description": "Message representing a case.", + "engineApiError": { "type": "object", "properties": { - "assignee": { - "description": "Assignee responsible for resolving the case.", - "$ref": "#/definitions/generalLookup" - }, - "author": { - "description": "Author or reporter of the case.", - "$ref": "#/definitions/generalLookup" - }, - "close": { - "description": "Close information (if applicable).", - "$ref": "#/definitions/casesCloseInfo" - }, - "close_reason_group": { - "description": "Close reason group, immutable once set.", - "$ref": "#/definitions/generalLookup" - }, - "comments": { - "description": "List of comments on the case.", - "$ref": "#/definitions/casesCaseCommentList" + "code": { + "type": "integer", + "format": "int32" }, - "contact_info": { - "description": "Contact information for the case.", + "detail": { "type": "string" }, - "created_at": { - "description": "Creation timestamp (in milliseconds since Unix epoch).", - "type": "string", - "format": "int64" - }, - "created_by": { - "description": "Creator of the case.", - "$ref": "#/definitions/generalLookup" - }, - "description": { - "description": "Detailed description of the case.", + "id": { "type": "string" }, - "etag": { - "description": "Unique etag identifier.", + "status": { "type": "string" + } + } + }, + "engineAttempt": { + "type": "object", + "properties": { + "agent": { + "$ref": "#/definitions/engineLookup" }, - "files": { - "description": "List of attached files.", - "$ref": "#/definitions/casesCaseFileList" + "agent_call_id": { + "type": "string" }, - "group": { - "description": "Group associated with the case.", - "$ref": "#/definitions/generalLookup" + "attempts": { + "type": "integer", + "format": "int32" }, - "id": { - "description": "Unique case ID.", + "bridged_at": { "type": "string", "format": "int64" }, - "impacted": { - "description": "Impacted contact (defaults to reporter if null).", - "$ref": "#/definitions/generalLookup" + "bucket": { + "$ref": "#/definitions/engineLookup" }, - "links": { - "description": "List of attached links.", - "$ref": "#/definitions/casesCaseLinkList" + "channel": { + "type": "string" + }, + "destination": { + "$ref": "#/definitions/engineMemberCommunication" }, - "name": { - "description": "Name of the case (may serve as an ID in docs).", + "display": { "type": "string" }, - "planned_reaction_at": { - "description": "Planned reaction time (in milliseconds).", + "id": { "type": "string", "format": "int64" }, - "planned_resolve_at": { - "description": "Planned resolution time (in milliseconds).", + "joined_at": { "type": "string", "format": "int64" }, - "priority": { - "description": "Priority level of the case.", - "$ref": "#/definitions/casesPriority" + "last_state_change": { + "type": "string", + "format": "int64" }, - "rate": { - "description": "Rating information.", - "$ref": "#/definitions/casesRateInfo" + "leaving_at": { + "type": "string", + "format": "int64" }, - "related": { - "description": "List of related cases.", - "$ref": "#/definitions/casesRelatedCaseList" + "list": { + "$ref": "#/definitions/engineLookup" }, - "reporter": { - "description": "Reporter of the issue (null if anonymous).", - "$ref": "#/definitions/generalLookup" + "member": { + "$ref": "#/definitions/engineLookup" }, - "service": { - "description": "Service associated with the case.", - "$ref": "#/definitions/generalLookup" + "member_call_id": { + "type": "string" }, - "sla": { - "description": "SLA associated with the case.", - "$ref": "#/definitions/generalLookup" + "offering_at": { + "type": "string", + "format": "int64" }, - "sla_condition": { - "description": "List of SLA conditions.", - "$ref": "#/definitions/generalLookup" + "position": { + "type": "integer", + "format": "int32" }, - "source": { - "description": "Source of the case.", - "$ref": "#/definitions/casesSourceTypeLookup" + "queue": { + "$ref": "#/definitions/engineLookup" }, - "status": { - "description": "Current status of the case.", - "$ref": "#/definitions/generalLookup" + "reporting_at": { + "type": "string", + "format": "int64" }, - "status_condition": { - "description": "Status condition from status lookup.", - "$ref": "#/definitions/casesStatusCondition" + "resource": { + "$ref": "#/definitions/engineLookup" }, - "subject": { - "description": "Subject of the case.", + "result": { "type": "string" }, - "timing": { - "description": "SLA timing details.", - "$ref": "#/definitions/casesTimingInfo" + "state": { + "type": "string" }, - "updated_at": { - "description": "Last update timestamp (in milliseconds since Unix epoch).", + "timeout": { "type": "string", "format": "int64" }, - "updated_by": { - "description": "Last updater of the case.", - "$ref": "#/definitions/generalLookup" - }, - "ver": { - "description": "Version number of the case.", - "type": "integer", - "format": "int32" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, - "casesCaseComment": { - "description": "Represents a comment associated with a case.", + "engineAttemptCallbackRequest": { "type": "object", "properties": { - "author": { - "description": "Contact-author of the comment.", - "$ref": "#/definitions/generalLookup" - }, - "can_edit": { - "description": "Indicates if the comment can be edited by current user.", - "type": "boolean" + "agent_id": { + "type": "integer", + "format": "int32" }, - "case_id": { - "description": "Optional relation to the associated case.", + "attempt_id": { "type": "string", "format": "int64" }, - "created_at": { - "description": "Timestamp (in milliseconds) of when the comment was created.", - "type": "string", - "format": "int64" + "description": { + "type": "string" }, - "created_by": { - "description": "User who created the comment.", - "$ref": "#/definitions/generalLookup" + "display": { + "type": "boolean", + "format": "boolean" }, - "edited": { - "description": "Indicates if the comment was edited; true if created_at \u003c updated_at.", - "type": "boolean" + "exclude_current_communication": { + "type": "boolean", + "format": "boolean" }, - "etag": { + "expire_at": { "type": "string", - "title": "entity tag representing id + ver" + "format": "int64" }, - "id": { - "description": "Main identifier for read, update, and delete operations.", + "min_offering_at": { "type": "string", "format": "int64" }, - "text": { - "description": "The content of the comment.", - "type": "string" + "only_current_communication": { + "type": "boolean", + "format": "boolean" }, - "updated_at": { - "description": "Timestamp (in milliseconds) of the last update.", - "type": "string", - "format": "int64" + "status": { + "type": "string" }, - "updated_by": { - "description": "User who last updated the comment.", - "$ref": "#/definitions/generalLookup" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } }, - "ver": { - "description": "Version number of the comment, used for concurrency control.", + "wait_between_retries": { "type": "integer", "format": "int32" } } }, - "casesCaseCommentList": { - "description": "Contains a paginated list of comments.", + "engineAttemptHistory": { "type": "object", "properties": { - "items": { - "description": "List of comments on the current page.", - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/casesCaseComment" - } + "agent": { + "$ref": "#/definitions/engineLookup" }, - "next": { - "description": "Flag to indicate if more pages are available.", - "type": "boolean" + "agent_call_id": { + "type": "string" }, - "page": { - "description": "Current page number.", + "amd_result": { + "type": "string" + }, + "attempts": { + "type": "integer", + "format": "int32" + }, + "bridged_at": { "type": "string", "format": "int64" - } - } - }, - "casesCaseCommunication": { - "description": "Represents a single case communication.", - "type": "object", - "properties": { - "communication_id": { - "description": "External communication ID.", + }, + "bucket": { + "$ref": "#/definitions/engineLookup" + }, + "channel": { "type": "string" }, - "communication_type": { - "description": "Type of the communication (e.g., Chat, Call).", - "$ref": "#/definitions/casesCaseCommunicationsTypes" + "destination": { + "$ref": "#/definitions/engineMemberCommunication" }, - "etag": { - "description": "Version of the communication record.", + "display": { "type": "string" }, "id": { - "description": "Database ID of the communication.", "type": "string", "format": "int64" }, - "ver": { - "description": "Version of the communication record.", + "joined_at": { + "type": "string", + "format": "int64" + }, + "leaving_at": { + "type": "string", + "format": "int64" + }, + "list": { + "$ref": "#/definitions/engineLookup" + }, + "member": { + "$ref": "#/definitions/engineLookup" + }, + "member_call_id": { + "type": "string" + }, + "offering_at": { + "type": "string", + "format": "int64" + }, + "position": { "type": "integer", "format": "int32" + }, + "queue": { + "$ref": "#/definitions/engineLookup" + }, + "reporting_at": { + "type": "string", + "format": "int64" + }, + "resource": { + "$ref": "#/definitions/engineLookup" + }, + "result": { + "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, - "casesCaseCommunicationsTypes": { - "description": "Enum to define types of case communications.\n\n - NO_TYPE: Default value, no type specified.\n - COMMUNICATION_CHAT: Communication type: Chat.\n - COMMUNICATION_CALL: Communication type: Call.\n - COMMUNICATION_EMAIL: Communication type: Email.", - "type": "string", - "default": "NO_TYPE", - "enum": [ - "NO_TYPE", - "COMMUNICATION_CHAT", - "COMMUNICATION_CALL", - "COMMUNICATION_EMAIL" - ] - }, - "casesCaseFileList": { - "description": "Contains a list of case files with pagination.", + "engineAttemptRenewalResultRequest": { "type": "object", "properties": { - "items": { - "description": "List of case files.", - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/casesFile" - } - }, - "next": { - "description": "Indicator if there is a next page.", - "type": "boolean" - }, - "page": { - "description": "Current page number.", + "attempt_id": { "type": "string", "format": "int64" + }, + "renewal": { + "type": "integer", + "format": "int64" } } }, - "casesCaseLink": { + "engineAttemptRenewalResultResponse": { + "type": "object" + }, + "engineAttemptResultRequest": { "type": "object", "properties": { - "author": { - "title": "contact-author calculated on-flight (optional)", - "$ref": "#/definitions/generalLookup" + "agent_id": { + "type": "integer", + "format": "int32" }, - "created_at": { + "attempt_id": { "type": "string", - "format": "int64", - "title": "unixmilli" + "format": "int64" }, - "created_by": { - "$ref": "#/definitions/generalLookup" + "description": { + "type": "string" }, - "etag": { + "display": { + "type": "boolean", + "format": "boolean" + }, + "exclude_current_communication": { + "type": "boolean", + "format": "boolean" + }, + "expire_at": { "type": "string", - "title": "main field required for read, update and delete" + "format": "int64" }, - "id": { + "member_id": { "type": "string", "format": "int64" }, - "name": { + "min_offering_at": { "type": "string", - "title": "link name (optional)" + "format": "int64" }, - "updated_at": { + "next_member_id": { "type": "string", "format": "int64" }, - "updated_by": { - "$ref": "#/definitions/generalLookup" + "only_current_communication": { + "type": "boolean", + "format": "boolean" }, - "url": { + "queue_id": { + "type": "integer", + "format": "int32" + }, + "status": { + "type": "string" + }, + "transfer_queue_id": { "type": "string", - "title": "URL" + "format": "int64" }, - "ver": { + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "wait_between_retries": { "type": "integer", "format": "int32" } } }, - "casesCaseLinkList": { + "engineAttemptResultResponse": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/casesCaseLink" - } - }, - "next": { - "type": "boolean" - }, - "page": { - "type": "string", - "format": "int64" + "status": { + "type": "string" } } }, - "casesCaseList": { - "description": "Response message containing a list of cases.", + "engineAuditForm": { "type": "object", "properties": { - "items": { - "description": "List of cases.", + "created_at": { + "type": "string", + "format": "int64" + }, + "created_by": { + "$ref": "#/definitions/engineLookup" + }, + "description": { + "type": "string" + }, + "editable": { + "type": "boolean", + "format": "boolean", + "title": "bool archive = 11;" + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string" + }, + "questions": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/casesCase" + "$ref": "#/definitions/engineQuestion" } }, - "next": { - "description": "Flag indicating if there are more pages.", - "type": "boolean" + "teams": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } }, - "page": { - "description": "Current page number.", + "updated_at": { "type": "string", "format": "int64" + }, + "updated_by": { + "$ref": "#/definitions/engineLookup" } } }, - "casesCaseTimelineEventType": { + "engineAuditQuestionType": { "type": "string", - "default": "TIMELINE_CHAT", + "default": "question_default", "enum": [ - "TIMELINE_CHAT", - "TIMELINE_CALL", - "TIMELINE_EMAIL" + "question_default", + "question_score", + "question_option" ] }, - "casesCatalog": { + "engineAuditRate": { "type": "object", - "title": "Catalog message represents the main catalog entity with metadata", "properties": { - "close_reason_group": { - "title": "Close reason group associated with the catalog", - "$ref": "#/definitions/generalLookup" + "answers": { + "type": "array", + "items": { + "$ref": "#/definitions/engineQuestionAnswer" + } }, - "code": { - "type": "string", - "title": "Code for external integrations (optional)" + "comment": { + "type": "string" }, "created_at": { "type": "string", - "format": "int64", - "title": "Timestamp when the catalog was created" + "format": "int64" }, "created_by": { - "title": "User who created the catalog", - "$ref": "#/definitions/generalLookup" + "$ref": "#/definitions/engineLookup" }, - "description": { - "type": "string", - "title": "Description of the catalog (optional)" + "form": { + "$ref": "#/definitions/engineLookup" }, "id": { "type": "string", - "format": "int64", - "title": "Unique identifier for the catalog" - }, - "name": { - "type": "string", - "title": "Name of the catalog" - }, - "prefix": { - "type": "string", - "title": "Prefix used for case identification (optional)" - }, - "searched": { - "type": "boolean", - "title": "flag showing whether the catalog was searched" + "format": "int64" }, - "service": { + "questions": { "type": "array", - "title": "Service associated with the catalog", "items": { - "type": "object", - "$ref": "#/definitions/casesService" + "$ref": "#/definitions/engineQuestion" } }, - "skills": { - "type": "array", - "title": "Skills associated with the catalog", - "items": { - "type": "object", - "$ref": "#/definitions/generalLookup" - } + "rated_user": { + "$ref": "#/definitions/engineLookup" }, - "sla": { - "title": "SLA associated with the catalog", - "$ref": "#/definitions/generalLookup" + "score_optional": { + "type": "number", + "format": "float" }, - "state": { - "type": "boolean", - "title": "State of the catalog (true for active, false for inactive)" + "score_required": { + "type": "number", + "format": "float" + }, + "updated_at": { + "type": "string", + "format": "int64" + }, + "updated_by": { + "$ref": "#/definitions/engineLookup" + } + } + }, + "engineAvailableSystemSetting": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "engineBlindTransferCallRequest": { + "type": "object", + "properties": { + "app_id": { + "type": "string" + }, + "destination": { + "type": "string" + }, + "domain_id": { + "type": "string", + "format": "int64" }, - "status": { - "title": "Status associated with the catalog", - "$ref": "#/definitions/generalLookup" + "id": { + "type": "string" + } + } + }, + "engineBlindTransferCallResponse": { + "type": "object" + }, + "engineBroadcastButton": { + "type": "object", + "properties": { + "caption": { + "type": "string" }, - "teams": { - "type": "array", - "title": "Teams associated with the catalog", - "items": { - "type": "object", - "$ref": "#/definitions/generalLookup" - } + "code": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "int64", - "title": "Timestamp when the catalog was last updated" + "text": { + "type": "string" }, - "updated_by": { - "title": "User who last updated the catalog", - "$ref": "#/definitions/generalLookup" + "type": { + "type": "string" + }, + "url": { + "type": "string" } } }, - "casesCatalogList": { + "engineBroadcastButtons": { "type": "object", - "title": "CatalogList message contains a list of catalogs with pagination", "properties": { - "items": { + "button": { "type": "array", - "title": "List of catalog items", "items": { - "type": "object", - "$ref": "#/definitions/casesCatalog" + "$ref": "#/definitions/engineBroadcastButton" } - }, - "next": { - "type": "boolean", - "title": "Indicates if there are more pages" - }, - "page": { - "type": "integer", - "format": "int32", - "title": "Page number for pagination" } } }, - "casesChatEvent": { + "engineBroadcastFile": { + "description": "Media File.", "type": "object", "properties": { - "closed_at": { - "type": "string", - "format": "int64" - }, - "duration": { + "id": { "type": "string", "format": "int64" }, - "flow_scheme": { - "$ref": "#/definitions/generalLookup" - }, - "gateway": { - "$ref": "#/definitions/generalExtendedLookup" + "mime": { + "type": "string" }, - "id": { + "name": { "type": "string" }, - "is_detailed": { - "type": "boolean" + "size": { + "type": "string", + "format": "int64" }, - "is_inbound": { - "type": "boolean" + "url": { + "type": "string" + } + } + }, + "engineBroadcastRequest": { + "type": "object", + "properties": { + "buttons": { + "type": "array", + "items": { + "$ref": "#/definitions/engineBroadcastButtons" + } }, - "is_missed": { - "type": "boolean" + "file": { + "description": "Message Media. Attachment.", + "$ref": "#/definitions/engineBroadcastFile" }, - "participants": { + "peer": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/generalLookup" + "type": "string" } }, - "queue": { - "$ref": "#/definitions/generalLookup" + "profile_id": { + "type": "string", + "format": "int64" + }, + "text": { + "type": "string" } } }, - "casesCloseInfo": { - "description": "Message representing close information for a case.", + "engineBroadcastResponse": { + "type": "object" + }, + "engineBucket": { "type": "object", "properties": { - "close_reason": { - "description": "Lookup for the close reason.", - "$ref": "#/definitions/generalLookup" + "description": { + "type": "string" }, - "close_result": { - "description": "Result or reason for closing the case.", + "id": { + "type": "string", + "format": "int64" + }, + "name": { "type": "string" } } }, - "casesCloseReason": { + "engineCalendar": { "type": "object", - "title": "CloseReason message represents a close reason entity with metadata", "properties": { - "close_reason_group_id": { - "type": "string", - "format": "int64", - "title": "Close Reason Group ID of the close reason" + "accepts": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAcceptOfDay" + } }, "created_at": { "type": "string", - "format": "int64", - "title": "CreatedAt timestamp of the close reason" + "format": "int64" }, "created_by": { - "title": "CreatedBy user of the close reason", - "$ref": "#/definitions/generalLookup" + "$ref": "#/definitions/engineLookup" }, "description": { + "type": "string" + }, + "domain_id": { "type": "string", - "title": "Description of the close reason" + "format": "int64" + }, + "end_at": { + "type": "string", + "format": "int64" + }, + "excepts": { + "type": "array", + "items": { + "$ref": "#/definitions/engineExceptDate" + } }, "id": { "type": "string", - "format": "int64", - "title": "Unique identifier of the close reason" + "format": "int64" }, "name": { + "type": "string" + }, + "specials": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAcceptOfDay" + } + }, + "start_at": { "type": "string", - "title": "Name of the close reason" + "format": "int64" + }, + "timezone": { + "$ref": "#/definitions/engineLookup" }, "updated_at": { "type": "string", - "format": "int64", - "title": "UpdatedAt timestamp of the close reason" + "format": "int64" }, "updated_by": { - "title": "UpdatedBy user of the close reason", - "$ref": "#/definitions/generalLookup" + "$ref": "#/definitions/engineLookup" } } }, - "casesCloseReasonGroup": { + "engineCallAnnotation": { "type": "object", - "title": "CloseReasonGroup message represents a close reason group entity with metadata", "properties": { + "call_id": { + "type": "string" + }, "created_at": { "type": "string", - "format": "int64", - "title": "CreatedAt timestamp of the close reason group" + "format": "int64" }, "created_by": { - "title": "CreatedBy user of the close reason group", - "$ref": "#/definitions/generalLookup" + "$ref": "#/definitions/engineLookup" }, - "description": { + "end_sec": { + "type": "integer", + "format": "int32" + }, + "id": { "type": "string", - "title": "Description of the close reason group" + "format": "int64" + }, + "note": { + "type": "string" + }, + "start_sec": { + "type": "integer", + "format": "int32" + }, + "updated_at": { + "type": "string", + "format": "int64" }, + "updated_by": { + "$ref": "#/definitions/engineLookup" + } + } + }, + "engineCallFile": { + "type": "object", + "properties": { "id": { "type": "string", - "format": "int64", - "title": "Unique identifier of the close reason group" + "format": "int64" + }, + "mime_type": { + "type": "string" }, "name": { + "type": "string" + }, + "size": { "type": "string", - "title": "Name of the close reason group" + "format": "int64" }, - "updated_at": { + "start_at": { "type": "string", - "format": "int64", - "title": "UpdatedAt timestamp of the close reason group" + "format": "int64" }, - "updated_by": { - "title": "UpdatedBy user of the close reason group", - "$ref": "#/definitions/generalLookup" + "stop_at": { + "type": "string", + "format": "int64" } } }, - "casesCloseReasonGroupList": { + "engineCallHold": { "type": "object", - "title": "CloseReasonGroupList message contains a list of CloseReasonGroup items with pagination", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/casesCloseReasonGroup" - } + "sec": { + "type": "number", + "format": "float" }, - "next": { - "type": "boolean" + "start": { + "type": "string", + "format": "int64" }, - "page": { - "type": "integer", - "format": "int32" + "stop": { + "type": "string", + "format": "int64" } } }, - "casesCloseReasonList": { + "engineChatPlan": { "type": "object", - "title": "CloseReasonList message contains a list of CloseReason items with pagination", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/casesCloseReason" - } + "description": { + "type": "string" }, - "next": { - "type": "boolean" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "page": { + "id": { "type": "integer", "format": "int32" + }, + "name": { + "type": "string" + }, + "schema": { + "$ref": "#/definitions/engineLookup" } } }, - "casesCreateCaseCloseInput": { - "description": "Structure for close information when a case is closed.", + "engineCommunicationChannels": { + "type": "string", + "default": "Undefined", + "enum": [ + "Undefined", + "Phone", + "Email", + "Messaging" + ] + }, + "engineCommunicationType": { "type": "object", "properties": { - "close_reason": { - "description": "Close reason ID from lookup.", - "$ref": "#/definitions/generalLookup" + "channel": { + "$ref": "#/definitions/engineCommunicationChannels" }, - "close_result": { - "description": "Comment or reason for closing the case.", + "code": { + "type": "string" + }, + "default": { + "type": "boolean", + "format": "boolean" + }, + "description": { + "type": "string" + }, + "domain_id": { + "type": "string", + "format": "int64" + }, + "id": { + "type": "string", + "format": "int64" + }, + "name": { "type": "string" } } }, - "casesCreateCaseRelatedCaseInput": { - "description": "Structure for related cases input when creating a case.", + "engineCommunicationTypeRequest": { "type": "object", "properties": { - "etag": { - "description": "Etag of the related case.", + "channel": { + "$ref": "#/definitions/engineCommunicationChannels" + }, + "code": { "type": "string" }, - "related_to": { - "description": "Identifier of the related case.", + "default": { + "type": "boolean", + "format": "boolean" + }, + "description": { "type": "string" }, - "relation_type": { - "description": "Type of relation (e.g., duplicate, linked).", - "$ref": "#/definitions/casesRelationType" + "name": { + "type": "string" } } }, - "casesCreateCatalogRequest": { + "engineConfirmPushResponse": { + "type": "object" + }, + "engineCreateAgentPauseCauseRequest": { "type": "object", - "title": "CreateCatalogRequest message for creating a new catalog", "properties": { - "close_reason_group": { - "title": "Close reason ID associated with the catalog", - "$ref": "#/definitions/generalLookup" + "allow_admin": { + "type": "boolean", + "format": "boolean" }, - "code": { - "type": "string", - "title": "Code for external integrations (optional)" + "allow_agent": { + "type": "boolean", + "format": "boolean" + }, + "allow_supervisor": { + "type": "boolean", + "format": "boolean" }, "description": { - "type": "string", - "title": "Description of the catalog (optional)" + "type": "string" }, - "name": { - "type": "string", - "title": "Name of the catalog (required)" + "limit_min": { + "type": "integer", + "format": "int64" }, - "prefix": { - "type": "string", - "title": "Prefix for case identification (optional)" + "name": { + "type": "string" + } + } + }, + "engineCreateAgentRequest": { + "type": "object", + "properties": { + "allow_channels": { + "type": "array", + "items": { + "type": "string" + } }, - "skills": { + "auditor": { "type": "array", - "title": "List of skill IDs associated with the catalog", "items": { - "type": "object", - "$ref": "#/definitions/generalLookup" + "$ref": "#/definitions/engineLookup" } }, - "sla": { - "title": "SLA ID associated with the catalog", - "$ref": "#/definitions/generalLookup" + "chat_count": { + "type": "integer", + "format": "int64" }, - "state": { + "description": { + "type": "string" + }, + "domain_id": { + "type": "string", + "format": "int64" + }, + "greeting_media": { + "$ref": "#/definitions/engineLookup" + }, + "is_supervisor": { "type": "boolean", - "title": "State of the catalog (true for active, false for inactive)" + "format": "boolean" }, - "status": { - "title": "Status ID associated with the catalog", - "$ref": "#/definitions/generalLookup" + "progressive_count": { + "type": "integer", + "format": "int32" }, - "teams": { + "region": { + "$ref": "#/definitions/engineLookup" + }, + "supervisor": { "type": "array", - "title": "List of team IDs associated with the catalog", "items": { - "type": "object", - "$ref": "#/definitions/generalLookup" + "$ref": "#/definitions/engineLookup" } + }, + "task_count": { + "type": "integer", + "format": "int64" + }, + "team": { + "$ref": "#/definitions/engineLookup" + }, + "user": { + "$ref": "#/definitions/engineLookup" } } }, - "casesCreateCloseReasonGroupRequest": { + "engineCreateAgentSkillBulkItem": { "type": "object", - "title": "CreateCloseReasonGroupRequest message for creating a new close reason group", - "required": [ - "name" - ], "properties": { - "description": { - "type": "string" + "capacity": { + "type": "integer", + "format": "int32" }, - "name": { - "type": "string" + "domain_id": { + "type": "string", + "format": "int64" + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "skill": { + "$ref": "#/definitions/engineLookup" + } + } + }, + "engineCreateAgentSkillRequest": { + "type": "object", + "properties": { + "agent_id": { + "type": "string", + "format": "int64" + }, + "capacity": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "string", + "format": "int64" + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "skill": { + "$ref": "#/definitions/engineLookup" + } + } + }, + "engineCreateAgentSkillsRequest": { + "type": "object", + "properties": { + "agent_id": { + "type": "string", + "format": "int64" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineCreateAgentSkillBulkItem" + } } } }, - "casesCreateInputRelatedCase": { - "description": "Input for creating a related case.", + "engineCreateAgentSkillsResponse": { "type": "object", "properties": { - "related_case": { - "description": "Related case details.", - "$ref": "#/definitions/generalLookup" - }, - "relation_type": { - "description": "Relation type between the cases.", - "$ref": "#/definitions/casesRelationType" + "ids": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } } } }, - "casesCreateSLARequest": { + "engineCreateAgentTeamRequest": { "type": "object", - "title": "CreateSLARequest message for creating a new SLA", - "required": [ - "name", - "calendar_id", - "reaction_time", - "resolution_time" - ], "properties": { - "calendar": { - "title": "Calendar ID from the \"Calendars\" dictionary", - "$ref": "#/definitions/generalLookup" + "admin": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } + }, + "call_timeout": { + "type": "integer", + "format": "int32" }, "description": { + "type": "string" + }, + "domain_id": { "type": "string", - "title": "Description of the SLA" + "format": "int64" + }, + "forecast_calculation": { + "$ref": "#/definitions/engineLookup" + }, + "invite_chat_timeout": { + "type": "integer", + "format": "int32" + }, + "max_no_answer": { + "type": "integer", + "format": "int32" }, "name": { - "type": "string", - "title": "InputSLA message for creating a new SLA\nName of the SLA" + "type": "string" }, - "reaction_time": { - "type": "string", - "format": "int64", - "title": "Reaction time" + "no_answer_delay_time": { + "type": "integer", + "format": "int32" }, - "resolution_time": { - "type": "string", - "format": "int64", - "title": "Resolution time" + "strategy": { + "type": "string" }, - "valid_from": { - "type": "string", - "format": "int64", - "title": "Validity period for the SLA" + "task_accept_timeout": { + "type": "integer", + "format": "int32" }, - "valid_to": { - "type": "string", - "format": "int64" + "wrap_up_time": { + "type": "integer", + "format": "int32" } } }, - "casesCreateServiceRequest": { + "engineCreateAttemptRequest": { "type": "object", - "title": "CreateServiceRequest message for creating a new service", "properties": { - "assignee": { - "title": "Assignee ID responsible for the service", - "$ref": "#/definitions/generalLookup" - }, - "catalog_id": { + "agent_id": { "type": "string", - "format": "int64", - "title": "ID of the root catalog" + "format": "int64" }, - "code": { + "domain_id": { "type": "string", - "title": "Code for external integrations (optional)" + "format": "int64" }, - "description": { + "member_id": { "type": "string", - "title": "Description of the service (optional)" - }, - "group": { - "title": "Group ID responsible for the service", - "$ref": "#/definitions/generalExtendedLookup" + "format": "int64" }, - "name": { + "queue_id": { "type": "string", - "title": "Name of the service (required)" - }, - "root_id": { + "format": "int64" + } + } + }, + "engineCreateAttemptResponse": { + "type": "object", + "properties": { + "attempt_id": { "type": "string", - "format": "int64", - "title": "Parent catalog ID (required)" - }, - "sla": { - "title": "SLA ID associated with the service", - "$ref": "#/definitions/generalLookup" - }, - "state": { - "type": "boolean", - "title": "State of the service (true for active, false for inactive)" + "format": "int64" } } }, - "casesCreateSourceRequest": { - "description": "Request message for creating a new source.", + "engineCreateAuditFormRateRequest": { "type": "object", - "required": [ - "name", - "type" - ], "properties": { - "description": { - "description": "The description of the source.", + "answers": { + "type": "array", + "items": { + "$ref": "#/definitions/engineQuestionAnswer" + } + }, + "call_id": { "type": "string" }, - "name": { - "description": "The name of the source.", + "comment": { "type": "string" }, - "type": { - "description": "The source type of the source.", - "$ref": "#/definitions/casesSourceType" + "form": { + "$ref": "#/definitions/engineLookup" } } }, - "casesCreateStatusRequest": { + "engineCreateAuditFormRequest": { "type": "object", - "title": "CreateStatusRequest message for creating a new status", - "required": [ - "name" - ], "properties": { "description": { "type": "string" }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, "name": { "type": "string" + }, + "questions": { + "type": "array", + "items": { + "$ref": "#/definitions/engineQuestion" + } + }, + "teams": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } } } }, - "casesDayTimeline": { + "engineCreateBucketRequest": { "type": "object", "properties": { - "calls_count": { - "type": "string", - "format": "int64" - }, - "chats_count": { - "type": "string", - "format": "int64" - }, - "day_timestamp": { - "type": "string", - "format": "int64" + "description": { + "type": "string" }, - "emails_count": { + "domain_id": { "type": "string", "format": "int64" }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/casesEvent" - } + "name": { + "type": "string" } } }, - "casesEmailEvent": { + "engineCreateCalendarRequest": { "type": "object", "properties": { - "attachments": { + "accepts": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/casesAttachment" + "$ref": "#/definitions/engineAcceptOfDay" } }, - "body": { + "description": { + "type": "string" + }, + "domain_id": { "type": "string", - "title": "plain text of email" + "format": "int64" }, - "cc": { - "type": "array", - "title": "array of ccs (email addresses)", - "items": { - "type": "string" - } + "end_at": { + "type": "string", + "format": "int64" }, - "from": { + "excepts": { "type": "array", - "title": "array of senders (email addresses)", "items": { - "type": "string" + "$ref": "#/definitions/engineExceptDate" } }, - "html": { - "type": "string", - "title": "html body of email" - }, - "id": { + "name": { "type": "string" }, - "is_detailed": { - "type": "boolean", - "title": "reserved for the open" - }, - "is_inbound": { - "type": "boolean", - "title": "inbound/outbound email" - }, - "owner": { - "title": "Agent who sent/accepted", - "$ref": "#/definitions/generalLookup" - }, - "profile": { - "title": "email profile", - "$ref": "#/definitions/generalLookup" - }, - "sender": { + "specials": { "type": "array", - "title": "array of receivers (email addresses)", "items": { - "type": "string" + "$ref": "#/definitions/engineAcceptOfDay" } }, - "subject": { - "type": "string" + "start_at": { + "type": "string", + "format": "int64" }, - "to": { - "type": "array", - "title": "array of receivers (email addresses)", - "items": { - "type": "string" - } + "timezone": { + "$ref": "#/definitions/engineLookup" } } }, - "casesEvent": { + "engineCreateCallAnnotationRequest": { "type": "object", "properties": { - "call": { - "$ref": "#/definitions/casesCallEvent" - }, - "chat": { - "$ref": "#/definitions/casesChatEvent" + "call_id": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "int64" + "end_sec": { + "type": "integer", + "format": "int32" }, - "email": { - "$ref": "#/definitions/casesEmailEvent" + "note": { + "type": "string" }, - "type": { - "$ref": "#/definitions/casesCaseTimelineEventType" + "start_sec": { + "type": "integer", + "format": "int32" } } }, - "casesFile": { - "description": "Metadata for a file associated with a case.", + "engineCreateCallRequest": { "type": "object", "properties": { - "author": { - "$ref": "#/definitions/generalLookup" + "destination": { + "type": "string" }, - "created_at": { - "description": "Creation timestamp in Unix milliseconds.", + "domain_id": { "type": "string", "format": "int64" }, - "created_by": { - "description": "Creator of the file.", - "$ref": "#/definitions/generalLookup" + "from": { + "$ref": "#/definitions/engineCreateCallRequestEndpointRequest" }, - "id": { - "description": "Storage file ID.", - "type": "string", - "format": "int64" + "params": { + "$ref": "#/definitions/CreateCallRequestCallSettings" }, - "mime": { - "description": "MIME type of the file.", + "to": { + "$ref": "#/definitions/engineCreateCallRequestEndpointRequest" + } + } + }, + "engineCreateCallRequestEndpointRequest": { + "type": "object", + "properties": { + "app_id": { "type": "string" }, - "name": { - "description": "File name.", + "extension": { "type": "string" }, - "size": { - "description": "File size in bytes.", + "id": { "type": "string", "format": "int64" }, - "url": { + "type": { "type": "string" } } }, - "casesGetTimelineCounterResponse": { + "engineCreateCallResponse": { "type": "object", "properties": { - "calls_count": { - "type": "string", - "format": "int64" - }, - "chats_count": { - "type": "string", - "format": "int64", - "title": "defined event types" - }, - "date_from": { - "type": "string", - "format": "int64", - "title": "filter dates" - }, - "date_to": { - "type": "string", - "format": "int64" - }, - "emails_count": { - "type": "string", - "format": "int64" + "id": { + "type": "string" } } }, - "casesGetTimelineResponse": { + "engineCreateChatPlanRequest": { "type": "object", "properties": { - "days": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/casesDayTimeline" - } + "description": { + "type": "string" }, - "next": { - "type": "boolean" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "page": { - "type": "integer", - "format": "int32" + "name": { + "type": "string" + }, + "schema": { + "$ref": "#/definitions/engineLookup" } } }, - "casesInputCase": { + "engineCreateEmailProfileRequest": { "type": "object", "properties": { - "assignee": { - "title": "create: not required, default from service or set by UI;", - "$ref": "#/definitions/generalLookup" - }, - "close": { - "title": "create: not required; update: required only when case status goes to the final state", - "$ref": "#/definitions/casesCloseInfo" + "auth_type": { + "$ref": "#/definitions/engineEmailAuthType" }, - "close_reason": { - "title": "create: not required;", - "$ref": "#/definitions/generalLookup" + "description": { + "type": "string" }, - "contact_info": { - "type": "string", - "title": "create: not required;" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "description": { - "type": "string", - "title": "create: not required;" + "fetch_interval": { + "type": "integer", + "format": "int32" }, - "etag": { + "imap_host": { "type": "string" }, - "group": { - "title": "create: not required, default from service or set by UI;", - "$ref": "#/definitions/generalLookup" + "imap_port": { + "type": "integer", + "format": "int32" }, - "impacted": { - "title": "create: required, default is reporter or ui (if empty recognize as anonymous);", - "$ref": "#/definitions/generalLookup" + "listen": { + "type": "boolean", + "format": "boolean" }, - "priority": { - "title": "create: not required, default first value from priority lookup", - "$ref": "#/definitions/generalLookup" + "login": { + "type": "string" }, - "rate": { - "title": "only for API, not UI", - "$ref": "#/definitions/casesRateInfo" + "mailbox": { + "type": "string" }, - "reporter": { - "title": "create: required (if empty recognize as anonymous contact);", - "$ref": "#/definitions/generalLookup" + "name": { + "type": "string" }, - "service": { - "title": "on this field base many other readonly fields on return", - "$ref": "#/definitions/generalLookup" + "params": { + "$ref": "#/definitions/engineEmailProfileParams" }, - "source": { - "title": "source of the case", - "$ref": "#/definitions/generalLookup" + "password": { + "type": "string" }, - "status": { - "title": "create: not required, default initial value from status lookup or ui;", - "$ref": "#/definitions/generalLookup" + "schema": { + "$ref": "#/definitions/engineLookup" }, - "status_condition": { - "$ref": "#/definitions/casesStatusCondition" + "smtp_host": { + "type": "string" }, - "subject": { + "smtp_port": { + "type": "integer", + "format": "int32" + } + } + }, + "engineCreateListCommunicationRequest": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "expire_at": { "type": "string", - "title": "create: required;" + "format": "int64" + }, + "list_id": { + "type": "string", + "format": "int64" + }, + "number": { + "type": "string" } } }, - "casesInputCaseComment": { - "description": "Input structure for creating or updating a case comment.", + "engineCreateListRequest": { "type": "object", "properties": { - "etag": { - "description": "Identifier for the comment.", + "description": { + "type": "string" + }, + "domain_id": { + "type": "string", + "format": "int64" + }, + "name": { "type": "string" + } + } + }, + "engineCreateMemberBulkItem": { + "type": "object", + "properties": { + "agent": { + "$ref": "#/definitions/engineLookup" + }, + "bucket": { + "$ref": "#/definitions/engineLookup" + }, + "communications": { + "type": "array", + "items": { + "$ref": "#/definitions/engineMemberCommunicationCreateRequest" + } + }, + "expire_at": { + "type": "string", + "format": "int64" + }, + "min_offering_at": { + "type": "string", + "format": "int64" }, - "text": { - "description": "Content of the comment.", - "type": "string" - } - }, - "example": { - "text": "My new comment" - } - }, - "casesInputCaseCommunication": { - "description": "Represents input data for creating or linking a communication.", - "type": "object", - "properties": { - "communication_id": { - "description": "External communication ID.", + "name": { "type": "string" }, - "communication_type": { - "description": "Type of the communication.", - "$ref": "#/definitions/casesCaseCommunicationsTypes" + "priority": { + "type": "integer", + "format": "int32" + }, + "skill": { + "$ref": "#/definitions/engineLookup" + }, + "timezone": { + "$ref": "#/definitions/engineLookup" + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, - "casesInputCaseLink": { + "engineCreateMemberBulkRequest": { "type": "object", "properties": { - "etag": { + "file_name": { "type": "string" }, - "name": { - "type": "string" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineCreateMemberBulkItem" + } }, - "url": { - "type": "string" + "queue_id": { + "type": "string", + "format": "int64" } } }, - "casesInputCatalog": { + "engineCreateMemberRequest": { "type": "object", - "title": "InputCatalog message contains the fields for creating or updating a catalog", "properties": { - "close_reason_group": { - "title": "Close reason group ID associated with the catalog", - "$ref": "#/definitions/generalLookup" + "agent": { + "$ref": "#/definitions/engineLookup" }, - "code": { - "type": "string", - "title": "Code for external integrations (optional)" + "bucket": { + "$ref": "#/definitions/engineLookup" }, - "description": { + "communications": { + "type": "array", + "items": { + "$ref": "#/definitions/engineMemberCommunicationCreateRequest" + } + }, + "domain_id": { "type": "string", - "title": "Description of the catalog (optional)" + "format": "int64" }, - "name": { + "expire_at": { "type": "string", - "title": "Name of the catalog (required)" + "format": "int64" }, - "prefix": { + "min_offering_at": { "type": "string", - "title": "Prefix for case identification (optional)" + "format": "int64" }, - "skills": { - "type": "array", - "title": "List of skill IDs associated with the catalog", - "items": { - "type": "object", - "$ref": "#/definitions/generalLookup" - } + "name": { + "type": "string" }, - "sla": { - "title": "SLA ID associated with the catalog", - "$ref": "#/definitions/generalLookup" + "priority": { + "type": "integer", + "format": "int32" }, - "state": { - "type": "boolean", - "title": "State of the catalog (true for active, false for inactive)" + "queue_id": { + "type": "string", + "format": "int64" }, - "status": { - "title": "Status ID associated with the catalog", - "$ref": "#/definitions/generalLookup" + "skill": { + "$ref": "#/definitions/engineLookup" }, - "teams": { + "timezone": { + "$ref": "#/definitions/engineLookup" + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "engineCreateOutboundResourceDisplayBulkRequest": { + "type": "object", + "properties": { + "items": { "type": "array", - "title": "List of team IDs associated with the catalog", "items": { - "type": "object", - "$ref": "#/definitions/generalLookup" + "$ref": "#/definitions/engineCreateOutboundResourceDisplayRequest" } + }, + "resource_id": { + "type": "string", + "format": "int64" } } }, - "casesInputCloseReason": { + "engineCreateOutboundResourceDisplayRequest": { "type": "object", - "title": "InputCloseReason message for inputting close reason data", "properties": { - "description": { + "display": { + "type": "string" + }, + "domain_id": { "type": "string", - "title": "Description of the close reason" + "format": "int64" }, - "name": { + "resource_id": { "type": "string", - "title": "Name of the close reason" + "format": "int64" } } }, - "casesInputCloseReasonGroup": { + "engineCreateOutboundResourceGroupRequest": { "type": "object", "properties": { + "communication": { + "$ref": "#/definitions/engineLookup" + }, "description": { "type": "string" }, + "domain_id": { + "type": "string", + "format": "int64" + }, "name": { "type": "string" + }, + "strategy": { + "type": "string" + }, + "time": { + "type": "array", + "items": { + "$ref": "#/definitions/engineOutboundResourceTimeRange" + } } } }, - "casesInputCreateCase": { - "description": "Input structure for creating a new case.", + "engineCreateOutboundResourceInGroupRequest": { "type": "object", "properties": { - "assignee": { - "description": "Optional assignee ID.", - "$ref": "#/definitions/generalLookup" - }, - "close": { - "description": "Optional close information.", - "$ref": "#/definitions/casesCreateCaseCloseInput" + "group_id": { + "type": "string", + "format": "int64" }, - "close_reason_group": { - "description": "Optional close reason.", - "$ref": "#/definitions/generalLookup" + "priority": { + "type": "integer", + "format": "int64" }, - "contact_info": { - "description": "Optional contact information.", - "type": "string" + "reserve_resource": { + "$ref": "#/definitions/engineLookup" }, + "resource": { + "$ref": "#/definitions/engineLookup" + } + } + }, + "engineCreateOutboundResourceRequest": { + "type": "object", + "properties": { "description": { - "description": "Optional description of the case.", "type": "string" }, - "group": { - "description": "Optional group ID.", - "$ref": "#/definitions/generalLookup" - }, - "impacted": { - "description": "Required impacted user ID (default: reporter).", - "$ref": "#/definitions/generalLookup" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "links": { - "description": "List of links attached to the case.", + "error_ids": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/casesInputCaseLink" + "type": "string" } }, - "priority": { - "description": "Optional priority level.", - "$ref": "#/definitions/generalLookup" + "failure_dial_delay": { + "type": "integer", + "format": "int64" }, - "rate": { - "description": "API-only rating information.", - "$ref": "#/definitions/casesRateInfo" + "gateway": { + "$ref": "#/definitions/engineLookup" }, - "related": { - "description": "List of related cases.", + "limit": { + "type": "integer", + "format": "int32" + }, + "max_successively_errors": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string" + }, + "number": { + "type": "string" + }, + "parameters": { + "$ref": "#/definitions/engineOutboundResourceParameters" + }, + "patterns": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/casesCreateCaseRelatedCaseInput" + "type": "string" } }, - "reporter": { - "description": "Required reporter ID (if empty, anonymous contact).", - "$ref": "#/definitions/generalLookup" - }, - "service": { - "description": "Service ID (affects many other readonly fields).", - "$ref": "#/definitions/generalLookup" + "reserve": { + "type": "boolean", + "format": "boolean" }, - "source": { - "description": "Source of the case.", - "$ref": "#/definitions/generalLookup" + "rps": { + "type": "integer", + "format": "int32" }, - "status": { - "description": "Initial case status (default from lookup or UI).", - "$ref": "#/definitions/generalLookup" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "engineCreatePresetQueryRequest": { + "type": "object", + "properties": { + "description": { + "type": "string" }, - "subject": { - "description": "Required subject of the case.", + "name": { "type": "string" + }, + "preset": { + "type": "object" + }, + "section": { + "$ref": "#/definitions/enginePresetQuerySection" } } }, - "casesInputPriority": { + "engineCreateQueueBucketRequest": { "type": "object", - "title": "InputPriority message for creating a new priority", "properties": { - "color": { - "type": "string", - "title": "Color of the priority" + "bucket": { + "$ref": "#/definitions/engineLookup" }, - "description": { - "type": "string", - "title": "Description of the priority" + "disabled": { + "type": "boolean", + "format": "boolean" }, - "name": { + "priority": { + "type": "integer", + "format": "int32" + }, + "queue_id": { "type": "string", - "title": "Name of the priority" + "format": "int64" + }, + "ratio": { + "type": "integer", + "format": "int32" } } }, - "casesInputRelatedCase": { - "description": "Input for creating or updating a related case.", + "engineCreateQueueHookRequest": { "type": "object", "properties": { - "primary_case": { - "description": "Primary case details.", - "$ref": "#/definitions/generalLookup" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "related_case": { - "description": "Related case details.", - "$ref": "#/definitions/generalLookup" + "event": { + "type": "string" }, - "relation_type": { - "description": "Relation type.", - "$ref": "#/definitions/casesRelationType" + "properties": { + "type": "array", + "items": { + "type": "string" + } + }, + "queue_id": { + "type": "integer", + "format": "int64" + }, + "schema": { + "$ref": "#/definitions/engineLookup" } } }, - "casesInputSLA": { + "engineCreateQueueRequest": { "type": "object", - "title": "InputSLA message for inputting SLA data", "properties": { + "after_schema": { + "$ref": "#/definitions/engineLookup" + }, "calendar": { - "title": "Calendar ID from the \"Calendars\" dictionary", - "$ref": "#/definitions/generalLookup" + "$ref": "#/definitions/engineLookup" }, "description": { + "type": "string" + }, + "dnc_list": { + "$ref": "#/definitions/engineLookup" + }, + "do_schema": { + "$ref": "#/definitions/engineLookup" + }, + "domain_id": { "type": "string", - "title": "Description of the SLA" + "format": "int64" + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "form_schema": { + "$ref": "#/definitions/engineLookup" + }, + "grantee": { + "$ref": "#/definitions/engineLookup" }, "name": { - "type": "string", - "title": "Name of the SLA" + "type": "string" }, - "reaction_time": { - "type": "string", - "format": "int64", - "title": "Reaction time" + "payload": { + "type": "object" }, - "resolution_time": { - "type": "string", - "format": "int64", - "title": "Resolution time" + "priority": { + "type": "integer", + "format": "int32" }, - "valid_from": { - "type": "string", - "format": "int64", - "title": "Validity period for the SLA" + "processing": { + "type": "boolean", + "format": "boolean" }, - "valid_to": { - "type": "string", + "processing_renewal_sec": { + "type": "integer", "format": "int64" - } - } - }, - "casesInputSLACondition": { - "type": "object", - "title": "InputSLACondition message for inputting SLACondition data", - "properties": { - "name": { + }, + "processing_sec": { + "type": "integer", + "format": "int64" + }, + "ringtone": { + "$ref": "#/definitions/engineLookup" + }, + "schema": { + "$ref": "#/definitions/engineLookup" + }, + "sec_locate_agent": { + "type": "integer", + "format": "int32" + }, + "sticky_agent": { + "type": "boolean", + "format": "boolean" + }, + "strategy": { "type": "string" }, - "priorities": { + "tags": { "type": "array", - "title": "List of priority IDs for creation", "items": { - "type": "object", - "$ref": "#/definitions/generalLookup" + "$ref": "#/definitions/engineTag" } }, - "reaction_time": { - "type": "string", - "format": "int64" + "task_processing": { + "$ref": "#/definitions/engineTaskProcessing" }, - "resolution_time": { + "team": { + "$ref": "#/definitions/engineLookup" + }, + "timeout": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "integer", + "format": "int32" + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "engineCreateQueueResourceGroupRequest": { + "type": "object", + "properties": { + "domain_id": { "type": "string", "format": "int64" }, - "sla_id": { + "queue_id": { "type": "string", "format": "int64" + }, + "resource_group": { + "$ref": "#/definitions/engineLookup" } } }, - "casesInputService": { + "engineCreateQueueSkillRequest": { "type": "object", - "title": "InputService message contains the fields for creating or updating a service", "properties": { - "assignee": { - "title": "Assignee ID responsible for the service", - "$ref": "#/definitions/generalLookup" - }, - "catalog_id": { - "type": "string", - "format": "int64", - "title": "The parent catalog (required)" - }, - "code": { - "type": "string", - "title": "Code for external integrations (optional)" + "buckets": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } }, - "description": { - "type": "string", - "title": "Description of the service (optional)" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "group": { - "title": "Group ID responsible for the service", - "$ref": "#/definitions/generalExtendedLookup" + "lvl": { + "type": "integer", + "format": "int32" }, - "name": { - "type": "string", - "title": "Name of the service (required)" + "max_capacity": { + "type": "integer", + "format": "int32" }, - "root_id": { - "type": "string", - "format": "int64", - "title": "ID of the root catalog" + "min_capacity": { + "type": "integer", + "format": "int32" }, - "sla": { - "title": "SLA ID associated with the service", - "$ref": "#/definitions/generalLookup" + "queue_id": { + "type": "integer", + "format": "int64" }, - "state": { - "type": "boolean", - "title": "State of the service (true for active, false for inactive)" + "skill": { + "$ref": "#/definitions/engineLookup" } } }, - "casesInputSource": { + "engineCreateQuickReplyRequest": { "type": "object", "properties": { - "description": { - "description": "The description of the source.", - "type": "string" + "article": { + "$ref": "#/definitions/engineLookup" }, "name": { - "description": "The name of the source.", "type": "string" }, - "type": { - "description": "The source type of the source.", - "$ref": "#/definitions/casesSourceType" + "queue": { + "$ref": "#/definitions/engineLookup" + }, + "team": { + "$ref": "#/definitions/engineLookup" + }, + "text": { + "type": "string" } } }, - "casesInputStatus": { + "engineCreateRegionRequest": { "type": "object", "properties": { "description": { @@ -40903,996 +42355,743 @@ }, "name": { "type": "string" + }, + "timezone": { + "$ref": "#/definitions/engineLookup" } } }, - "casesInputStatusCondition": { + "engineCreateRoutingOutboundCallRequest": { "type": "object", - "title": "InputStatusCondition message for inputting status condition data", "properties": { "description": { - "type": "string", - "title": "Description of the status condition" + "type": "string" }, - "final": { + "disabled": { "type": "boolean", - "title": "Final status condition" + "format": "boolean" }, - "initial": { - "type": "boolean", - "title": "Initial status condition" + "domain_id": { + "type": "string", + "format": "int64" }, "name": { - "type": "string", - "title": "Name of the status condition" + "type": "string" + }, + "pattern": { + "type": "string" + }, + "schema": { + "$ref": "#/definitions/engineLookup" } } }, - "casesLinkCommunicationResponse": { - "description": "Response message after linking communications to a case.", + "engineCreateRoutingSchemaRequest": { "type": "object", "properties": { - "data": { - "description": "List of linked communications.", + "debug": { + "type": "boolean", + "format": "boolean" + }, + "description": { + "type": "string" + }, + "editor": { + "type": "boolean", + "format": "boolean" + }, + "name": { + "type": "string" + }, + "payload": { + "type": "object" + }, + "schema": { + "type": "object" + }, + "tags": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/casesCaseCommunication" + "$ref": "#/definitions/engineSchemaTag" } + }, + "type": { + "$ref": "#/definitions/engineRoutingSchemaType" } } }, - "casesListCommunicationsResponse": { - "description": "Response message for listing communications linked to a case.", + "engineCreateRoutingVariableRequest": { "type": "object", "properties": { - "data": { - "description": "List of communications.", - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/casesCaseCommunication" - } + "domain_id": { + "type": "string", + "format": "int64" }, - "next": { - "type": "boolean" + "key": { + "type": "string" }, - "page": { - "description": "Current page number.", - "type": "integer", - "format": "int32" - } - } - }, - "casesLocateCatalogResponse": { - "type": "object", - "title": "LocateCatalogResponse message contains a single catalog entity", - "properties": { - "catalog": { - "title": "The located catalog", - "$ref": "#/definitions/casesCatalog" - } - } - }, - "casesLocateCloseReasonGroupResponse": { - "type": "object", - "title": "LocateCloseReasonGroupResponse message contains a single close reason group entity", - "properties": { - "close_reason_group": { - "$ref": "#/definitions/casesCloseReasonGroup" - } - } - }, - "casesLocateCloseReasonResponse": { - "type": "object", - "title": "LocateCloseReasonResponse message contains a single close reason entity", - "properties": { - "close_reason": { - "$ref": "#/definitions/casesCloseReason" - } - } - }, - "casesLocatePriorityResponse": { - "type": "object", - "title": "LocatePriorityResponse message contains a single priority entity", - "properties": { - "priority": { - "$ref": "#/definitions/casesPriority" - } - } - }, - "casesLocateSLAConditionResponse": { - "type": "object", - "title": "LocateSLAConditionResponse message contains a single SLACondition entity", - "properties": { - "sla_condition": { - "$ref": "#/definitions/casesSLACondition" - } - } - }, - "casesLocateSLAResponse": { - "type": "object", - "title": "LocateSLAResponse message contains a single SLA entity", - "properties": { - "sla": { - "$ref": "#/definitions/casesSLA" - } - } - }, - "casesLocateServiceResponse": { - "type": "object", - "title": "LocateServiceResponse message contains a single service entity", - "properties": { - "service": { - "title": "The located service", - "$ref": "#/definitions/casesService" - } - } - }, - "casesLocateSourceResponse": { - "description": "Response message for locating a source.", - "type": "object", - "properties": { - "source": { - "description": "The located source.", - "$ref": "#/definitions/casesSource" - } - } - }, - "casesLocateStatusConditionResponse": { - "type": "object", - "title": "LocateStatusConditionResponse message contains a single status entity", - "properties": { - "status": { - "$ref": "#/definitions/casesStatusCondition" + "value": { + "type": "string" } } }, - "casesLocateStatusResponse": { + "engineCreateSchemaVariableRequest": { "type": "object", - "title": "LocateStatusResponse message contains a single status entity", "properties": { - "status": { - "$ref": "#/definitions/webitelcasesStatus" + "encrypt": { + "type": "boolean", + "format": "boolean" + }, + "name": { + "type": "string" + }, + "value": { + "type": "object" } } }, - "casesPriority": { + "engineCreateSkillAgentRequest": { "type": "object", - "title": "Priority message represents a priority entity with metadata", "properties": { - "color": { - "type": "string", - "title": "Color of the priority" - }, - "created_at": { - "type": "string", - "format": "int64", - "title": "CreatedAt timestamp of the priority" - }, - "created_by": { - "title": "CreatedBy user of the priority", - "$ref": "#/definitions/generalLookup" - }, - "description": { - "type": "string", - "title": "Description of the priority" + "agent": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } }, - "id": { - "type": "string", - "format": "int64", - "title": "Unique identifier of the priority" + "capacity": { + "type": "integer", + "format": "int32" }, - "name": { - "type": "string", - "title": "Name of the priority" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "updated_at": { + "skill_id": { "type": "string", - "format": "int64", - "title": "UpdatedAt timestamp of the priority" - }, - "updated_by": { - "title": "UpdatedBy user of the priority", - "$ref": "#/definitions/generalLookup" + "format": "int64" } } }, - "casesPriorityList": { + "engineCreateSkillAgentResponse": { "type": "object", - "title": "PriorityList message contains a list of Priority items with pagination", "properties": { "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/casesPriority" + "$ref": "#/definitions/engineSkillAgentItem" } - }, - "next": { - "type": "boolean" - }, - "page": { - "type": "integer", - "format": "int32" } } }, - "casesRateInfo": { - "description": "Message representing rating information.", + "engineCreateSkillRequest": { "type": "object", "properties": { - "rating": { - "description": "Rating value.", + "description": { + "type": "string" + }, + "domain_id": { "type": "string", "format": "int64" }, - "rating_comment": { - "description": "Optional comment for the rating.", + "name": { "type": "string" } } }, - "casesRelatedCase": { - "description": "Represents a related case with its relationship details.", + "engineCreateSystemSettingRequest": { "type": "object", "properties": { - "created_at": { - "description": "Timestamp (in milliseconds) of when the relation was created.", - "type": "string", - "format": "int64" - }, - "created_by": { - "description": "User who created the relation.", - "$ref": "#/definitions/generalLookup" - }, - "etag": { - "description": "Etag for the related case entity.", - "type": "string" - }, - "id": { - "description": "Unique identifier for the related case.", - "type": "string", - "format": "int64" - }, - "primary_case": { - "description": "Primary case details.", - "$ref": "#/definitions/casesRelatedCaseLookup" - }, - "related_case": { - "description": "Related case details.", - "$ref": "#/definitions/casesRelatedCaseLookup" - }, - "relation_type": { - "description": "Relation type between cases.", - "$ref": "#/definitions/casesRelationType" - }, - "updated_at": { - "description": "Timestamp (in milliseconds) of the last update.", - "type": "string", - "format": "int64" - }, - "updated_by": { - "description": "User who last updated the relation.", - "$ref": "#/definitions/generalLookup" + "name": { + "$ref": "#/definitions/engineSystemSettingName" }, - "ver": { - "description": "Version number of the related case, used for concurrency control.", - "type": "integer", - "format": "int32" + "value": { + "type": "object" } } }, - "casesRelatedCaseList": { - "description": "Paginated list of related cases.", + "engineCreateTeamHookRequest": { "type": "object", "properties": { - "data": { - "description": "List of related cases on the current page.", + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "event": { + "$ref": "#/definitions/engineTeamHookEvent" + }, + "properties": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/casesRelatedCase" + "type": "string" } }, - "next": { - "description": "Flag to indicate if more pages are available.", - "type": "boolean" + "schema": { + "$ref": "#/definitions/engineLookup" }, - "page": { - "description": "Current page number.", + "team_id": { "type": "string", "format": "int64" } } }, - "casesRelatedCaseLookup": { - "description": "RelatedCaseLookup is created specifically to include the subject field.", + "engineCreateTeamTriggerRequest": { "type": "object", "properties": { - "etag": { + "description": { "type": "string" }, - "id": { - "type": "string", - "format": "int64", - "title": "id" + "enabled": { + "type": "boolean", + "format": "boolean" }, "name": { - "type": "string", - "title": "name" + "type": "string" }, - "subject": { - "type": "string", - "title": "subject" + "schema": { + "$ref": "#/definitions/engineLookup" }, - "ver": { - "type": "integer", - "format": "int32", - "title": "ver" + "team_id": { + "type": "string", + "format": "int64" } } }, - "casesRelationType": { - "description": "Enum for relation types between cases.", - "type": "string", - "default": "RELATION_TYPE_UNSPECIFIED", - "enum": [ - "RELATION_TYPE_UNSPECIFIED", - "DUPLICATES", - "IS_DUPLICATED_BY", - "BLOCKS", - "IS_BLOCKED_BY", - "CAUSES", - "IS_CAUSED_BY", - "IS_CHILD_OF", - "IS_PARENT_OF", - "RELATES_TO" - ] - }, - "casesSLA": { + "engineCreateTriggerJobRequest": { "type": "object", - "title": "SLA message represents an SLA entity with metadata", "properties": { - "calendar": { - "title": "Calendar ID from the \"Calendars\" dictionary - required", - "$ref": "#/definitions/generalLookup" - }, - "created_at": { - "type": "string", - "format": "int64", - "title": "CreatedAt timestamp of the SLA" - }, - "created_by": { - "title": "CreatedBy user of the SLA", - "$ref": "#/definitions/generalLookup" - }, - "description": { - "type": "string", - "title": "Description of the SLA - optional" - }, - "id": { - "type": "string", - "format": "int64", - "title": "Unique identifier of the SLA" - }, - "name": { - "type": "string", - "title": "Name of the SLA - required" - }, - "reaction_time": { - "type": "string", - "format": "int64", - "title": "Reaction time - required" - }, - "resolution_time": { - "type": "string", - "format": "int64", - "title": "Resolution time - required" - }, - "updated_at": { - "type": "string", - "format": "int64", - "title": "UpdatedAt timestamp of the SLA" - }, - "updated_by": { - "title": "UpdatedBy user of the SLA", - "$ref": "#/definitions/generalLookup" - }, - "valid_from": { - "type": "string", - "format": "int64", - "title": "Validity period for the SLA - optional" + "trigger_id": { + "type": "integer", + "format": "int32" }, - "valid_to": { - "type": "string", - "format": "int64" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, - "casesSLACondition": { + "engineCreateTriggerRequest": { "type": "object", - "title": "SLACondition message represents an SLACondition entity with metadata", "properties": { - "created_at": { - "type": "string", - "format": "int64", - "title": "CreatedAt timestamp of the SLACondition" + "description": { + "type": "string" }, - "created_by": { - "title": "CreatedBy user of the SLACondition", - "$ref": "#/definitions/generalLookup" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "id": { - "type": "string", - "format": "int64", - "title": "Unique identifier of the SLACondition" + "expression": { + "type": "string" }, "name": { - "type": "string", - "title": "Name of the SLACondition - required" - }, - "priorities": { - "type": "array", - "title": "Priorities associated with the SLACondition - fetched as Lookup entities [ Priority name + ID ]", - "items": { - "type": "object", - "$ref": "#/definitions/generalLookup" - } + "type": "string" }, - "reaction_time": { - "type": "string", - "format": "int64", - "title": "Reaction time - required" + "schema": { + "$ref": "#/definitions/engineLookup" }, - "resolution_time": { - "type": "string", - "format": "int64", - "title": "Resolution time - required" + "timeout": { + "type": "integer", + "format": "int32" }, - "sla_id": { - "type": "string", - "format": "int64", - "title": "SLA ID associated with the SLACondition" + "timezone": { + "$ref": "#/definitions/engineLookup" }, - "updated_at": { - "type": "string", - "format": "int64", - "title": "UpdatedAt timestamp of the SLACondition" + "type": { + "$ref": "#/definitions/engineTriggerType" }, - "updated_by": { - "title": "UpdatedBy user of the SLACondition", - "$ref": "#/definitions/generalLookup" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, - "casesSLAConditionList": { + "engineCreateWebHookRequest": { "type": "object", - "title": "SLAConditionList message contains a list of SLACondition items with pagination", "properties": { - "items": { + "authorization": { + "type": "string" + }, + "description": { + "type": "string" + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "name": { + "type": "string" + }, + "origin": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/casesSLACondition" + "type": "string" } }, - "next": { - "type": "boolean" - }, - "page": { - "type": "integer", - "format": "int32" + "schema": { + "$ref": "#/definitions/engineLookup" } } }, - "casesSLAList": { + "engineDefaultDeviceConfigResponse": { "type": "object", - "title": "SLAList message contains a list of SLA items with pagination", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/casesSLA" - } - }, - "next": { - "type": "boolean" + "sip": { + "$ref": "#/definitions/DefaultDeviceConfigResponseSipDeviceConfig" }, - "page": { - "type": "integer", - "format": "int32" + "webrtc": { + "$ref": "#/definitions/DefaultDeviceConfigResponseWebRTCDeviceConfig" } } }, - "casesService": { + "engineDeleteMembersRequest": { "type": "object", - "title": "Service message represents a service entity within a catalog", "properties": { - "assignee": { - "title": "Assignee responsible for the service", - "$ref": "#/definitions/generalLookup" + "agent_id": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } }, - "catalog_id": { - "type": "string", - "format": "int64", - "title": "Catalogs associated with the service" + "attempts": { + "$ref": "#/definitions/engineFilterBetween" }, - "code": { - "type": "string", - "title": "Code for external integrations (optional)" + "bucket_id": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } }, "created_at": { - "type": "string", - "format": "int64", - "title": "Timestamp when the service was created" - }, - "created_by": { - "title": "User who created the service", - "$ref": "#/definitions/generalLookup" - }, - "description": { - "type": "string", - "title": "Description of the service (optional)" + "$ref": "#/definitions/engineFilterBetween" }, - "group": { - "title": "Group responsible for the service", - "$ref": "#/definitions/generalExtendedLookup" + "destination": { + "type": "string" }, "id": { - "type": "string", - "format": "int64", - "title": "Unique identifier for the service" + "type": "array", + "items": { + "type": "string", + "format": "int64" + } + }, + "ids": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } }, "name": { - "type": "string", - "title": "Name of the service" + "type": "string" }, - "root_id": { + "numbers": { + "type": "array", + "items": { + "type": "string" + } + }, + "offering_at": { + "$ref": "#/definitions/engineFilterBetween" + }, + "priority": { + "$ref": "#/definitions/engineFilterBetween" + }, + "q": { + "type": "string" + }, + "queue_id": { "type": "string", - "format": "int64", - "title": "ID of the parent catalog" + "format": "int64" }, - "searched": { - "type": "boolean", - "title": "flag showing whether the catalog was searched" + "size": { + "type": "integer", + "format": "int32" }, - "service": { + "sort": { + "type": "string" + }, + "stop_cause": { "type": "array", - "title": "Service associated with the service", "items": { - "type": "object", - "$ref": "#/definitions/casesService" + "type": "string" } }, - "sla": { - "title": "SLA associated with the service", - "$ref": "#/definitions/generalLookup" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } }, - "state": { + "without_members": { "type": "boolean", - "title": "State of the service (true for active, false for inactive)" + "format": "boolean" + } + } + }, + "engineDeleteSkillAgentRequest": { + "type": "object", + "properties": { + "agent_id": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } }, - "updated_at": { - "type": "string", - "format": "int64", - "title": "Timestamp when the service was last updated" + "id": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } }, - "updated_by": { - "title": "User who last updated the service", - "$ref": "#/definitions/generalLookup" + "skill_id": { + "type": "string", + "format": "int64" } } }, - "casesServiceList": { + "engineDeleteSkillAgentResponse": { "type": "object", - "title": "ServiceList message contains a list of services with pagination", "properties": { "items": { "type": "array", - "title": "List of service items", "items": { - "type": "object", - "$ref": "#/definitions/casesService" + "$ref": "#/definitions/engineSkillAgentItem" } + } + } + }, + "engineDtmfCallRequest": { + "type": "object", + "properties": { + "app_id": { + "type": "string" }, - "next": { - "type": "boolean", - "title": "Indicates if there are more pages" + "digit": { + "type": "string" }, - "page": { - "type": "integer", - "format": "int32", - "title": "Page number for pagination" + "domain_id": { + "type": "string", + "format": "int64" + }, + "id": { + "type": "string" } } }, - "casesSource": { - "description": "Represents a source entity in the contact system.", + "engineDtmfCallResponse": { + "type": "object" + }, + "engineEavesdropCallRequest": { "type": "object", "properties": { - "created_at": { - "type": "string", - "format": "int64", - "title": "CreatedAt timestamp of the source" + "app_id": { + "type": "string" }, - "created_by": { - "title": "CreatedBy user of the source", - "$ref": "#/definitions/generalLookup" + "control": { + "type": "boolean", + "format": "boolean" }, - "description": { - "type": "string", - "title": "Description of the source" + "from": { + "$ref": "#/definitions/engineEavesdropCallRequestEndpointRequest" }, "id": { - "type": "string", - "format": "int64", - "title": "Unique identifier of the source" + "type": "string" }, - "name": { - "type": "string", - "title": "Name of the source" + "listen_a": { + "type": "boolean", + "format": "boolean" }, - "type": { - "title": "Source type of the source", - "$ref": "#/definitions/casesSourceType" + "listen_b": { + "type": "boolean", + "format": "boolean" }, - "updated_at": { - "type": "string", - "format": "int64", - "title": "UpdatedAt timestamp of the source" + "whisper_a": { + "type": "boolean", + "format": "boolean" }, - "updated_by": { - "title": "UpdatedBy user of the source", - "$ref": "#/definitions/generalLookup" + "whisper_b": { + "type": "boolean", + "format": "boolean" } } }, - "casesSourceList": { - "description": "A list of sources.", + "engineEavesdropCallRequestEndpointRequest": { "type": "object", "properties": { - "items": { - "description": "List of sources.", - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/casesSource" - } + "app_id": { + "type": "string" }, - "next": { - "description": "Have more records.", - "type": "boolean" + "extension": { + "type": "string" }, - "page": { - "description": "Page number of the partial result.", - "type": "integer", - "format": "int32" + "id": { + "type": "string", + "format": "int64" + }, + "type": { + "type": "string" } } }, - "casesSourceType": { - "description": "Represents a source type for the source entity.\n\n - TYPE_UNSPECIFIED: Unspecified source type.\n - CALL: Phone call source type.\n - CHAT: Chat source type.\n - SOCIAL_MEDIA: Social media source type.\n - EMAIL: Email source type.\n - API: API source type.\n - MANUAL: Manual source type.", + "engineEmailAuthType": { "type": "string", - "default": "TYPE_UNSPECIFIED", + "default": "EmailAuthTypeUndefined", "enum": [ - "TYPE_UNSPECIFIED", - "CALL", - "CHAT", - "SOCIAL_MEDIA", - "EMAIL", - "API", - "MANUAL" + "EmailAuthTypeUndefined", + "Plain", + "OAuth2" ] }, - "casesSourceTypeLookup": { + "engineEmailProfile": { "type": "object", "properties": { - "id": { + "activity_at": { "type": "string", "format": "int64" }, - "name": { - "type": "string" + "auth_type": { + "$ref": "#/definitions/engineEmailAuthType" }, - "type": { - "$ref": "#/definitions/casesSourceType" - } - } - }, - "casesStatusCondition": { - "type": "object", - "title": "StatusCondition message represents a status entity with metadata", - "properties": { "created_at": { "type": "string", - "format": "int64", - "title": "CreatedAt timestamp of the status condition" + "format": "int64" }, "created_by": { - "title": "CreatedBy user of the status condition", - "$ref": "#/definitions/generalLookup" + "$ref": "#/definitions/engineLookup" }, "description": { - "type": "string", - "title": "Description of the status condition" + "type": "string" }, - "final": { + "enabled": { "type": "boolean", - "title": "Final status condition" + "format": "boolean" + }, + "fetch_error": { + "type": "string" + }, + "fetch_interval": { + "type": "integer", + "format": "int32" }, "id": { "type": "string", - "format": "int64", - "title": "Unique identifier of the status condition" + "format": "int64" }, - "initial": { + "imap_host": { + "type": "string" + }, + "imap_port": { + "type": "integer", + "format": "int32" + }, + "listen": { "type": "boolean", - "title": "Initial status condition" + "format": "boolean" }, - "name": { - "type": "string", - "title": "Name of the status condition" + "logged": { + "type": "boolean", + "format": "boolean" }, - "status_id": { - "type": "string", - "format": "int64", - "title": "Status ID of the status condition" + "login": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "int64", - "title": "UpdatedAt timestamp of the status condition" + "mailbox": { + "type": "string" }, - "updated_by": { - "title": "UpdatedBy user of the status condition", - "$ref": "#/definitions/generalLookup" - } - } - }, - "casesStatusConditionList": { - "type": "object", - "title": "StatusConditionList message contains a list of StatusCondition items with pagination", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/casesStatusCondition" - } + "name": { + "type": "string" }, - "next": { - "type": "boolean" + "params": { + "$ref": "#/definitions/engineEmailProfileParams" }, - "page": { - "type": "integer", - "format": "int32" - } - } - }, - "casesStatusList": { - "type": "object", - "title": "StatusList message contains a list of Status items with pagination", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/webitelcasesStatus" - } + "password": { + "type": "string" }, - "next": { - "type": "boolean" + "schema": { + "$ref": "#/definitions/engineLookup" }, - "page": { + "smtp_host": { + "type": "string" + }, + "smtp_port": { "type": "integer", "format": "int32" - } - } - }, - "casesTimingInfo": { - "description": "Message representing SLA timing information.", - "type": "object", - "properties": { - "difference_in_reaction": { - "description": "Difference between actual and planned reaction time.", - "type": "string", - "format": "int64" }, - "difference_in_resolve": { - "description": "Difference between actual and planned resolution time.", - "type": "string", - "format": "int64" + "state": { + "type": "string" }, - "reacted_at": { - "description": "Actual reaction timestamp (in milliseconds).", + "updated_at": { "type": "string", "format": "int64" }, - "resolved_at": { - "description": "Actual resolution timestamp (in milliseconds).", - "type": "string", - "format": "int64" + "updated_by": { + "$ref": "#/definitions/engineLookup" } } }, - "casesTranscriptLookup": { + "engineEmailProfileParams": { "type": "object", "properties": { - "file": { - "$ref": "#/definitions/generalLookup" - }, - "id": { - "type": "string", - "format": "int64" - }, - "locale": { - "type": "string" + "oauth2": { + "$ref": "#/definitions/EmailProfileParamsOAuth2" } } }, - "casesUnlinkCommunicationResponse": { - "description": "Response message after unlinking a communication from a case.", - "type": "object", - "properties": { - "affected": { - "description": "Affected rows.", - "type": "string", - "format": "int64" - } - } + "engineEmptyResponse": { + "type": "object" }, - "chatBroadcastError": { + "engineEndpoint": { "type": "object", "properties": { - "error": { - "$ref": "#/definitions/rpcStatus" + "id": { + "type": "string" }, - "peer_id": { + "name": { "type": "string" - } - } - }, - "chatBroadcastMessageRequest": { - "type": "object", - "properties": { - "message": { - "$ref": "#/definitions/chatInputMessage" }, - "peers": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/chatInputPeer" - } - } - } - }, - "chatBroadcastMessageResponse": { - "type": "object", - "properties": { - "failure": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/chatBroadcastError" - } + "number": { + "type": "string" + }, + "type": { + "type": "string" } } }, - "chatInputButton": { + "engineExceptDate": { "type": "object", - "properties": { - "caption": { - "type": "string" + "properties": { + "date": { + "type": "string", + "format": "int64" }, - "code": { - "type": "string" + "disabled": { + "type": "boolean", + "format": "boolean" }, - "text": { + "name": { "type": "string" }, - "type": { - "type": "string" + "repeat": { + "type": "boolean", + "format": "boolean" }, - "url": { - "type": "string" + "work_start": { + "type": "integer", + "format": "int32" + }, + "work_stop": { + "type": "integer", + "format": "int32" + }, + "working": { + "type": "boolean", + "format": "boolean" } } }, - "chatInputButtonRow": { + "engineFilterBetween": { "type": "object", "properties": { - "buttons": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/chatInputButton" - } + "from": { + "type": "string", + "format": "int64" + }, + "to": { + "type": "string", + "format": "int64" } } }, - "chatInputFile": { + "engineForAgentPauseCause": { "type": "object", "properties": { + "duration_min": { + "type": "integer", + "format": "int64" + }, "id": { - "type": "string" + "type": "integer", + "format": "int64" }, - "url": { + "limit_min": { + "type": "integer", + "format": "int64" + }, + "name": { "type": "string" } } }, - "chatInputKeyboard": { + "engineForAgentPauseCauseList": { "type": "object", "properties": { - "rows": { + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/chatInputButtonRow" + "$ref": "#/definitions/engineForAgentPauseCause" } } } }, - "chatInputMessage": { + "engineHangupCallRequest": { "type": "object", "properties": { - "file": { - "$ref": "#/definitions/chatInputFile" + "app_id": { + "type": "string" }, - "keyboard": { - "$ref": "#/definitions/chatInputKeyboard" + "cause": { + "type": "string" }, - "text": { + "domain_id": { + "type": "string", + "format": "int64" + }, + "id": { "type": "string" } } }, - "chatInputPeer": { - "description": "InputPeer identity.", + "engineHangupCallResponse": { + "type": "object" + }, + "engineHistoryCall": { "type": "object", "properties": { - "id": { - "type": "string" + "agent": { + "$ref": "#/definitions/engineLookup" }, - "name": { + "agent_description": { "type": "string" }, - "type": { - "type": "string" + "allow_evaluation": { + "type": "boolean", + "format": "boolean" }, - "via": { - "type": "string" - } - } - }, - "engineAcceptOfDay": { - "type": "object", - "properties": { - "day": { - "type": "integer", - "format": "int32" + "amd_ai_logs": { + "type": "array", + "items": { + "type": "string" + } }, - "disabled": { - "type": "boolean" + "amd_ai_result": { + "type": "string" }, - "end_time_of_day": { - "type": "integer", - "format": "int32" + "amd_result": { + "type": "string" }, - "start_time_of_day": { - "type": "integer", - "format": "int32" - } - } - }, - "engineActiveCall": { - "type": "object", - "properties": { - "agent": { - "$ref": "#/definitions/engineLookup" + "annotations": { + "type": "array", + "items": { + "$ref": "#/definitions/engineCallAnnotation" + } }, "answered_at": { "type": "string", @@ -41901,6 +43100,10 @@ "app_id": { "type": "string" }, + "attempt_id": { + "type": "string", + "format": "int64" + }, "bill_sec": { "type": "integer", "format": "int32" @@ -41908,6 +43111,12 @@ "blind_transfer": { "type": "string" }, + "blind_transfers": { + "type": "array", + "items": { + "$ref": "#/definitions/HistoryCallBlindTransfer" + } + }, "bridged_at": { "type": "string", "format": "int64" @@ -41915,6 +43124,12 @@ "bridged_id": { "type": "string" }, + "cause": { + "type": "string" + }, + "contact": { + "$ref": "#/definitions/engineLookup" + }, "created_at": { "type": "string", "format": "int64" @@ -41935,12 +43150,56 @@ "extension": { "type": "string" }, + "files": { + "type": "array", + "items": { + "$ref": "#/definitions/engineCallFile" + } + }, + "files_job": { + "type": "array", + "items": { + "$ref": "#/definitions/engineHistoryFileJob" + } + }, + "form_fields": { + "type": "object" + }, "from": { "$ref": "#/definitions/engineEndpoint" }, + "from_number": { + "type": "string" + }, "gateway": { "$ref": "#/definitions/engineLookup" }, + "grantee": { + "$ref": "#/definitions/engineLookup" + }, + "hangup_at": { + "type": "string", + "format": "int64" + }, + "hangup_by": { + "type": "string" + }, + "hangup_disposition": { + "type": "string" + }, + "hangup_phrase": { + "type": "string" + }, + "has_children": { + "type": "boolean", + "format": "boolean" + }, + "hold": { + "type": "array", + "items": { + "$ref": "#/definitions/engineCallHold" + } + }, "hold_sec": { "type": "integer", "format": "int32" @@ -41959,6 +43218,10 @@ "member": { "$ref": "#/definitions/engineLookup" }, + "member_id": { + "type": "string", + "format": "int64" + }, "parent_id": { "type": "string" }, @@ -41977,6 +43240,16 @@ "type": "integer", "format": "int32" }, + "rate_id": { + "type": "string", + "format": "int64" + }, + "rated_by": { + "$ref": "#/definitions/engineLookup" + }, + "rated_user": { + "$ref": "#/definitions/engineLookup" + }, "reporting_at": { "type": "string", "format": "int64" @@ -41985,26 +43258,62 @@ "type": "integer", "format": "int32" }, - "state": { + "result": { "type": "string" }, - "supervisor": { + "schemas": { "type": "array", "items": { - "type": "object", "$ref": "#/definitions/engineLookup" } }, - "team": { - "$ref": "#/definitions/engineLookup" + "score_optional": { + "type": "number", + "format": "float" }, - "timestamp": { + "score_required": { + "type": "number", + "format": "float" + }, + "sip_code": { + "type": "integer", + "format": "int32" + }, + "stored_at": { "type": "string", "format": "int64" }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "talk_sec": { + "type": "integer", + "format": "int32" + }, + "team": { + "$ref": "#/definitions/engineLookup" + }, "to": { "$ref": "#/definitions/engineEndpoint" }, + "to_number": { + "type": "string" + }, + "transcripts": { + "type": "array", + "items": { + "$ref": "#/definitions/engineTranscriptLookup" + } + }, + "transfer_from": { + "type": "string" + }, + "transfer_to": { + "type": "string" + }, "type": { "type": "string" }, @@ -42023,1098 +43332,980 @@ } } }, - "engineActivityWorkspaceWidgetResponse": { + "engineHistoryFileJob": { "type": "object", "properties": { - "available": { - "type": "integer", - "format": "int32" - }, - "avg_hold_sec": { - "type": "number", - "format": "float" + "action": { + "$ref": "#/definitions/HistoryFileJobHistoryFileJobAction" }, - "avg_talk_sec": { - "type": "number", - "format": "float" + "created_at": { + "type": "string", + "format": "int64" }, - "call_abandoned": { - "type": "integer", - "format": "int32" + "error_detail": { + "type": "string" }, - "call_handled": { - "type": "integer", - "format": "int32" + "file_id": { + "type": "string", + "format": "int64" }, - "call_inbound": { - "type": "integer", - "format": "int32" + "id": { + "type": "string", + "format": "int64" }, - "call_missed": { - "type": "integer", - "format": "int32" + "state": { + "$ref": "#/definitions/HistoryFileJobHistoryFileJobState" + } + } + }, + "engineHoldCallResponse": { + "type": "object", + "properties": { + "state": { + "type": "string" + } + } + }, + "engineList": { + "type": "object", + "properties": { + "count": { + "type": "string", + "format": "int64" }, - "chat_accepts": { - "type": "integer", - "format": "int32" + "created_at": { + "type": "string", + "format": "int64" }, - "chat_aht": { - "type": "number", - "format": "float" + "created_by": { + "$ref": "#/definitions/engineLookup" }, - "occupancy": { - "type": "number", - "format": "float" + "description": { + "type": "string" }, - "online": { - "type": "integer", - "format": "int32" + "domain_id": { + "type": "string", + "format": "int64" }, - "processing": { - "type": "integer", - "format": "int32" + "id": { + "type": "string", + "format": "int64" }, - "queue_talk_sec": { - "type": "integer", - "format": "int32" + "name": { + "type": "string" }, - "score_count": { + "updated_at": { "type": "string", "format": "int64" }, - "score_optional_avg": { - "type": "number", - "format": "float" + "updated_by": { + "$ref": "#/definitions/engineLookup" + } + } + }, + "engineListAgent": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgent" + } }, - "score_optional_sum": { - "type": "number", - "format": "float" + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListAgentInQueue": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgentInQueue" + } }, - "score_required_avg": { - "type": "number", - "format": "float" + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListAgentInTeam": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgentInTeam" + } }, - "score_required_sum": { - "type": "number", - "format": "float" + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListAgentPauseCause": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgentPauseCause" + } }, - "sum_talk_sec": { - "type": "string", - "format": "int64" + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListAgentSkill": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgentSkillItem" + } }, - "task_accepts": { - "type": "integer", - "format": "int32" + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListAgentStateHistory": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgentState" + } }, - "utilization": { - "type": "number", - "format": "float" + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListAgentStatsStatistic": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgentStatsStatistic" + } + }, + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListAgentTeam": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgentTeam" + } + }, + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListAgentUser": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgentUser" + } + }, + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListAggregate": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAggregateResult" + } + } + } + }, + "engineListAttempt": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAttempt" + } }, - "voice_mail": { - "type": "integer", - "format": "int32" + "next": { + "type": "boolean", + "format": "boolean" } } }, - "engineAgent": { + "engineListAuditForm": { "type": "object", "properties": { - "allow_channels": { + "items": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineAuditForm" } }, - "auditor": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListAuditRate": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "$ref": "#/definitions/engineAuditRate" } }, - "channel": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListAvailableSystemSetting": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAgentChannel" + "$ref": "#/definitions/engineAvailableSystemSetting" } }, - "chat_count": { - "type": "integer", - "format": "int64" - }, - "description": { - "type": "string" - }, - "extension": { - "type": "string" - }, - "greeting_media": { - "$ref": "#/definitions/engineLookup" - }, - "id": { - "type": "string", - "format": "int64" - }, - "is_supervisor": { - "type": "boolean" - }, - "last_status_change": { - "type": "string", - "format": "int64" - }, - "name": { - "type": "string" - }, - "progressive_count": { - "type": "integer", - "format": "int32" - }, - "region": { - "$ref": "#/definitions/engineLookup" - }, - "skills": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListBucket": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "$ref": "#/definitions/engineBucket" } }, - "status": { - "type": "string" - }, - "status_duration": { - "type": "string", - "format": "int64" - }, - "supervisor": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListCalendar": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "$ref": "#/definitions/engineCalendar" } }, - "task_count": { - "type": "integer", - "format": "int64" - }, - "team": { - "$ref": "#/definitions/engineLookup" - }, - "user": { - "$ref": "#/definitions/engineLookup" + "next": { + "type": "boolean", + "format": "boolean" } } }, - "engineAgentCallStatistics": { + "engineListCall": { "type": "object", "properties": { - "abandoned": { - "type": "integer", - "format": "int32" - }, - "avg_hold_sec": { - "type": "number", - "format": "float" - }, - "avg_talk_sec": { - "type": "number", - "format": "float" - }, - "chat_accepts": { - "type": "integer", - "format": "int32" - }, - "chat_aht": { - "type": "integer", - "format": "int32" - }, - "count": { - "type": "integer", - "format": "int32" - }, - "handles": { - "type": "integer", - "format": "int32" - }, - "max_hold_sec": { - "type": "number", - "format": "float" - }, - "max_talk_sec": { - "type": "number", - "format": "float" - }, - "min_hold_sec": { - "type": "number", - "format": "float" - }, - "min_talk_sec": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - }, - "occupancy": { - "type": "number", - "format": "float" - }, - "sum_hold_sec": { - "type": "number", - "format": "float" - }, - "sum_talk_sec": { - "type": "number", - "format": "float" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineActiveCall" + } }, - "utilization": { - "type": "number", - "format": "float" + "next": { + "type": "boolean", + "format": "boolean" } } }, - "engineAgentCallStatisticsList": { + "engineListChatPlan": { "type": "object", "properties": { "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAgentCallStatistics" + "$ref": "#/definitions/engineChatPlan" } }, "next": { - "type": "boolean" + "type": "boolean", + "format": "boolean" } } }, - "engineAgentChannel": { + "engineListCommunication": { "type": "object", "properties": { - "channel": { + "description": { "type": "string" }, - "joined_at": { + "expire_at": { "type": "string", "format": "int64" }, - "state": { - "type": "string" - }, - "timeout": { + "id": { "type": "string", "format": "int64" - } - } - }, - "engineAgentInQueue": { - "type": "object", - "properties": { - "active_members": { - "type": "integer", - "format": "int32" - }, - "agents": { - "$ref": "#/definitions/AgentInQueueAgentsInQueue" - }, - "count_members": { - "type": "integer", - "format": "int32" - }, - "enabled": { - "type": "boolean" }, - "priority": { - "type": "integer", - "format": "int32" - }, - "queue": { - "$ref": "#/definitions/engineLookup" + "list_id": { + "type": "string", + "format": "int64" }, - "strategy": { + "number": { "type": "string" - }, - "type": { - "type": "integer", - "format": "int32" - }, - "waiting_members": { - "type": "integer", - "format": "int32" } } }, - "engineAgentInQueueStatistics": { + "engineListCommunicationType": { "type": "object", "properties": { - "queue": { - "$ref": "#/definitions/engineLookup" - }, - "statistics": { + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/AgentInQueueStatisticsAgentInQueueStatisticsItem" + "$ref": "#/definitions/engineCommunicationType" } + }, + "next": { + "type": "boolean", + "format": "boolean" } } }, - "engineAgentInQueueStatisticsList": { + "engineListEmailProfile": { "type": "object", "properties": { "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAgentInQueueStatistics" + "$ref": "#/definitions/engineEmailProfile" } + }, + "next": { + "type": "boolean", + "format": "boolean" } } }, - "engineAgentInTeam": { + "engineListHistoryAttempt": { "type": "object", "properties": { - "strategy": { - "type": "string" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAttemptHistory" + } }, - "team": { - "$ref": "#/definitions/engineLookup" + "next": { + "type": "boolean", + "format": "boolean" } } }, - "engineAgentPauseCause": { + "engineListHistoryCall": { "type": "object", "properties": { - "allow_admin": { - "type": "boolean" - }, - "allow_agent": { - "type": "boolean" - }, - "allow_supervisor": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "int64" - }, - "created_by": { - "$ref": "#/definitions/engineLookup" - }, - "description": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "limit_min": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "int64" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineHistoryCall" + } }, - "updated_by": { - "$ref": "#/definitions/engineLookup" + "next": { + "type": "boolean", + "format": "boolean" } } }, - "engineAgentSetStateResponse": { - "type": "object" - }, - "engineAgentSkill": { + "engineListMember": { "type": "object", "properties": { - "agent": { - "$ref": "#/definitions/engineLookup" - }, - "capacity": { - "type": "integer", - "format": "int32" - }, - "created_at": { - "type": "string", - "format": "int64" - }, - "created_by": { - "$ref": "#/definitions/engineLookup" - }, - "domain_id": { - "type": "string", - "format": "int64" - }, - "enabled": { - "type": "boolean" - }, - "id": { - "type": "string", - "format": "int64" - }, - "skill": { - "$ref": "#/definitions/engineLookup" - }, - "updated_at": { - "type": "string", - "format": "int64" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineMemberInQueue" + } }, - "updated_by": { - "$ref": "#/definitions/engineLookup" + "next": { + "type": "boolean", + "format": "boolean" } } }, - "engineAgentSkillItem": { + "engineListMemberAttempt": { "type": "object", "properties": { - "capacity": { - "type": "integer", - "format": "int32" - }, - "enabled": { - "type": "boolean" - }, - "id": { - "type": "string", - "format": "int64" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineMemberAttempt" + } }, - "skill": { - "$ref": "#/definitions/engineLookup" + "next": { + "type": "boolean", + "format": "boolean" } } }, - "engineAgentState": { + "engineListOfList": { "type": "object", "properties": { - "agent": { - "$ref": "#/definitions/engineLookup" - }, - "channel": { - "type": "string" - }, - "duration": { - "type": "string", - "format": "int64" - }, - "id": { - "type": "string", - "format": "int64" - }, - "joined_at": { - "type": "string", - "format": "int64" - }, - "pause_cause": { - "type": "string" - }, - "payload": { - "type": "string" - }, - "queue": { - "$ref": "#/definitions/engineLookup" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineList" + } }, - "state": { - "type": "string" + "next": { + "type": "boolean", + "format": "boolean" } } }, - "engineAgentStatsStatistic": { + "engineListOfListCommunication": { "type": "object", "properties": { - "active_call_id": { - "type": "string" - }, - "agent_id": { - "type": "integer", - "format": "int32" - }, - "auditor": { + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "$ref": "#/definitions/engineListCommunication" } }, - "call_time": { - "type": "string", - "format": "int64" - }, - "chat_count": { - "type": "integer", - "format": "int32" - }, - "extension": { - "type": "string" - }, - "handles": { - "type": "integer", - "format": "int32" - }, - "max_bridged_at": { - "type": "string", - "format": "int64" - }, - "max_offering_at": { - "type": "string", - "format": "int64" - }, - "missed": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string" - }, - "occupancy": { - "type": "number", - "format": "float" - }, - "offline": { - "type": "string", - "format": "int64" - }, - "online": { - "type": "string", - "format": "int64" - }, - "pause": { - "type": "string", - "format": "int64" - }, - "pause_cause": { - "type": "string" - }, - "queues": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListOutboundResource": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "$ref": "#/definitions/engineOutboundResource" } }, - "skills": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListOutboundResourceDisplay": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "$ref": "#/definitions/engineResourceDisplay" } }, - "status": { - "type": "string" - }, - "status_duration": { - "type": "string", - "format": "int64" - }, - "supervisor": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListOutboundResourceGroup": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "$ref": "#/definitions/engineOutboundResourceViewGroup" } }, - "team": { - "$ref": "#/definitions/engineLookup" - }, - "transferred": { - "type": "integer", - "format": "int64" - }, - "user": { - "$ref": "#/definitions/engineLookup" - }, - "utilization": { - "type": "number", - "format": "float" + "next": { + "type": "boolean", + "format": "boolean" } } }, - "engineAgentStatusStatisticItem": { + "engineListOutboundResourceInGroup": { "type": "object", "properties": { - "agent_id": { - "type": "integer", - "format": "int32" - }, - "auditor": { + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "$ref": "#/definitions/engineOutboundResourceInGroup" } }, - "chat_count": { - "type": "integer", - "format": "int64" - }, - "extension": { - "type": "string" - }, - "name": { - "type": "string" - }, - "offline": { - "type": "string", - "format": "int64" - }, - "online": { - "type": "string", - "format": "int64" - }, - "pause": { - "type": "string", - "format": "int64" - }, - "pause_cause": { - "type": "string" - }, - "progressive_count": { - "type": "integer", - "format": "int64" - }, - "region": { - "$ref": "#/definitions/engineLookup" - }, - "score_count": { - "type": "string", - "format": "int64" - }, - "score_optional_avg": { - "type": "number", - "format": "float" - }, - "score_required_avg": { - "type": "number", - "format": "float" - }, - "status": { - "type": "string" - }, - "status_duration": { - "type": "string", - "format": "int64" - }, - "supervisor": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListPresetQuery": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "$ref": "#/definitions/enginePresetQuery" } }, - "team": { - "$ref": "#/definitions/engineLookup" - }, - "user": { - "$ref": "#/definitions/engineLookup" + "next": { + "type": "boolean", + "format": "boolean" } } }, - "engineAgentTeam": { + "engineListQueue": { "type": "object", "properties": { - "admin": { + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "$ref": "#/definitions/engineQueue" } }, - "call_timeout": { - "type": "integer", - "format": "int32" - }, - "description": { - "type": "string" - }, - "domain_id": { - "type": "string", - "format": "int64" - }, - "forecast_calculation": { - "$ref": "#/definitions/engineLookup" - }, - "id": { - "type": "string", - "format": "int64" - }, - "invite_chat_timeout": { - "type": "integer", - "format": "int32" - }, - "max_no_answer": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string" - }, - "no_answer_delay_time": { - "type": "integer", - "format": "int32" - }, - "strategy": { - "type": "string" - }, - "task_accept_timeout": { - "type": "integer", - "format": "int32" - }, - "updated_at": { - "type": "string", - "format": "int64" - }, - "wrap_up_time": { - "type": "integer", - "format": "int32" + "next": { + "type": "boolean", + "format": "boolean" } } }, - "engineAgentTodayStatisticsResponse": { + "engineListQueueBucket": { "type": "object", "properties": { - "available": { - "type": "integer", - "format": "int32" - }, - "avg_hold_sec": { - "type": "number", - "format": "float" - }, - "avg_talk_sec": { - "type": "number", - "format": "float" - }, - "call_abandoned": { - "type": "integer", - "format": "int32" - }, - "call_handled": { - "type": "integer", - "format": "int32" - }, - "call_inbound": { - "type": "integer", - "format": "int32" - }, - "call_missed": { - "type": "integer", - "format": "int32" - }, - "chat_accepts": { - "type": "integer", - "format": "int32" - }, - "chat_aht": { - "type": "number", - "format": "float" - }, - "occupancy": { - "type": "number", - "format": "float" - }, - "online": { - "type": "integer", - "format": "int32" - }, - "processing": { - "type": "integer", - "format": "int32" - }, - "queue_talk_sec": { - "type": "integer", - "format": "int32" - }, - "score_count": { - "type": "string", - "format": "int64" - }, - "score_optional_avg": { - "type": "number", - "format": "float" - }, - "score_optional_sum": { - "type": "number", - "format": "float" - }, - "score_required_avg": { - "type": "number", - "format": "float" - }, - "score_required_sum": { - "type": "number", - "format": "float" - }, - "sum_talk_sec": { - "type": "string", - "format": "int64" - }, - "task_accepts": { - "type": "integer", - "format": "int32" - }, - "utilization": { - "type": "number", - "format": "float" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineQueueBucket" + } }, - "voice_mail": { - "type": "integer", - "format": "int32" + "next": { + "type": "boolean", + "format": "boolean" } } }, - "engineAgentUser": { + "engineListQueueHook": { "type": "object", "properties": { - "id": { - "type": "string", - "format": "int64" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineQueueHook" + } }, - "name": { - "type": "string" + "next": { + "type": "boolean", + "format": "boolean" } } }, - "engineAggregateHistoryCallRequest": { + "engineListQueueResourceGroup": { "type": "object", "properties": { - "agent_description": { - "type": "string" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineQueueResourceGroup" + } }, - "agent_id": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListQueueSkill": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "string", - "format": "int64" + "$ref": "#/definitions/engineQueueSkill" } }, - "aggs": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListQuickReplies": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAggregateRequest" + "$ref": "#/definitions/engineQuickReply" } }, - "amd_result": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListRegion": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineRegion" } }, - "answered_at": { - "$ref": "#/definitions/engineFilterBetween" + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListReportGeneral": { + "type": "object", + "properties": { + "aggs": { + "$ref": "#/definitions/engineQueueReportGeneralAgentStatus" }, - "cause": { + "items": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineQueueReportGeneral" } }, - "contact_id": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListResourceDisplay": { + "type": "object", + "properties": { + "id": { "type": "array", "items": { "type": "string", "format": "int64" } - }, - "created_at": { - "$ref": "#/definitions/engineFilterBetween" - }, - "dependency_id": { - "type": "string" - }, - "direction": { - "type": "string" - }, - "directions": { + } + } + }, + "engineListRoutingOutboundCall": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineRoutingOutboundCallCompact" } }, - "domain_id": { - "type": "string", - "format": "int64" - }, - "duration": { - "$ref": "#/definitions/engineFilterBetween" - }, - "fts": { - "type": "string" - }, - "gateway_id": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListRoutingSchema": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "string", - "format": "int64" + "$ref": "#/definitions/engineRoutingSchema" } }, - "has_file": { - "type": "boolean" - }, - "has_transcript": { - "type": "boolean" - }, - "id": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListRoutingSchemaTags": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineRoutingSchemaTag" } }, - "member_id": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListRoutingVariable": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "string", - "format": "int64" + "$ref": "#/definitions/engineRoutingVariable" } - }, - "missed": { - "type": "boolean" - }, - "number": { - "type": "string" - }, - "page": { - "type": "integer", - "format": "int32" - }, - "parent_id": { - "type": "string" - }, - "q": { - "type": "string" - }, - "queue_id": { + } + } + }, + "engineListSchemaVariable": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "string", - "format": "int64" + "$ref": "#/definitions/engineSchemaVariable" } }, - "size": { - "type": "integer", - "format": "int32" - }, - "skip_parent": { - "type": "boolean" + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListSkill": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineSkill" + } }, - "stored_at": { - "$ref": "#/definitions/engineFilterBetween" + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListSkillAgent": { + "type": "object", + "properties": { + "aggs": { + "$ref": "#/definitions/ListSkillAgentListSkillAgg" }, - "tags": { + "items": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineSkillAgentItem" } }, - "team_id": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListSystemSetting": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "string", - "format": "int64" + "$ref": "#/definitions/engineSystemSetting" } }, - "transfer_from": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListTags": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineTag" } }, - "transfer_to": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListTeamHook": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineTeamHook" } }, - "user_id": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListTeamTrigger": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "string", - "format": "int64" + "$ref": "#/definitions/engineTeamTrigger" } }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "next": { + "type": "boolean", + "format": "boolean" } } }, - "engineAggregateRequest": { + "engineListTimezoneResponse": { "type": "object", "properties": { - "avg": { + "items": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineTimezone" } }, - "count": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListTrigger": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineTrigger" } }, - "group": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListTriggerJob": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/AggregateRequestGroup" + "$ref": "#/definitions/engineTriggerJob" } }, - "limit": { - "type": "integer", - "format": "int32" - }, - "max": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListUserStatus": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineUserStatus" } }, - "min": { + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListWebHook": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineWebHook" } }, - "name": { - "type": "string" + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineLoginEmailProfileResponse": { + "type": "object", + "properties": { + "auth_type": { + "$ref": "#/definitions/engineEmailAuthType" }, - "sort": { - "type": "array", - "items": { + "cookie": { + "type": "object", + "additionalProperties": { "type": "string" } }, - "sum": { - "type": "array", - "items": { - "type": "string" - } + "redirect_url": { + "type": "string" } } }, - "engineAggregateResult": { + "engineLogoutEmailProfileResponse": { + "type": "object" + }, + "engineLookup": { "type": "object", "properties": { - "data": {}, + "id": { + "type": "string", + "format": "int64" + }, "name": { "type": "string" } } }, - "engineAttempt": { + "engineMemberAttempt": { "type": "object", "properties": { + "active": { + "type": "boolean", + "format": "boolean" + }, "agent": { "$ref": "#/definitions/engineLookup" }, - "agent_call_id": { - "type": "string" + "answered_at": { + "type": "string", + "format": "int64" }, "attempts": { "type": "integer", @@ -43127,53 +44318,37 @@ "bucket": { "$ref": "#/definitions/engineLookup" }, - "channel": { - "type": "string" + "created_at": { + "type": "string", + "format": "int64" }, "destination": { - "$ref": "#/definitions/engineMemberCommunication" - }, - "display": { "type": "string" }, - "id": { + "hangup_at": { "type": "string", "format": "int64" }, - "joined_at": { + "id": { "type": "string", "format": "int64" }, - "last_state_change": { - "type": "string", - "format": "int64" + "leg_a_id": { + "type": "string" }, - "leaving_at": { - "type": "string", - "format": "int64" + "leg_b_id": { + "type": "string" }, - "list": { - "title": "black list ?", - "$ref": "#/definitions/engineLookup" + "logs": { + "type": "object" }, "member": { "$ref": "#/definitions/engineLookup" }, - "member_call_id": { + "node": { "type": "string" }, - "offering_at": { - "type": "string", - "format": "int64" - }, - "position": { - "type": "integer", - "format": "int32" - }, - "queue": { - "$ref": "#/definitions/engineLookup" - }, - "reporting_at": { + "originate_at": { "type": "string", "format": "int64" }, @@ -43183,322 +44358,204 @@ "result": { "type": "string" }, - "state": { - "type": "string" - }, - "timeout": { - "type": "string", - "format": "int64" - }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" + "weight": { + "type": "integer", + "format": "int32" + } + } + }, + "engineMemberBulkResponse": { + "type": "object", + "properties": { + "ids": { + "type": "array", + "items": { + "type": "string", + "format": "int64" } } } }, - "engineAttemptHistory": { + "engineMemberCommunication": { "type": "object", "properties": { - "agent": { - "$ref": "#/definitions/engineLookup" - }, - "agent_call_id": { - "type": "string" - }, - "amd_result": { - "type": "string" - }, "attempts": { "type": "integer", "format": "int32" }, - "bridged_at": { - "type": "string", - "format": "int64" - }, - "bucket": { - "$ref": "#/definitions/engineLookup" - }, - "channel": { + "description": { "type": "string" }, "destination": { - "$ref": "#/definitions/engineMemberCommunication" + "type": "string" }, "display": { "type": "string" }, - "id": { - "type": "string", - "format": "int64" + "dtmf": { + "type": "string" }, - "joined_at": { + "id": { "type": "string", "format": "int64" }, - "leaving_at": { + "last_activity_at": { "type": "string", "format": "int64" }, - "list": { - "title": "black list ?", - "$ref": "#/definitions/engineLookup" - }, - "member": { - "$ref": "#/definitions/engineLookup" - }, - "member_call_id": { + "last_cause": { "type": "string" }, - "offering_at": { - "type": "string", - "format": "int64" - }, - "position": { + "priority": { "type": "integer", "format": "int32" }, - "queue": { + "resource": { "$ref": "#/definitions/engineLookup" }, - "reporting_at": { + "state": { + "type": "integer", + "format": "int32" + }, + "stop_at": { "type": "string", "format": "int64" }, - "resource": { + "type": { "$ref": "#/definitions/engineLookup" - }, - "result": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } } } }, - "engineAttemptRenewalResultResponse": { - "type": "object" - }, - "engineAttemptResultResponse": { + "engineMemberCommunicationCreateRequest": { "type": "object", "properties": { - "status": { + "description": { "type": "string" - } - } - }, - "engineAuditForm": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "format": "int64" - }, - "created_by": { - "$ref": "#/definitions/engineLookup" }, - "description": { + "destination": { "type": "string" }, - "editable": { - "type": "boolean", - "title": "bool archive = 11;" + "display": { + "type": "string" }, - "enabled": { - "type": "boolean" + "dtmf": { + "type": "string" }, - "id": { + "priority": { "type": "integer", "format": "int32" }, - "name": { - "type": "string" - }, - "questions": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineQuestion" - } - }, - "teams": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } + "resource": { + "$ref": "#/definitions/engineLookup" }, - "updated_at": { + "stop_at": { "type": "string", "format": "int64" }, - "updated_by": { + "type": { "$ref": "#/definitions/engineLookup" } } }, - "engineAuditQuestionType": { - "type": "string", - "default": "question_default", - "enum": [ - "question_default", - "question_score", - "question_option" - ] - }, - "engineAuditRate": { + "engineMemberInQueue": { "type": "object", "properties": { - "answers": { + "agent": { + "$ref": "#/definitions/engineLookup" + }, + "attempts": { + "type": "integer", + "format": "int32" + }, + "bucket": { + "$ref": "#/definitions/engineLookup" + }, + "communications": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineQuestionAnswer" + "$ref": "#/definitions/engineMemberCommunication" } }, - "comment": { - "type": "string" - }, "created_at": { "type": "string", "format": "int64" }, - "created_by": { - "$ref": "#/definitions/engineLookup" - }, - "form": { - "$ref": "#/definitions/engineLookup" + "expire_at": { + "type": "string", + "format": "int64" }, "id": { "type": "string", "format": "int64" }, - "questions": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineQuestion" - } - }, - "rated_user": { - "$ref": "#/definitions/engineLookup" - }, - "score_optional": { - "type": "number", - "format": "float" - }, - "score_required": { - "type": "number", - "format": "float" + "last_activity_at": { + "type": "string", + "format": "int64" }, - "updated_at": { + "min_offering_at": { "type": "string", "format": "int64" }, - "updated_by": { - "$ref": "#/definitions/engineLookup" - } - } - }, - "engineAvailableSystemSetting": { - "type": "object", - "properties": { "name": { "type": "string" - } - } - }, - "engineBlindTransferCallResponse": { - "type": "object" - }, - "engineBroadcastButton": { - "type": "object", - "properties": { - "caption": { - "type": "string" - }, - "code": { - "type": "string" }, - "text": { - "type": "string" + "priority": { + "type": "integer", + "format": "int32" }, - "type": { - "type": "string" + "queue": { + "$ref": "#/definitions/engineLookup" }, - "url": { - "type": "string" - } - } - }, - "engineBroadcastButtons": { - "type": "object", - "properties": { - "button": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineBroadcastButton" - } - } - } - }, - "engineBroadcastFile": { - "description": "Media File.", - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "int64" + "reserved": { + "type": "boolean", + "format": "boolean" }, - "mime": { - "type": "string" + "skill": { + "$ref": "#/definitions/engineLookup" }, - "name": { + "stop_cause": { "type": "string" }, - "size": { - "type": "string", - "format": "int64" + "timezone": { + "$ref": "#/definitions/engineLookup" }, - "url": { - "type": "string" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, - "engineBroadcastResponse": { - "type": "object" - }, - "engineBucket": { + "engineMovePositionRoutingOutboundCallRequest": { "type": "object", "properties": { - "description": { - "type": "string" + "domain_id": { + "type": "string", + "format": "int64" }, - "id": { + "from_id": { "type": "string", "format": "int64" }, - "name": { - "type": "string" + "to_id": { + "type": "string", + "format": "int64" } } }, - "engineCalendar": { + "engineMovePositionRoutingOutboundCallResponse": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineOutboundResource": { "type": "object", "properties": { - "accepts": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAcceptOfDay" - } - }, "created_at": { "type": "string", "format": "int64" @@ -43513,37 +44570,68 @@ "type": "string", "format": "int64" }, - "end_at": { - "type": "string", - "format": "int64" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "excepts": { + "error_ids": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineExceptDate" + "type": "string" } }, + "failure_dial_delay": { + "type": "integer", + "format": "int64" + }, + "gateway": { + "$ref": "#/definitions/engineLookup" + }, "id": { "type": "string", "format": "int64" }, + "last_error_at": { + "type": "string", + "format": "int64" + }, + "last_error_id": { + "type": "string" + }, + "limit": { + "type": "integer", + "format": "int32" + }, + "max_successively_errors": { + "type": "integer", + "format": "int32" + }, "name": { "type": "string" }, - "specials": { + "number": { + "type": "string" + }, + "parameters": { + "$ref": "#/definitions/engineOutboundResourceParameters" + }, + "patterns": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAcceptOfDay" + "type": "string" } }, - "start_at": { - "type": "string", - "format": "int64" + "reserve": { + "type": "boolean", + "format": "boolean" }, - "timezone": { - "$ref": "#/definitions/engineLookup" + "rps": { + "type": "integer", + "format": "int32" + }, + "successively_errors": { + "type": "integer", + "format": "int32" }, "updated_at": { "type": "string", @@ -43551,14 +44639,20 @@ }, "updated_by": { "$ref": "#/definitions/engineLookup" + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, - "engineCallAnnotation": { + "engineOutboundResourceGroup": { "type": "object", "properties": { - "call_id": { - "type": "string" + "communication": { + "$ref": "#/definitions/engineLookup" }, "created_at": { "type": "string", @@ -43567,20 +44661,28 @@ "created_by": { "$ref": "#/definitions/engineLookup" }, - "end_sec": { - "type": "integer", - "format": "int32" + "description": { + "type": "string" + }, + "domain_id": { + "type": "string", + "format": "int64" }, "id": { "type": "string", "format": "int64" }, - "note": { + "name": { "type": "string" }, - "start_sec": { - "type": "integer", - "format": "int32" + "strategy": { + "type": "string" + }, + "time": { + "type": "array", + "items": { + "$ref": "#/definitions/engineOutboundResourceTimeRange" + } }, "updated_at": { "type": "string", @@ -43591,147 +44693,102 @@ } } }, - "engineCallFile": { + "engineOutboundResourceInGroup": { "type": "object", "properties": { - "id": { + "group_id": { "type": "string", "format": "int64" }, - "mime_type": { - "type": "string" - }, - "name": { - "type": "string" - }, - "size": { + "id": { "type": "string", "format": "int64" }, - "start_at": { - "type": "string", + "priority": { + "type": "integer", "format": "int64" }, - "stop_at": { - "type": "string", - "format": "int64" + "reserve_resource": { + "$ref": "#/definitions/engineLookup" + }, + "resource": { + "$ref": "#/definitions/engineLookup" } } }, - "engineCallHold": { + "engineOutboundResourceParameters": { "type": "object", "properties": { - "sec": { - "type": "number", - "format": "float" - }, - "start": { - "type": "string", - "format": "int64" + "cid_type": { + "type": "string" }, - "stop": { - "type": "string", - "format": "int64" + "ignore_early_media": { + "type": "string" } } }, - "engineChatPlan": { + "engineOutboundResourceTimeRange": { "type": "object", "properties": { - "description": { - "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "id": { + "end_time_of_day": { "type": "integer", "format": "int32" }, - "name": { - "type": "string" - }, - "schema": { - "$ref": "#/definitions/engineLookup" + "start_time_of_day": { + "type": "integer", + "format": "int32" } } }, - "engineCommunicationChannels": { - "type": "string", - "default": "Undefined", - "enum": [ - "Undefined", - "Phone", - "Email", - "Messaging" - ] - }, - "engineCommunicationType": { + "engineOutboundResourceViewGroup": { "type": "object", "properties": { - "channel": { - "$ref": "#/definitions/engineCommunicationChannels" - }, - "code": { - "type": "string" - }, - "default": { - "type": "boolean" + "communication": { + "$ref": "#/definitions/engineLookup" }, "description": { "type": "string" }, - "domain_id": { - "type": "string", - "format": "int64" - }, "id": { "type": "string", "format": "int64" }, "name": { "type": "string" - } - } - }, - "engineCommunicationTypeRequest": { - "type": "object", - "properties": { - "channel": { - "$ref": "#/definitions/engineCommunicationChannels" - }, - "code": { - "type": "string" - }, - "default": { - "type": "boolean" - }, - "description": { - "type": "string" }, - "name": { + "strategy": { "type": "string" } } }, - "engineConfirmPushResponse": { - "type": "object" - }, - "engineCreateAgentPauseCauseRequest": { + "enginePatchAgentPauseCauseRequest": { "type": "object", "properties": { "allow_admin": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "allow_agent": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "allow_supervisor": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "description": { "type": "string" }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "integer", + "format": "int64" + }, "limit_min": { "type": "integer", "format": "int64" @@ -43741,7 +44798,7 @@ } } }, - "engineCreateAgentRequest": { + "enginePatchAgentRequest": { "type": "object", "properties": { "allow_channels": { @@ -43753,7 +44810,6 @@ "auditor": { "type": "array", "items": { - "type": "object", "$ref": "#/definitions/engineLookup" } }, @@ -43764,15 +44820,22 @@ "description": { "type": "string" }, - "domain_id": { - "type": "string", - "format": "int64" + "fields": { + "type": "array", + "items": { + "type": "string" + } }, "greeting_media": { "$ref": "#/definitions/engineLookup" }, + "id": { + "type": "string", + "format": "int64" + }, "is_supervisor": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "progressive_count": { "type": "integer", @@ -43784,14 +44847,9 @@ "supervisor": { "type": "array", "items": { - "type": "object", "$ref": "#/definitions/engineLookup" } }, - "task_count": { - "type": "integer", - "format": "int64" - }, "team": { "$ref": "#/definitions/engineLookup" }, @@ -43800,9 +44858,13 @@ } } }, - "engineCreateAgentSkillBulkItem": { + "enginePatchAgentSkillRequest": { "type": "object", "properties": { + "agent_id": { + "type": "string", + "format": "int64" + }, "capacity": { "type": "integer", "format": "int32" @@ -43812,115 +44874,80 @@ "format": "int64" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, - "skill": { - "$ref": "#/definitions/engineLookup" - } - } - }, - "engineCreateAgentSkillsResponse": { - "type": "object", - "properties": { - "ids": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - } - } - }, - "engineCreateAgentTeamRequest": { - "type": "object", - "properties": { - "admin": { + "fields": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "type": "string" } }, - "call_timeout": { - "type": "integer", - "format": "int32" - }, - "description": { - "type": "string" - }, - "domain_id": { + "id": { "type": "string", "format": "int64" }, - "forecast_calculation": { + "skill": { "$ref": "#/definitions/engineLookup" - }, - "invite_chat_timeout": { - "type": "integer", - "format": "int32" - }, - "max_no_answer": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string" - }, - "no_answer_delay_time": { - "type": "integer", - "format": "int32" - }, - "strategy": { - "type": "string" - }, - "task_accept_timeout": { - "type": "integer", - "format": "int32" - }, - "wrap_up_time": { - "type": "integer", - "format": "int32" } } }, - "engineCreateAttemptResponse": { + "enginePatchAgentSkillsRequest": { "type": "object", "properties": { - "attempt_id": { + "agent_id": { "type": "string", "format": "int64" - } - } - }, - "engineCreateAuditFormRateRequest": { - "type": "object", - "properties": { - "answers": { + }, + "capacity": { + "type": "integer", + "format": "int32" + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "fields": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineQuestionAnswer" + "type": "string" } }, - "call_id": { - "type": "string" - }, - "comment": { - "type": "string" + "id": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } }, - "form": { - "$ref": "#/definitions/engineLookup" + "skill_id": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } } } }, - "engineCreateAuditFormRequest": { + "enginePatchAuditFormRequest": { "type": "object", "properties": { "description": { "type": "string" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "integer", + "format": "int32" }, "name": { "type": "string" @@ -43928,161 +44955,100 @@ "questions": { "type": "array", "items": { - "type": "object", "$ref": "#/definitions/engineQuestion" } }, "teams": { "type": "array", "items": { - "type": "object", "$ref": "#/definitions/engineLookup" } } } }, - "engineCreateBucketRequest": { + "enginePatchChatPlanRequest": { "type": "object", "properties": { "description": { "type": "string" }, - "domain_id": { - "type": "string", - "format": "int64" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "name": { - "type": "string" - } - } - }, - "engineCreateCalendarRequest": { - "type": "object", - "properties": { - "accepts": { + "fields": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAcceptOfDay" + "type": "string" } }, - "description": { - "type": "string" - }, - "domain_id": { - "type": "string", - "format": "int64" - }, - "end_at": { - "type": "string", - "format": "int64" - }, - "excepts": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineExceptDate" - } + "id": { + "type": "integer", + "format": "int32" }, "name": { "type": "string" }, - "specials": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAcceptOfDay" - } - }, - "start_at": { - "type": "string", - "format": "int64" - }, - "timezone": { + "schema": { "$ref": "#/definitions/engineLookup" } } }, - "engineCreateCallRequest": { + "enginePatchCommunicationTypeRequest": { "type": "object", "properties": { - "destination": { - "type": "string" - }, - "domain_id": { - "type": "string", - "format": "int64" + "channel": { + "$ref": "#/definitions/engineCommunicationChannels" }, - "from": { - "$ref": "#/definitions/engineCreateCallRequestEndpointRequest" + "code": { + "type": "string" }, - "params": { - "$ref": "#/definitions/CreateCallRequestCallSettings" + "default": { + "type": "boolean", + "format": "boolean" }, - "to": { - "$ref": "#/definitions/engineCreateCallRequestEndpointRequest" - } - } - }, - "engineCreateCallRequestEndpointRequest": { - "type": "object", - "properties": { - "app_id": { + "description": { "type": "string" }, - "extension": { - "type": "string" + "fields": { + "type": "array", + "items": { + "type": "string" + } }, "id": { "type": "string", "format": "int64" }, - "type": { - "type": "string" - } - } - }, - "engineCreateCallResponse": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - } - }, - "engineCreateChatPlanRequest": { - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "enabled": { - "type": "boolean" - }, "name": { "type": "string" - }, - "schema": { - "$ref": "#/definitions/engineLookup" } } }, - "engineCreateEmailProfileRequest": { + "enginePatchEmailProfileRequest": { "type": "object", "properties": { - "auth_type": { - "$ref": "#/definitions/engineEmailAuthType" - }, "description": { "type": "string" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "fetch_interval": { "type": "integer", "format": "int32" }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string", + "format": "int64" + }, "imap_host": { "type": "string" }, @@ -44091,7 +45057,8 @@ "format": "int32" }, "listen": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "login": { "type": "string" @@ -44102,9 +45069,6 @@ "name": { "type": "string" }, - "params": { - "$ref": "#/definitions/engineEmailProfileParams" - }, "password": { "type": "string" }, @@ -44120,41 +45084,61 @@ } } }, - "engineCreateListRequest": { + "enginePatchHistoryCallRequest": { "type": "object", "properties": { - "description": { - "type": "string" - }, - "domain_id": { - "type": "string", - "format": "int64" + "hide_missed": { + "type": "boolean", + "format": "boolean" }, - "name": { + "id": { "type": "string" + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, - "engineCreateMemberBulkItem": { + "enginePatchMemberOneRequest": { "type": "object", "properties": { "agent": { "$ref": "#/definitions/engineLookup" }, + "attempts": { + "type": "integer", + "format": "int32" + }, "bucket": { "$ref": "#/definitions/engineLookup" }, "communications": { "type": "array", "items": { - "type": "object", "$ref": "#/definitions/engineMemberCommunicationCreateRequest" } }, + "domain_id": { + "type": "string", + "format": "int64" + }, "expire_at": { "type": "string", "format": "int64" }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string", + "format": "int64" + }, "min_offering_at": { "type": "string", "format": "int64" @@ -44169,6 +45153,9 @@ "skill": { "$ref": "#/definitions/engineLookup" }, + "stop_cause": { + "type": "string" + }, "timezone": { "$ref": "#/definitions/engineLookup" }, @@ -44180,58 +45167,84 @@ } } }, - "engineCreateOutboundResourceDisplayRequest": { + "enginePatchMemberRequest": { "type": "object", "properties": { - "display": { - "type": "string" + "agent": { + "$ref": "#/definitions/engineLookup" + }, + "attempts": { + "type": "integer", + "format": "int32" + }, + "bucket": { + "$ref": "#/definitions/engineLookup" + }, + "communications": { + "type": "array", + "items": { + "$ref": "#/definitions/engineMemberCommunicationCreateRequest" + } }, "domain_id": { "type": "string", "format": "int64" }, - "resource_id": { + "expire_at": { "type": "string", "format": "int64" - } - } - }, - "engineCreateOutboundResourceGroupRequest": { - "type": "object", - "properties": { - "communication": { - "$ref": "#/definitions/engineLookup" }, - "description": { - "type": "string" + "fields": { + "type": "array", + "items": { + "type": "string" + } }, - "domain_id": { + "id": { + "type": "string", + "format": "int64" + }, + "min_offering_at": { "type": "string", "format": "int64" }, "name": { "type": "string" }, - "strategy": { + "priority": { + "type": "integer", + "format": "int32" + }, + "queue_id": { + "type": "string", + "format": "int64" + }, + "skill": { + "$ref": "#/definitions/engineLookup" + }, + "stop_cause": { "type": "string" }, - "time": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineOutboundResourceTimeRange" + "timezone": { + "$ref": "#/definitions/engineLookup" + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" } } } }, - "engineCreateOutboundResourceRequest": { + "enginePatchOutboundResourceRequest": { "type": "object", "properties": { "description": { "type": "string" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "error_ids": { "type": "array", @@ -44243,9 +45256,19 @@ "type": "integer", "format": "int64" }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, "gateway": { "$ref": "#/definitions/engineLookup" }, + "id": { + "type": "string", + "format": "int64" + }, "limit": { "type": "integer", "format": "int32" @@ -44270,7 +45293,8 @@ } }, "reserve": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "rps": { "type": "integer", @@ -44284,22 +45308,103 @@ } } }, - "engineCreatePresetQueryRequest": { + "enginePatchPresetQueryRequest": { "type": "object", "properties": { "description": { "type": "string" }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "integer", + "format": "int32" + }, "name": { "type": "string" }, - "preset": {}, + "preset": { + "type": "object" + }, "section": { "$ref": "#/definitions/enginePresetQuerySection" } } }, - "engineCreateQueueRequest": { + "enginePatchQueueBucketRequest": { + "type": "object", + "properties": { + "bucket": { + "$ref": "#/definitions/engineLookup" + }, + "disabled": { + "type": "boolean", + "format": "boolean" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string", + "format": "int64" + }, + "priority": { + "type": "integer", + "format": "int32" + }, + "queue_id": { + "type": "string", + "format": "int64" + }, + "ratio": { + "type": "integer", + "format": "int32" + } + } + }, + "enginePatchQueueHookRequest": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "event": { + "type": "string" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "integer", + "format": "int64" + }, + "properties": { + "type": "array", + "items": { + "type": "string" + } + }, + "queue_id": { + "type": "integer", + "format": "int64" + }, + "schema": { + "$ref": "#/definitions/engineLookup" + } + } + }, + "enginePatchQueueRequest": { "type": "object", "properties": { "after_schema": { @@ -44322,36 +45427,46 @@ "format": "int64" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } }, "form_schema": { - "title": "deprecated", "$ref": "#/definitions/engineLookup" }, "grantee": { "$ref": "#/definitions/engineLookup" }, + "id": { + "type": "string", + "format": "int64" + }, "name": { "type": "string" }, - "payload": {}, + "payload": { + "type": "object" + }, "priority": { "type": "integer", "format": "int32" }, "processing": { "type": "boolean", - "title": "deprecated" + "format": "boolean" }, "processing_renewal_sec": { "type": "integer", - "format": "int64", - "title": "deprecated" + "format": "int64" }, "processing_sec": { "type": "integer", - "format": "int64", - "title": "deprecated" + "format": "int64" }, "ringtone": { "$ref": "#/definitions/engineLookup" @@ -44364,7 +45479,8 @@ "format": "int32" }, "sticky_agent": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "strategy": { "type": "string" @@ -44372,7 +45488,6 @@ "tags": { "type": "array", "items": { - "type": "object", "$ref": "#/definitions/engineTag" } }, @@ -44398,12 +45513,96 @@ } } }, - "engineCreateRegionRequest": { + "enginePatchQueueSkillRequest": { + "type": "object", + "properties": { + "buckets": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "integer", + "format": "int64" + }, + "lvl": { + "type": "integer", + "format": "int32" + }, + "max_capacity": { + "type": "integer", + "format": "int32" + }, + "min_capacity": { + "type": "integer", + "format": "int32" + }, + "queue_id": { + "type": "integer", + "format": "int64" + }, + "skill": { + "$ref": "#/definitions/engineLookup" + } + } + }, + "enginePatchQuickReplyRequest": { + "type": "object", + "properties": { + "article": { + "$ref": "#/definitions/engineLookup" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "queue": { + "$ref": "#/definitions/engineLookup" + }, + "team": { + "$ref": "#/definitions/engineLookup" + }, + "text": { + "type": "string" + } + } + }, + "enginePatchRegionRequest": { "type": "object", "properties": { "description": { "type": "string" }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string", + "format": "int64" + }, "name": { "type": "string" }, @@ -44412,19 +45611,30 @@ } } }, - "engineCreateRoutingOutboundCallRequest": { + "enginePatchRoutingOutboundCallRequest": { "type": "object", "properties": { "description": { "type": "string" }, "disabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "domain_id": { "type": "string", "format": "int64" }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string", + "format": "int64" + }, "name": { "type": "string" }, @@ -44436,27 +45646,45 @@ } } }, - "engineCreateRoutingSchemaRequest": { + "enginePatchRoutingSchemaRequest": { "type": "object", "properties": { "debug": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "description": { "type": "string" }, "editor": { - "type": "boolean" + "type": "boolean", + "format": "boolean" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string", + "format": "int64" }, "name": { "type": "string" }, - "payload": {}, - "schema": {}, + "note": { + "type": "string" + }, + "payload": { + "type": "object" + }, + "schema": { + "type": "object" + }, "tags": { "type": "array", "items": { - "type": "object", "$ref": "#/definitions/engineSchemaTag" } }, @@ -44465,81 +45693,190 @@ } } }, - "engineCreateRoutingVariableRequest": { + "enginePatchSchemaVariableRequest": { "type": "object", "properties": { - "domain_id": { - "type": "string", - "format": "int64" + "encrypt": { + "type": "boolean", + "format": "boolean" }, - "key": { + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "integer", + "format": "int32" + }, + "name": { "type": "string" }, "value": { - "type": "string" + "type": "object" } } }, - "engineCreateSchemaVariableRequest": { + "enginePatchSkillAgentRequest": { "type": "object", "properties": { - "encrypt": { - "type": "boolean" + "agent_id": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } }, - "name": { - "type": "string" + "capacity": { + "type": "integer", + "format": "int32" }, - "value": {} + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } + }, + "skill": { + "$ref": "#/definitions/engineLookup" + }, + "skill_id": { + "type": "string", + "format": "int64" + } } }, - "engineCreateSkillAgentResponse": { + "enginePatchSkillAgentResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { - "type": "object", "$ref": "#/definitions/engineSkillAgentItem" } } } }, - "engineCreateSkillRequest": { + "enginePatchSystemSettingRequest": { "type": "object", "properties": { - "description": { - "type": "string" + "fields": { + "type": "array", + "items": { + "type": "string" + } }, - "domain_id": { - "type": "string", + "id": { + "type": "integer", + "format": "int32" + }, + "value": { + "type": "object" + } + } + }, + "enginePatchTeamHookRequest": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "event": { + "$ref": "#/definitions/engineTeamHookEvent" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "integer", "format": "int64" }, - "name": { - "type": "string" + "properties": { + "type": "array", + "items": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/engineLookup" + }, + "team_id": { + "type": "string", + "format": "int64" } } }, - "engineCreateSystemSettingRequest": { + "enginePatchTeamTriggerRequest": { "type": "object", "properties": { + "description": { + "type": "string" + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "integer", + "format": "int64" + }, "name": { - "$ref": "#/definitions/engineSystemSettingName" + "type": "string" }, - "value": {} + "schema": { + "$ref": "#/definitions/engineLookup" + }, + "team_id": { + "type": "string", + "format": "int64" + } } }, - "engineCreateTriggerRequest": { + "enginePatchTriggerRequest": { "type": "object", "properties": { "description": { "type": "string" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "expression": { "type": "string" }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "integer", + "format": "int32" + }, "name": { "type": "string" }, @@ -44564,7 +45901,7 @@ } } }, - "engineCreateWebHookRequest": { + "enginePatchWebHookRequest": { "type": "object", "properties": { "authorization": { @@ -44574,7 +45911,18 @@ "type": "string" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "integer", + "format": "int32" }, "name": { "type": "string" @@ -44590,561 +45938,412 @@ } } }, - "engineDefaultDeviceConfigResponse": { - "type": "object", - "properties": { - "sip": { - "$ref": "#/definitions/DefaultDeviceConfigResponseSipDeviceConfig" - }, - "webrtc": { - "$ref": "#/definitions/DefaultDeviceConfigResponseWebRTCDeviceConfig" - } - } - }, - "engineDeleteSkillAgentResponse": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineSkillAgentItem" - } - } - } - }, - "engineDtmfCallResponse": { - "type": "object" - }, - "engineEavesdropCallRequestEndpointRequest": { - "type": "object", - "properties": { - "app_id": { - "type": "string" - }, - "extension": { - "type": "string" - }, - "id": { - "type": "string", - "format": "int64" - }, - "type": { - "type": "string" - } - } - }, - "engineEmailAuthType": { - "type": "string", - "default": "EmailAuthTypeUndefined", - "enum": [ - "EmailAuthTypeUndefined", - "Plain", - "OAuth2" - ] - }, - "engineEmailProfile": { + "enginePresetQuery": { "type": "object", "properties": { - "activity_at": { - "type": "string", - "format": "int64" - }, - "auth_type": { - "$ref": "#/definitions/engineEmailAuthType" - }, "created_at": { "type": "string", "format": "int64" }, - "created_by": { - "$ref": "#/definitions/engineLookup" - }, "description": { "type": "string" }, - "enabled": { - "type": "boolean" - }, - "fetch_error": { - "type": "string" - }, - "fetch_interval": { - "type": "integer", - "format": "int32" - }, "id": { - "type": "string", - "format": "int64" - }, - "imap_host": { - "type": "string" - }, - "imap_port": { "type": "integer", "format": "int32" }, - "listen": { - "type": "boolean" - }, - "logged": { - "type": "boolean" - }, - "login": { - "type": "string" - }, - "mailbox": { - "type": "string" - }, "name": { "type": "string" }, - "params": { - "$ref": "#/definitions/engineEmailProfileParams" - }, - "password": { - "type": "string" - }, - "schema": { - "$ref": "#/definitions/engineLookup" - }, - "smtp_host": { - "type": "string" - }, - "smtp_port": { - "type": "integer", - "format": "int32" + "preset": { + "type": "object" }, - "state": { - "type": "string" + "section": { + "$ref": "#/definitions/enginePresetQuerySection" }, "updated_at": { "type": "string", "format": "int64" - }, - "updated_by": { - "$ref": "#/definitions/engineLookup" } } }, - "engineEmailProfileParams": { - "type": "object", - "properties": { - "oauth2": { - "$ref": "#/definitions/EmailProfileParamsOAuth2" - } - } - }, - "engineEmptyResponse": { - "type": "object" - }, - "engineEndpoint": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "number": { - "type": "string" - }, - "type": { - "type": "string" - } - } + "enginePresetQuerySection": { + "type": "string", + "default": "section_default", + "enum": [ + "section_default", + "section_calls" + ] }, - "engineExceptDate": { + "engineQuestion": { "type": "object", "properties": { - "date": { - "type": "string", - "format": "int64" - }, - "disabled": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "repeat": { - "type": "boolean" - }, - "work_start": { + "max": { "type": "integer", "format": "int32" }, - "work_stop": { + "min": { "type": "integer", "format": "int32" }, - "working": { - "type": "boolean" - } - } - }, - "engineFilterBetween": { - "type": "object", - "properties": { - "from": { - "type": "string", - "format": "int64" - }, - "to": { - "type": "string", - "format": "int64" - } - } - }, - "engineForAgentPauseCause": { - "type": "object", - "properties": { - "duration_min": { - "type": "integer", - "format": "int64" + "options": { + "type": "array", + "items": { + "$ref": "#/definitions/QuestionOption" + } }, - "id": { - "type": "integer", - "format": "int64" + "question": { + "type": "string" }, - "limit_min": { - "type": "integer", - "format": "int64" + "required": { + "type": "boolean", + "format": "boolean" }, - "name": { - "type": "string" + "type": { + "$ref": "#/definitions/engineAuditQuestionType" } } }, - "engineForAgentPauseCauseList": { + "engineQuestionAnswer": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineForAgentPauseCause" - } + "score": { + "type": "number", + "format": "float" } } }, - "engineHangupCallResponse": { - "type": "object" - }, - "engineHistoryCall": { + "engineQueue": { "type": "object", "properties": { - "agent": { - "$ref": "#/definitions/engineLookup" - }, - "agent_description": { - "type": "string" - }, - "allow_evaluation": { - "type": "boolean" - }, - "amd_ai_logs": { - "type": "array", - "items": { - "type": "string" - } - }, - "amd_ai_result": { - "type": "string" - }, - "amd_result": { - "type": "string" + "active": { + "type": "integer", + "format": "int32" }, - "annotations": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineCallAnnotation" - } + "after_schema": { + "$ref": "#/definitions/engineLookup" }, - "answered_at": { - "type": "string", - "format": "int64" + "calendar": { + "$ref": "#/definitions/engineLookup" }, - "app_id": { - "type": "string" + "count": { + "type": "integer", + "format": "int32" }, - "attempt_id": { + "created_at": { "type": "string", "format": "int64" }, - "bill_sec": { - "type": "integer", - "format": "int32" + "created_by": { + "$ref": "#/definitions/engineLookup" }, - "blind_transfer": { + "description": { "type": "string" }, - "blind_transfers": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/HistoryCallBlindTransfer" - } + "dnc_list": { + "$ref": "#/definitions/engineLookup" }, - "bridged_at": { + "do_schema": { + "$ref": "#/definitions/engineLookup" + }, + "domain_id": { "type": "string", "format": "int64" }, - "bridged_id": { - "type": "string" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "cause": { - "type": "string" + "form_schema": { + "$ref": "#/definitions/engineLookup" }, - "contact": { + "grantee": { "$ref": "#/definitions/engineLookup" }, - "created_at": { + "id": { "type": "string", "format": "int64" }, - "destination": { - "type": "string" - }, - "direction": { + "name": { "type": "string" }, - "display": { - "type": "string" + "payload": { + "type": "object" }, - "duration": { + "priority": { "type": "integer", "format": "int32" }, - "extension": { - "type": "string" - }, - "files": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineCallFile" - } - }, - "files_job": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineHistoryFileJob" - } + "processing": { + "type": "boolean", + "format": "boolean" }, - "form_fields": {}, - "from": { - "$ref": "#/definitions/engineEndpoint" + "processing_renewal_sec": { + "type": "integer", + "format": "int64" }, - "from_number": { - "type": "string" + "processing_sec": { + "type": "integer", + "format": "int64" }, - "gateway": { + "ringtone": { "$ref": "#/definitions/engineLookup" }, - "grantee": { + "schema": { "$ref": "#/definitions/engineLookup" }, - "hangup_at": { - "type": "string", - "format": "int64" - }, - "hangup_by": { - "type": "string" + "sec_locate_agent": { + "type": "integer", + "format": "int32" }, - "hangup_disposition": { - "type": "string" + "sticky_agent": { + "type": "boolean", + "format": "boolean" }, - "hangup_phrase": { + "strategy": { "type": "string" }, - "has_children": { - "type": "boolean" - }, - "hold": { + "tags": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineCallHold" + "$ref": "#/definitions/engineTag" } }, - "hold_sec": { + "task_processing": { + "$ref": "#/definitions/engineTaskProcessing" + }, + "team": { + "$ref": "#/definitions/engineLookup" + }, + "timeout": { "type": "integer", "format": "int32" }, - "id": { - "type": "string" - }, - "joined_at": { - "type": "string", - "format": "int64" + "type": { + "type": "integer", + "format": "int32" }, - "leaving_at": { + "updated_at": { "type": "string", "format": "int64" }, - "member": { + "updated_by": { "$ref": "#/definitions/engineLookup" }, - "member_id": { - "type": "string", - "format": "int64" - }, - "parent_id": { - "type": "string" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } }, - "queue": { + "waiting": { + "type": "integer", + "format": "int32" + } + } + }, + "engineQueueBucket": { + "type": "object", + "properties": { + "bucket": { "$ref": "#/definitions/engineLookup" }, - "queue_bridged_at": { + "disabled": { + "type": "boolean", + "format": "boolean" + }, + "id": { "type": "string", "format": "int64" }, - "queue_duration_sec": { + "priority": { "type": "integer", "format": "int32" }, - "queue_wait_sec": { + "ratio": { "type": "integer", "format": "int32" + } + } + }, + "engineQueueHook": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "format": "boolean" }, - "rate_id": { - "type": "string", + "event": { + "type": "string" + }, + "id": { + "type": "integer", "format": "int64" }, - "rated_by": { - "$ref": "#/definitions/engineLookup" + "properties": { + "type": "array", + "items": { + "type": "string" + } }, - "rated_user": { + "schema": { "$ref": "#/definitions/engineLookup" - }, - "reporting_at": { - "type": "string", + } + } + }, + "engineQueueReportGeneral": { + "type": "object", + "properties": { + "abandoned": { + "type": "integer", "format": "int64" }, - "reporting_sec": { + "agent_status": { + "$ref": "#/definitions/engineQueueReportGeneralAgentStatus" + }, + "attempts": { "type": "integer", - "format": "int32" + "format": "int64" }, - "result": { - "type": "string" + "avg_aht_sec": { + "type": "number", + "format": "float" }, - "schemas": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } + "avg_asa_sec": { + "type": "number", + "format": "float" }, - "score_optional": { + "avg_awt_sec": { "type": "number", "format": "float" }, - "score_required": { + "avg_wrap_sec": { "type": "number", "format": "float" }, - "sip_code": { - "type": "integer", - "format": "int32" + "bridged": { + "type": "number", + "format": "float" }, - "stored_at": { + "count": { "type": "string", - "format": "int64" + "format": "uint64" }, - "tags": { - "type": "array", - "items": { - "type": "string" - } + "missed": { + "type": "integer", + "format": "int64" }, - "talk_sec": { + "processed": { "type": "integer", - "format": "int32" + "format": "int64" }, - "team": { + "queue": { "$ref": "#/definitions/engineLookup" }, - "to": { - "$ref": "#/definitions/engineEndpoint" - }, - "to_number": { - "type": "string" - }, - "transcripts": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineTranscriptLookup" - } - }, - "transfer_from": { - "type": "string" + "sl20": { + "type": "number", + "format": "float" }, - "transfer_to": { - "type": "string" + "sl30": { + "type": "number", + "format": "float" }, - "type": { - "type": "string" + "sum_bill_sec": { + "type": "number", + "format": "float" }, - "user": { + "team": { "$ref": "#/definitions/engineLookup" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "transferred": { + "type": "integer", + "format": "int64" }, - "wait_sec": { + "waiting": { "type": "integer", - "format": "int32" + "format": "int64" } } }, - "engineHistoryFileJob": { + "engineQueueReportGeneralAgentStatus": { "type": "object", "properties": { - "action": { - "$ref": "#/definitions/HistoryFileJobHistoryFileJobAction" + "free": { + "type": "integer", + "format": "int64" }, - "created_at": { - "type": "string", + "offline": { + "type": "integer", "format": "int64" }, - "error_detail": { - "type": "string" + "online": { + "type": "integer", + "format": "int64" }, - "file_id": { - "type": "string", + "pause": { + "type": "integer", + "format": "int64" + }, + "total": { + "type": "integer", "format": "int64" + } + } + }, + "engineQueueResourceGroup": { + "type": "object", + "properties": { + "communication": { + "$ref": "#/definitions/engineLookup" }, "id": { "type": "string", "format": "int64" }, - "state": { - "$ref": "#/definitions/HistoryFileJobHistoryFileJobState" + "resource_group": { + "$ref": "#/definitions/engineLookup" } } }, - "engineHoldCallResponse": { + "engineQueueSkill": { "type": "object", "properties": { - "state": { - "type": "string" + "buckets": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "lvl": { + "type": "integer", + "format": "int32" + }, + "max_capacity": { + "type": "integer", + "format": "int32" + }, + "min_capacity": { + "type": "integer", + "format": "int32" + }, + "skill": { + "$ref": "#/definitions/engineLookup" } } }, - "engineList": { + "engineQuickReply": { "type": "object", "properties": { - "count": { - "type": "string", - "format": "int64" + "article": { + "$ref": "#/definitions/engineLookup" }, "created_at": { "type": "string", @@ -45153,20 +46352,22 @@ "created_by": { "$ref": "#/definitions/engineLookup" }, - "description": { - "type": "string" - }, - "domain_id": { - "type": "string", - "format": "int64" - }, "id": { - "type": "string", + "type": "integer", "format": "int64" }, "name": { "type": "string" }, + "queue": { + "$ref": "#/definitions/engineLookup" + }, + "team": { + "$ref": "#/definitions/engineLookup" + }, + "text": { + "type": "string" + }, "updated_at": { "type": "string", "format": "int64" @@ -45176,1837 +46377,1475 @@ } } }, - "engineListAgent": { + "engineRedialCallRequest": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAgent" - } - }, - "next": { - "type": "boolean" + "call_id": { + "type": "string" } } }, - "engineListAgentInQueue": { + "engineRegion": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAgentInQueue" - } + "description": { + "type": "string" }, - "next": { - "type": "boolean" - } - } - }, - "engineListAgentInTeam": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAgentInTeam" - } + "id": { + "type": "string", + "format": "int64" }, - "next": { - "type": "boolean" - } - } - }, - "engineListAgentPauseCause": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAgentPauseCause" - } + "name": { + "type": "string" }, - "next": { - "type": "boolean" + "timezone": { + "$ref": "#/definitions/engineLookup" } } }, - "engineListAgentSkill": { + "engineResetMembersRequest": { "type": "object", "properties": { - "items": { + "agent_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAgentSkillItem" + "type": "integer", + "format": "int32" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListAgentStateHistory": { - "type": "object", - "properties": { - "items": { + "bucket_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAgentState" + "type": "string", + "format": "int64" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListAgentStatsStatistic": { - "type": "object", - "properties": { - "items": { + "id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAgentStatsStatistic" + "type": "string", + "format": "int64" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListAgentTeam": { - "type": "object", - "properties": { - "items": { + "ids": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAgentTeam" + "type": "string", + "format": "int64" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListAgentUser": { - "type": "object", - "properties": { - "items": { + "numbers": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAgentUser" + "type": "string" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListAggregate": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAggregateResult" - } - } - } - }, - "engineListAttempt": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAttempt" - } + "queue_id": { + "type": "string", + "format": "int64" }, - "next": { - "type": "boolean" - } - } - }, - "engineListAuditForm": { - "type": "object", - "properties": { - "items": { + "stop_cause": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAuditForm" + "type": "string" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListAuditRate": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAuditRate" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" } - }, - "next": { - "type": "boolean" } } }, - "engineListAvailableSystemSetting": { + "engineResetMembersResponse": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAvailableSystemSetting" - } - }, - "next": { - "type": "boolean" + "count": { + "type": "string", + "format": "int64" } } }, - "engineListBucket": { + "engineResourceDisplay": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineBucket" - } + "display": { + "type": "string" }, - "next": { - "type": "boolean" + "id": { + "type": "string", + "format": "int64" } } }, - "engineListCalendar": { + "engineResponse": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineCalendar" - } - }, - "next": { - "type": "boolean" + "status": { + "type": "string" } } }, - "engineListCall": { + "engineRoutingOutboundCall": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineActiveCall" - } + "created_at": { + "type": "string", + "format": "int64" }, - "next": { - "type": "boolean" - } - } - }, - "engineListChatPlan": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineChatPlan" - } + "created_by": { + "$ref": "#/definitions/engineLookup" }, - "next": { - "type": "boolean" - } - } - }, - "engineListCommunication": { - "type": "object", - "properties": { "description": { "type": "string" }, - "expire_at": { - "type": "string", - "format": "int64" + "disabled": { + "type": "boolean", + "format": "boolean" }, - "id": { + "domain_id": { "type": "string", "format": "int64" }, - "list_id": { + "id": { "type": "string", "format": "int64" }, - "number": { + "name": { "type": "string" - } - } - }, - "engineListCommunicationType": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineCommunicationType" - } - }, - "next": { - "type": "boolean" - } - } - }, - "engineListEmailProfile": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineEmailProfile" - } }, - "next": { - "type": "boolean" - } - } - }, - "engineListHistoryAttempt": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAttemptHistory" - } + "pattern": { + "type": "string" }, - "next": { - "type": "boolean" - } - } - }, - "engineListHistoryCall": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineHistoryCall" - } + "schema": { + "$ref": "#/definitions/engineLookup" }, - "next": { - "type": "boolean" - } - } - }, - "engineListMember": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineMemberInQueue" - } + "updated_at": { + "type": "string", + "format": "int64" }, - "next": { - "type": "boolean" + "updated_by": { + "$ref": "#/definitions/engineLookup" } } }, - "engineListMemberAttempt": { + "engineRoutingOutboundCallCompact": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineMemberAttempt" - } + "description": { + "type": "string" }, - "next": { - "type": "boolean" + "disabled": { + "type": "boolean", + "format": "boolean" + }, + "domain_id": { + "type": "string", + "format": "int64" + }, + "id": { + "type": "string", + "format": "int64" + }, + "name": { + "type": "string" + }, + "pattern": { + "type": "string" + }, + "position": { + "type": "integer", + "format": "int32" + }, + "schema": { + "$ref": "#/definitions/engineLookup" } } }, - "engineListOfList": { + "engineRoutingSchema": { "type": "object", "properties": { - "items": { + "created_at": { + "type": "string", + "format": "int64" + }, + "created_by": { + "$ref": "#/definitions/engineLookup" + }, + "debug": { + "type": "boolean", + "format": "boolean" + }, + "description": { + "type": "string" + }, + "editor": { + "type": "boolean", + "format": "boolean" + }, + "id": { + "type": "string", + "format": "int64" + }, + "name": { + "type": "string" + }, + "payload": { + "type": "object" + }, + "schema": { + "type": "object" + }, + "tags": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineList" + "$ref": "#/definitions/engineSchemaTag" } }, - "next": { - "type": "boolean" + "type": { + "$ref": "#/definitions/engineRoutingSchemaType" + }, + "updated_at": { + "type": "string", + "format": "int64" + }, + "updated_by": { + "$ref": "#/definitions/engineLookup" } } }, - "engineListOfListCommunication": { + "engineRoutingSchemaTag": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineListCommunication" - } + "count": { + "type": "integer", + "format": "int64" }, - "next": { - "type": "boolean" + "name": { + "type": "string" } } }, - "engineListOutboundResource": { + "engineRoutingSchemaType": { + "type": "string", + "default": "default", + "enum": [ + "default", + "voice", + "chat", + "processing", + "service" + ] + }, + "engineRoutingVariable": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineOutboundResource" - } + "domain_id": { + "type": "string", + "format": "int64" }, - "next": { - "type": "boolean" + "id": { + "type": "string", + "format": "int64" + }, + "key": { + "type": "string" + }, + "value": { + "type": "string" } } }, - "engineListOutboundResourceDisplay": { + "engineRunTeamTriggerRequest": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineResourceDisplay" - } + "trigger_id": { + "type": "integer", + "format": "int32" }, - "next": { - "type": "boolean" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, - "engineListOutboundResourceGroup": { + "engineRunTeamTriggerResponse": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineOutboundResourceViewGroup" - } - }, - "next": { - "type": "boolean" + "job_id": { + "type": "string" } } }, - "engineListOutboundResourceInGroup": { + "engineSchemaTag": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineOutboundResourceInGroup" - } - }, - "next": { - "type": "boolean" + "name": { + "type": "string" } } }, - "engineListPresetQuery": { + "engineSchemaVariable": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/enginePresetQuery" - } + "encrypt": { + "type": "boolean", + "format": "boolean" }, - "next": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string" + }, + "value": { + "type": "object" } } }, - "engineListQueue": { + "engineSchemaVersion": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineQueue" - } + "created_at": { + "type": "string", + "format": "int64" }, - "next": { - "type": "boolean" + "created_by": { + "$ref": "#/definitions/engineLookup" + }, + "id": { + "type": "string", + "format": "int64" + }, + "note": { + "type": "string" + }, + "payload": { + "type": "object" + }, + "schema": { + "type": "object" + }, + "schema_id": { + "type": "string", + "format": "int64" + }, + "version": { + "type": "string", + "format": "uint64" } } }, - "engineListQueueBucket": { + "engineSearchHistoryCallRequest": { "type": "object", "properties": { - "items": { + "agent_description": { + "type": "string" + }, + "agent_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineQueueBucket" + "type": "string", + "format": "int64" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListQueueHook": { - "type": "object", - "properties": { - "items": { + "amd_ai_result": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineQueueHook" + "type": "string" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListQueueResourceGroup": { - "type": "object", - "properties": { - "items": { + "amd_result": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineQueueResourceGroup" + "type": "string" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListQueueSkill": { - "type": "object", - "properties": { - "items": { + "answered_at": { + "$ref": "#/definitions/engineFilterBetween" + }, + "cause": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineQueueSkill" + "type": "string" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListRegion": { - "type": "object", - "properties": { - "items": { + "contact_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineRegion" + "type": "string", + "format": "int64" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListReportGeneral": { - "type": "object", - "properties": { - "aggs": { - "$ref": "#/definitions/engineQueueReportGeneralAgentStatus" + "created_at": { + "$ref": "#/definitions/engineFilterBetween" }, - "items": { + "dependency_id": { + "type": "string" + }, + "direction": { + "type": "string" + }, + "directions": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineQueueReportGeneral" + "type": "string" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListResourceDisplay": { - "type": "object", - "properties": { - "id": { + "domain_id": { + "type": "string", + "format": "int64" + }, + "duration": { + "$ref": "#/definitions/engineFilterBetween" + }, + "fields": { "type": "array", "items": { - "type": "string", - "format": "int64" + "type": "string" } - } - } - }, - "engineListRoutingOutboundCall": { - "type": "object", - "properties": { - "items": { + }, + "fts": { + "type": "string" + }, + "gateway_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineRoutingOutboundCallCompact" + "type": "string", + "format": "int64" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListRoutingSchema": { - "type": "object", - "properties": { - "items": { + "grantee_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineRoutingSchema" + "type": "string", + "format": "int64" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListRoutingSchemaTags": { - "type": "object", - "properties": { - "items": { + "has_file": { + "type": "boolean", + "format": "boolean" + }, + "has_transcript": { + "type": "boolean", + "format": "boolean" + }, + "has_transfer": { + "type": "boolean", + "format": "boolean" + }, + "id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineRoutingSchemaTag" + "type": "string" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListRoutingVariable": { - "type": "object", - "properties": { - "items": { + "member_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineRoutingVariable" + "type": "string", + "format": "int64" } - } - } - }, - "engineListSchemaVariable": { - "type": "object", - "properties": { - "items": { + }, + "missed": { + "type": "boolean", + "format": "boolean" + }, + "number": { + "type": "string" + }, + "owner_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineSchemaVariable" + "type": "string", + "format": "int64" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListSkill": { - "type": "object", - "properties": { - "items": { + "page": { + "type": "integer", + "format": "int32" + }, + "parent_id": { + "type": "string" + }, + "q": { + "type": "string" + }, + "queue_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineSkill" + "type": "string", + "format": "int64" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListSkillAgent": { - "type": "object", - "properties": { - "aggs": { - "$ref": "#/definitions/ListSkillAgentListSkillAgg" + "rated": { + "type": "boolean", + "format": "boolean" }, - "items": { + "rated_by": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineSkillAgentItem" + "type": "string", + "format": "int64" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListSystemSetting": { - "type": "object", - "properties": { - "items": { + "rated_user": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineSystemSetting" + "type": "string", + "format": "int64" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListTags": { - "type": "object", - "properties": { - "items": { + "schema_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineTag" + "type": "integer", + "format": "int32" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListTeamHook": { - "type": "object", - "properties": { - "items": { + "score_optional": { + "$ref": "#/definitions/engineFilterBetween" + }, + "score_required": { + "$ref": "#/definitions/engineFilterBetween" + }, + "size": { + "type": "integer", + "format": "int32" + }, + "skip_parent": { + "type": "boolean", + "format": "boolean" + }, + "sort": { + "type": "string" + }, + "stored_at": { + "$ref": "#/definitions/engineFilterBetween" + }, + "tags": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineTeamHook" + "type": "string" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListTeamTrigger": { - "type": "object", - "properties": { - "items": { + "talk": { + "$ref": "#/definitions/engineFilterBetween" + }, + "team_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineTeamTrigger" + "type": "string", + "format": "int64" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListTimezoneResponse": { - "type": "object", - "properties": { - "items": { + "timeline": { + "type": "boolean", + "format": "boolean" + }, + "transfer_from": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineTimezone" + "type": "string" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListTrigger": { - "type": "object", - "properties": { - "items": { + "transfer_to": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineTrigger" + "type": "string" } }, - "next": { - "type": "boolean" - } - } - }, - "engineListTriggerJob": { - "type": "object", - "properties": { - "items": { + "user_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineTriggerJob" + "type": "string", + "format": "int64" } }, - "next": { - "type": "boolean" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, - "engineListUserStatus": { + "engineSearchSchemaVersionResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineUserStatus" + "$ref": "#/definitions/engineSchemaVersion" } }, "next": { - "type": "boolean" + "type": "boolean", + "format": "boolean" } } }, - "engineListWebHook": { + "engineSendPushResponse": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineWebHook" - } - }, - "next": { - "type": "boolean" + "send": { + "type": "integer", + "format": "int32" } } }, - "engineLoginEmailProfileResponse": { + "engineSetVariablesCallRequest": { "type": "object", "properties": { - "auth_type": { - "$ref": "#/definitions/engineEmailAuthType" + "id": { + "type": "string" }, - "cookie": { + "variables": { "type": "object", "additionalProperties": { "type": "string" } - }, - "redirect_url": { - "type": "string" } } }, - "engineLogoutEmailProfileResponse": { + "engineSetVariablesCallResponse": { "type": "object" }, - "engineLookup": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "engineMemberAttempt": { + "engineSkill": { "type": "object", "properties": { - "active": { - "type": "boolean" - }, - "agent": { - "$ref": "#/definitions/engineLookup" - }, - "answered_at": { - "type": "string", - "format": "int64" - }, - "attempts": { + "active_agents": { "type": "integer", "format": "int32" }, - "bridged_at": { - "type": "string", - "format": "int64" - }, - "bucket": { - "$ref": "#/definitions/engineLookup" - }, "created_at": { "type": "string", "format": "int64" }, - "destination": { - "type": "string" - }, - "hangup_at": { - "type": "string", - "format": "int64" - }, - "id": { - "type": "string", - "format": "int64" - }, - "leg_a_id": { - "type": "string" - }, - "leg_b_id": { - "type": "string" - }, - "logs": {}, - "member": { - "$ref": "#/definitions/engineLookup" - }, - "node": { - "type": "string" - }, - "originate_at": { - "type": "string", - "format": "int64" - }, - "resource": { + "created_by": { "$ref": "#/definitions/engineLookup" }, - "result": { - "type": "string" - }, - "weight": { - "type": "integer", - "format": "int32" - } - } - }, - "engineMemberBulkResponse": { - "type": "object", - "properties": { - "ids": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - } - } - }, - "engineMemberCommunication": { - "type": "object", - "properties": { - "attempts": { - "type": "integer", - "format": "int32" - }, "description": { "type": "string" }, - "destination": { - "type": "string" - }, - "display": { - "type": "string" - }, - "dtmf": { - "type": "string" - }, - "id": { + "domain_id": { "type": "string", "format": "int64" }, - "last_activity_at": { + "id": { "type": "string", "format": "int64" }, - "last_cause": { + "name": { "type": "string" }, - "priority": { - "type": "integer", - "format": "int32" - }, - "resource": { - "$ref": "#/definitions/engineLookup" - }, - "state": { + "total_agents": { "type": "integer", "format": "int32" }, - "stop_at": { + "updated_at": { "type": "string", "format": "int64" }, - "type": { + "updated_by": { "$ref": "#/definitions/engineLookup" } } }, - "engineMemberCommunicationCreateRequest": { + "engineSkillAgentItem": { "type": "object", "properties": { - "description": { - "type": "string" - }, - "destination": { - "type": "string" - }, - "display": { - "type": "string" - }, - "dtmf": { - "type": "string" + "agent": { + "$ref": "#/definitions/engineLookup" }, - "priority": { + "capacity": { "type": "integer", "format": "int32" }, - "resource": { - "$ref": "#/definitions/engineLookup" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "stop_at": { + "id": { "type": "string", "format": "int64" }, - "type": { + "skill": { + "$ref": "#/definitions/engineLookup" + }, + "team": { "$ref": "#/definitions/engineLookup" } } }, - "engineMemberInQueue": { + "engineSystemSetting": { "type": "object", "properties": { - "agent": { - "$ref": "#/definitions/engineLookup" - }, - "attempts": { - "type": "integer", - "format": "int32" - }, - "bucket": { - "$ref": "#/definitions/engineLookup" - }, - "communications": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineMemberCommunication" - } - }, - "created_at": { - "type": "string", - "format": "int64" - }, - "expire_at": { - "type": "string", - "format": "int64" - }, "id": { - "type": "string", - "format": "int64" - }, - "last_activity_at": { - "type": "string", - "format": "int64" - }, - "min_offering_at": { - "type": "string", - "format": "int64", - "title": "deprecated" - }, - "name": { - "type": "string" - }, - "priority": { "type": "integer", "format": "int32" }, - "queue": { - "$ref": "#/definitions/engineLookup" - }, - "reserved": { - "type": "boolean" - }, - "skill": { - "$ref": "#/definitions/engineLookup" - }, - "stop_cause": { - "type": "string" - }, - "timezone": { - "$ref": "#/definitions/engineLookup" + "name": { + "$ref": "#/definitions/engineSystemSettingName" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "value": { + "type": "object" } } }, - "engineMovePositionRoutingOutboundCallResponse": { + "engineSystemSettingName": { + "type": "string", + "default": "empty_system_settings_name", + "enum": [ + "empty_system_settings_name", + "enable_omnichannel", + "member_chunk_size", + "amd_cancel_not_human", + "scheme_version_limit", + "enable_2fa", + "export_settings", + "search_number_length", + "chat_ai_connection", + "password_reg_exp", + "password_validation_text", + "autolink_call_to_contact", + "period_to_playback_records" + ] + }, + "engineTag": { "type": "object", "properties": { - "success": { - "type": "boolean" + "name": { + "type": "string" } } }, - "engineOutboundResource": { + "engineTaskProcessing": { "type": "object", "properties": { - "created_at": { - "type": "string", - "format": "int64" - }, - "created_by": { - "$ref": "#/definitions/engineLookup" - }, - "description": { - "type": "string" - }, - "domain_id": { - "type": "string", - "format": "int64" - }, "enabled": { - "type": "boolean" - }, - "error_ids": { - "type": "array", - "items": { - "type": "string" - } - }, - "failure_dial_delay": { - "type": "integer", - "format": "int64" + "type": "boolean", + "format": "boolean" }, - "gateway": { + "form_schema": { "$ref": "#/definitions/engineLookup" }, - "id": { - "type": "string", - "format": "int64" - }, - "last_error_at": { - "type": "string", - "format": "int64" - }, - "last_error_id": { - "type": "string" - }, - "limit": { - "type": "integer", - "format": "int32" - }, - "max_successively_errors": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string" - }, - "number": { - "type": "string" - }, - "parameters": { - "$ref": "#/definitions/engineOutboundResourceParameters" - }, - "patterns": { - "type": "array", - "items": { - "type": "string" - } - }, - "reserve": { - "type": "boolean" - }, - "rps": { + "renewal_sec": { "type": "integer", - "format": "int32" + "format": "int64" }, - "successively_errors": { + "sec": { "type": "integer", - "format": "int32" - }, - "updated_at": { - "type": "string", "format": "int64" - }, - "updated_by": { - "$ref": "#/definitions/engineLookup" - }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } } } }, - "engineOutboundResourceGroup": { + "engineTeamHook": { "type": "object", "properties": { - "communication": { - "$ref": "#/definitions/engineLookup" - }, - "created_at": { - "type": "string", - "format": "int64" - }, - "created_by": { - "$ref": "#/definitions/engineLookup" - }, - "description": { - "type": "string" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "domain_id": { - "type": "string", - "format": "int64" + "event": { + "$ref": "#/definitions/engineTeamHookEvent" }, "id": { - "type": "string", + "type": "integer", "format": "int64" }, - "name": { - "type": "string" - }, - "strategy": { - "type": "string" - }, - "time": { + "properties": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineOutboundResourceTimeRange" + "type": "string" } }, - "updated_at": { - "type": "string", - "format": "int64" - }, - "updated_by": { + "schema": { "$ref": "#/definitions/engineLookup" } } }, - "engineOutboundResourceInGroup": { + "engineTeamHookEvent": { + "type": "string", + "default": "teamHookEventUndefined", + "enum": [ + "teamHookEventUndefined", + "agent_status" + ] + }, + "engineTeamTrigger": { "type": "object", "properties": { - "group_id": { - "type": "string", - "format": "int64" + "description": { + "type": "string" }, - "id": { - "type": "string", - "format": "int64" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "priority": { + "id": { "type": "integer", "format": "int64" }, - "reserve_resource": { - "$ref": "#/definitions/engineLookup" + "name": { + "type": "string" }, - "resource": { + "schema": { "$ref": "#/definitions/engineLookup" } } }, - "engineOutboundResourceParameters": { + "engineTestEmailProfileResponse": { "type": "object", "properties": { - "cid_type": { - "type": "string" - }, - "ignore_early_media": { + "error": { "type": "string" } } }, - "engineOutboundResourceTimeRange": { + "engineTimezone": { "type": "object", "properties": { - "end_time_of_day": { - "type": "integer", - "format": "int32" + "id": { + "type": "string", + "format": "int64" }, - "start_time_of_day": { - "type": "integer", - "format": "int32" + "name": { + "type": "string" + }, + "offset": { + "type": "string" } } }, - "engineOutboundResourceViewGroup": { + "engineTranscriptLookup": { "type": "object", "properties": { - "communication": { + "file": { "$ref": "#/definitions/engineLookup" }, - "description": { - "type": "string" + "file_id": { + "type": "string", + "format": "int64" }, "id": { "type": "string", "format": "int64" }, - "name": { - "type": "string" - }, - "strategy": { + "locale": { "type": "string" } } }, - "enginePatchSkillAgentResponse": { + "engineTrigger": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineSkillAgentItem" + "description": { + "type": "string" + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "expression": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string" + }, + "schema": { + "$ref": "#/definitions/engineLookup" + }, + "timeout": { + "type": "integer", + "format": "int32" + }, + "timezone": { + "$ref": "#/definitions/engineLookup" + }, + "type": { + "$ref": "#/definitions/engineTriggerType" + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" } } } }, - "enginePresetQuery": { + "engineTriggerJob": { "type": "object", "properties": { "created_at": { "type": "string", "format": "int64" }, - "description": { + "error": { "type": "string" }, "id": { - "type": "integer", - "format": "int32" + "type": "string", + "format": "int64" }, - "name": { - "type": "string" + "parameters": { + "type": "object" }, - "preset": {}, - "section": { - "$ref": "#/definitions/enginePresetQuerySection" + "result": { + "type": "object" }, - "updated_at": { + "started_at": { + "type": "string", + "format": "int64" + }, + "state": { + "$ref": "#/definitions/engineTriggerJobState" + }, + "stopped_at": { "type": "string", "format": "int64" + }, + "trigger": { + "$ref": "#/definitions/engineLookup" } } }, - "enginePresetQuerySection": { + "engineTriggerJobState": { "type": "string", - "default": "section_default", + "default": "idle", "enum": [ - "section_default", - "section_calls" + "idle", + "active", + "done", + "error" ] }, - "engineQuestion": { + "engineTriggerType": { + "type": "string", + "default": "default_trigger_type", + "enum": [ + "default_trigger_type", + "cron" + ] + }, + "engineUpdateAgentPauseCauseRequest": { "type": "object", "properties": { - "max": { - "type": "integer", - "format": "int32" + "allow_admin": { + "type": "boolean", + "format": "boolean" }, - "min": { - "type": "integer", - "format": "int32" + "allow_agent": { + "type": "boolean", + "format": "boolean" }, - "options": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/QuestionOption" - } + "allow_supervisor": { + "type": "boolean", + "format": "boolean" }, - "question": { + "description": { "type": "string" }, - "required": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64" }, - "type": { - "$ref": "#/definitions/engineAuditQuestionType" - } - } - }, - "engineQuestionAnswer": { - "type": "object", - "properties": { - "score": { - "type": "number", - "format": "float" + "limit_min": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" } } }, - "engineQueue": { + "engineUpdateAgentRequest": { "type": "object", "properties": { - "active": { - "type": "integer", - "format": "int32" - }, - "after_schema": { - "$ref": "#/definitions/engineLookup" + "allow_channels": { + "type": "array", + "items": { + "type": "string" + } }, - "calendar": { - "$ref": "#/definitions/engineLookup" + "auditor": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } }, - "count": { + "chat_count": { "type": "integer", - "format": "int32" - }, - "created_at": { - "type": "string", "format": "int64" }, - "created_by": { - "$ref": "#/definitions/engineLookup" - }, "description": { "type": "string" }, - "dnc_list": { - "$ref": "#/definitions/engineLookup" - }, - "do_schema": { - "$ref": "#/definitions/engineLookup" - }, "domain_id": { "type": "string", "format": "int64" }, - "enabled": { - "type": "boolean" - }, - "form_schema": { - "title": "deprecated", - "$ref": "#/definitions/engineLookup" - }, - "grantee": { + "greeting_media": { "$ref": "#/definitions/engineLookup" }, "id": { "type": "string", "format": "int64" }, - "name": { - "type": "string" + "is_supervisor": { + "type": "boolean", + "format": "boolean" }, - "payload": {}, - "priority": { + "progressive_count": { "type": "integer", "format": "int32" }, - "processing": { - "type": "boolean", - "title": "deprecated" + "region": { + "$ref": "#/definitions/engineLookup" }, - "processing_renewal_sec": { - "type": "integer", - "format": "int64", - "title": "deprecated" + "supervisor": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } }, - "processing_sec": { + "task_count": { "type": "integer", - "format": "int64", - "title": "deprecated" + "format": "int64" }, - "ringtone": { + "team": { "$ref": "#/definitions/engineLookup" }, - "schema": { + "user": { "$ref": "#/definitions/engineLookup" + } + } + }, + "engineUpdateAgentSkillRequest": { + "type": "object", + "properties": { + "agent_id": { + "type": "string", + "format": "int64" }, - "sec_locate_agent": { + "capacity": { "type": "integer", "format": "int32" }, - "sticky_agent": { - "type": "boolean" + "domain_id": { + "type": "string", + "format": "int64" }, - "strategy": { - "type": "string" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "tags": { + "id": { + "type": "string", + "format": "int64" + }, + "skill": { + "$ref": "#/definitions/engineLookup" + } + } + }, + "engineUpdateAgentTeamRequest": { + "type": "object", + "properties": { + "admin": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineTag" + "$ref": "#/definitions/engineLookup" } }, - "task_processing": { - "$ref": "#/definitions/engineTaskProcessing" - }, - "team": { - "$ref": "#/definitions/engineLookup" - }, - "timeout": { + "call_timeout": { "type": "integer", "format": "int32" }, - "type": { - "type": "integer", - "format": "int32" + "description": { + "type": "string" }, - "updated_at": { + "domain_id": { "type": "string", "format": "int64" }, - "updated_by": { + "forecast_calculation": { "$ref": "#/definitions/engineLookup" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "id": { + "type": "string", + "format": "int64" }, - "waiting": { + "invite_chat_timeout": { "type": "integer", "format": "int32" - } - } - }, - "engineQueueBucket": { - "type": "object", - "properties": { - "bucket": { - "$ref": "#/definitions/engineLookup" }, - "disabled": { - "type": "boolean" + "max_no_answer": { + "type": "integer", + "format": "int32" }, - "id": { - "type": "string", - "format": "int64" + "name": { + "type": "string" }, - "priority": { + "no_answer_delay_time": { "type": "integer", "format": "int32" }, - "ratio": { + "strategy": { + "type": "string" + }, + "task_accept_timeout": { + "type": "integer", + "format": "int32" + }, + "wrap_up_time": { "type": "integer", "format": "int32" } } }, - "engineQueueHook": { + "engineUpdateAuditFormRequest": { "type": "object", "properties": { - "enabled": { - "type": "boolean" - }, - "event": { + "description": { "type": "string" }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, "id": { "type": "integer", - "format": "int64" + "format": "int32" }, - "properties": { + "name": { + "type": "string" + }, + "questions": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineQuestion" } }, - "schema": { - "$ref": "#/definitions/engineLookup" + "teams": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } } } }, - "engineQueueReportGeneral": { + "engineUpdateBucketRequest": { "type": "object", "properties": { - "abandoned": { - "type": "integer", - "format": "int64" - }, - "agent_status": { - "$ref": "#/definitions/engineQueueReportGeneralAgentStatus" + "description": { + "type": "string" }, - "attempts": { - "type": "integer", + "domain_id": { + "type": "string", "format": "int64" }, - "avg_aht_sec": { - "type": "number", - "format": "float" - }, - "avg_asa_sec": { - "type": "number", - "format": "float" - }, - "avg_awt_sec": { - "type": "number", - "format": "float" + "id": { + "type": "string", + "format": "int64" }, - "avg_wrap_sec": { - "type": "number", - "format": "float" + "name": { + "type": "string" + } + } + }, + "engineUpdateCalendarRequest": { + "type": "object", + "properties": { + "accepts": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAcceptOfDay" + } }, - "bridged": { - "type": "number", - "format": "float" + "description": { + "type": "string" }, - "count": { + "domain_id": { "type": "string", - "format": "uint64" - }, - "missed": { - "type": "integer", "format": "int64" }, - "processed": { - "type": "integer", + "end_at": { + "type": "string", "format": "int64" }, - "queue": { - "$ref": "#/definitions/engineLookup" + "excepts": { + "type": "array", + "items": { + "$ref": "#/definitions/engineExceptDate" + } }, - "sl20": { - "type": "number", - "format": "float" + "id": { + "type": "string", + "format": "int64" }, - "sl30": { - "type": "number", - "format": "float" + "name": { + "type": "string" }, - "sum_bill_sec": { - "type": "number", - "format": "float" + "specials": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAcceptOfDay" + } }, - "team": { + "start_at": { + "type": "string", + "format": "int64" + }, + "timezone": { "$ref": "#/definitions/engineLookup" + } + } + }, + "engineUpdateCallAnnotationRequest": { + "type": "object", + "properties": { + "call_id": { + "type": "string" }, - "transferred": { + "end_sec": { "type": "integer", + "format": "int32" + }, + "id": { + "type": "string", "format": "int64" }, - "waiting": { + "note": { + "type": "string" + }, + "start_sec": { "type": "integer", - "format": "int64" + "format": "int32" } } }, - "engineQueueReportGeneralAgentStatus": { + "engineUpdateChatPlanRequest": { "type": "object", "properties": { - "free": { - "type": "integer", - "format": "int64" + "description": { + "type": "string" }, - "offline": { - "type": "integer", - "format": "int64" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "online": { + "id": { "type": "integer", - "format": "int64" + "format": "int32" }, - "pause": { - "type": "integer", - "format": "int64" + "name": { + "type": "string" }, - "total": { - "type": "integer", - "format": "int64" + "schema": { + "$ref": "#/definitions/engineLookup" } } }, - "engineQueueResourceGroup": { + "engineUpdateCommunicationTypeRequest": { "type": "object", "properties": { - "communication": { - "$ref": "#/definitions/engineLookup" + "channel": { + "$ref": "#/definitions/engineCommunicationChannels" + }, + "code": { + "type": "string" + }, + "default": { + "type": "boolean", + "format": "boolean" + }, + "description": { + "type": "string" }, "id": { "type": "string", "format": "int64" }, - "resource_group": { - "$ref": "#/definitions/engineLookup" + "name": { + "type": "string" } } }, - "engineQueueSkill": { + "engineUpdateEmailProfileRequest": { "type": "object", "properties": { - "buckets": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } + "auth_type": { + "$ref": "#/definitions/engineEmailAuthType" + }, + "description": { + "type": "string" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, - "id": { + "fetch_interval": { "type": "integer", + "format": "int32" + }, + "id": { + "type": "string", "format": "int64" }, - "lvl": { - "type": "integer", - "format": "int32" + "imap_host": { + "type": "string" }, - "max_capacity": { + "imap_port": { "type": "integer", "format": "int32" }, - "min_capacity": { - "type": "integer", - "format": "int32" + "listen": { + "type": "boolean", + "format": "boolean" }, - "skill": { + "login": { + "type": "string" + }, + "mailbox": { + "type": "string" + }, + "name": { + "type": "string" + }, + "params": { + "$ref": "#/definitions/engineEmailProfileParams" + }, + "password": { + "type": "string" + }, + "schema": { "$ref": "#/definitions/engineLookup" + }, + "smtp_host": { + "type": "string" + }, + "smtp_port": { + "type": "integer", + "format": "int32" } } }, - "engineRegion": { + "engineUpdateListCommunicationRequest": { "type": "object", "properties": { "description": { "type": "string" }, - "id": { + "expire_at": { "type": "string", "format": "int64" }, - "name": { - "type": "string" + "id": { + "type": "string", + "format": "int64" }, - "timezone": { - "$ref": "#/definitions/engineLookup" - } - } - }, - "engineResetMembersResponse": { - "type": "object", - "properties": { - "count": { + "list_id": { "type": "string", "format": "int64" + }, + "number": { + "type": "string" } } }, - "engineResourceDisplay": { + "engineUpdateListRequest": { "type": "object", "properties": { - "display": { + "description": { "type": "string" }, + "domain_id": { + "type": "string", + "format": "int64" + }, "id": { "type": "string", "format": "int64" - } - } - }, - "engineResponse": { - "type": "object", - "properties": { - "status": { + }, + "name": { "type": "string" } } }, - "engineRoutingOutboundCall": { + "engineUpdateMemberRequest": { "type": "object", "properties": { - "created_at": { - "type": "string", - "format": "int64" - }, - "created_by": { + "agent": { "$ref": "#/definitions/engineLookup" }, - "description": { - "type": "string" + "bucket": { + "$ref": "#/definitions/engineLookup" }, - "disabled": { - "type": "boolean" + "communications": { + "type": "array", + "items": { + "$ref": "#/definitions/engineMemberCommunicationCreateRequest" + } }, "domain_id": { "type": "string", "format": "int64" }, + "expire_at": { + "type": "string", + "format": "int64" + }, "id": { "type": "string", "format": "int64" }, - "name": { - "type": "string" + "min_offering_at": { + "type": "string", + "format": "int64" }, - "pattern": { + "name": { "type": "string" }, - "schema": { - "$ref": "#/definitions/engineLookup" + "priority": { + "type": "integer", + "format": "int32" }, - "updated_at": { + "queue_id": { "type": "string", "format": "int64" }, - "updated_by": { + "skill": { + "$ref": "#/definitions/engineLookup" + }, + "stop_cause": { + "type": "string" + }, + "timezone": { "$ref": "#/definitions/engineLookup" + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, - "engineRoutingOutboundCallCompact": { + "engineUpdateOutboundResourceDisplayRequest": { "type": "object", "properties": { - "description": { + "display": { "type": "string" }, - "disabled": { - "type": "boolean" - }, "domain_id": { "type": "string", "format": "int64" @@ -47015,39 +47854,24 @@ "type": "string", "format": "int64" }, - "name": { - "type": "string" - }, - "pattern": { - "type": "string" - }, - "position": { - "type": "integer", - "format": "int32" - }, - "schema": { - "$ref": "#/definitions/engineLookup" + "resource_id": { + "type": "string", + "format": "int64" } } }, - "engineRoutingSchema": { + "engineUpdateOutboundResourceGroupRequest": { "type": "object", "properties": { - "created_at": { - "type": "string", - "format": "int64" - }, - "created_by": { + "communication": { "$ref": "#/definitions/engineLookup" }, - "debug": { - "type": "boolean" - }, "description": { "type": "string" }, - "editor": { - "type": "boolean" + "domain_id": { + "type": "string", + "format": "int64" }, "id": { "type": "string", @@ -47056,90 +47880,111 @@ "name": { "type": "string" }, - "payload": {}, - "schema": {}, - "tags": { + "strategy": { + "type": "string" + }, + "time": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineSchemaTag" + "$ref": "#/definitions/engineOutboundResourceTimeRange" } - }, - "type": { - "$ref": "#/definitions/engineRoutingSchemaType" - }, - "updated_at": { - "type": "string", - "format": "int64" - }, - "updated_by": { - "$ref": "#/definitions/engineLookup" } } }, - "engineRoutingSchemaTag": { + "engineUpdateOutboundResourceInGroupRequest": { "type": "object", "properties": { - "count": { + "group_id": { + "type": "string", + "format": "int64" + }, + "id": { + "type": "string", + "format": "int64" + }, + "priority": { "type": "integer", "format": "int64" }, - "name": { - "type": "string" + "reserve_resource": { + "$ref": "#/definitions/engineLookup" + }, + "resource": { + "$ref": "#/definitions/engineLookup" } } }, - "engineRoutingSchemaType": { - "type": "string", - "default": "default", - "enum": [ - "default", - "voice", - "chat", - "processing", - "service" - ] - }, - "engineRoutingVariable": { + "engineUpdateOutboundResourceRequest": { "type": "object", "properties": { - "domain_id": { - "type": "string", + "description": { + "type": "string" + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "error_ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "failure_dial_delay": { + "type": "integer", "format": "int64" }, + "gateway": { + "$ref": "#/definitions/engineLookup" + }, "id": { "type": "string", "format": "int64" }, - "key": { - "type": "string" + "limit": { + "type": "integer", + "format": "int32" }, - "value": { + "max_successively_errors": { + "type": "integer", + "format": "int32" + }, + "name": { "type": "string" - } - } - }, - "engineRunTeamTriggerResponse": { - "type": "object", - "properties": { - "job_id": { + }, + "number": { "type": "string" + }, + "parameters": { + "$ref": "#/definitions/engineOutboundResourceParameters" + }, + "patterns": { + "type": "array", + "items": { + "type": "string" + } + }, + "reserve": { + "type": "boolean", + "format": "boolean" + }, + "rps": { + "type": "integer", + "format": "int32" + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, - "engineSchemaTag": { + "engineUpdatePresetQueryRequest": { "type": "object", "properties": { - "name": { + "description": { "type": "string" - } - } - }, - "engineSchemaVariable": { - "type": "object", - "properties": { - "encrypt": { - "type": "boolean" }, "id": { "type": "integer", @@ -47148,258 +47993,167 @@ "name": { "type": "string" }, - "value": {} + "preset": { + "type": "object" + }, + "section": { + "$ref": "#/definitions/enginePresetQuerySection" + } } }, - "engineSchemaVersion": { + "engineUpdateQueueBucketRequest": { "type": "object", "properties": { - "created_at": { - "type": "string", - "format": "int64" - }, - "created_by": { + "bucket": { "$ref": "#/definitions/engineLookup" }, + "disabled": { + "type": "boolean", + "format": "boolean" + }, "id": { "type": "string", "format": "int64" }, - "note": { - "type": "string" + "priority": { + "type": "integer", + "format": "int32" }, - "payload": {}, - "schema": {}, - "schema_id": { + "queue_id": { "type": "string", "format": "int64" }, - "version": { - "type": "string", - "format": "uint64" + "ratio": { + "type": "integer", + "format": "int32" } } }, - "engineSearchHistoryCallRequest": { + "engineUpdateQueueHookRequest": { "type": "object", "properties": { - "agent_description": { - "type": "string" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "agent_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "event": { + "type": "string" }, - "amd_ai_result": { - "type": "array", - "items": { - "type": "string" - } + "id": { + "type": "integer", + "format": "int64" }, - "amd_result": { + "properties": { "type": "array", "items": { "type": "string" } }, - "answered_at": { - "$ref": "#/definitions/engineFilterBetween" - }, - "cause": { - "type": "array", - "items": { - "type": "string" - } + "queue_id": { + "type": "integer", + "format": "int64" }, - "contact_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "schema": { + "$ref": "#/definitions/engineLookup" + } + } + }, + "engineUpdateQueueRequest": { + "type": "object", + "properties": { + "after_schema": { + "$ref": "#/definitions/engineLookup" }, - "created_at": { - "$ref": "#/definitions/engineFilterBetween" + "calendar": { + "$ref": "#/definitions/engineLookup" }, - "dependency_id": { + "description": { "type": "string" }, - "direction": { - "type": "string" + "dnc_list": { + "$ref": "#/definitions/engineLookup" }, - "directions": { - "type": "array", - "items": { - "type": "string" - } + "do_schema": { + "$ref": "#/definitions/engineLookup" }, "domain_id": { "type": "string", "format": "int64" }, - "duration": { - "$ref": "#/definitions/engineFilterBetween" - }, - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "fts": { - "type": "string" - }, - "gateway_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - }, - "grantee_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - }, - "has_file": { - "type": "boolean" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "has_transcript": { - "type": "boolean" + "form_schema": { + "$ref": "#/definitions/engineLookup" }, - "has_transfer": { - "type": "boolean" + "grantee": { + "$ref": "#/definitions/engineLookup" }, "id": { - "type": "array", - "items": { - "type": "string" - } - }, - "member_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - }, - "missed": { - "type": "boolean" + "type": "string", + "format": "int64" }, - "number": { + "name": { "type": "string" }, - "owner_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "payload": { + "type": "object" }, - "page": { + "priority": { "type": "integer", "format": "int32" }, - "parent_id": { - "type": "string" - }, - "q": { - "type": "string" - }, - "queue_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - }, - "rated": { - "type": "boolean" - }, - "rated_by": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "processing": { + "type": "boolean", + "format": "boolean" }, - "rated_user": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "processing_renewal_sec": { + "type": "integer", + "format": "int64" }, - "schema_id": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } + "processing_sec": { + "type": "integer", + "format": "int64" }, - "score_optional": { - "$ref": "#/definitions/engineFilterBetween" + "ringtone": { + "$ref": "#/definitions/engineLookup" }, - "score_required": { - "$ref": "#/definitions/engineFilterBetween" + "schema": { + "$ref": "#/definitions/engineLookup" }, - "size": { + "sec_locate_agent": { "type": "integer", "format": "int32" }, - "skip_parent": { - "type": "boolean" + "sticky_agent": { + "type": "boolean", + "format": "boolean" }, - "sort": { + "strategy": { "type": "string" }, - "stored_at": { - "$ref": "#/definitions/engineFilterBetween" - }, "tags": { "type": "array", "items": { - "type": "string" - } - }, - "talk": { - "$ref": "#/definitions/engineFilterBetween" - }, - "team_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" + "$ref": "#/definitions/engineTag" } }, - "timeline": { - "type": "boolean" + "task_processing": { + "$ref": "#/definitions/engineTaskProcessing" }, - "transfer_from": { - "type": "array", - "items": { - "type": "string" - } + "team": { + "$ref": "#/definitions/engineLookup" }, - "transfer_to": { - "type": "array", - "items": { - "type": "string" - } + "timeout": { + "type": "integer", + "format": "int32" }, - "user_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "type": { + "type": "integer", + "format": "int32" }, - "variables[string]": { + "variables": { "type": "object", "additionalProperties": { "type": "string" @@ -47407,50 +48161,116 @@ } } }, - "engineSearchSchemaVersionResponse": { + "engineUpdateQueueResourceGroupRequest": { "type": "object", "properties": { - "items": { + "domain_id": { + "type": "string", + "format": "int64" + }, + "id": { + "type": "string", + "format": "int64" + }, + "queue_id": { + "type": "string", + "format": "int64" + }, + "resource_group": { + "$ref": "#/definitions/engineLookup" + } + } + }, + "engineUpdateQueueSkillRequest": { + "type": "object", + "properties": { + "buckets": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineSchemaVersion" + "$ref": "#/definitions/engineLookup" } }, - "next": { - "type": "boolean" + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "lvl": { + "type": "integer", + "format": "int32" + }, + "max_capacity": { + "type": "integer", + "format": "int32" + }, + "min_capacity": { + "type": "integer", + "format": "int32" + }, + "queue_id": { + "type": "integer", + "format": "int64" + }, + "skill": { + "$ref": "#/definitions/engineLookup" } } }, - "engineSendPushResponse": { + "engineUpdateQuickReplyRequest": { "type": "object", "properties": { - "send": { + "article": { + "$ref": "#/definitions/engineLookup" + }, + "id": { "type": "integer", - "format": "int32" + "format": "int64" + }, + "name": { + "type": "string" + }, + "queue": { + "$ref": "#/definitions/engineLookup" + }, + "team": { + "$ref": "#/definitions/engineLookup" + }, + "text": { + "type": "string" } } }, - "engineSetVariablesCallResponse": { - "type": "object" - }, - "engineSkill": { + "engineUpdateRegionRequest": { "type": "object", "properties": { - "active_agents": { - "type": "integer", - "format": "int32" + "description": { + "type": "string" }, - "created_at": { + "id": { "type": "string", "format": "int64" }, - "created_by": { - "$ref": "#/definitions/engineLookup" + "name": { + "type": "string" }, + "timezone": { + "$ref": "#/definitions/engineLookup" + } + } + }, + "engineUpdateRoutingOutboundCallRequest": { + "type": "object", + "properties": { "description": { "type": "string" }, + "disabled": { + "type": "boolean", + "format": "boolean" + }, "domain_id": { "type": "string", "format": "int64" @@ -47462,107 +48282,130 @@ "name": { "type": "string" }, - "total_agents": { - "type": "integer", - "format": "int32" - }, - "updated_at": { - "type": "string", - "format": "int64" + "pattern": { + "type": "string" }, - "updated_by": { + "schema": { "$ref": "#/definitions/engineLookup" } } }, - "engineSkillAgentItem": { + "engineUpdateRoutingSchemaRequest": { "type": "object", "properties": { - "agent": { - "$ref": "#/definitions/engineLookup" + "debug": { + "type": "boolean", + "format": "boolean" }, - "capacity": { - "type": "integer", - "format": "int32" + "description": { + "type": "string" }, - "enabled": { - "type": "boolean" + "editor": { + "type": "boolean", + "format": "boolean" }, "id": { "type": "string", "format": "int64" }, - "skill": { - "$ref": "#/definitions/engineLookup" + "name": { + "type": "string" }, - "team": { - "$ref": "#/definitions/engineLookup" + "note": { + "type": "string" + }, + "payload": { + "type": "object" + }, + "schema": { + "type": "object" + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/definitions/engineSchemaTag" + } + }, + "type": { + "$ref": "#/definitions/engineRoutingSchemaType" } } }, - "engineSystemSetting": { + "engineUpdateRoutingVariableRequest": { "type": "object", "properties": { + "domain_id": { + "type": "string", + "format": "int64" + }, "id": { - "type": "integer", - "format": "int32" + "type": "string", + "format": "int64" }, - "name": { - "$ref": "#/definitions/engineSystemSettingName" + "key": { + "type": "string" }, - "value": {} + "value": { + "type": "string" + } } }, - "engineSystemSettingName": { - "type": "string", - "default": "empty_system_settings_name", - "enum": [ - "empty_system_settings_name", - "enable_omnichannel", - "member_chunk_size", - "amd_cancel_not_human", - "scheme_version_limit", - "enable_2fa", - "export_settings", - "search_number_length", - "chat_ai_connection", - "password_reg_exp", - "password_validation_text", - "autolink_call_to_contact" - ] - }, - "engineTag": { + "engineUpdateSchemaVariableRequest": { "type": "object", "properties": { + "encrypt": { + "type": "boolean", + "format": "boolean" + }, + "id": { + "type": "integer", + "format": "int32" + }, "name": { "type": "string" + }, + "value": { + "type": "object" } } }, - "engineTaskProcessing": { + "engineUpdateSkillRequest": { "type": "object", "properties": { - "enabled": { - "type": "boolean" + "description": { + "type": "string" }, - "form_schema": { - "$ref": "#/definitions/engineLookup" + "domain_id": { + "type": "string", + "format": "int64" }, - "renewal_sec": { - "type": "integer", + "id": { + "type": "string", "format": "int64" }, - "sec": { + "name": { + "type": "string" + } + } + }, + "engineUpdateSystemSettingRequest": { + "type": "object", + "properties": { + "id": { "type": "integer", - "format": "int64" + "format": "int32" + }, + "value": { + "type": "object" } } }, - "engineTeamHook": { + "engineUpdateTeamHookRequest": { "type": "object", "properties": { "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "event": { "$ref": "#/definitions/engineTeamHookEvent" @@ -47579,25 +48422,22 @@ }, "schema": { "$ref": "#/definitions/engineLookup" + }, + "team_id": { + "type": "string", + "format": "int64" } } }, - "engineTeamHookEvent": { - "type": "string", - "default": "teamHookEventUndefined", - "enum": [ - "teamHookEventUndefined", - "agent_status" - ] - }, - "engineTeamTrigger": { + "engineUpdateTeamTriggerRequest": { "type": "object", "properties": { "description": { "type": "string" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "id": { "type": "integer", @@ -47608,60 +48448,22 @@ }, "schema": { "$ref": "#/definitions/engineLookup" - } - } - }, - "engineTestEmailProfileResponse": { - "type": "object", - "properties": { - "error": { - "type": "string" - } - } - }, - "engineTimezone": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "int64" - }, - "name": { - "type": "string" - }, - "offset": { - "type": "string" - } - } - }, - "engineTranscriptLookup": { - "type": "object", - "properties": { - "file": { - "$ref": "#/definitions/engineLookup" - }, - "file_id": { - "type": "string", - "format": "int64", - "title": "deprecated" }, - "id": { + "team_id": { "type": "string", "format": "int64" - }, - "locale": { - "type": "string" } } }, - "engineTrigger": { + "engineUpdateTriggerRequest": { "type": "object", "properties": { "description": { "type": "string" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "expression": { "type": "string" @@ -47694,56 +48496,52 @@ } } }, - "engineTriggerJob": { + "engineUpdateWebHookRequest": { "type": "object", "properties": { - "created_at": { - "type": "string", - "format": "int64" + "authorization": { + "type": "string" }, - "error": { + "description": { "type": "string" }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, "id": { - "type": "string", - "format": "int64" + "type": "integer", + "format": "int32" }, - "parameters": {}, - "result": {}, - "started_at": { - "type": "string", - "format": "int64" + "name": { + "type": "string" }, - "state": { - "$ref": "#/definitions/engineTriggerJobState" + "origin": { + "type": "array", + "items": { + "type": "string" + } }, - "stopped_at": { + "schema": { + "$ref": "#/definitions/engineLookup" + } + } + }, + "engineUserCallRequest": { + "type": "object", + "properties": { + "app_id": { + "type": "string" + }, + "domain_id": { "type": "string", "format": "int64" }, - "trigger": { - "$ref": "#/definitions/engineLookup" + "id": { + "type": "string" } } }, - "engineTriggerJobState": { - "type": "string", - "default": "idle", - "enum": [ - "idle", - "active", - "done", - "error" - ] - }, - "engineTriggerType": { - "type": "string", - "default": "default_trigger_type", - "enum": [ - "default_trigger_type", - "cron" - ] - }, "engineUserStatus": { "type": "object", "properties": { @@ -47782,7 +48580,8 @@ "type": "string" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "id": { "type": "integer", @@ -48155,15 +48954,16 @@ } }, "protobufAny": { - "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", "type": "object", "properties": { - "@type": { - "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", + "type_url": { "type": "string" + }, + "value": { + "type": "string", + "format": "byte" } - }, - "additionalProperties": {} + } }, "protobufNullValue": { "description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\nThe JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value.", @@ -48173,29 +48973,6 @@ "NULL_VALUE" ] }, - "rpcStatus": { - "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", - "type": "object", - "properties": { - "code": { - "description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code].", - "type": "integer", - "format": "int32" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/protobufAny" - } - }, - "message": { - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client.", - "type": "string" - } - } - }, "runtimeError": { "type": "object", "properties": { @@ -54391,115 +55168,5 @@ { "AccessToken": [] } - ], - "tags": [ - { - "name": "RoutingChatPlanService" - }, - { - "name": "RoutingOutboundCallService" - }, - { - "name": "RoutingSchemaService" - }, - { - "name": "RoutingVariableService" - }, - { - "name": "AgentService" - }, - { - "name": "SkillService" - }, - { - "name": "AgentSkillService" - }, - { - "name": "AgentTeamService" - }, - { - "name": "AuditFormService" - }, - { - "name": "BucketService" - }, - { - "name": "CalendarService" - }, - { - "name": "CallService" - }, - { - "name": "ChatHelperService" - }, - { - "name": "EmailProfileService" - }, - { - "name": "ListService" - }, - { - "name": "MemberService" - }, - { - "name": "OutboundResourceService" - }, - { - "name": "OutboundResourceGroupService" - }, - { - "name": "AgentPauseCauseService" - }, - { - "name": "PresetQueryService" - }, - { - "name": "PushService" - }, - { - "name": "QueueService" - }, - { - "name": "QueueBucketService" - }, - { - "name": "CommunicationTypeService" - }, - { - "name": "QueueHookService" - }, - { - "name": "QueueResourcesService" - }, - { - "name": "QueueSkillService" - }, - { - "name": "RegionService" - }, - { - "name": "SchemaVariablesService" - }, - { - "name": "SchemaVersionService" - }, - { - "name": "SystemSettingService" - }, - { - "name": "TeamHookService" - }, - { - "name": "TeamTriggerService" - }, - { - "name": "TriggerService" - }, - { - "name": "UserHelperService" - }, - { - "name": "WebHookService" - } ] } \ No newline at end of file diff --git a/swagger/engine.swagger.json b/swagger/engine.swagger.json index 4bcca72..7f03e42 100644 --- a/swagger/engine.swagger.json +++ b/swagger/engine.swagger.json @@ -12,116 +12,6 @@ "name": "MIT" } }, - "tags": [ - { - "name": "RoutingChatPlanService" - }, - { - "name": "RoutingOutboundCallService" - }, - { - "name": "RoutingSchemaService" - }, - { - "name": "RoutingVariableService" - }, - { - "name": "AgentService" - }, - { - "name": "SkillService" - }, - { - "name": "AgentSkillService" - }, - { - "name": "AgentTeamService" - }, - { - "name": "AuditFormService" - }, - { - "name": "BucketService" - }, - { - "name": "CalendarService" - }, - { - "name": "CallService" - }, - { - "name": "ChatHelperService" - }, - { - "name": "EmailProfileService" - }, - { - "name": "ListService" - }, - { - "name": "MemberService" - }, - { - "name": "OutboundResourceService" - }, - { - "name": "OutboundResourceGroupService" - }, - { - "name": "AgentPauseCauseService" - }, - { - "name": "PresetQueryService" - }, - { - "name": "PushService" - }, - { - "name": "QueueService" - }, - { - "name": "QueueBucketService" - }, - { - "name": "CommunicationTypeService" - }, - { - "name": "QueueHookService" - }, - { - "name": "QueueResourcesService" - }, - { - "name": "QueueSkillService" - }, - { - "name": "RegionService" - }, - { - "name": "SchemaVariablesService" - }, - { - "name": "SchemaVersionService" - }, - { - "name": "SystemSettingService" - }, - { - "name": "TeamHookService" - }, - { - "name": "TeamTriggerService" - }, - { - "name": "TriggerService" - }, - { - "name": "UserHelperService" - }, - { - "name": "WebHookService" - } - ], "host": "dev.webitel.com", "basePath": "/api", "schemes": [ @@ -146,9 +36,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -216,9 +106,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -249,9 +139,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -321,9 +211,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -358,9 +248,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -395,9 +285,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -414,7 +304,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CalendarServiceUpdateCalendarBody" + "$ref": "#/definitions/engineUpdateCalendarRequest" } } ], @@ -435,9 +325,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -546,7 +436,8 @@ "name": "is_supervisor", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" }, { "name": "skill_id", @@ -574,7 +465,8 @@ "name": "not_supervisor", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" }, { "name": "user_id", @@ -635,9 +527,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -667,9 +559,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -759,9 +651,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -877,7 +769,8 @@ "name": "has_call", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" }, { "name": "skill_id", @@ -940,9 +833,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -985,9 +878,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1068,9 +961,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1086,7 +979,8 @@ "name": "allow_change", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" } ], "tags": [ @@ -1106,9 +1000,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1193,9 +1087,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1245,9 +1139,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1264,7 +1158,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentSkillServiceCreateAgentSkillBody" + "$ref": "#/definitions/engineCreateAgentSkillRequest" } } ], @@ -1282,9 +1176,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1301,7 +1195,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentSkillServicePatchAgentSkillsBody" + "$ref": "#/definitions/enginePatchAgentSkillsRequest" } } ], @@ -1321,9 +1215,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1340,7 +1234,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentSkillServiceCreateAgentSkillsBody" + "$ref": "#/definitions/engineCreateAgentSkillsRequest" } } ], @@ -1361,9 +1255,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1405,9 +1299,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1449,9 +1343,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1475,7 +1369,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentSkillServiceUpdateAgentSkillBody" + "$ref": "#/definitions/engineUpdateAgentSkillRequest" } } ], @@ -1493,9 +1387,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1519,7 +1413,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentSkillServicePatchAgentSkillBody" + "$ref": "#/definitions/enginePatchAgentSkillRequest" } } ], @@ -1539,9 +1433,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1611,9 +1505,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1630,7 +1524,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentServiceAgentSetStateBody" + "$ref": "#/definitions/engineAgentSetStateRequest" } } ], @@ -1650,9 +1544,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1688,9 +1582,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1730,9 +1624,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1767,9 +1661,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1804,9 +1698,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1823,7 +1717,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentServiceUpdateAgentBody" + "$ref": "#/definitions/engineUpdateAgentRequest" } } ], @@ -1842,9 +1736,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1861,7 +1755,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentServicePatchAgentBody" + "$ref": "#/definitions/enginePatchAgentRequest" } } ], @@ -1881,9 +1775,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1949,9 +1843,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -1968,7 +1862,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentServiceUpdateAgentStatusBody" + "$ref": "#/definitions/engineAgentStatusRequest" } } ], @@ -1989,9 +1883,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2047,9 +1941,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2066,7 +1960,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServiceAttemptCallbackBody" + "$ref": "#/definitions/engineAttemptCallbackRequest" } } ], @@ -2086,9 +1980,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2155,14 +2049,16 @@ "name": "enabled", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" }, { "name": "editable", - "description": "bool archive = 9;\n\nbool active = 11; // not archive", + "description": "bool archive = 9;.", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" }, { "name": "question", @@ -2185,9 +2081,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2217,9 +2113,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2330,9 +2226,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2359,9 +2255,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2388,9 +2284,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2407,7 +2303,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AuditFormServiceUpdateAuditFormBody" + "$ref": "#/definitions/engineUpdateAuditFormRequest" } } ], @@ -2425,9 +2321,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2444,7 +2340,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AuditFormServicePatchAuditFormBody" + "$ref": "#/definitions/enginePatchAuditFormRequest" } } ], @@ -2464,9 +2360,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2496,9 +2392,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2528,9 +2424,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2598,9 +2494,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2631,9 +2527,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2668,9 +2564,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2705,9 +2601,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2724,7 +2620,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/BucketServiceUpdateBucketBody" + "$ref": "#/definitions/engineUpdateBucketRequest" } } ], @@ -2745,9 +2641,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2819,7 +2715,8 @@ "name": "default", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" } ], "tags": [ @@ -2837,9 +2734,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2870,9 +2767,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2907,9 +2804,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2944,9 +2841,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -2963,7 +2860,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CommunicationTypeServiceUpdateCommunicationTypeBody" + "$ref": "#/definitions/engineUpdateCommunicationTypeRequest" } } ], @@ -2981,9 +2878,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -3000,7 +2897,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CommunicationTypeServicePatchCommunicationTypeBody" + "$ref": "#/definitions/enginePatchCommunicationTypeRequest" } } ], @@ -3021,9 +2918,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -3091,9 +2988,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -3124,9 +3021,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -3161,9 +3058,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -3198,9 +3095,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -3217,7 +3114,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/ListServiceUpdateListBody" + "$ref": "#/definitions/engineUpdateListRequest" } } ], @@ -3238,9 +3135,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -3329,9 +3226,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -3348,7 +3245,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/ListServiceCreateListCommunicationBody" + "$ref": "#/definitions/engineCreateListCommunicationRequest" } } ], @@ -3369,9 +3266,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -3413,9 +3310,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -3457,9 +3354,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -3483,7 +3380,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/ListServiceUpdateListCommunicationBody" + "$ref": "#/definitions/engineUpdateListCommunicationRequest" } } ], @@ -3504,9 +3401,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -3563,9 +3460,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -3615,9 +3512,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -3797,9 +3694,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -3816,7 +3713,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServicePatchMemberOneBody" + "$ref": "#/definitions/enginePatchMemberOneRequest" } } ], @@ -3836,9 +3733,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -3905,9 +3802,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -3937,9 +3834,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -3966,9 +3863,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -3995,9 +3892,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -4014,7 +3911,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentPauseCauseServiceUpdateAgentPauseCauseBody" + "$ref": "#/definitions/engineUpdateAgentPauseCauseRequest" } } ], @@ -4032,9 +3929,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -4051,7 +3948,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentPauseCauseServicePatchAgentPauseCauseBody" + "$ref": "#/definitions/enginePatchAgentPauseCauseRequest" } } ], @@ -4071,9 +3968,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -4154,9 +4051,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -4186,9 +4083,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -4215,9 +4112,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -4244,9 +4141,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -4263,7 +4160,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/PresetQueryServiceUpdatePresetQueryBody" + "$ref": "#/definitions/engineUpdatePresetQueryRequest" } } ], @@ -4281,9 +4178,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -4300,7 +4197,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/PresetQueryServicePatchPresetQueryBody" + "$ref": "#/definitions/enginePatchPresetQueryRequest" } } ], @@ -4321,9 +4218,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -4410,7 +4307,8 @@ "name": "enabled", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" } ], "tags": [ @@ -4428,9 +4326,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -4461,9 +4359,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -4643,9 +4541,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -4824,9 +4722,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -4843,7 +4741,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServiceAttemptsRenewalResultBody" + "$ref": "#/definitions/engineAttemptRenewalResultRequest" } } ], @@ -4863,9 +4761,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -4978,9 +4876,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -5039,9 +4937,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -5076,9 +4974,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -5113,9 +5011,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -5132,7 +5030,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueServiceUpdateQueueBody" + "$ref": "#/definitions/engineUpdateQueueRequest" } } ], @@ -5151,9 +5049,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -5170,7 +5068,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueServicePatchQueueBody" + "$ref": "#/definitions/enginePatchQueueRequest" } } ], @@ -5191,9 +5089,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -5268,9 +5166,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -5287,7 +5185,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueBucketServiceCreateQueueBucketBody" + "$ref": "#/definitions/engineCreateQueueBucketRequest" } } ], @@ -5308,9 +5206,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -5345,9 +5243,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -5382,9 +5280,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -5408,7 +5306,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueBucketServiceUpdateQueueBucketBody" + "$ref": "#/definitions/engineUpdateQueueBucketRequest" } } ], @@ -5426,9 +5324,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -5452,7 +5350,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueBucketServicePatchQueueBucketBody" + "$ref": "#/definitions/enginePatchQueueBucketRequest" } } ], @@ -5472,9 +5370,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -5569,9 +5467,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -5588,7 +5486,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueHookServiceCreateQueueHookBody" + "$ref": "#/definitions/engineCreateQueueHookRequest" } } ], @@ -5608,9 +5506,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -5644,9 +5542,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -5680,9 +5578,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -5706,7 +5604,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueHookServiceUpdateQueueHookBody" + "$ref": "#/definitions/engineUpdateQueueHookRequest" } } ], @@ -5724,9 +5622,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -5750,7 +5648,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueHookServicePatchQueueHookBody" + "$ref": "#/definitions/enginePatchQueueHookRequest" } } ], @@ -5771,9 +5669,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -5931,13 +5829,6 @@ "format": "int32" }, "collectionFormat": "multi" - }, - { - "name": "variables[string]", - "description": "This is a request variable of the map type. The query format is \"map_name[key]=value\", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age[\"bob\"]=18", - "in": "query", - "required": false, - "type": "string" } ], "tags": [ @@ -5955,9 +5846,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -5974,7 +5865,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServiceDeleteMembersBody" + "$ref": "#/definitions/engineDeleteMembersRequest" } } ], @@ -5993,9 +5884,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6012,7 +5903,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServiceCreateMemberBody" + "$ref": "#/definitions/engineCreateMemberRequest" } } ], @@ -6033,9 +5924,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6052,7 +5943,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServiceCreateMemberBulkBody" + "$ref": "#/definitions/engineCreateMemberBulkRequest" } } ], @@ -6073,9 +5964,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6092,7 +5983,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServiceResetMembersBody" + "$ref": "#/definitions/engineResetMembersRequest" } } ], @@ -6113,9 +6004,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6157,9 +6048,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6201,9 +6092,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6227,7 +6118,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServiceUpdateMemberBody" + "$ref": "#/definitions/engineUpdateMemberRequest" } } ], @@ -6246,9 +6137,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6272,7 +6163,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServicePatchMemberBody" + "$ref": "#/definitions/enginePatchMemberRequest" } } ], @@ -6293,9 +6184,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6337,9 +6228,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6363,7 +6254,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServiceCreateAttemptBody" + "$ref": "#/definitions/engineCreateAttemptRequest" } } ], @@ -6383,9 +6274,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6416,7 +6307,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/MemberServiceAttemptResultBody" + "$ref": "#/definitions/engineAttemptResultRequest" } } ], @@ -6437,9 +6328,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6514,9 +6405,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6533,7 +6424,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueResourcesServiceCreateQueueResourceGroupBody" + "$ref": "#/definitions/engineCreateQueueResourceGroupRequest" } } ], @@ -6554,9 +6445,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6598,9 +6489,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6642,9 +6533,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6668,7 +6559,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueResourcesServiceUpdateQueueResourceGroupBody" + "$ref": "#/definitions/engineUpdateQueueResourceGroupRequest" } } ], @@ -6688,9 +6579,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6808,7 +6699,8 @@ "name": "enabled", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" } ], "tags": [ @@ -6825,9 +6717,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6844,7 +6736,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueSkillServiceCreateQueueSkillBody" + "$ref": "#/definitions/engineCreateQueueSkillRequest" } } ], @@ -6864,9 +6756,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6900,9 +6792,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6936,9 +6828,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -6962,7 +6854,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueSkillServiceUpdateQueueSkillBody" + "$ref": "#/definitions/engineUpdateQueueSkillRequest" } } ], @@ -6980,9 +6872,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7006,7 +6898,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/QueueSkillServicePatchQueueSkillBody" + "$ref": "#/definitions/enginePatchQueueSkillRequest" } } ], @@ -7015,21 +6907,20 @@ ] } }, - "/call_center/resource_group": { + "/call_center/quick_replies": { "get": { - "summary": "List of OutboundResourceGroup", - "operationId": "SearchOutboundResourceGroup", + "operationId": "SearchQuickReplies", "responses": { "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/engineListOutboundResourceGroup" + "$ref": "#/definitions/engineListQuickReplies" } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7083,23 +6974,22 @@ } ], "tags": [ - "OutboundResourceGroupService" + "QuickRepliesService" ] }, "post": { - "summary": "Create OutboundResourceGroup", - "operationId": "CreateOutboundResourceGroup", + "operationId": "CreateQuickReply", "responses": { "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/engineOutboundResourceGroup" + "$ref": "#/definitions/engineQuickReply" } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7109,41 +6999,168 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/engineCreateOutboundResourceGroupRequest" + "$ref": "#/definitions/engineCreateQuickReplyRequest" } } ], "tags": [ - "OutboundResourceGroupService" + "QuickRepliesService" ] } }, - "/call_center/resource_group/{group_id}/resource": { + "/call_center/quick_replies/{id}": { "get": { - "summary": "List of OutboundResourceInGroup", - "operationId": "SearchOutboundResourceInGroup", + "operationId": "ReadQuickReply", "responses": { "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/engineListOutboundResourceInGroup" + "$ref": "#/definitions/engineQuickReply" } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, "parameters": [ { - "name": "group_id", + "name": "id", "in": "path", "required": true, - "type": "string", + "type": "integer", + "format": "int64" + } + ], + "tags": [ + "QuickRepliesService" + ] + }, + "delete": { + "operationId": "DeleteQuickReply", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/engineQuickReply" + } + }, + "default": { + "description": "Server error", + "schema": { + "$ref": "#/definitions/engineApiError" + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "tags": [ + "QuickRepliesService" + ] + }, + "put": { + "operationId": "UpdateQuickReply", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/engineQuickReply" + } + }, + "default": { + "description": "Server error", + "schema": { + "$ref": "#/definitions/engineApiError" + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/engineUpdateQuickReplyRequest" + } + } + ], + "tags": [ + "QuickRepliesService" + ] + }, + "patch": { + "operationId": "PatchQuickReply", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/engineQuickReply" + } + }, + "default": { + "description": "Server error", + "schema": { + "$ref": "#/definitions/engineApiError" + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "type": "integer", "format": "int64" }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/enginePatchQuickReplyRequest" + } + } + ], + "tags": [ + "QuickRepliesService" + ] + } + }, + "/call_center/resource_group": { + "get": { + "summary": "List of OutboundResourceGroup", + "operationId": "SearchOutboundResourceGroup", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/engineListOutboundResourceGroup" + } + }, + "default": { + "description": "Server error", + "schema": { + "$ref": "#/definitions/engineApiError" + } + } + }, + "parameters": [ { "name": "page", "in": "query", @@ -7198,35 +7215,28 @@ }, "post": { "summary": "Create OutboundResourceGroup", - "operationId": "CreateOutboundResourceInGroup", + "operationId": "CreateOutboundResourceGroup", "responses": { "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/engineOutboundResourceInGroup" + "$ref": "#/definitions/engineOutboundResourceGroup" } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, "parameters": [ - { - "name": "group_id", - "in": "path", - "required": true, - "type": "string", - "format": "int64" - }, { "name": "body", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OutboundResourceGroupServiceCreateOutboundResourceInGroupBody" + "$ref": "#/definitions/engineCreateOutboundResourceGroupRequest" } } ], @@ -7235,21 +7245,21 @@ ] } }, - "/call_center/resource_group/{group_id}/resource/{id}": { + "/call_center/resource_group/{group_id}/resource": { "get": { - "summary": "OutboundResourceInGroup item", - "operationId": "ReadOutboundResourceInGroup", + "summary": "List of OutboundResourceInGroup", + "operationId": "SearchOutboundResourceInGroup", "responses": { "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/engineOutboundResourceInGroup" + "$ref": "#/definitions/engineListOutboundResourceInGroup" } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7262,38 +7272,155 @@ "format": "int64" }, { - "name": "id", - "in": "path", - "required": true, - "type": "string", - "format": "int64" + "name": "page", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" }, { - "name": "domain_id", + "name": "size", "in": "query", "required": false, - "type": "string", - "format": "int64" - } - ], - "tags": [ - "OutboundResourceGroupService" - ] - }, - "delete": { - "summary": "Remove OutboundResourceInGroup", - "operationId": "DeleteOutboundResourceInGroup", - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "$ref": "#/definitions/engineOutboundResourceInGroup" - } + "type": "integer", + "format": "int32" }, - "default": { - "description": "An unexpected error response.", + { + "name": "q", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "sort", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "fields", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "id", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "integer", + "format": "int64" + }, + "collectionFormat": "multi" + } + ], + "tags": [ + "OutboundResourceGroupService" + ] + }, + "post": { + "summary": "Create OutboundResourceGroup", + "operationId": "CreateOutboundResourceInGroup", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/engineOutboundResourceInGroup" + } + }, + "default": { + "description": "Server error", + "schema": { + "$ref": "#/definitions/engineApiError" + } + } + }, + "parameters": [ + { + "name": "group_id", + "in": "path", + "required": true, + "type": "string", + "format": "int64" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/engineCreateOutboundResourceInGroupRequest" + } + } + ], + "tags": [ + "OutboundResourceGroupService" + ] + } + }, + "/call_center/resource_group/{group_id}/resource/{id}": { + "get": { + "summary": "OutboundResourceInGroup item", + "operationId": "ReadOutboundResourceInGroup", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/engineOutboundResourceInGroup" + } + }, + "default": { + "description": "Server error", + "schema": { + "$ref": "#/definitions/engineApiError" + } + } + }, + "parameters": [ + { + "name": "group_id", + "in": "path", + "required": true, + "type": "string", + "format": "int64" + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "format": "int64" + }, + { + "name": "domain_id", + "in": "query", + "required": false, + "type": "string", + "format": "int64" + } + ], + "tags": [ + "OutboundResourceGroupService" + ] + }, + "delete": { + "summary": "Remove OutboundResourceInGroup", + "operationId": "DeleteOutboundResourceInGroup", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/engineOutboundResourceInGroup" + } + }, + "default": { + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7335,9 +7462,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7361,7 +7488,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OutboundResourceGroupServiceUpdateOutboundResourceInGroupBody" + "$ref": "#/definitions/engineUpdateOutboundResourceInGroupRequest" } } ], @@ -7382,9 +7509,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7419,9 +7546,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7456,9 +7583,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7475,7 +7602,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OutboundResourceGroupServiceUpdateOutboundResourceGroupBody" + "$ref": "#/definitions/engineUpdateOutboundResourceGroupRequest" } } ], @@ -7496,9 +7623,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7566,9 +7693,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7599,9 +7726,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7636,9 +7763,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7673,9 +7800,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7692,7 +7819,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OutboundResourceServiceUpdateOutboundResourceBody" + "$ref": "#/definitions/engineUpdateOutboundResourceRequest" } } ], @@ -7711,9 +7838,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7730,7 +7857,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OutboundResourceServicePatchOutboundResourceBody" + "$ref": "#/definitions/enginePatchOutboundResourceRequest" } } ], @@ -7751,9 +7878,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7828,9 +7955,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7869,9 +7996,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7888,7 +8015,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OutboundResourceServiceCreateOutboundResourceDisplayBody" + "$ref": "#/definitions/engineCreateOutboundResourceDisplayRequest" } } ], @@ -7909,9 +8036,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7928,7 +8055,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OutboundResourceServiceCreateOutboundResourceDisplayBulkBody" + "$ref": "#/definitions/engineCreateOutboundResourceDisplayBulkRequest" } } ], @@ -7949,9 +8076,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -7993,9 +8120,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8037,9 +8164,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8063,7 +8190,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/OutboundResourceServiceUpdateOutboundResourceDisplayBody" + "$ref": "#/definitions/engineUpdateOutboundResourceDisplayRequest" } } ], @@ -8084,9 +8211,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8154,9 +8281,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8187,9 +8314,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8224,9 +8351,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8261,9 +8388,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8280,7 +8407,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/SkillServiceUpdateSkillBody" + "$ref": "#/definitions/engineUpdateSkillRequest" } } ], @@ -8301,9 +8428,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8388,9 +8515,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8407,7 +8534,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/SkillServiceDeleteSkillAgentBody" + "$ref": "#/definitions/engineDeleteSkillAgentRequest" } } ], @@ -8425,9 +8552,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8444,7 +8571,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/SkillServiceCreateSkillAgentBody" + "$ref": "#/definitions/engineCreateSkillAgentRequest" } } ], @@ -8462,9 +8589,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8481,7 +8608,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/SkillServicePatchSkillAgentBody" + "$ref": "#/definitions/enginePatchSkillAgentRequest" } } ], @@ -8502,9 +8629,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8593,9 +8720,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8625,9 +8752,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8679,7 +8806,8 @@ "name": "enabled", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" }, { "name": "id", @@ -8720,9 +8848,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8739,7 +8867,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TeamTriggerServiceRunTeamTriggerBody" + "$ref": "#/definitions/engineRunTeamTriggerRequest" } } ], @@ -8760,9 +8888,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8797,9 +8925,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8834,9 +8962,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8853,7 +8981,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AgentTeamServiceUpdateAgentTeamBody" + "$ref": "#/definitions/engineUpdateAgentTeamRequest" } } ], @@ -8873,9 +9001,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8974,9 +9102,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -8993,7 +9121,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TeamHookServiceCreateTeamHookBody" + "$ref": "#/definitions/engineCreateTeamHookRequest" } } ], @@ -9013,9 +9141,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -9049,9 +9177,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -9085,9 +9213,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -9111,7 +9239,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TeamHookServiceUpdateTeamHookBody" + "$ref": "#/definitions/engineUpdateTeamHookRequest" } } ], @@ -9129,9 +9257,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -9155,7 +9283,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TeamHookServicePatchTeamHookBody" + "$ref": "#/definitions/enginePatchTeamHookRequest" } } ], @@ -9175,9 +9303,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -9229,7 +9357,8 @@ "name": "enabled", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" }, { "name": "id", @@ -9268,9 +9397,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -9287,7 +9416,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TeamTriggerServiceCreateTeamTriggerBody" + "$ref": "#/definitions/engineCreateTeamTriggerRequest" } } ], @@ -9307,9 +9436,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -9343,9 +9472,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -9379,9 +9508,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -9405,7 +9534,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TeamTriggerServiceUpdateTeamTriggerBody" + "$ref": "#/definitions/engineUpdateTeamTriggerRequest" } } ], @@ -9423,9 +9552,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -9449,7 +9578,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TeamTriggerServicePatchTeamTriggerBody" + "$ref": "#/definitions/enginePatchTeamTriggerRequest" } } ], @@ -9470,9 +9599,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -9530,9 +9659,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -9562,9 +9691,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -9703,7 +9832,8 @@ "name": "skip_parent", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" }, { "name": "parent_id", @@ -9725,7 +9855,8 @@ "name": "exists_file", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" }, { "name": "domain_id", @@ -9768,7 +9899,8 @@ "name": "missed", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" }, { "name": "stored_at.from", @@ -9823,9 +9955,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -9858,9 +9990,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -9876,7 +10008,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceHangupCallBody" + "$ref": "#/definitions/engineHangupCallRequest" } } ], @@ -9897,9 +10029,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -9927,9 +10059,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -9945,7 +10077,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceDtmfCallBody" + "$ref": "#/definitions/engineDtmfCallRequest" } } ], @@ -9965,9 +10097,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -9983,7 +10115,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceEavesdropCallBody" + "$ref": "#/definitions/engineEavesdropCallRequest" } } ], @@ -10003,9 +10135,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -10021,7 +10153,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceHoldCallBody" + "$ref": "#/definitions/engineUserCallRequest" } } ], @@ -10041,9 +10173,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -10059,7 +10191,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceBlindTransferCallBody" + "$ref": "#/definitions/engineBlindTransferCallRequest" } } ], @@ -10079,9 +10211,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -10097,7 +10229,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceUnHoldCallBody" + "$ref": "#/definitions/engineUserCallRequest" } } ], @@ -10117,9 +10249,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -10135,7 +10267,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceSetVariablesCallBody" + "$ref": "#/definitions/engineSetVariablesCallRequest" } } ], @@ -10156,9 +10288,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -10297,7 +10429,8 @@ "name": "skip_parent", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" }, { "name": "parent_id", @@ -10319,7 +10452,8 @@ "name": "has_file", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" }, { "name": "domain_id", @@ -10358,7 +10492,8 @@ "name": "missed", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" }, { "name": "stored_at.from", @@ -10420,13 +10555,6 @@ }, "collectionFormat": "multi" }, - { - "name": "variables[string]", - "description": "This is a request variable of the map type. The query format is \"map_name[key]=value\", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age[\"bob\"]=18", - "in": "query", - "required": false, - "type": "string" - }, { "name": "amd_result", "in": "query", @@ -10457,7 +10585,8 @@ "name": "has_transcript", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" }, { "name": "agent_description", @@ -10515,7 +10644,8 @@ "name": "rated", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" }, { "name": "rated_by", @@ -10593,13 +10723,15 @@ "name": "has_transfer", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" }, { "name": "timeline", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" } ], "tags": [ @@ -10617,9 +10749,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -10649,9 +10781,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -10681,9 +10813,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -10699,7 +10831,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceCreateCallAnnotationBody" + "$ref": "#/definitions/engineCreateCallAnnotationRequest" } } ], @@ -10719,9 +10851,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -10754,9 +10886,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -10779,7 +10911,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceUpdateCallAnnotationBody" + "$ref": "#/definitions/engineUpdateCallAnnotationRequest" } } ], @@ -10799,9 +10931,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -10817,7 +10949,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServiceRedialCallBody" + "$ref": "#/definitions/engineRedialCallRequest" } } ], @@ -10837,9 +10969,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -10855,7 +10987,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/CallServicePatchHistoryCallBody" + "$ref": "#/definitions/enginePatchHistoryCallRequest" } } ], @@ -10875,9 +11007,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -10894,39 +11026,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/ChatHelperServiceBroadcastBody" - } - } - ], - "tags": [ - "ChatHelperService" - ] - } - }, - "/chat/broadcast": { - "post": { - "operationId": "BroadcastV2", - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "$ref": "#/definitions/chatBroadcastMessageResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/rpcStatus" - } - } - }, - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/chatBroadcastMessageRequest" + "$ref": "#/definitions/engineBroadcastRequest" } } ], @@ -10947,9 +11047,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11006,9 +11106,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11039,9 +11139,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11069,9 +11169,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11099,9 +11199,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11118,7 +11218,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/EmailProfileServiceUpdateEmailProfileBody" + "$ref": "#/definitions/engineUpdateEmailProfileRequest" } } ], @@ -11136,9 +11236,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11155,7 +11255,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/EmailProfileServicePatchEmailProfileBody" + "$ref": "#/definitions/enginePatchEmailProfileRequest" } } ], @@ -11175,9 +11275,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11206,9 +11306,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11238,9 +11338,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11270,9 +11370,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11340,9 +11440,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11373,9 +11473,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11403,9 +11503,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11433,9 +11533,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11452,7 +11552,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/WebHookServiceUpdateWebHookBody" + "$ref": "#/definitions/engineUpdateWebHookRequest" } } ], @@ -11471,9 +11571,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11490,7 +11590,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/WebHookServicePatchWebHookBody" + "$ref": "#/definitions/enginePatchWebHookRequest" } } ], @@ -11510,9 +11610,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11602,9 +11702,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11634,9 +11734,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11663,9 +11763,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11692,9 +11792,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11711,7 +11811,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RegionServiceUpdateRegionBody" + "$ref": "#/definitions/engineUpdateRegionRequest" } } ], @@ -11729,9 +11829,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11748,7 +11848,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RegionServicePatchRegionBody" + "$ref": "#/definitions/enginePatchRegionRequest" } } ], @@ -11769,9 +11869,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11868,9 +11968,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11901,9 +12001,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11927,7 +12027,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RoutingOutboundCallServiceMovePositionRoutingOutboundCallBody" + "$ref": "#/definitions/engineMovePositionRoutingOutboundCallRequest" } } ], @@ -11948,9 +12048,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -11985,9 +12085,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12022,9 +12122,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12041,7 +12141,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RoutingOutboundCallServiceUpdateRoutingOutboundCallBody" + "$ref": "#/definitions/engineUpdateRoutingOutboundCallRequest" } } ], @@ -12060,9 +12160,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12079,7 +12179,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RoutingOutboundCallServicePatchRoutingOutboundCallBody" + "$ref": "#/definitions/enginePatchRoutingOutboundCallRequest" } } ], @@ -12099,9 +12199,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12163,7 +12263,8 @@ "name": "enabled", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" } ], "tags": [ @@ -12180,9 +12281,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12212,9 +12313,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12241,9 +12342,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12270,9 +12371,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12289,7 +12390,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RoutingChatPlanServiceUpdateChatPlanBody" + "$ref": "#/definitions/engineUpdateChatPlanRequest" } } ], @@ -12307,9 +12408,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12326,7 +12427,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RoutingChatPlanServicePatchChatPlanBody" + "$ref": "#/definitions/enginePatchChatPlanRequest" } } ], @@ -12347,9 +12448,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12428,7 +12529,8 @@ "name": "editor", "in": "query", "required": false, - "type": "boolean" + "type": "boolean", + "format": "boolean" }, { "name": "tags", @@ -12456,9 +12558,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12489,9 +12591,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12566,9 +12668,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12624,9 +12726,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12656,9 +12758,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12685,9 +12787,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12714,9 +12816,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12733,7 +12835,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/SchemaVariablesServiceUpdateSchemaVariableBody" + "$ref": "#/definitions/engineUpdateSchemaVariableRequest" } } ], @@ -12751,9 +12853,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12770,7 +12872,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/SchemaVariablesServicePatchSchemaVariableBody" + "$ref": "#/definitions/enginePatchSchemaVariableRequest" } } ], @@ -12791,9 +12893,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12828,9 +12930,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12865,9 +12967,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12884,7 +12986,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RoutingSchemaServiceUpdateRoutingSchemaBody" + "$ref": "#/definitions/engineUpdateRoutingSchemaRequest" } } ], @@ -12903,9 +13005,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -12922,7 +13024,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RoutingSchemaServicePatchRoutingSchemaBody" + "$ref": "#/definitions/enginePatchRoutingSchemaRequest" } } ], @@ -12942,9 +13044,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13010,9 +13112,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13054,9 +13156,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13087,9 +13189,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13124,9 +13226,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13161,9 +13263,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13180,7 +13282,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RoutingVariableServiceUpdateRoutingVariableBody" + "$ref": "#/definitions/engineUpdateRoutingVariableRequest" } } ], @@ -13200,9 +13302,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13245,7 +13347,7 @@ }, { "name": "name", - "description": "Filter by setting names", + "description": "Filter by setting names.", "in": "query", "required": false, "type": "array", @@ -13263,7 +13365,8 @@ "chat_ai_connection", "password_reg_exp", "password_validation_text", - "autolink_call_to_contact" + "autolink_call_to_contact", + "period_to_playback_records" ] }, "collectionFormat": "multi" @@ -13283,9 +13386,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13315,9 +13418,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13375,9 +13478,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13404,9 +13507,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13433,9 +13536,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13452,7 +13555,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/SystemSettingServiceUpdateSystemSettingBody" + "$ref": "#/definitions/engineUpdateSystemSettingRequest" } } ], @@ -13470,9 +13573,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13489,7 +13592,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/SystemSettingServicePatchSystemSettingBody" + "$ref": "#/definitions/enginePatchSystemSettingRequest" } } ], @@ -13510,9 +13613,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13591,9 +13694,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13624,9 +13727,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13654,9 +13757,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13684,9 +13787,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13703,7 +13806,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TriggerServiceUpdateTriggerBody" + "$ref": "#/definitions/engineUpdateTriggerRequest" } } ], @@ -13721,9 +13824,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13740,7 +13843,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TriggerServicePatchTriggerBody" + "$ref": "#/definitions/enginePatchTriggerRequest" } } ], @@ -13760,9 +13863,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13883,9 +13986,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13902,7 +14005,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TriggerServiceCreateTriggerJobBody" + "$ref": "#/definitions/engineCreateTriggerJobRequest" } } ], @@ -13922,9 +14025,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -13952,9 +14055,9 @@ } }, "default": { - "description": "An unexpected error response.", + "description": "Server error", "schema": { - "$ref": "#/definitions/rpcStatus" + "$ref": "#/definitions/engineApiError" } } }, @@ -14021,1478 +14124,1380 @@ } } }, - "AgentPauseCauseServicePatchAgentPauseCauseBody": { + "AggregateRequestGroup": { "type": "object", "properties": { - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "name": { + "id": { "type": "string" }, - "limit_min": { - "type": "integer", - "format": "int64" + "interval": { + "type": "string" }, - "allow_supervisor": { - "type": "boolean" + "aggregate": { + "type": "string" }, - "allow_agent": { - "type": "boolean" + "field": { + "type": "string" }, - "allow_admin": { - "type": "boolean" + "top": { + "type": "integer", + "format": "int32" }, - "description": { - "type": "string" + "desc": { + "type": "boolean", + "format": "boolean" } } }, - "AgentPauseCauseServiceUpdateAgentPauseCauseBody": { + "CreateCallRequestCallSettings": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "limit_min": { + "timeout": { "type": "integer", - "format": "int64" + "format": "int32" }, - "allow_supervisor": { - "type": "boolean" + "audio": { + "type": "boolean", + "format": "boolean" }, - "allow_agent": { - "type": "boolean" + "video": { + "type": "boolean", + "format": "boolean" }, - "allow_admin": { - "type": "boolean" + "screen": { + "type": "boolean", + "format": "boolean" }, - "description": { + "record": { + "type": "boolean", + "format": "boolean" + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "display": { "type": "string" + }, + "disable_stun": { + "type": "boolean", + "format": "boolean" + }, + "cancel_distribute": { + "type": "boolean", + "format": "boolean" + }, + "is_online": { + "type": "boolean", + "format": "boolean" + }, + "disable_auto_answer": { + "type": "boolean", + "format": "boolean" + }, + "hide_number": { + "type": "boolean", + "format": "boolean" } } }, - "AgentServiceAgentSetStateBody": { - "type": "object" - }, - "AgentServicePatchAgentBody": { + "DefaultDeviceConfigResponseSipDeviceConfig": { "type": "object", "properties": { - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "user": { - "$ref": "#/definitions/engineLookup" + "auth": { + "type": "string" }, - "description": { + "domain": { "type": "string" }, - "progressive_count": { - "type": "integer", - "format": "int32" + "extension": { + "type": "string" }, - "greeting_media": { - "$ref": "#/definitions/engineLookup" + "password": { + "type": "string" }, - "allow_channels": { - "type": "array", - "items": { - "type": "string" - } - }, - "chat_count": { - "type": "integer", - "format": "int64" - }, - "supervisor": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } - }, - "team": { - "$ref": "#/definitions/engineLookup" - }, - "region": { - "$ref": "#/definitions/engineLookup" - }, - "auditor": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } - }, - "is_supervisor": { - "type": "boolean" + "proxy": { + "type": "string" } } }, - "AgentServiceUpdateAgentBody": { + "DefaultDeviceConfigResponseWebRTCDeviceConfig": { "type": "object", "properties": { - "user": { - "$ref": "#/definitions/engineLookup" - }, - "description": { + "authorization_user": { "type": "string" }, - "progressive_count": { - "type": "integer", - "format": "int32" - }, - "greeting_media": { - "$ref": "#/definitions/engineLookup" - }, - "domain_id": { - "type": "string", - "format": "int64" - }, - "allow_channels": { - "type": "array", - "items": { - "type": "string" - } - }, - "chat_count": { - "type": "integer", - "format": "int64" - }, - "supervisor": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } + "display_name": { + "type": "string" }, - "team": { - "$ref": "#/definitions/engineLookup" + "extension": { + "type": "string" }, - "region": { - "$ref": "#/definitions/engineLookup" + "ha1": { + "type": "string" }, - "auditor": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } + "realm": { + "type": "string" }, - "is_supervisor": { - "type": "boolean" + "server": { + "type": "string" }, - "task_count": { - "type": "integer", - "format": "int64" + "uri": { + "type": "string" } } }, - "AgentServiceUpdateAgentStatusBody": { + "EmailProfileParamsOAuth2": { "type": "object", "properties": { - "status": { - "type": "string", - "title": "FIXME enumerate" - }, - "on_demand": { - "type": "boolean" - }, - "channels": { - "type": "array", - "items": { - "type": "string" - } + "client_id": { + "type": "string" }, - "payload": { + "client_secret": { "type": "string" }, - "domain_id": { - "type": "string", - "format": "int64" + "redirect_url": { + "type": "string" } } }, - "AgentSkillServiceCreateAgentSkillBody": { + "HistoryCallBlindTransfer": { "type": "object", "properties": { - "skill": { - "$ref": "#/definitions/engineLookup" - }, - "capacity": { - "type": "integer", - "format": "int32" + "number": { + "type": "string" }, - "domain_id": { + "time": { "type": "string", "format": "int64" }, - "enabled": { - "type": "boolean" + "user": { + "$ref": "#/definitions/engineLookup" } } }, - "AgentSkillServiceCreateAgentSkillsBody": { + "HistoryFileJobHistoryFileJobAction": { + "type": "string", + "enum": [ + "undefined", + "STT", + "delete" + ], + "default": "undefined" + }, + "HistoryFileJobHistoryFileJobState": { + "type": "string", + "enum": [ + "idle", + "active", + "finished", + "error" + ], + "default": "idle" + }, + "ListSkillAgentListSkillAgg": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineCreateAgentSkillBulkItem" - } + "enabled": { + "type": "boolean", + "format": "boolean" } } }, - "AgentSkillServicePatchAgentSkillBody": { + "QuestionOption": { "type": "object", "properties": { - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "skill": { - "$ref": "#/definitions/engineLookup" - }, - "capacity": { - "type": "integer", - "format": "int32" - }, - "domain_id": { - "type": "string", - "format": "int64" + "name": { + "type": "string" }, - "enabled": { - "type": "boolean" + "score": { + "type": "number", + "format": "float" } } }, - "AgentSkillServicePatchAgentSkillsBody": { + "UserStatusUserPresence": { "type": "object", "properties": { - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - }, - "skill_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - }, - "capacity": { - "type": "integer", - "format": "int32" - }, - "enabled": { - "type": "boolean" + "status": { + "type": "string" } } }, - "AgentSkillServiceUpdateAgentSkillBody": { + "engineAcceptOfDay": { "type": "object", "properties": { - "skill": { - "$ref": "#/definitions/engineLookup" + "day": { + "type": "integer", + "format": "int32" }, - "capacity": { + "start_time_of_day": { "type": "integer", "format": "int32" }, - "domain_id": { - "type": "string", - "format": "int64" + "end_time_of_day": { + "type": "integer", + "format": "int32" }, - "enabled": { - "type": "boolean" + "disabled": { + "type": "boolean", + "format": "boolean" } } }, - "AgentTeamServiceUpdateAgentTeamBody": { + "engineActiveCall": { "type": "object", "properties": { - "name": { + "id": { "type": "string" }, - "description": { + "app_id": { "type": "string" }, - "strategy": { + "state": { "type": "string" }, - "max_no_answer": { - "type": "integer", - "format": "int32" + "timestamp": { + "type": "string", + "format": "int64" }, - "no_answer_delay_time": { - "type": "integer", - "format": "int32" + "type": { + "type": "string" }, - "wrap_up_time": { - "type": "integer", - "format": "int32" + "parent_id": { + "type": "string" }, - "call_timeout": { - "type": "integer", - "format": "int32" + "user": { + "$ref": "#/definitions/engineLookup" }, - "admin": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } + "extension": { + "type": "string" }, - "domain_id": { - "type": "string", - "format": "int64" + "gateway": { + "$ref": "#/definitions/engineLookup" }, - "invite_chat_timeout": { - "type": "integer", - "format": "int32" - }, - "task_accept_timeout": { - "type": "integer", - "format": "int32" - }, - "forecast_calculation": { - "$ref": "#/definitions/engineLookup" - } - } - }, - "AggregateRequestGroup": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "interval": { + "direction": { "type": "string" }, - "aggregate": { + "destination": { "type": "string" }, - "field": { - "type": "string" + "from": { + "$ref": "#/definitions/engineEndpoint" }, - "top": { - "type": "integer", - "format": "int32" + "to": { + "$ref": "#/definitions/engineEndpoint" }, - "desc": { - "type": "boolean" - } - } - }, - "AuditFormServicePatchAuditFormBody": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { + "variables": { + "type": "object", + "additionalProperties": { "type": "string" } }, - "name": { - "type": "string" + "created_at": { + "type": "string", + "format": "int64" }, - "description": { - "type": "string" + "answered_at": { + "type": "string", + "format": "int64" }, - "enabled": { - "type": "boolean" + "bridged_at": { + "type": "string", + "format": "int64" }, - "questions": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineQuestion" - } + "duration": { + "type": "integer", + "format": "int32" }, - "teams": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - }, - "title": "bool archive = 8;" - } - } - }, - "AuditFormServiceUpdateAuditFormBody": { - "type": "object", - "properties": { - "name": { - "type": "string" + "hold_sec": { + "type": "integer", + "format": "int32" }, - "description": { - "type": "string" + "wait_sec": { + "type": "integer", + "format": "int32" }, - "enabled": { - "type": "boolean" + "bill_sec": { + "type": "integer", + "format": "int32" }, - "questions": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineQuestion" - } + "queue": { + "$ref": "#/definitions/engineLookup" }, - "teams": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - }, - "title": "bool archive = 7;" - } - } - }, - "BucketServiceUpdateBucketBody": { - "type": "object", - "properties": { - "name": { - "type": "string" + "member": { + "$ref": "#/definitions/engineLookup" }, - "description": { - "type": "string" + "team": { + "$ref": "#/definitions/engineLookup" }, - "domain_id": { + "agent": { + "$ref": "#/definitions/engineLookup" + }, + "joined_at": { "type": "string", "format": "int64" - } - } - }, - "CalendarServiceUpdateCalendarBody": { - "type": "object", - "properties": { - "name": { - "type": "string" }, - "start_at": { + "leaving_at": { "type": "string", "format": "int64" }, - "end_at": { + "reporting_at": { "type": "string", "format": "int64" }, - "timezone": { - "$ref": "#/definitions/engineLookup" + "queue_bridged_at": { + "type": "string", + "format": "int64" }, - "description": { - "type": "string" + "queue_wait_sec": { + "type": "integer", + "format": "int32" }, - "accepts": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAcceptOfDay" - } + "queue_duration_sec": { + "type": "integer", + "format": "int32" }, - "excepts": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineExceptDate" - } + "reporting_sec": { + "type": "integer", + "format": "int32" }, - "domain_id": { - "type": "string", - "format": "int64" + "display": { + "type": "string" }, - "specials": { + "supervisor": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAcceptOfDay" + "$ref": "#/definitions/engineLookup" } - } - } - }, - "CallServiceBlindTransferCallBody": { - "type": "object", - "properties": { - "app_id": { - "type": "string" }, - "destination": { + "blind_transfer": { "type": "string" }, - "domain_id": { - "type": "string", - "format": "int64" + "bridged_id": { + "type": "string" } } }, - "CallServiceCreateCallAnnotationBody": { + "engineActivityWorkspaceWidgetResponse": { "type": "object", "properties": { - "note": { - "type": "string" + "utilization": { + "type": "number", + "format": "float" }, - "start_sec": { + "occupancy": { + "type": "number", + "format": "float" + }, + "call_abandoned": { "type": "integer", "format": "int32" }, - "end_sec": { + "call_handled": { "type": "integer", "format": "int32" - } - } - }, - "CallServiceDtmfCallBody": { - "type": "object", - "properties": { - "app_id": { - "type": "string" }, - "digit": { - "type": "string" - }, - "domain_id": { - "type": "string", - "format": "int64" - } - } - }, - "CallServiceEavesdropCallBody": { - "type": "object", - "properties": { - "app_id": { - "type": "string" + "avg_talk_sec": { + "type": "number", + "format": "float" }, - "control": { - "type": "boolean" + "avg_hold_sec": { + "type": "number", + "format": "float" }, - "listen_a": { - "type": "boolean" + "chat_accepts": { + "type": "integer", + "format": "int32" }, - "listen_b": { - "type": "boolean" + "chat_aht": { + "type": "number", + "format": "float" }, - "whisper_a": { - "type": "boolean" + "call_missed": { + "type": "integer", + "format": "int32" }, - "whisper_b": { - "type": "boolean" + "call_inbound": { + "type": "integer", + "format": "int32" }, - "from": { - "$ref": "#/definitions/engineEavesdropCallRequestEndpointRequest" - } - } - }, - "CallServiceHangupCallBody": { - "type": "object", - "properties": { - "cause": { - "type": "string" + "score_required_avg": { + "type": "number", + "format": "float" }, - "app_id": { - "type": "string" + "score_optional_avg": { + "type": "number", + "format": "float" }, - "domain_id": { + "score_count": { "type": "string", "format": "int64" - } - } - }, - "CallServiceHoldCallBody": { - "type": "object", - "properties": { - "app_id": { - "type": "string" }, - "domain_id": { + "score_required_sum": { + "type": "number", + "format": "float" + }, + "score_optional_sum": { + "type": "number", + "format": "float" + }, + "sum_talk_sec": { "type": "string", "format": "int64" - } - } - }, - "CallServicePatchHistoryCallBody": { - "type": "object", - "properties": { - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } }, - "hide_missed": { - "type": "boolean" - } - } - }, - "CallServiceRedialCallBody": { - "type": "object" - }, - "CallServiceSetVariablesCallBody": { - "type": "object", - "properties": { - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "voice_mail": { + "type": "integer", + "format": "int32" + }, + "available": { + "type": "integer", + "format": "int32" + }, + "online": { + "type": "integer", + "format": "int32" + }, + "processing": { + "type": "integer", + "format": "int32" + }, + "task_accepts": { + "type": "integer", + "format": "int32" + }, + "queue_talk_sec": { + "type": "integer", + "format": "int32" } } }, - "CallServiceUnHoldCallBody": { + "engineAgent": { "type": "object", "properties": { - "app_id": { + "id": { + "type": "string", + "format": "int64" + }, + "user": { + "$ref": "#/definitions/engineLookup" + }, + "status": { "type": "string" }, - "domain_id": { + "description": { + "type": "string" + }, + "last_status_change": { "type": "string", "format": "int64" - } - } - }, - "CallServiceUpdateCallAnnotationBody": { - "type": "object", - "properties": { - "note": { - "type": "string" }, - "start_sec": { + "progressive_count": { "type": "integer", "format": "int32" }, - "end_sec": { - "type": "integer", - "format": "int32" - } - } - }, - "ChatHelperServiceBroadcastBody": { - "type": "object", - "properties": { - "peer": { + "name": { + "type": "string" + }, + "channel": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineAgentChannel" } }, - "text": { - "type": "string" + "status_duration": { + "type": "string", + "format": "int64" }, - "file": { - "$ref": "#/definitions/engineBroadcastFile", - "description": "Message Media. Attachment." + "greeting_media": { + "$ref": "#/definitions/engineLookup" }, - "buttons": { + "allow_channels": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineBroadcastButtons" + "type": "string" } - } - } - }, - "CommunicationTypeServicePatchCommunicationTypeBody": { - "type": "object", - "properties": { - "fields": { + }, + "chat_count": { + "type": "integer", + "format": "int64" + }, + "supervisor": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineLookup" } }, - "name": { - "type": "string" + "team": { + "$ref": "#/definitions/engineLookup" }, - "description": { - "type": "string" + "region": { + "$ref": "#/definitions/engineLookup" }, - "code": { - "type": "string" + "auditor": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } }, - "channel": { - "$ref": "#/definitions/engineCommunicationChannels" + "is_supervisor": { + "type": "boolean", + "format": "boolean" }, - "default": { - "type": "boolean" + "skills": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } + }, + "extension": { + "type": "string" + }, + "task_count": { + "type": "integer", + "format": "int64" } } }, - "CommunicationTypeServiceUpdateCommunicationTypeBody": { + "engineAgentCallStatistics": { "type": "object", "properties": { "name": { "type": "string" }, - "code": { - "type": "string" - }, - "channel": { - "$ref": "#/definitions/engineCommunicationChannels" + "count": { + "type": "integer", + "format": "int32" }, - "description": { - "type": "string" + "abandoned": { + "type": "integer", + "format": "int32" }, - "default": { - "type": "boolean" - } - } - }, - "CreateCallRequestCallSettings": { - "type": "object", - "properties": { - "timeout": { + "handles": { "type": "integer", "format": "int32" }, - "audio": { - "type": "boolean" + "sum_talk_sec": { + "type": "number", + "format": "float" }, - "video": { - "type": "boolean" + "avg_talk_sec": { + "type": "number", + "format": "float" }, - "screen": { - "type": "boolean" + "min_talk_sec": { + "type": "number", + "format": "float" }, - "record": { - "type": "boolean" + "max_talk_sec": { + "type": "number", + "format": "float" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "sum_hold_sec": { + "type": "number", + "format": "float" }, - "display": { - "type": "string" + "avg_hold_sec": { + "type": "number", + "format": "float" }, - "disable_stun": { - "type": "boolean" + "min_hold_sec": { + "type": "number", + "format": "float" }, - "cancel_distribute": { - "type": "boolean" + "max_hold_sec": { + "type": "number", + "format": "float" }, - "is_online": { - "type": "boolean" + "utilization": { + "type": "number", + "format": "float" }, - "disable_auto_answer": { - "type": "boolean" + "occupancy": { + "type": "number", + "format": "float" }, - "hide_number": { - "type": "boolean" + "chat_accepts": { + "type": "integer", + "format": "int32" + }, + "chat_aht": { + "type": "integer", + "format": "int32" } } }, - "DefaultDeviceConfigResponseSipDeviceConfig": { + "engineAgentCallStatisticsList": { "type": "object", "properties": { - "auth": { - "type": "string" + "next": { + "type": "boolean", + "format": "boolean" }, - "domain": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgentCallStatistics" + } + } + } + }, + "engineAgentChannel": { + "type": "object", + "properties": { + "channel": { "type": "string" }, - "extension": { + "state": { "type": "string" }, - "password": { - "type": "string" + "joined_at": { + "type": "string", + "format": "int64" }, - "proxy": { - "type": "string" + "timeout": { + "type": "string", + "format": "int64" } } }, - "DefaultDeviceConfigResponseWebRTCDeviceConfig": { + "engineAgentInQueue": { "type": "object", "properties": { - "authorization_user": { - "type": "string" + "queue": { + "$ref": "#/definitions/engineLookup" }, - "display_name": { - "type": "string" + "priority": { + "type": "integer", + "format": "int32" }, - "extension": { - "type": "string" + "type": { + "type": "integer", + "format": "int32" }, - "ha1": { + "strategy": { "type": "string" }, - "realm": { - "type": "string" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "server": { - "type": "string" + "count_members": { + "type": "integer", + "format": "int32" }, - "uri": { - "type": "string" + "waiting_members": { + "type": "integer", + "format": "int32" + }, + "active_members": { + "type": "integer", + "format": "int32" + }, + "agents": { + "$ref": "#/definitions/AgentInQueueAgentsInQueue" } } }, - "EmailProfileParamsOAuth2": { + "engineAgentInQueueStatistics": { "type": "object", "properties": { - "client_id": { - "type": "string" + "queue": { + "$ref": "#/definitions/engineLookup" }, - "client_secret": { - "type": "string" + "statistics": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentInQueueStatisticsAgentInQueueStatisticsItem" + } + } + } + }, + "engineAgentInQueueStatisticsList": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgentInQueueStatistics" + } + } + } + }, + "engineAgentInTeam": { + "type": "object", + "properties": { + "team": { + "$ref": "#/definitions/engineLookup" }, - "redirect_url": { + "strategy": { "type": "string" } } }, - "EmailProfileServicePatchEmailProfileBody": { + "engineAgentPauseCause": { "type": "object", "properties": { - "name": { - "type": "string" + "id": { + "type": "integer", + "format": "int64" }, - "description": { - "type": "string" + "created_at": { + "type": "string", + "format": "int64" }, - "schema": { + "created_by": { "$ref": "#/definitions/engineLookup" }, - "enabled": { - "type": "boolean" - }, - "imap_host": { - "type": "string" + "updated_at": { + "type": "string", + "format": "int64" }, - "login": { - "type": "string" + "updated_by": { + "$ref": "#/definitions/engineLookup" }, - "mailbox": { + "name": { "type": "string" }, - "smtp_port": { + "limit_min": { "type": "integer", - "format": "int32" + "format": "int64" }, - "imap_port": { - "type": "integer", - "format": "int32" + "allow_supervisor": { + "type": "boolean", + "format": "boolean" }, - "password": { - "type": "string" + "allow_agent": { + "type": "boolean", + "format": "boolean" }, - "smtp_host": { - "type": "string" + "allow_admin": { + "type": "boolean", + "format": "boolean" }, - "fetch_interval": { + "description": { + "type": "string" + } + } + }, + "engineAgentSetStateRequest": { + "type": "object", + "properties": { + "agent_id": { "type": "integer", "format": "int32" - }, - "listen": { - "type": "boolean" - }, - "fields": { - "type": "array", - "items": { - "type": "string" - } } } }, - "EmailProfileServiceUpdateEmailProfileBody": { + "engineAgentSetStateResponse": { + "type": "object" + }, + "engineAgentSkill": { "type": "object", "properties": { - "name": { - "type": "string" + "id": { + "type": "string", + "format": "int64" }, - "description": { - "type": "string" + "domain_id": { + "type": "string", + "format": "int64" }, - "schema": { + "created_at": { + "type": "string", + "format": "int64" + }, + "created_by": { "$ref": "#/definitions/engineLookup" }, - "enabled": { - "type": "boolean" + "updated_at": { + "type": "string", + "format": "int64" }, - "imap_host": { - "type": "string" + "updated_by": { + "$ref": "#/definitions/engineLookup" }, - "login": { - "type": "string" + "agent": { + "$ref": "#/definitions/engineLookup" }, - "mailbox": { - "type": "string" + "skill": { + "$ref": "#/definitions/engineLookup" }, - "smtp_port": { + "capacity": { "type": "integer", "format": "int32" }, - "imap_port": { + "enabled": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineAgentSkillItem": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "int64" + }, + "skill": { + "$ref": "#/definitions/engineLookup" + }, + "capacity": { "type": "integer", "format": "int32" }, - "password": { + "enabled": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineAgentState": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "int64" + }, + "channel": { "type": "string" }, - "smtp_host": { + "joined_at": { + "type": "string", + "format": "int64" + }, + "state": { "type": "string" }, - "fetch_interval": { - "type": "integer", - "format": "int32" + "payload": { + "type": "string" }, - "auth_type": { - "$ref": "#/definitions/engineEmailAuthType" + "duration": { + "type": "string", + "format": "int64" }, - "listen": { - "type": "boolean" + "queue": { + "$ref": "#/definitions/engineLookup" }, - "params": { - "$ref": "#/definitions/engineEmailProfileParams" + "agent": { + "$ref": "#/definitions/engineLookup" + }, + "pause_cause": { + "type": "string" } } }, - "HistoryCallBlindTransfer": { + "engineAgentStatsStatistic": { "type": "object", "properties": { - "number": { + "agent_id": { + "type": "integer", + "format": "int32" + }, + "name": { "type": "string" }, - "time": { + "status": { + "type": "string" + }, + "status_duration": { "type": "string", "format": "int64" }, "user": { "$ref": "#/definitions/engineLookup" - } - } - }, - "HistoryFileJobHistoryFileJobAction": { - "type": "string", - "enum": [ - "undefined", - "STT", - "delete" - ], - "default": "undefined" - }, - "HistoryFileJobHistoryFileJobState": { - "type": "string", - "enum": [ - "idle", - "active", - "finished", - "error" - ], - "default": "idle", - "title": "- error: TODO" - }, - "ListServiceCreateListCommunicationBody": { - "type": "object", - "properties": { - "number": { - "type": "string" }, - "description": { + "extension": { "type": "string" }, - "expire_at": { - "type": "string", - "format": "int64" - } - } - }, - "ListServiceUpdateListBody": { - "type": "object", - "properties": { - "name": { - "type": "string" + "team": { + "$ref": "#/definitions/engineLookup" }, - "description": { - "type": "string" + "queues": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } }, - "domain_id": { + "online": { "type": "string", "format": "int64" - } - } - }, - "ListServiceUpdateListCommunicationBody": { - "type": "object", - "properties": { - "number": { - "type": "string" }, - "description": { - "type": "string" - }, - "expire_at": { + "offline": { "type": "string", "format": "int64" - } - } - }, - "ListSkillAgentListSkillAgg": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "MemberServiceAttemptCallbackBody": { - "type": "object", - "properties": { - "status": { - "type": "string" }, - "min_offering_at": { + "pause": { "type": "string", "format": "int64" }, - "expire_at": { + "utilization": { + "type": "number", + "format": "float" + }, + "call_time": { "type": "string", "format": "int64" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "display": { - "type": "boolean" - }, - "description": { - "type": "string" - }, - "agent_id": { + "handles": { "type": "integer", "format": "int32" }, - "exclude_current_communication": { - "type": "boolean" + "missed": { + "type": "integer", + "format": "int32" }, - "wait_between_retries": { + "chat_count": { "type": "integer", "format": "int32" - } - } - }, - "MemberServiceAttemptResultBody": { - "type": "object", - "properties": { - "status": { - "type": "string" }, - "min_offering_at": { + "max_bridged_at": { "type": "string", "format": "int64" }, - "expire_at": { + "max_offering_at": { "type": "string", "format": "int64" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "display": { - "type": "boolean" - }, - "description": { + "active_call_id": { "type": "string" }, - "transfer_queue_id": { - "type": "string", + "transferred": { + "type": "integer", "format": "int64" }, - "next_member_id": { - "type": "string", - "format": "int64" + "skills": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } }, - "agent_id": { - "type": "integer", - "format": "int32" + "supervisor": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } }, - "exclude_current_communication": { - "type": "boolean" + "auditor": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } }, - "wait_between_retries": { - "type": "integer", - "format": "int32" - } - } - }, - "MemberServiceAttemptsRenewalResultBody": { - "type": "object", - "properties": { - "renewal": { - "type": "integer", - "format": "int64" + "pause_cause": { + "type": "string" + }, + "occupancy": { + "type": "number", + "format": "float" } } }, - "MemberServiceCreateAttemptBody": { + "engineAgentStatusRequest": { "type": "object", "properties": { - "agent_id": { + "id": { "type": "string", "format": "int64" }, + "status": { + "type": "string" + }, + "on_demand": { + "type": "boolean", + "format": "boolean" + }, + "channels": { + "type": "array", + "items": { + "type": "string" + } + }, + "payload": { + "type": "string" + }, "domain_id": { "type": "string", "format": "int64" } } }, - "MemberServiceCreateMemberBody": { + "engineAgentStatusStatisticItem": { "type": "object", "properties": { - "priority": { + "agent_id": { "type": "integer", "format": "int32" }, - "expire_at": { + "name": { + "type": "string" + }, + "status": { + "type": "string" + }, + "status_duration": { "type": "string", "format": "int64" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "user": { + "$ref": "#/definitions/engineLookup" }, - "name": { + "extension": { "type": "string" }, - "timezone": { + "team": { "$ref": "#/definitions/engineLookup" }, - "communications": { + "supervisor": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineMemberCommunicationCreateRequest" + "$ref": "#/definitions/engineLookup" } }, - "bucket": { + "auditor": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } + }, + "region": { "$ref": "#/definitions/engineLookup" }, - "min_offering_at": { + "progressive_count": { + "type": "integer", + "format": "int64" + }, + "chat_count": { + "type": "integer", + "format": "int64" + }, + "pause_cause": { + "type": "string" + }, + "online": { "type": "string", "format": "int64" }, - "domain_id": { + "offline": { "type": "string", "format": "int64" }, - "agent": { - "$ref": "#/definitions/engineLookup" + "pause": { + "type": "string", + "format": "int64" }, - "skill": { - "$ref": "#/definitions/engineLookup" + "score_required_avg": { + "type": "number", + "format": "float" + }, + "score_optional_avg": { + "type": "number", + "format": "float" + }, + "score_count": { + "type": "string", + "format": "int64" } } }, - "MemberServiceCreateMemberBulkBody": { + "engineAgentTeam": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineCreateMemberBulkItem" - } + "id": { + "type": "string", + "format": "int64" }, - "file_name": { - "type": "string" - } - } - }, - "MemberServiceDeleteMembersBody": { - "type": "object", - "properties": { - "q": { - "type": "string" - }, - "id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - }, - "ids": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - }, - "title": "deprecated" - }, - "bucket_id": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } + "domain_id": { + "type": "string", + "format": "int64" }, - "destination": { + "name": { "type": "string" }, - "created_at": { - "$ref": "#/definitions/engineFilterBetween" + "description": { + "type": "string" }, - "offering_at": { - "$ref": "#/definitions/engineFilterBetween" + "strategy": { + "type": "string" }, - "stop_cause": { - "type": "array", - "items": { - "type": "string" - } + "max_no_answer": { + "type": "integer", + "format": "int32" }, - "priority": { - "$ref": "#/definitions/engineFilterBetween" + "no_answer_delay_time": { + "type": "integer", + "format": "int32" }, - "name": { - "type": "string" + "wrap_up_time": { + "type": "integer", + "format": "int32" }, - "attempts": { - "$ref": "#/definitions/engineFilterBetween" + "call_timeout": { + "type": "integer", + "format": "int32" }, - "agent_id": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } + "updated_at": { + "type": "string", + "format": "int64" }, - "numbers": { + "admin": { "type": "array", "items": { - "type": "string" - } - }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" + "$ref": "#/definitions/engineLookup" } }, - "size": { + "invite_chat_timeout": { "type": "integer", "format": "int32" }, - "sort": { - "type": "string" + "task_accept_timeout": { + "type": "integer", + "format": "int32" }, - "without_members": { - "type": "boolean" + "forecast_calculation": { + "$ref": "#/definitions/engineLookup" } } }, - "MemberServicePatchMemberBody": { + "engineAgentTodayStatisticsResponse": { "type": "object", "properties": { - "priority": { + "utilization": { + "type": "number", + "format": "float" + }, + "occupancy": { + "type": "number", + "format": "float" + }, + "call_abandoned": { "type": "integer", "format": "int32" }, - "expire_at": { - "type": "string", - "format": "int64" + "call_handled": { + "type": "integer", + "format": "int32" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "avg_talk_sec": { + "type": "number", + "format": "float" }, - "name": { - "type": "string" + "avg_hold_sec": { + "type": "number", + "format": "float" }, - "timezone": { - "$ref": "#/definitions/engineLookup" + "chat_accepts": { + "type": "integer", + "format": "int32" }, - "communications": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineMemberCommunicationCreateRequest" - } + "chat_aht": { + "type": "number", + "format": "float" }, - "bucket": { - "$ref": "#/definitions/engineLookup" + "call_missed": { + "type": "integer", + "format": "int32" }, - "min_offering_at": { + "call_inbound": { + "type": "integer", + "format": "int32" + }, + "score_required_avg": { + "type": "number", + "format": "float" + }, + "score_optional_avg": { + "type": "number", + "format": "float" + }, + "score_count": { "type": "string", "format": "int64" }, - "stop_cause": { - "type": "string" + "score_required_sum": { + "type": "number", + "format": "float" }, - "fields": { - "type": "array", - "items": { - "type": "string" - } + "score_optional_sum": { + "type": "number", + "format": "float" }, - "domain_id": { + "sum_talk_sec": { "type": "string", "format": "int64" }, - "agent": { - "$ref": "#/definitions/engineLookup" + "voice_mail": { + "type": "integer", + "format": "int32" }, - "skill": { - "$ref": "#/definitions/engineLookup" + "available": { + "type": "integer", + "format": "int32" }, - "attempts": { + "online": { + "type": "integer", + "format": "int32" + }, + "processing": { + "type": "integer", + "format": "int32" + }, + "task_accepts": { + "type": "integer", + "format": "int32" + }, + "queue_talk_sec": { "type": "integer", "format": "int32" } } }, - "MemberServicePatchMemberOneBody": { + "engineAgentUser": { "type": "object", "properties": { - "priority": { - "type": "integer", - "format": "int32" - }, - "expire_at": { + "id": { "type": "string", "format": "int64" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, "name": { "type": "string" + } + } + }, + "engineAggregateHistoryCallRequest": { + "type": "object", + "properties": { + "page": { + "type": "integer", + "format": "int32" }, - "timezone": { - "$ref": "#/definitions/engineLookup" + "size": { + "type": "integer", + "format": "int32" }, - "communications": { + "q": { + "type": "string" + }, + "aggs": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineMemberCommunicationCreateRequest" + "$ref": "#/definitions/engineAggregateRequest" } }, - "bucket": { - "$ref": "#/definitions/engineLookup" + "created_at": { + "$ref": "#/definitions/engineFilterBetween" }, - "min_offering_at": { - "type": "string", - "format": "int64" + "user_id": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } }, - "stop_cause": { - "type": "string" + "agent_id": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } }, - "fields": { + "queue_id": { "type": "array", "items": { - "type": "string" + "type": "string", + "format": "int64" } }, - "domain_id": { - "type": "string", - "format": "int64" - }, - "agent": { - "$ref": "#/definitions/engineLookup" - }, - "skill": { - "$ref": "#/definitions/engineLookup" - }, - "attempts": { - "type": "integer", - "format": "int32" - } - } - }, - "MemberServiceResetMembersBody": { - "type": "object", - "properties": { - "ids": { + "team_id": { "type": "array", "items": { "type": "string", "format": "int64" } }, - "id": { + "member_id": { "type": "array", "items": { "type": "string", "format": "int64" } }, - "bucket_id": { + "gateway_id": { "type": "array", "items": { "type": "string", "format": "int64" } }, - "stop_cause": { + "duration": { + "$ref": "#/definitions/engineFilterBetween" + }, + "skip_parent": { + "type": "boolean", + "format": "boolean" + }, + "parent_id": { + "type": "string" + }, + "cause": { "type": "array", "items": { "type": "string" } }, - "agent_id": { + "has_file": { + "type": "boolean", + "format": "boolean" + }, + "domain_id": { + "type": "string", + "format": "int64" + }, + "number": { + "type": "string" + }, + "direction": { + "type": "string" + }, + "answered_at": { + "$ref": "#/definitions/engineFilterBetween" + }, + "missed": { + "type": "boolean", + "format": "boolean" + }, + "stored_at": { + "$ref": "#/definitions/engineFilterBetween" + }, + "id": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "type": "string" } }, - "numbers": { + "transfer_from": { "type": "array", "items": { "type": "string" } }, - "variables": { - "type": "object", - "additionalProperties": { + "transfer_to": { + "type": "array", + "items": { "type": "string" } - } - } - }, - "MemberServiceUpdateMemberBody": { - "type": "object", - "properties": { - "priority": { - "type": "integer", - "format": "int32" }, - "expire_at": { - "type": "string", - "format": "int64" + "dependency_id": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } }, "variables": { "type": "object", @@ -15500,205 +15505,169 @@ "type": "string" } }, - "name": { - "type": "string" - }, - "timezone": { - "$ref": "#/definitions/engineLookup" - }, - "communications": { + "amd_result": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineMemberCommunicationCreateRequest" + "type": "string" } }, - "bucket": { - "$ref": "#/definitions/engineLookup" - }, - "min_offering_at": { - "type": "string", - "format": "int64" - }, - "stop_cause": { + "fts": { "type": "string" }, - "domain_id": { - "type": "string", - "format": "int64" - }, - "agent": { - "$ref": "#/definitions/engineLookup" - }, - "skill": { - "$ref": "#/definitions/engineLookup" - } - } - }, - "OutboundResourceGroupServiceCreateOutboundResourceInGroupBody": { - "type": "object", - "properties": { - "resource": { - "$ref": "#/definitions/engineLookup" - }, - "reserve_resource": { - "$ref": "#/definitions/engineLookup" - }, - "priority": { - "type": "integer", - "format": "int64" - } - } - }, - "OutboundResourceGroupServiceUpdateOutboundResourceGroupBody": { - "type": "object", - "properties": { - "name": { - "type": "string" + "directions": { + "type": "array", + "items": { + "type": "string" + } }, - "strategy": { - "type": "string" + "has_transcript": { + "type": "boolean", + "format": "boolean" }, - "description": { + "agent_description": { "type": "string" }, - "communication": { - "$ref": "#/definitions/engineLookup" - }, - "time": { + "contact_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineOutboundResourceTimeRange" + "type": "string", + "format": "int64" } - }, - "domain_id": { - "type": "string", - "format": "int64" } } }, - "OutboundResourceGroupServiceUpdateOutboundResourceInGroupBody": { - "type": "object", - "properties": { - "resource": { - "$ref": "#/definitions/engineLookup" - }, - "reserve_resource": { - "$ref": "#/definitions/engineLookup" - }, - "priority": { - "type": "integer", - "format": "int64" - } - } - }, - "OutboundResourceServiceCreateOutboundResourceDisplayBody": { + "engineAggregateRequest": { "type": "object", "properties": { - "display": { + "name": { "type": "string" }, - "domain_id": { - "type": "string", - "format": "int64" - } - } - }, - "OutboundResourceServiceCreateOutboundResourceDisplayBulkBody": { - "type": "object", - "properties": { - "items": { + "group": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineCreateOutboundResourceDisplayRequest" + "$ref": "#/definitions/AggregateRequestGroup" } - } - } - }, - "OutboundResourceServicePatchOutboundResourceBody": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "format": "int32" - }, - "enabled": { - "type": "boolean" - }, - "rps": { - "type": "integer", - "format": "int32" - }, - "reserve": { - "type": "boolean" }, - "variables": { - "type": "object", - "additionalProperties": { + "min": { + "type": "array", + "items": { "type": "string" } }, - "number": { - "type": "string" - }, - "max_successively_errors": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string" - }, - "error_ids": { + "max": { "type": "array", "items": { "type": "string" } }, - "fields": { + "sum": { "type": "array", "items": { "type": "string" } }, - "gateway": { - "$ref": "#/definitions/engineLookup" + "avg": { + "type": "array", + "items": { + "type": "string" + } }, - "description": { - "type": "string" + "count": { + "type": "array", + "items": { + "type": "string" + } }, - "patterns": { + "sort": { "type": "array", "items": { "type": "string" } }, - "failure_dial_delay": { + "limit": { "type": "integer", - "format": "int64" - }, - "parameters": { - "$ref": "#/definitions/engineOutboundResourceParameters" + "format": "int32" } } }, - "OutboundResourceServiceUpdateOutboundResourceBody": { + "engineAggregateResult": { "type": "object", "properties": { - "limit": { - "type": "integer", - "format": "int32" - }, - "enabled": { - "type": "boolean" + "name": { + "type": "string" }, - "rps": { + "data": { + "type": "object" + } + } + }, + "engineApiError": { + "type": "object", + "properties": { + "code": { "type": "integer", "format": "int32" }, - "reserve": { - "type": "boolean" + "detail": { + "type": "string" + }, + "id": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "engineAttempt": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "int64" + }, + "state": { + "type": "string" + }, + "last_state_change": { + "type": "string", + "format": "int64" + }, + "joined_at": { + "type": "string", + "format": "int64" + }, + "offering_at": { + "type": "string", + "format": "int64" + }, + "bridged_at": { + "type": "string", + "format": "int64" + }, + "reporting_at": { + "type": "string", + "format": "int64" + }, + "timeout": { + "type": "string", + "format": "int64" + }, + "leaving_at": { + "type": "string", + "format": "int64" + }, + "channel": { + "type": "string" + }, + "queue": { + "$ref": "#/definitions/engineLookup" + }, + "member": { + "$ref": "#/definitions/engineLookup" + }, + "member_call_id": { + "type": "string" }, "variables": { "type": "object", @@ -15706,249 +15675,390 @@ "type": "string" } }, - "number": { + "agent": { + "$ref": "#/definitions/engineLookup" + }, + "agent_call_id": { "type": "string" }, - "max_successively_errors": { + "position": { "type": "integer", "format": "int32" }, - "name": { - "type": "string" + "resource": { + "$ref": "#/definitions/engineLookup" }, - "error_ids": { - "type": "array", - "items": { - "type": "string" - } + "bucket": { + "$ref": "#/definitions/engineLookup" }, - "gateway": { + "list": { "$ref": "#/definitions/engineLookup" }, - "description": { + "display": { "type": "string" }, - "patterns": { - "type": "array", - "items": { - "type": "string" - } + "destination": { + "$ref": "#/definitions/engineMemberCommunication" }, - "failure_dial_delay": { - "type": "integer", - "format": "int64" + "result": { + "type": "string" }, - "parameters": { - "$ref": "#/definitions/engineOutboundResourceParameters" + "attempts": { + "type": "integer", + "format": "int32" } } }, - "OutboundResourceServiceUpdateOutboundResourceDisplayBody": { + "engineAttemptCallbackRequest": { "type": "object", "properties": { - "display": { + "attempt_id": { + "type": "string", + "format": "int64" + }, + "status": { "type": "string" }, - "domain_id": { + "min_offering_at": { "type": "string", "format": "int64" - } - } - }, - "PresetQueryServicePatchPresetQueryBody": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { + }, + "expire_at": { + "type": "string", + "format": "int64" + }, + "variables": { + "type": "object", + "additionalProperties": { "type": "string" } }, - "name": { - "type": "string" + "display": { + "type": "boolean", + "format": "boolean" }, "description": { "type": "string" }, - "preset": {}, - "section": { - "$ref": "#/definitions/enginePresetQuerySection" + "agent_id": { + "type": "integer", + "format": "int32" + }, + "exclude_current_communication": { + "type": "boolean", + "format": "boolean" + }, + "wait_between_retries": { + "type": "integer", + "format": "int32" + }, + "only_current_communication": { + "type": "boolean", + "format": "boolean" } } }, - "PresetQueryServiceUpdatePresetQueryBody": { + "engineAttemptHistory": { "type": "object", "properties": { - "name": { + "id": { + "type": "string", + "format": "int64" + }, + "joined_at": { + "type": "string", + "format": "int64" + }, + "offering_at": { + "type": "string", + "format": "int64" + }, + "bridged_at": { + "type": "string", + "format": "int64" + }, + "reporting_at": { + "type": "string", + "format": "int64" + }, + "leaving_at": { + "type": "string", + "format": "int64" + }, + "channel": { "type": "string" }, - "description": { + "queue": { + "$ref": "#/definitions/engineLookup" + }, + "member": { + "$ref": "#/definitions/engineLookup" + }, + "member_call_id": { "type": "string" }, - "preset": {}, - "section": { - "$ref": "#/definitions/enginePresetQuerySection" - } - } - }, - "QuestionOption": { - "type": "object", - "properties": { - "name": { + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "agent": { + "$ref": "#/definitions/engineLookup" + }, + "agent_call_id": { "type": "string" }, - "score": { - "type": "number", - "format": "float" - } - } - }, - "QueueBucketServiceCreateQueueBucketBody": { - "type": "object", - "properties": { - "ratio": { + "position": { "type": "integer", "format": "int32" }, + "resource": { + "$ref": "#/definitions/engineLookup" + }, "bucket": { "$ref": "#/definitions/engineLookup" }, - "disabled": { - "type": "boolean" + "list": { + "$ref": "#/definitions/engineLookup" }, - "priority": { + "display": { + "type": "string" + }, + "destination": { + "$ref": "#/definitions/engineMemberCommunication" + }, + "result": { + "type": "string" + }, + "amd_result": { + "type": "string" + }, + "attempts": { "type": "integer", "format": "int32" } } }, - "QueueBucketServicePatchQueueBucketBody": { + "engineAttemptRenewalResultRequest": { "type": "object", "properties": { - "ratio": { - "type": "integer", - "format": "int32" - }, - "bucket": { - "$ref": "#/definitions/engineLookup" - }, - "disabled": { - "type": "boolean" + "attempt_id": { + "type": "string", + "format": "int64" }, - "priority": { + "renewal": { "type": "integer", - "format": "int32" - }, - "fields": { - "type": "array", - "items": { - "type": "string" - } + "format": "int64" } } }, - "QueueBucketServiceUpdateQueueBucketBody": { + "engineAttemptRenewalResultResponse": { + "type": "object" + }, + "engineAttemptResultRequest": { "type": "object", "properties": { - "ratio": { + "queue_id": { "type": "integer", "format": "int32" }, - "bucket": { - "$ref": "#/definitions/engineLookup" + "member_id": { + "type": "string", + "format": "int64" }, - "disabled": { - "type": "boolean" + "attempt_id": { + "type": "string", + "format": "int64" }, - "priority": { + "status": { + "type": "string" + }, + "min_offering_at": { + "type": "string", + "format": "int64" + }, + "expire_at": { + "type": "string", + "format": "int64" + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "display": { + "type": "boolean", + "format": "boolean" + }, + "description": { + "type": "string" + }, + "transfer_queue_id": { + "type": "string", + "format": "int64" + }, + "next_member_id": { + "type": "string", + "format": "int64" + }, + "agent_id": { + "type": "integer", + "format": "int32" + }, + "exclude_current_communication": { + "type": "boolean", + "format": "boolean" + }, + "wait_between_retries": { "type": "integer", "format": "int32" + }, + "only_current_communication": { + "type": "boolean", + "format": "boolean" } } }, - "QueueHookServiceCreateQueueHookBody": { + "engineAttemptResultResponse": { "type": "object", "properties": { - "schema": { - "$ref": "#/definitions/engineLookup" - }, - "event": { + "status": { "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "properties": { - "type": "array", - "items": { - "type": "string" - } } } }, - "QueueHookServicePatchQueueHookBody": { + "engineAuditForm": { "type": "object", "properties": { - "fields": { - "type": "array", - "items": { - "type": "string" - } + "id": { + "type": "integer", + "format": "int32" }, - "schema": { + "created_at": { + "type": "string", + "format": "int64" + }, + "created_by": { "$ref": "#/definitions/engineLookup" }, - "event": { + "updated_at": { + "type": "string", + "format": "int64" + }, + "updated_by": { + "$ref": "#/definitions/engineLookup" + }, + "name": { + "type": "string" + }, + "description": { "type": "string" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, - "properties": { + "questions": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineQuestion" + } + }, + "teams": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" } + }, + "editable": { + "type": "boolean", + "format": "boolean", + "title": "bool archive = 11;" } } }, - "QueueHookServiceUpdateQueueHookBody": { + "engineAuditQuestionType": { + "type": "string", + "enum": [ + "question_default", + "question_score", + "question_option" + ], + "default": "question_default" + }, + "engineAuditRate": { "type": "object", "properties": { - "schema": { + "id": { + "type": "string", + "format": "int64" + }, + "created_at": { + "type": "string", + "format": "int64" + }, + "created_by": { "$ref": "#/definitions/engineLookup" }, - "event": { - "type": "string" + "updated_at": { + "type": "string", + "format": "int64" }, - "enabled": { - "type": "boolean" + "updated_by": { + "$ref": "#/definitions/engineLookup" }, - "properties": { + "form": { + "$ref": "#/definitions/engineLookup" + }, + "questions": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineQuestion" } + }, + "answers": { + "type": "array", + "items": { + "$ref": "#/definitions/engineQuestionAnswer" + } + }, + "score_required": { + "type": "number", + "format": "float" + }, + "score_optional": { + "type": "number", + "format": "float" + }, + "comment": { + "type": "string" + }, + "rated_user": { + "$ref": "#/definitions/engineLookup" } } }, - "QueueResourcesServiceCreateQueueResourceGroupBody": { + "engineAvailableSystemSetting": { "type": "object", "properties": { - "resource_group": { - "$ref": "#/definitions/engineLookup" - }, - "domain_id": { - "type": "string", - "format": "int64" + "name": { + "type": "string" } } }, - "QueueResourcesServiceUpdateQueueResourceGroupBody": { + "engineBlindTransferCallRequest": { "type": "object", "properties": { - "resource_group": { - "$ref": "#/definitions/engineLookup" + "id": { + "type": "string" + }, + "app_id": { + "type": "string" + }, + "destination": { + "type": "string" }, "domain_id": { "type": "string", @@ -15956,343 +16066,259 @@ } } }, - "QueueServicePatchQueueBody": { + "engineBlindTransferCallResponse": { + "type": "object" + }, + "engineBroadcastButton": { "type": "object", "properties": { - "strategy": { + "caption": { "type": "string" }, - "enabled": { - "type": "boolean" - }, - "payload": {}, - "calendar": { - "$ref": "#/definitions/engineLookup" - }, - "priority": { - "type": "integer", - "format": "int32" - }, - "name": { + "text": { "type": "string" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "timeout": { - "type": "integer", - "format": "int32" - }, - "dnc_list": { - "$ref": "#/definitions/engineLookup" - }, - "sec_locate_agent": { - "type": "integer", - "format": "int32" - }, "type": { - "type": "integer", - "format": "int32" - }, - "team": { - "$ref": "#/definitions/engineLookup" - }, - "description": { "type": "string" }, - "schema": { - "$ref": "#/definitions/engineLookup" - }, - "ringtone": { - "$ref": "#/definitions/engineLookup" + "url": { + "type": "string" }, - "fields": { + "code": { + "type": "string" + } + } + }, + "engineBroadcastButtons": { + "type": "object", + "properties": { + "button": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineBroadcastButton" } - }, - "domain_id": { + } + } + }, + "engineBroadcastFile": { + "type": "object", + "properties": { + "id": { "type": "string", "format": "int64" }, - "do_schema": { - "$ref": "#/definitions/engineLookup" + "url": { + "type": "string" }, - "after_schema": { - "$ref": "#/definitions/engineLookup" - }, - "sticky_agent": { - "type": "boolean" - }, - "processing": { - "type": "boolean", - "title": "deprecated" + "mime": { + "type": "string" }, - "processing_sec": { - "type": "integer", - "format": "int64", - "title": "deprecated" + "name": { + "type": "string" }, - "processing_renewal_sec": { - "type": "integer", - "format": "int64", - "title": "deprecated" + "size": { + "type": "string", + "format": "int64" + } + }, + "description": "Media File." + }, + "engineBroadcastRequest": { + "type": "object", + "properties": { + "profile_id": { + "type": "string", + "format": "int64" }, - "form_schema": { - "$ref": "#/definitions/engineLookup", - "title": "deprecated" + "peer": { + "type": "array", + "items": { + "type": "string" + } }, - "task_processing": { - "$ref": "#/definitions/engineTaskProcessing" + "text": { + "type": "string" }, - "grantee": { - "$ref": "#/definitions/engineLookup" + "file": { + "$ref": "#/definitions/engineBroadcastFile", + "description": "Message Media. Attachment." }, - "tags": { + "buttons": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineTag" + "$ref": "#/definitions/engineBroadcastButtons" } } } }, - "QueueServiceUpdateQueueBody": { + "engineBroadcastResponse": { + "type": "object" + }, + "engineBucket": { "type": "object", "properties": { - "strategy": { - "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "payload": {}, - "calendar": { - "$ref": "#/definitions/engineLookup" - }, - "priority": { - "type": "integer", - "format": "int32" + "id": { + "type": "string", + "format": "int64" }, "name": { "type": "string" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "timeout": { - "type": "integer", - "format": "int32" - }, - "dnc_list": { - "$ref": "#/definitions/engineLookup" - }, - "sec_locate_agent": { - "type": "integer", - "format": "int32" - }, - "type": { - "type": "integer", - "format": "int32" - }, - "team": { - "$ref": "#/definitions/engineLookup" - }, "description": { "type": "string" - }, - "schema": { - "$ref": "#/definitions/engineLookup" - }, - "ringtone": { - "$ref": "#/definitions/engineLookup" + } + } + }, + "engineCalendar": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "int64" }, "domain_id": { "type": "string", "format": "int64" }, - "do_schema": { - "$ref": "#/definitions/engineLookup" + "created_at": { + "type": "string", + "format": "int64" }, - "after_schema": { + "created_by": { "$ref": "#/definitions/engineLookup" }, - "sticky_agent": { - "type": "boolean" - }, - "processing": { - "type": "boolean", - "title": "deprecated" + "updated_at": { + "type": "string", + "format": "int64" }, - "processing_sec": { - "type": "integer", - "format": "int64", - "title": "deprecated" + "updated_by": { + "$ref": "#/definitions/engineLookup" }, - "processing_renewal_sec": { - "type": "integer", - "format": "int64", - "title": "deprecated" + "name": { + "type": "string" }, - "form_schema": { - "$ref": "#/definitions/engineLookup", - "title": "deprecated" + "start_at": { + "type": "string", + "format": "int64" }, - "task_processing": { - "$ref": "#/definitions/engineTaskProcessing" + "end_at": { + "type": "string", + "format": "int64" }, - "grantee": { + "timezone": { "$ref": "#/definitions/engineLookup" }, - "tags": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineTag" - } - } - } - }, - "QueueSkillServiceCreateQueueSkillBody": { - "type": "object", - "properties": { - "skill": { - "$ref": "#/definitions/engineLookup" + "description": { + "type": "string" }, - "buckets": { + "accepts": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "$ref": "#/definitions/engineAcceptOfDay" } }, - "lvl": { - "type": "integer", - "format": "int32" - }, - "min_capacity": { - "type": "integer", - "format": "int32" - }, - "max_capacity": { - "type": "integer", - "format": "int32" - }, - "enabled": { - "type": "boolean" - } - } - }, - "QueueSkillServicePatchQueueSkillBody": { - "type": "object", - "properties": { - "skill": { - "$ref": "#/definitions/engineLookup" - }, - "buckets": { + "excepts": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "$ref": "#/definitions/engineExceptDate" } }, - "lvl": { - "type": "integer", - "format": "int32" - }, - "min_capacity": { - "type": "integer", - "format": "int32" - }, - "max_capacity": { - "type": "integer", - "format": "int32" - }, - "enabled": { - "type": "boolean" - }, - "fields": { + "specials": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineAcceptOfDay" } } } }, - "QueueSkillServiceUpdateQueueSkillBody": { + "engineCallAnnotation": { "type": "object", "properties": { - "skill": { + "id": { + "type": "string", + "format": "int64" + }, + "call_id": { + "type": "string" + }, + "created_by": { "$ref": "#/definitions/engineLookup" }, - "buckets": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } + "created_at": { + "type": "string", + "format": "int64" }, - "lvl": { - "type": "integer", - "format": "int32" + "updated_by": { + "$ref": "#/definitions/engineLookup" }, - "min_capacity": { + "updated_at": { + "type": "string", + "format": "int64" + }, + "note": { + "type": "string" + }, + "start_sec": { "type": "integer", "format": "int32" }, - "max_capacity": { + "end_sec": { "type": "integer", "format": "int32" - }, - "enabled": { - "type": "boolean" } } }, - "RegionServicePatchRegionBody": { + "engineCallFile": { "type": "object", "properties": { - "fields": { - "type": "array", - "items": { - "type": "string" - } + "id": { + "type": "string", + "format": "int64" }, "name": { "type": "string" }, - "description": { + "size": { + "type": "string", + "format": "int64" + }, + "mime_type": { "type": "string" }, - "timezone": { - "$ref": "#/definitions/engineLookup" + "start_at": { + "type": "string", + "format": "int64" + }, + "stop_at": { + "type": "string", + "format": "int64" } } }, - "RegionServiceUpdateRegionBody": { + "engineCallHold": { "type": "object", "properties": { - "name": { - "type": "string" + "start": { + "type": "string", + "format": "int64" }, - "description": { - "type": "string" + "stop": { + "type": "string", + "format": "int64" }, - "timezone": { - "$ref": "#/definitions/engineLookup" + "sec": { + "type": "number", + "format": "float" } } }, - "RoutingChatPlanServicePatchChatPlanBody": { + "engineChatPlan": { "type": "object", "properties": { + "id": { + "type": "integer", + "format": "int32" + }, "name": { "type": "string" }, @@ -16303,241 +16329,222 @@ "$ref": "#/definitions/engineLookup" }, "enabled": { - "type": "boolean" - }, - "fields": { - "type": "array", - "items": { - "type": "string" - } + "type": "boolean", + "format": "boolean" } } }, - "RoutingChatPlanServiceUpdateChatPlanBody": { + "engineCommunicationChannels": { + "type": "string", + "enum": [ + "Undefined", + "Phone", + "Email", + "Messaging" + ], + "default": "Undefined" + }, + "engineCommunicationType": { "type": "object", "properties": { + "id": { + "type": "string", + "format": "int64" + }, + "domain_id": { + "type": "string", + "format": "int64" + }, "name": { "type": "string" }, - "description": { + "code": { "type": "string" }, - "schema": { - "$ref": "#/definitions/engineLookup" + "channel": { + "$ref": "#/definitions/engineCommunicationChannels" }, - "enabled": { - "type": "boolean" - } - } - }, - "RoutingOutboundCallServiceMovePositionRoutingOutboundCallBody": { - "type": "object", - "properties": { - "domain_id": { - "type": "string", - "format": "int64" + "description": { + "type": "string" + }, + "default": { + "type": "boolean", + "format": "boolean" } } }, - "RoutingOutboundCallServicePatchRoutingOutboundCallBody": { + "engineCommunicationTypeRequest": { "type": "object", "properties": { "name": { "type": "string" }, - "description": { + "code": { "type": "string" }, - "schema": { - "$ref": "#/definitions/engineLookup" + "channel": { + "$ref": "#/definitions/engineCommunicationChannels" }, - "pattern": { + "description": { "type": "string" }, - "disabled": { - "type": "boolean" - }, - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "domain_id": { - "type": "string", - "format": "int64" + "default": { + "type": "boolean", + "format": "boolean" } } }, - "RoutingOutboundCallServiceUpdateRoutingOutboundCallBody": { + "engineConfirmPushResponse": { + "type": "object" + }, + "engineCreateAgentPauseCauseRequest": { "type": "object", "properties": { "name": { "type": "string" }, - "description": { - "type": "string" + "limit_min": { + "type": "integer", + "format": "int64" }, - "schema": { - "$ref": "#/definitions/engineLookup" + "allow_supervisor": { + "type": "boolean", + "format": "boolean" }, - "pattern": { - "type": "string" + "allow_agent": { + "type": "boolean", + "format": "boolean" }, - "disabled": { - "type": "boolean" + "allow_admin": { + "type": "boolean", + "format": "boolean" }, - "domain_id": { - "type": "string", - "format": "int64" + "description": { + "type": "string" } } }, - "RoutingSchemaServicePatchRoutingSchemaBody": { + "engineCreateAgentRequest": { "type": "object", "properties": { - "name": { - "type": "string" + "user": { + "$ref": "#/definitions/engineLookup" }, "description": { "type": "string" }, - "type": { - "$ref": "#/definitions/engineRoutingSchemaType" + "progressive_count": { + "type": "integer", + "format": "int32" }, - "schema": {}, - "payload": {}, - "debug": { - "type": "boolean" + "greeting_media": { + "$ref": "#/definitions/engineLookup" }, - "fields": { + "domain_id": { + "type": "string", + "format": "int64" + }, + "allow_channels": { "type": "array", "items": { "type": "string" } }, - "editor": { - "type": "boolean" + "chat_count": { + "type": "integer", + "format": "int64" }, - "tags": { + "supervisor": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineSchemaTag" + "$ref": "#/definitions/engineLookup" } }, - "note": { - "type": "string" - } - } - }, - "RoutingSchemaServiceUpdateRoutingSchemaBody": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "type": { - "$ref": "#/definitions/engineRoutingSchemaType" - }, - "schema": {}, - "payload": {}, - "debug": { - "type": "boolean" + "team": { + "$ref": "#/definitions/engineLookup" }, - "editor": { - "type": "boolean" + "region": { + "$ref": "#/definitions/engineLookup" }, - "tags": { + "auditor": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineSchemaTag" + "$ref": "#/definitions/engineLookup" } }, - "note": { - "type": "string" + "is_supervisor": { + "type": "boolean", + "format": "boolean" + }, + "task_count": { + "type": "integer", + "format": "int64" } } }, - "RoutingVariableServiceUpdateRoutingVariableBody": { + "engineCreateAgentSkillBulkItem": { "type": "object", "properties": { - "key": { - "type": "string" + "skill": { + "$ref": "#/definitions/engineLookup" }, - "value": { - "type": "string" + "capacity": { + "type": "integer", + "format": "int32" }, "domain_id": { "type": "string", "format": "int64" - } - } - }, - "SchemaVariablesServicePatchSchemaVariableBody": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "name": { - "type": "string" }, - "value": {}, - "encrypt": { - "type": "boolean" + "enabled": { + "type": "boolean", + "format": "boolean" } } }, - "SchemaVariablesServiceUpdateSchemaVariableBody": { + "engineCreateAgentSkillRequest": { "type": "object", "properties": { - "name": { - "type": "string" + "agent_id": { + "type": "string", + "format": "int64" }, - "value": {}, - "encrypt": { - "type": "boolean" - } - } - }, - "SkillServiceCreateSkillAgentBody": { - "type": "object", - "properties": { - "agent": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } + "skill": { + "$ref": "#/definitions/engineLookup" }, "capacity": { "type": "integer", "format": "int32" }, + "domain_id": { + "type": "string", + "format": "int64" + }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" } } }, - "SkillServiceDeleteSkillAgentBody": { + "engineCreateAgentSkillsRequest": { "type": "object", "properties": { - "id": { + "agent_id": { + "type": "string", + "format": "int64" + }, + "items": { "type": "array", "items": { - "type": "string", - "format": "int64" + "$ref": "#/definitions/engineCreateAgentSkillBulkItem" } - }, - "agent_id": { + } + } + }, + "engineCreateAgentSkillsResponse": { + "type": "object", + "properties": { + "ids": { "type": "array", "items": { "type": "string", @@ -16546,49 +16553,71 @@ } } }, - "SkillServicePatchSkillAgentBody": { + "engineCreateAgentTeamRequest": { "type": "object", "properties": { - "fields": { - "type": "array", - "items": { - "type": "string" - } + "name": { + "type": "string" }, - "skill": { - "$ref": "#/definitions/engineLookup" + "description": { + "type": "string" }, - "capacity": { - "type": "integer", + "strategy": { + "type": "string" + }, + "max_no_answer": { + "type": "integer", "format": "int32" }, - "enabled": { - "type": "boolean" + "no_answer_delay_time": { + "type": "integer", + "format": "int32" }, - "id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "wrap_up_time": { + "type": "integer", + "format": "int32" }, - "agent_id": { + "call_timeout": { + "type": "integer", + "format": "int32" + }, + "admin": { "type": "array", "items": { - "type": "string", - "format": "int64" + "$ref": "#/definitions/engineLookup" } + }, + "domain_id": { + "type": "string", + "format": "int64" + }, + "invite_chat_timeout": { + "type": "integer", + "format": "int32" + }, + "task_accept_timeout": { + "type": "integer", + "format": "int32" + }, + "forecast_calculation": { + "$ref": "#/definitions/engineLookup" } } }, - "SkillServiceUpdateSkillBody": { + "engineCreateAttemptRequest": { "type": "object", "properties": { - "name": { - "type": "string" + "queue_id": { + "type": "string", + "format": "int64" }, - "description": { - "type": "string" + "member_id": { + "type": "string", + "format": "int64" + }, + "agent_id": { + "type": "string", + "format": "int64" }, "domain_id": { "type": "string", @@ -16596,500 +16625,635 @@ } } }, - "SystemSettingServicePatchSystemSettingBody": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "value": {} - } - }, - "SystemSettingServiceUpdateSystemSettingBody": { + "engineCreateAttemptResponse": { "type": "object", "properties": { - "value": {} + "attempt_id": { + "type": "string", + "format": "int64" + } } }, - "TeamHookServiceCreateTeamHookBody": { + "engineCreateAuditFormRateRequest": { "type": "object", "properties": { - "schema": { + "form": { "$ref": "#/definitions/engineLookup" }, - "event": { - "$ref": "#/definitions/engineTeamHookEvent" - }, - "enabled": { - "type": "boolean" - }, - "properties": { + "answers": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineQuestionAnswer" } + }, + "comment": { + "type": "string" + }, + "call_id": { + "type": "string" } } }, - "TeamHookServicePatchTeamHookBody": { + "engineCreateAuditFormRequest": { "type": "object", "properties": { - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/engineLookup" + "name": { + "type": "string" }, - "event": { - "$ref": "#/definitions/engineTeamHookEvent" + "description": { + "type": "string" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, - "properties": { + "questions": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineQuestion" } - } - } - }, - "TeamHookServiceUpdateTeamHookBody": { - "type": "object", - "properties": { - "schema": { - "$ref": "#/definitions/engineLookup" - }, - "event": { - "$ref": "#/definitions/engineTeamHookEvent" - }, - "enabled": { - "type": "boolean" }, - "properties": { + "teams": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineLookup" } } } }, - "TeamTriggerServiceCreateTeamTriggerBody": { + "engineCreateBucketRequest": { "type": "object", "properties": { - "schema": { - "$ref": "#/definitions/engineLookup" - }, - "enabled": { - "type": "boolean" - }, "name": { "type": "string" }, "description": { "type": "string" + }, + "domain_id": { + "type": "string", + "format": "int64" } } }, - "TeamTriggerServicePatchTeamTriggerBody": { + "engineCreateCalendarRequest": { "type": "object", "properties": { - "fields": { + "name": { + "type": "string" + }, + "start_at": { + "type": "string", + "format": "int64" + }, + "end_at": { + "type": "string", + "format": "int64" + }, + "timezone": { + "$ref": "#/definitions/engineLookup" + }, + "description": { + "type": "string" + }, + "accepts": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineAcceptOfDay" } }, - "schema": { - "$ref": "#/definitions/engineLookup" + "excepts": { + "type": "array", + "items": { + "$ref": "#/definitions/engineExceptDate" + } }, - "enabled": { - "type": "boolean" + "domain_id": { + "type": "string", + "format": "int64" }, - "name": { + "specials": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAcceptOfDay" + } + } + } + }, + "engineCreateCallAnnotationRequest": { + "type": "object", + "properties": { + "call_id": { "type": "string" }, - "description": { + "note": { "type": "string" + }, + "start_sec": { + "type": "integer", + "format": "int32" + }, + "end_sec": { + "type": "integer", + "format": "int32" } } }, - "TeamTriggerServiceRunTeamTriggerBody": { + "engineCreateCallRequest": { "type": "object", "properties": { - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "from": { + "$ref": "#/definitions/engineCreateCallRequestEndpointRequest" + }, + "to": { + "$ref": "#/definitions/engineCreateCallRequestEndpointRequest" + }, + "destination": { + "type": "string" + }, + "params": { + "$ref": "#/definitions/CreateCallRequestCallSettings" + }, + "domain_id": { + "type": "string", + "format": "int64" } } }, - "TeamTriggerServiceUpdateTeamTriggerBody": { + "engineCreateCallRequestEndpointRequest": { "type": "object", "properties": { - "schema": { - "$ref": "#/definitions/engineLookup" - }, - "enabled": { - "type": "boolean" + "app_id": { + "type": "string" }, - "name": { + "type": { "type": "string" }, - "description": { + "id": { + "type": "string", + "format": "int64" + }, + "extension": { "type": "string" } } }, - "TriggerServiceCreateTriggerJobBody": { + "engineCreateCallResponse": { "type": "object", "properties": { - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "id": { + "type": "string" } } }, - "TriggerServicePatchTriggerBody": { + "engineCreateChatPlanRequest": { "type": "object", "properties": { - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, "name": { "type": "string" }, - "enabled": { - "type": "boolean" - }, - "type": { - "$ref": "#/definitions/engineTriggerType" + "description": { + "type": "string" }, "schema": { "$ref": "#/definitions/engineLookup" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "description": { - "type": "string" - }, - "expression": { - "type": "string" - }, - "timezone": { - "$ref": "#/definitions/engineLookup" - }, - "timeout": { - "type": "integer", - "format": "int32" + "enabled": { + "type": "boolean", + "format": "boolean" } } }, - "TriggerServiceUpdateTriggerBody": { + "engineCreateEmailProfileRequest": { "type": "object", "properties": { "name": { "type": "string" }, - "enabled": { - "type": "boolean" - }, - "type": { - "$ref": "#/definitions/engineTriggerType" + "description": { + "type": "string" }, "schema": { "$ref": "#/definitions/engineLookup" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "enabled": { + "type": "boolean", + "format": "boolean" }, - "description": { + "smtp_host": { "type": "string" }, - "expression": { + "login": { "type": "string" }, - "timezone": { - "$ref": "#/definitions/engineLookup" + "password": { + "type": "string" }, - "timeout": { + "mailbox": { + "type": "string" + }, + "smtp_port": { + "type": "integer", + "format": "int32" + }, + "imap_port": { + "type": "integer", + "format": "int32" + }, + "imap_host": { + "type": "string" + }, + "fetch_interval": { "type": "integer", "format": "int32" + }, + "auth_type": { + "$ref": "#/definitions/engineEmailAuthType" + }, + "listen": { + "type": "boolean", + "format": "boolean" + }, + "params": { + "$ref": "#/definitions/engineEmailProfileParams" } } }, - "UserStatusUserPresence": { + "engineCreateListCommunicationRequest": { "type": "object", "properties": { - "status": { + "number": { + "type": "string" + }, + "description": { "type": "string" + }, + "list_id": { + "type": "string", + "format": "int64" + }, + "expire_at": { + "type": "string", + "format": "int64" } } }, - "WebHookServicePatchWebHookBody": { + "engineCreateListRequest": { "type": "object", "properties": { - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, "name": { "type": "string" }, "description": { "type": "string" }, - "origin": { - "type": "array", - "items": { - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/engineLookup" - }, - "enabled": { - "type": "boolean" - }, - "authorization": { - "type": "string" + "domain_id": { + "type": "string", + "format": "int64" } } }, - "WebHookServiceUpdateWebHookBody": { + "engineCreateMemberBulkItem": { "type": "object", "properties": { + "priority": { + "type": "integer", + "format": "int32" + }, + "expire_at": { + "type": "string", + "format": "int64" + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, "name": { "type": "string" }, - "description": { - "type": "string" + "timezone": { + "$ref": "#/definitions/engineLookup" }, - "origin": { + "communications": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineMemberCommunicationCreateRequest" } }, - "schema": { + "bucket": { "$ref": "#/definitions/engineLookup" }, - "enabled": { - "type": "boolean" + "min_offering_at": { + "type": "string", + "format": "int64" }, - "authorization": { - "type": "string" - } - } - }, - "chatBroadcastError": { - "type": "object", - "properties": { - "peer_id": { - "type": "string" + "agent": { + "$ref": "#/definitions/engineLookup" }, - "error": { - "$ref": "#/definitions/rpcStatus" + "skill": { + "$ref": "#/definitions/engineLookup" } } }, - "chatBroadcastMessageRequest": { + "engineCreateMemberBulkRequest": { "type": "object", "properties": { - "peers": { + "queue_id": { + "type": "string", + "format": "int64" + }, + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/chatInputPeer" + "$ref": "#/definitions/engineCreateMemberBulkItem" } }, - "message": { - "$ref": "#/definitions/chatInputMessage" + "file_name": { + "type": "string" } } }, - "chatBroadcastMessageResponse": { + "engineCreateMemberRequest": { "type": "object", "properties": { - "failure": { + "queue_id": { + "type": "string", + "format": "int64" + }, + "priority": { + "type": "integer", + "format": "int32" + }, + "expire_at": { + "type": "string", + "format": "int64" + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "name": { + "type": "string" + }, + "timezone": { + "$ref": "#/definitions/engineLookup" + }, + "communications": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/chatBroadcastError" + "$ref": "#/definitions/engineMemberCommunicationCreateRequest" } - } - } - }, - "chatInputButton": { - "type": "object", - "properties": { - "caption": { - "type": "string" }, - "text": { - "type": "string" + "bucket": { + "$ref": "#/definitions/engineLookup" }, - "type": { - "type": "string" + "min_offering_at": { + "type": "string", + "format": "int64" }, - "url": { - "type": "string" + "domain_id": { + "type": "string", + "format": "int64" }, - "code": { - "type": "string" + "agent": { + "$ref": "#/definitions/engineLookup" + }, + "skill": { + "$ref": "#/definitions/engineLookup" } } }, - "chatInputButtonRow": { + "engineCreateOutboundResourceDisplayBulkRequest": { "type": "object", "properties": { - "buttons": { + "resource_id": { + "type": "string", + "format": "int64" + }, + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/chatInputButton" + "$ref": "#/definitions/engineCreateOutboundResourceDisplayRequest" } } } }, - "chatInputFile": { + "engineCreateOutboundResourceDisplayRequest": { "type": "object", "properties": { - "id": { - "type": "string" + "resource_id": { + "type": "string", + "format": "int64" }, - "url": { + "display": { "type": "string" + }, + "domain_id": { + "type": "string", + "format": "int64" } } }, - "chatInputKeyboard": { + "engineCreateOutboundResourceGroupRequest": { "type": "object", "properties": { - "rows": { + "name": { + "type": "string" + }, + "strategy": { + "type": "string" + }, + "description": { + "type": "string" + }, + "communication": { + "$ref": "#/definitions/engineLookup" + }, + "time": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/chatInputButtonRow" + "$ref": "#/definitions/engineOutboundResourceTimeRange" } + }, + "domain_id": { + "type": "string", + "format": "int64" } } }, - "chatInputMessage": { + "engineCreateOutboundResourceInGroupRequest": { "type": "object", "properties": { - "text": { - "type": "string" + "group_id": { + "type": "string", + "format": "int64" }, - "file": { - "$ref": "#/definitions/chatInputFile" + "resource": { + "$ref": "#/definitions/engineLookup" + }, + "reserve_resource": { + "$ref": "#/definitions/engineLookup" }, - "keyboard": { - "$ref": "#/definitions/chatInputKeyboard" + "priority": { + "type": "integer", + "format": "int64" } } }, - "chatInputPeer": { + "engineCreateOutboundResourceRequest": { "type": "object", "properties": { - "id": { - "type": "string" - }, - "type": { - "type": "string" + "limit": { + "type": "integer", + "format": "int32" }, - "name": { - "type": "string" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "via": { - "type": "string" - } - }, - "description": "InputPeer identity." - }, - "engineAcceptOfDay": { - "type": "object", - "properties": { - "day": { + "rps": { "type": "integer", "format": "int32" }, - "start_time_of_day": { + "reserve": { + "type": "boolean", + "format": "boolean" + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "number": { + "type": "string" + }, + "max_successively_errors": { "type": "integer", "format": "int32" }, - "end_time_of_day": { + "name": { + "type": "string" + }, + "error_ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "gateway": { + "$ref": "#/definitions/engineLookup" + }, + "description": { + "type": "string" + }, + "patterns": { + "type": "array", + "items": { + "type": "string" + } + }, + "failure_dial_delay": { "type": "integer", - "format": "int32" + "format": "int64" }, - "disabled": { - "type": "boolean" + "parameters": { + "$ref": "#/definitions/engineOutboundResourceParameters" } } }, - "engineActiveCall": { + "engineCreatePresetQueryRequest": { "type": "object", "properties": { - "id": { + "name": { "type": "string" }, - "app_id": { + "description": { "type": "string" }, - "state": { - "type": "string" + "preset": { + "type": "object" }, - "timestamp": { + "section": { + "$ref": "#/definitions/enginePresetQuerySection" + } + } + }, + "engineCreateQueueBucketRequest": { + "type": "object", + "properties": { + "queue_id": { "type": "string", "format": "int64" }, - "type": { - "type": "string" - }, - "parent_id": { - "type": "string" + "ratio": { + "type": "integer", + "format": "int32" }, - "user": { + "bucket": { "$ref": "#/definitions/engineLookup" }, - "extension": { - "type": "string" + "disabled": { + "type": "boolean", + "format": "boolean" }, - "gateway": { + "priority": { + "type": "integer", + "format": "int32" + } + } + }, + "engineCreateQueueHookRequest": { + "type": "object", + "properties": { + "queue_id": { + "type": "integer", + "format": "int64" + }, + "schema": { "$ref": "#/definitions/engineLookup" }, - "direction": { + "event": { "type": "string" }, - "destination": { + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "properties": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "engineCreateQueueRequest": { + "type": "object", + "properties": { + "strategy": { "type": "string" }, - "from": { - "$ref": "#/definitions/engineEndpoint" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "to": { - "$ref": "#/definitions/engineEndpoint" + "payload": { + "type": "object" + }, + "calendar": { + "$ref": "#/definitions/engineLookup" + }, + "priority": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string" }, "variables": { "type": "object", @@ -17097,508 +17261,656 @@ "type": "string" } }, - "created_at": { - "type": "string", - "format": "int64" - }, - "answered_at": { - "type": "string", - "format": "int64" - }, - "bridged_at": { - "type": "string", - "format": "int64" - }, - "duration": { + "timeout": { "type": "integer", "format": "int32" }, - "hold_sec": { - "type": "integer", - "format": "int32" + "dnc_list": { + "$ref": "#/definitions/engineLookup" }, - "wait_sec": { + "sec_locate_agent": { "type": "integer", "format": "int32" }, - "bill_sec": { + "type": { "type": "integer", "format": "int32" }, - "queue": { + "team": { "$ref": "#/definitions/engineLookup" }, - "member": { - "$ref": "#/definitions/engineLookup" + "description": { + "type": "string" }, - "team": { + "schema": { "$ref": "#/definitions/engineLookup" }, - "agent": { + "ringtone": { "$ref": "#/definitions/engineLookup" }, - "joined_at": { + "domain_id": { "type": "string", "format": "int64" }, - "leaving_at": { - "type": "string", - "format": "int64" + "do_schema": { + "$ref": "#/definitions/engineLookup" }, - "reporting_at": { - "type": "string", - "format": "int64" + "after_schema": { + "$ref": "#/definitions/engineLookup" }, - "queue_bridged_at": { - "type": "string", - "format": "int64" + "sticky_agent": { + "type": "boolean", + "format": "boolean" }, - "queue_wait_sec": { - "type": "integer", - "format": "int32" + "processing": { + "type": "boolean", + "format": "boolean" }, - "queue_duration_sec": { + "processing_sec": { "type": "integer", - "format": "int32" + "format": "int64" }, - "reporting_sec": { + "processing_renewal_sec": { "type": "integer", - "format": "int32" + "format": "int64" }, - "display": { - "type": "string" + "form_schema": { + "$ref": "#/definitions/engineLookup" }, - "supervisor": { + "task_processing": { + "$ref": "#/definitions/engineTaskProcessing" + }, + "grantee": { + "$ref": "#/definitions/engineLookup" + }, + "tags": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "$ref": "#/definitions/engineTag" } + } + } + }, + "engineCreateQueueResourceGroupRequest": { + "type": "object", + "properties": { + "queue_id": { + "type": "string", + "format": "int64" }, - "blind_transfer": { - "type": "string" + "resource_group": { + "$ref": "#/definitions/engineLookup" }, - "bridged_id": { - "type": "string" + "domain_id": { + "type": "string", + "format": "int64" } } }, - "engineActivityWorkspaceWidgetResponse": { + "engineCreateQueueSkillRequest": { "type": "object", "properties": { - "utilization": { - "type": "number", - "format": "float" + "queue_id": { + "type": "integer", + "format": "int64" }, - "occupancy": { - "type": "number", - "format": "float" + "skill": { + "$ref": "#/definitions/engineLookup" }, - "call_abandoned": { + "buckets": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } + }, + "lvl": { "type": "integer", "format": "int32" }, - "call_handled": { + "min_capacity": { "type": "integer", "format": "int32" }, - "avg_talk_sec": { - "type": "number", - "format": "float" - }, - "avg_hold_sec": { - "type": "number", - "format": "float" - }, - "chat_accepts": { + "max_capacity": { "type": "integer", "format": "int32" }, - "chat_aht": { - "type": "number", - "format": "float" + "enabled": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineCreateQuickReplyRequest": { + "type": "object", + "properties": { + "name": { + "type": "string" }, - "call_missed": { - "type": "integer", - "format": "int32" + "text": { + "type": "string" }, - "call_inbound": { - "type": "integer", - "format": "int32" + "queue": { + "$ref": "#/definitions/engineLookup" }, - "score_required_avg": { - "type": "number", - "format": "float" + "team": { + "$ref": "#/definitions/engineLookup" }, - "score_optional_avg": { - "type": "number", - "format": "float" + "article": { + "$ref": "#/definitions/engineLookup" + } + } + }, + "engineCreateRegionRequest": { + "type": "object", + "properties": { + "name": { + "type": "string" }, - "score_count": { - "type": "string", - "format": "int64" + "description": { + "type": "string" }, - "score_required_sum": { - "type": "number", - "format": "float" + "timezone": { + "$ref": "#/definitions/engineLookup" + } + } + }, + "engineCreateRoutingOutboundCallRequest": { + "type": "object", + "properties": { + "name": { + "type": "string" }, - "score_optional_sum": { - "type": "number", - "format": "float" + "description": { + "type": "string" }, - "sum_talk_sec": { + "schema": { + "$ref": "#/definitions/engineLookup" + }, + "pattern": { + "type": "string" + }, + "disabled": { + "type": "boolean", + "format": "boolean" + }, + "domain_id": { "type": "string", "format": "int64" + } + } + }, + "engineCreateRoutingSchemaRequest": { + "type": "object", + "properties": { + "name": { + "type": "string" }, - "voice_mail": { - "type": "integer", - "format": "int32" + "description": { + "type": "string" }, - "available": { - "type": "integer", - "format": "int32" + "type": { + "$ref": "#/definitions/engineRoutingSchemaType" }, - "online": { - "type": "integer", - "format": "int32" + "schema": { + "type": "object" }, - "processing": { - "type": "integer", - "format": "int32" + "payload": { + "type": "object" }, - "task_accepts": { - "type": "integer", - "format": "int32" + "debug": { + "type": "boolean", + "format": "boolean" }, - "queue_talk_sec": { - "type": "integer", - "format": "int32" + "editor": { + "type": "boolean", + "format": "boolean" + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/definitions/engineSchemaTag" + } } } }, - "engineAgent": { + "engineCreateRoutingVariableRequest": { "type": "object", "properties": { - "id": { - "type": "string", - "format": "int64" - }, - "user": { - "$ref": "#/definitions/engineLookup" - }, - "status": { + "key": { "type": "string" }, - "description": { + "value": { "type": "string" }, - "last_status_change": { + "domain_id": { "type": "string", "format": "int64" - }, - "progressive_count": { - "type": "integer", - "format": "int32" - }, + } + } + }, + "engineCreateSchemaVariableRequest": { + "type": "object", + "properties": { "name": { "type": "string" }, - "channel": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAgentChannel" - } + "encrypt": { + "type": "boolean", + "format": "boolean" }, - "status_duration": { + "value": { + "type": "object" + } + } + }, + "engineCreateSkillAgentRequest": { + "type": "object", + "properties": { + "skill_id": { "type": "string", "format": "int64" }, - "greeting_media": { - "$ref": "#/definitions/engineLookup" - }, - "allow_channels": { + "agent": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineLookup" } }, - "chat_count": { + "capacity": { "type": "integer", - "format": "int64" + "format": "int32" }, - "supervisor": { + "enabled": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineCreateSkillAgentResponse": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "$ref": "#/definitions/engineSkillAgentItem" } + } + } + }, + "engineCreateSkillRequest": { + "type": "object", + "properties": { + "name": { + "type": "string" }, - "team": { - "$ref": "#/definitions/engineLookup" + "description": { + "type": "string" }, - "region": { + "domain_id": { + "type": "string", + "format": "int64" + } + } + }, + "engineCreateSystemSettingRequest": { + "type": "object", + "properties": { + "name": { + "$ref": "#/definitions/engineSystemSettingName" + }, + "value": { + "type": "object" + } + } + }, + "engineCreateTeamHookRequest": { + "type": "object", + "properties": { + "team_id": { + "type": "string", + "format": "int64" + }, + "schema": { "$ref": "#/definitions/engineLookup" }, - "auditor": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } + "event": { + "$ref": "#/definitions/engineTeamHookEvent" }, - "is_supervisor": { - "type": "boolean" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "skills": { + "properties": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "type": "string" } - }, - "extension": { - "type": "string" - }, - "task_count": { - "type": "integer", - "format": "int64" } } }, - "engineAgentCallStatistics": { + "engineCreateTeamTriggerRequest": { "type": "object", "properties": { + "team_id": { + "type": "string", + "format": "int64" + }, + "schema": { + "$ref": "#/definitions/engineLookup" + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, "name": { "type": "string" }, - "count": { - "type": "integer", - "format": "int32" - }, - "abandoned": { - "type": "integer", - "format": "int32" - }, - "handles": { + "description": { + "type": "string" + } + } + }, + "engineCreateTriggerJobRequest": { + "type": "object", + "properties": { + "trigger_id": { "type": "integer", "format": "int32" }, - "sum_talk_sec": { - "type": "number", - "format": "float" - }, - "avg_talk_sec": { - "type": "number", - "format": "float" - }, - "min_talk_sec": { - "type": "number", - "format": "float" - }, - "max_talk_sec": { - "type": "number", - "format": "float" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "engineCreateTriggerRequest": { + "type": "object", + "properties": { + "name": { + "type": "string" }, - "sum_hold_sec": { - "type": "number", - "format": "float" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "avg_hold_sec": { - "type": "number", - "format": "float" + "type": { + "$ref": "#/definitions/engineTriggerType" }, - "min_hold_sec": { - "type": "number", - "format": "float" + "schema": { + "$ref": "#/definitions/engineLookup" }, - "max_hold_sec": { - "type": "number", - "format": "float" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } }, - "utilization": { - "type": "number", - "format": "float" + "description": { + "type": "string" }, - "occupancy": { - "type": "number", - "format": "float" + "expression": { + "type": "string" }, - "chat_accepts": { - "type": "integer", - "format": "int32" + "timezone": { + "$ref": "#/definitions/engineLookup" }, - "chat_aht": { + "timeout": { "type": "integer", "format": "int32" } } }, - "engineAgentCallStatisticsList": { + "engineCreateWebHookRequest": { "type": "object", "properties": { - "next": { - "type": "boolean" + "name": { + "type": "string" }, - "items": { + "description": { + "type": "string" + }, + "origin": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAgentCallStatistics" + "type": "string" } + }, + "schema": { + "$ref": "#/definitions/engineLookup" + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "authorization": { + "type": "string" } } }, - "engineAgentChannel": { + "engineDefaultDeviceConfigResponse": { "type": "object", "properties": { - "channel": { - "type": "string" - }, - "state": { - "type": "string" - }, - "joined_at": { - "type": "string", - "format": "int64" + "sip": { + "$ref": "#/definitions/DefaultDeviceConfigResponseSipDeviceConfig" }, - "timeout": { - "type": "string", - "format": "int64" + "webrtc": { + "$ref": "#/definitions/DefaultDeviceConfigResponseWebRTCDeviceConfig" } } }, - "engineAgentInQueue": { + "engineDeleteMembersRequest": { "type": "object", "properties": { - "queue": { - "$ref": "#/definitions/engineLookup" + "q": { + "type": "string" }, - "priority": { - "type": "integer", - "format": "int32" + "id": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } }, - "type": { - "type": "integer", - "format": "int32" + "ids": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } }, - "strategy": { + "queue_id": { + "type": "string", + "format": "int64" + }, + "bucket_id": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "destination": { "type": "string" }, - "enabled": { - "type": "boolean" + "created_at": { + "$ref": "#/definitions/engineFilterBetween" }, - "count_members": { - "type": "integer", - "format": "int32" + "offering_at": { + "$ref": "#/definitions/engineFilterBetween" }, - "waiting_members": { - "type": "integer", - "format": "int32" + "stop_cause": { + "type": "array", + "items": { + "type": "string" + } }, - "active_members": { + "priority": { + "$ref": "#/definitions/engineFilterBetween" + }, + "name": { + "type": "string" + }, + "attempts": { + "$ref": "#/definitions/engineFilterBetween" + }, + "agent_id": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + }, + "numbers": { + "type": "array", + "items": { + "type": "string" + } + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "size": { "type": "integer", "format": "int32" }, - "agents": { - "$ref": "#/definitions/AgentInQueueAgentsInQueue" + "sort": { + "type": "string" + }, + "without_members": { + "type": "boolean", + "format": "boolean" } } }, - "engineAgentInQueueStatistics": { + "engineDeleteSkillAgentRequest": { "type": "object", "properties": { - "queue": { - "$ref": "#/definitions/engineLookup" + "skill_id": { + "type": "string", + "format": "int64" }, - "statistics": { + "id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/AgentInQueueStatisticsAgentInQueueStatisticsItem" + "type": "string", + "format": "int64" + } + }, + "agent_id": { + "type": "array", + "items": { + "type": "string", + "format": "int64" } } } }, - "engineAgentInQueueStatisticsList": { + "engineDeleteSkillAgentResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAgentInQueueStatistics" + "$ref": "#/definitions/engineSkillAgentItem" } } } }, - "engineAgentInTeam": { + "engineDtmfCallRequest": { "type": "object", "properties": { - "team": { - "$ref": "#/definitions/engineLookup" + "id": { + "type": "string" }, - "strategy": { + "app_id": { + "type": "string" + }, + "digit": { "type": "string" + }, + "domain_id": { + "type": "string", + "format": "int64" } } }, - "engineAgentPauseCause": { + "engineDtmfCallResponse": { + "type": "object" + }, + "engineEavesdropCallRequest": { "type": "object", "properties": { "id": { - "type": "integer", - "format": "int64" + "type": "string" }, - "created_at": { - "type": "string", - "format": "int64" + "app_id": { + "type": "string" }, - "created_by": { - "$ref": "#/definitions/engineLookup" + "control": { + "type": "boolean", + "format": "boolean" }, - "updated_at": { - "type": "string", - "format": "int64" + "listen_a": { + "type": "boolean", + "format": "boolean" }, - "updated_by": { - "$ref": "#/definitions/engineLookup" + "listen_b": { + "type": "boolean", + "format": "boolean" }, - "name": { - "type": "string" + "whisper_a": { + "type": "boolean", + "format": "boolean" }, - "limit_min": { - "type": "integer", - "format": "int64" + "whisper_b": { + "type": "boolean", + "format": "boolean" }, - "allow_supervisor": { - "type": "boolean" + "from": { + "$ref": "#/definitions/engineEavesdropCallRequestEndpointRequest" + } + } + }, + "engineEavesdropCallRequestEndpointRequest": { + "type": "object", + "properties": { + "app_id": { + "type": "string" }, - "allow_agent": { - "type": "boolean" + "type": { + "type": "string" }, - "allow_admin": { - "type": "boolean" + "id": { + "type": "string", + "format": "int64" }, - "description": { + "extension": { "type": "string" } } }, - "engineAgentSetStateResponse": { - "type": "object" + "engineEmailAuthType": { + "type": "string", + "enum": [ + "EmailAuthTypeUndefined", + "Plain", + "OAuth2" + ], + "default": "EmailAuthTypeUndefined" }, - "engineAgentSkill": { + "engineEmailProfile": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "domain_id": { - "type": "string", - "format": "int64" - }, "created_at": { "type": "string", "format": "int64" @@ -17613,201 +17925,211 @@ "updated_by": { "$ref": "#/definitions/engineLookup" }, - "agent": { - "$ref": "#/definitions/engineLookup" + "name": { + "type": "string" }, - "skill": { - "$ref": "#/definitions/engineLookup" + "description": { + "type": "string" }, - "capacity": { - "type": "integer", - "format": "int32" + "schema": { + "$ref": "#/definitions/engineLookup" }, "enabled": { - "type": "boolean" - } - } - }, - "engineAgentSkillItem": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "int64" + "type": "boolean", + "format": "boolean" }, - "skill": { - "$ref": "#/definitions/engineLookup" + "imap_host": { + "type": "string" }, - "capacity": { + "login": { + "type": "string" + }, + "mailbox": { + "type": "string" + }, + "smtp_port": { "type": "integer", "format": "int32" }, - "enabled": { - "type": "boolean" - } - } - }, - "engineAgentState": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "int64" + "imap_port": { + "type": "integer", + "format": "int32" }, - "channel": { + "password": { "type": "string" }, - "joined_at": { - "type": "string", - "format": "int64" + "smtp_host": { + "type": "string" }, - "state": { + "fetch_interval": { + "type": "integer", + "format": "int32" + }, + "fetch_error": { "type": "string" }, - "payload": { + "state": { "type": "string" }, - "duration": { + "activity_at": { "type": "string", "format": "int64" }, - "queue": { - "$ref": "#/definitions/engineLookup" + "auth_type": { + "$ref": "#/definitions/engineEmailAuthType" }, - "agent": { - "$ref": "#/definitions/engineLookup" + "listen": { + "type": "boolean", + "format": "boolean" }, - "pause_cause": { - "type": "string" + "params": { + "$ref": "#/definitions/engineEmailProfileParams" + }, + "logged": { + "type": "boolean", + "format": "boolean" } } }, - "engineAgentStatsStatistic": { + "engineEmailProfileParams": { "type": "object", "properties": { - "agent_id": { - "type": "integer", - "format": "int32" - }, - "name": { + "oauth2": { + "$ref": "#/definitions/EmailProfileParamsOAuth2" + } + } + }, + "engineEmptyResponse": { + "type": "object" + }, + "engineEndpoint": { + "type": "object", + "properties": { + "type": { "type": "string" }, - "status": { + "number": { "type": "string" }, - "status_duration": { - "type": "string", - "format": "int64" - }, - "user": { - "$ref": "#/definitions/engineLookup" - }, - "extension": { + "id": { "type": "string" }, - "team": { - "$ref": "#/definitions/engineLookup" - }, - "queues": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } - }, - "online": { - "type": "string", - "format": "int64" - }, - "offline": { - "type": "string", - "format": "int64" + "name": { + "type": "string" + } + } + }, + "engineExceptDate": { + "type": "object", + "properties": { + "name": { + "type": "string" }, - "pause": { + "date": { "type": "string", "format": "int64" }, - "utilization": { - "type": "number", - "format": "float" + "repeat": { + "type": "boolean", + "format": "boolean" }, - "call_time": { - "type": "string", - "format": "int64" + "disabled": { + "type": "boolean", + "format": "boolean" }, - "handles": { - "type": "integer", - "format": "int32" + "working": { + "type": "boolean", + "format": "boolean" }, - "missed": { + "work_start": { "type": "integer", "format": "int32" }, - "chat_count": { + "work_stop": { "type": "integer", "format": "int32" - }, - "max_bridged_at": { + } + } + }, + "engineFilterBetween": { + "type": "object", + "properties": { + "from": { "type": "string", "format": "int64" }, - "max_offering_at": { + "to": { "type": "string", "format": "int64" + } + } + }, + "engineForAgentPauseCause": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" }, - "active_call_id": { + "name": { "type": "string" }, - "transferred": { + "limit_min": { "type": "integer", "format": "int64" }, - "skills": { + "duration_min": { + "type": "integer", + "format": "int64" + } + } + }, + "engineForAgentPauseCauseList": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } - }, - "supervisor": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "$ref": "#/definitions/engineForAgentPauseCause" } + } + } + }, + "engineHangupCallRequest": { + "type": "object", + "properties": { + "id": { + "type": "string" }, - "auditor": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } + "cause": { + "type": "string" }, - "pause_cause": { + "app_id": { "type": "string" }, - "occupancy": { - "type": "number", - "format": "float" + "domain_id": { + "type": "string", + "format": "int64" } } }, - "engineAgentStatusStatisticItem": { + "engineHangupCallResponse": { + "type": "object" + }, + "engineHistoryCall": { "type": "object", "properties": { - "agent_id": { - "type": "integer", - "format": "int32" + "id": { + "type": "string" }, - "name": { + "app_id": { "type": "string" }, - "status": { + "type": { "type": "string" }, - "status_duration": { - "type": "string", - "format": "int64" + "parent_id": { + "type": "string" }, "user": { "$ref": "#/definitions/engineLookup" @@ -17815,625 +18137,1280 @@ "extension": { "type": "string" }, - "team": { + "gateway": { "$ref": "#/definitions/engineLookup" }, - "supervisor": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } - }, - "auditor": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } - }, - "region": { - "$ref": "#/definitions/engineLookup" + "direction": { + "type": "string" }, - "progressive_count": { - "type": "integer", - "format": "int64" + "destination": { + "type": "string" }, - "chat_count": { - "type": "integer", - "format": "int64" + "from": { + "$ref": "#/definitions/engineEndpoint" }, - "pause_cause": { - "type": "string" + "to": { + "$ref": "#/definitions/engineEndpoint" }, - "online": { - "type": "string", - "format": "int64" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } }, - "offline": { + "created_at": { "type": "string", "format": "int64" }, - "pause": { + "answered_at": { "type": "string", "format": "int64" }, - "score_required_avg": { - "type": "number", - "format": "float" - }, - "score_optional_avg": { - "type": "number", - "format": "float" - }, - "score_count": { - "type": "string", - "format": "int64" - } - } - }, - "engineAgentTeam": { - "type": "object", - "properties": { - "id": { + "bridged_at": { "type": "string", "format": "int64" }, - "domain_id": { + "hangup_at": { "type": "string", "format": "int64" }, - "name": { - "type": "string" - }, - "description": { + "hangup_by": { "type": "string" }, - "strategy": { + "cause": { "type": "string" }, - "max_no_answer": { + "duration": { "type": "integer", "format": "int32" }, - "no_answer_delay_time": { + "hold_sec": { "type": "integer", "format": "int32" }, - "wrap_up_time": { + "wait_sec": { "type": "integer", "format": "int32" }, - "call_timeout": { + "bill_sec": { "type": "integer", "format": "int32" }, - "updated_at": { - "type": "string", - "format": "int64" + "sip_code": { + "type": "integer", + "format": "int32" }, - "admin": { + "files": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "$ref": "#/definitions/engineCallFile" } }, - "invite_chat_timeout": { - "type": "integer", - "format": "int32" + "queue": { + "$ref": "#/definitions/engineLookup" }, - "task_accept_timeout": { - "type": "integer", - "format": "int32" + "member": { + "$ref": "#/definitions/engineLookup" }, - "forecast_calculation": { + "team": { "$ref": "#/definitions/engineLookup" - } - } - }, - "engineAgentTodayStatisticsResponse": { - "type": "object", - "properties": { - "utilization": { - "type": "number", - "format": "float" }, - "occupancy": { - "type": "number", - "format": "float" + "agent": { + "$ref": "#/definitions/engineLookup" }, - "call_abandoned": { - "type": "integer", - "format": "int32" + "joined_at": { + "type": "string", + "format": "int64" }, - "call_handled": { - "type": "integer", - "format": "int32" + "leaving_at": { + "type": "string", + "format": "int64" }, - "avg_talk_sec": { - "type": "number", - "format": "float" + "reporting_at": { + "type": "string", + "format": "int64" }, - "avg_hold_sec": { - "type": "number", - "format": "float" + "queue_bridged_at": { + "type": "string", + "format": "int64" }, - "chat_accepts": { + "queue_wait_sec": { "type": "integer", "format": "int32" }, - "chat_aht": { - "type": "number", - "format": "float" - }, - "call_missed": { + "queue_duration_sec": { "type": "integer", "format": "int32" }, - "call_inbound": { + "reporting_sec": { "type": "integer", "format": "int32" }, - "score_required_avg": { - "type": "number", - "format": "float" + "result": { + "type": "string" }, - "score_optional_avg": { - "type": "number", - "format": "float" + "tags": { + "type": "array", + "items": { + "type": "string" + } }, - "score_count": { + "display": { + "type": "string" + }, + "stored_at": { "type": "string", "format": "int64" }, - "score_required_sum": { - "type": "number", - "format": "float" + "transfer_from": { + "type": "string" }, - "score_optional_sum": { - "type": "number", - "format": "float" + "transfer_to": { + "type": "string" }, - "sum_talk_sec": { - "type": "string", - "format": "int64" + "has_children": { + "type": "boolean", + "format": "boolean" }, - "voice_mail": { - "type": "integer", - "format": "int32" + "agent_description": { + "type": "string" }, - "available": { - "type": "integer", - "format": "int32" + "hold": { + "type": "array", + "items": { + "$ref": "#/definitions/engineCallHold" + } }, - "online": { - "type": "integer", - "format": "int32" + "annotations": { + "type": "array", + "items": { + "$ref": "#/definitions/engineCallAnnotation" + } }, - "processing": { - "type": "integer", - "format": "int32" + "amd_result": { + "type": "string" }, - "task_accepts": { - "type": "integer", - "format": "int32" - }, - "queue_talk_sec": { - "type": "integer", - "format": "int32" - } - } - }, - "engineAgentUser": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "int64" - }, - "name": { + "hangup_disposition": { "type": "string" - } - } - }, - "engineAggregateHistoryCallRequest": { - "type": "object", - "properties": { - "page": { - "type": "integer", - "format": "int32" - }, - "size": { - "type": "integer", - "format": "int32" }, - "q": { + "blind_transfer": { "type": "string" }, - "aggs": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAggregateRequest" - } - }, - "created_at": { - "$ref": "#/definitions/engineFilterBetween" - }, - "user_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - }, - "agent_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - }, - "queue_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - }, - "team_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - }, - "member_id": { + "files_job": { "type": "array", "items": { - "type": "string", - "format": "int64" + "$ref": "#/definitions/engineHistoryFileJob" } }, - "gateway_id": { + "transcripts": { "type": "array", "items": { - "type": "string", - "format": "int64" + "$ref": "#/definitions/engineTranscriptLookup" } }, - "duration": { - "$ref": "#/definitions/engineFilterBetween" + "talk_sec": { + "type": "integer", + "format": "int32" }, - "skip_parent": { - "type": "boolean" + "grantee": { + "$ref": "#/definitions/engineLookup" }, - "parent_id": { + "amd_ai_result": { "type": "string" }, - "cause": { + "amd_ai_logs": { "type": "array", "items": { "type": "string" } }, - "has_file": { - "type": "boolean" - }, - "domain_id": { + "rate_id": { "type": "string", "format": "int64" }, - "number": { - "type": "string" - }, - "direction": { - "type": "string" + "rated_user": { + "$ref": "#/definitions/engineLookup" }, - "answered_at": { - "$ref": "#/definitions/engineFilterBetween" + "rated_by": { + "$ref": "#/definitions/engineLookup" }, - "missed": { - "type": "boolean" + "score_optional": { + "type": "number", + "format": "float" }, - "stored_at": { - "$ref": "#/definitions/engineFilterBetween" + "score_required": { + "type": "number", + "format": "float" }, - "id": { - "type": "array", - "items": { - "type": "string" - } + "attempt_id": { + "type": "string", + "format": "int64" }, - "transfer_from": { - "type": "array", - "items": { - "type": "string" - } + "allow_evaluation": { + "type": "boolean", + "format": "boolean" }, - "transfer_to": { - "type": "array", - "items": { - "type": "string" - } + "form_fields": { + "type": "object" }, - "dependency_id": { + "bridged_id": { "type": "string" }, - "tags": { - "type": "array", - "items": { - "type": "string" - } + "contact": { + "$ref": "#/definitions/engineLookup" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "member_id": { + "type": "string", + "format": "int64" }, - "amd_result": { + "schemas": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineLookup" } }, - "fts": { + "hangup_phrase": { "type": "string" }, - "directions": { + "blind_transfers": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/HistoryCallBlindTransfer" } }, - "has_transcript": { - "type": "boolean" - }, - "agent_description": { + "from_number": { "type": "string" }, - "contact_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "to_number": { + "type": "string" } } }, - "engineAggregateRequest": { + "engineHistoryFileJob": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "group": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/AggregateRequestGroup" - } - }, - "min": { - "type": "array", - "items": { - "type": "string" - } - }, - "max": { - "type": "array", - "items": { - "type": "string" - } + "id": { + "type": "string", + "format": "int64" }, - "sum": { - "type": "array", - "items": { - "type": "string" - } + "file_id": { + "type": "string", + "format": "int64" }, - "avg": { - "type": "array", - "items": { - "type": "string" - } + "created_at": { + "type": "string", + "format": "int64" }, - "count": { - "type": "array", - "items": { - "type": "string" - } + "action": { + "$ref": "#/definitions/HistoryFileJobHistoryFileJobAction" }, - "sort": { - "type": "array", - "items": { - "type": "string" - } + "state": { + "$ref": "#/definitions/HistoryFileJobHistoryFileJobState" }, - "limit": { - "type": "integer", - "format": "int32" + "error_detail": { + "type": "string" } } }, - "engineAggregateResult": { + "engineHoldCallResponse": { "type": "object", "properties": { - "name": { + "state": { "type": "string" - }, - "data": {} + } } }, - "engineAttempt": { + "engineList": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "state": { - "type": "string" - }, - "last_state_change": { + "created_at": { "type": "string", "format": "int64" }, - "joined_at": { - "type": "string", - "format": "int64" + "created_by": { + "$ref": "#/definitions/engineLookup" }, - "offering_at": { + "updated_at": { "type": "string", "format": "int64" }, - "bridged_at": { - "type": "string", - "format": "int64" + "updated_by": { + "$ref": "#/definitions/engineLookup" }, - "reporting_at": { + "domain_id": { "type": "string", "format": "int64" }, - "timeout": { - "type": "string", - "format": "int64" + "name": { + "type": "string" }, - "leaving_at": { + "description": { + "type": "string" + }, + "count": { "type": "string", "format": "int64" + } + } + }, + "engineListAgent": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" }, - "channel": { - "type": "string" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgent" + } + } + } + }, + "engineListAgentInQueue": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" }, - "queue": { - "$ref": "#/definitions/engineLookup" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgentInQueue" + } + } + } + }, + "engineListAgentInTeam": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" }, - "member": { - "$ref": "#/definitions/engineLookup" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgentInTeam" + } + } + } + }, + "engineListAgentPauseCause": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" }, - "member_call_id": { - "type": "string" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgentPauseCause" + } + } + } + }, + "engineListAgentSkill": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgentSkillItem" } + } + } + }, + "engineListAgentStateHistory": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" }, - "agent": { - "$ref": "#/definitions/engineLookup" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgentState" + } + } + } + }, + "engineListAgentStatsStatistic": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" }, - "agent_call_id": { - "type": "string" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgentStatsStatistic" + } + } + } + }, + "engineListAgentTeam": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" }, - "position": { - "type": "integer", - "format": "int32" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgentTeam" + } + } + } + }, + "engineListAgentUser": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" }, - "resource": { - "$ref": "#/definitions/engineLookup" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAgentUser" + } + } + } + }, + "engineListAggregate": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAggregateResult" + } + } + } + }, + "engineListAttempt": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" }, - "bucket": { - "$ref": "#/definitions/engineLookup" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAttempt" + } + } + } + }, + "engineListAuditForm": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" }, - "list": { - "$ref": "#/definitions/engineLookup", - "title": "black list ?" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAuditForm" + } + } + } + }, + "engineListAuditRate": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" }, - "display": { - "type": "string" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAuditRate" + } + } + } + }, + "engineListAvailableSystemSetting": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" }, - "destination": { - "$ref": "#/definitions/engineMemberCommunication" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAvailableSystemSetting" + } + } + } + }, + "engineListBucket": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineBucket" + } + } + } + }, + "engineListCalendar": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineCalendar" + } + } + } + }, + "engineListCall": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineActiveCall" + } + } + } + }, + "engineListChatPlan": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineChatPlan" + } + } + } + }, + "engineListCommunication": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "int64" + }, + "list_id": { + "type": "string", + "format": "int64" + }, + "number": { + "type": "string" + }, + "description": { + "type": "string" + }, + "expire_at": { + "type": "string", + "format": "int64" + } + } + }, + "engineListCommunicationType": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineCommunicationType" + } + } + } + }, + "engineListEmailProfile": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineEmailProfile" + } + } + } + }, + "engineListHistoryAttempt": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAttemptHistory" + } + } + } + }, + "engineListHistoryCall": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineHistoryCall" + } + } + } + }, + "engineListMember": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineMemberInQueue" + } + } + } + }, + "engineListMemberAttempt": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineMemberAttempt" + } + } + } + }, + "engineListOfList": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineList" + } + } + } + }, + "engineListOfListCommunication": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineListCommunication" + } + } + } + }, + "engineListOutboundResource": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineOutboundResource" + } + } + } + }, + "engineListOutboundResourceDisplay": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineResourceDisplay" + } + } + } + }, + "engineListOutboundResourceGroup": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineOutboundResourceViewGroup" + } + } + } + }, + "engineListOutboundResourceInGroup": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineOutboundResourceInGroup" + } + } + } + }, + "engineListPresetQuery": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/enginePresetQuery" + } + } + } + }, + "engineListQueue": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineQueue" + } + } + } + }, + "engineListQueueBucket": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineQueueBucket" + } + } + } + }, + "engineListQueueHook": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineQueueHook" + } + } + } + }, + "engineListQueueResourceGroup": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineQueueResourceGroup" + } + } + } + }, + "engineListQueueSkill": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineQueueSkill" + } + } + } + }, + "engineListQuickReplies": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineQuickReply" + } + } + } + }, + "engineListRegion": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineRegion" + } + } + } + }, + "engineListReportGeneral": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineQueueReportGeneral" + } + }, + "aggs": { + "$ref": "#/definitions/engineQueueReportGeneralAgentStatus" + } + } + }, + "engineListResourceDisplay": { + "type": "object", + "properties": { + "id": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } + } + } + }, + "engineListRoutingOutboundCall": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineRoutingOutboundCallCompact" + } + } + } + }, + "engineListRoutingSchema": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineRoutingSchema" + } + } + } + }, + "engineListRoutingSchemaTags": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineRoutingSchemaTag" + } + } + } + }, + "engineListRoutingVariable": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineRoutingVariable" + } + } + } + }, + "engineListSchemaVariable": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineSchemaVariable" + } + } + } + }, + "engineListSkill": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineSkill" + } + } + } + }, + "engineListSkillAgent": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineSkillAgentItem" + } + }, + "aggs": { + "$ref": "#/definitions/ListSkillAgentListSkillAgg" + } + } + }, + "engineListSystemSetting": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineSystemSetting" + } + } + } + }, + "engineListTags": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineTag" + } + } + } + }, + "engineListTeamHook": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineTeamHook" + } + } + } + }, + "engineListTeamTrigger": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineTeamTrigger" + } + } + } + }, + "engineListTimezoneResponse": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineTimezone" + } + } + } + }, + "engineListTrigger": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineTrigger" + } + } + } + }, + "engineListTriggerJob": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineTriggerJob" + } + } + } + }, + "engineListUserStatus": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineUserStatus" + } + }, + "next": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineListWebHook": { + "type": "object", + "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineWebHook" + } + } + } + }, + "engineLoginEmailProfileResponse": { + "type": "object", + "properties": { + "auth_type": { + "$ref": "#/definitions/engineEmailAuthType" + }, + "redirect_url": { + "type": "string" + }, + "cookie": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "engineLogoutEmailProfileResponse": { + "type": "object" + }, + "engineLookup": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "int64" }, - "result": { + "name": { "type": "string" - }, - "attempts": { - "type": "integer", - "format": "int32" } } }, - "engineAttemptHistory": { + "engineMemberAttempt": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "joined_at": { + "member": { + "$ref": "#/definitions/engineLookup" + }, + "created_at": { "type": "string", "format": "int64" }, - "offering_at": { + "destination": { + "type": "string" + }, + "weight": { + "type": "integer", + "format": "int32" + }, + "originate_at": { "type": "string", "format": "int64" }, - "bridged_at": { + "answered_at": { "type": "string", "format": "int64" }, - "reporting_at": { + "bridged_at": { "type": "string", "format": "int64" }, - "leaving_at": { + "hangup_at": { "type": "string", "format": "int64" }, - "channel": { - "type": "string" - }, - "queue": { - "$ref": "#/definitions/engineLookup" - }, - "member": { + "resource": { "$ref": "#/definitions/engineLookup" }, - "member_call_id": { + "leg_a_id": { "type": "string" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "agent": { - "$ref": "#/definitions/engineLookup" + "leg_b_id": { + "type": "string" }, - "agent_call_id": { + "node": { "type": "string" }, - "position": { - "type": "integer", - "format": "int32" + "result": { + "type": "string" }, - "resource": { + "agent": { "$ref": "#/definitions/engineLookup" }, "bucket": { "$ref": "#/definitions/engineLookup" }, - "list": { - "$ref": "#/definitions/engineLookup", - "title": "black list ?" - }, - "display": { - "type": "string" - }, - "destination": { - "$ref": "#/definitions/engineMemberCommunication" - }, - "result": { - "type": "string" + "logs": { + "type": "object" }, - "amd_result": { - "type": "string" + "active": { + "type": "boolean", + "format": "boolean" }, "attempts": { "type": "integer", @@ -18441,215 +19418,196 @@ } } }, - "engineAttemptRenewalResultResponse": { - "type": "object" - }, - "engineAttemptResultResponse": { + "engineMemberBulkResponse": { "type": "object", "properties": { - "status": { - "type": "string" + "ids": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } } } }, - "engineAuditForm": { + "engineMemberCommunication": { "type": "object", "properties": { "id": { + "type": "string", + "format": "int64" + }, + "destination": { + "type": "string" + }, + "type": { + "$ref": "#/definitions/engineLookup" + }, + "priority": { "type": "integer", "format": "int32" }, - "created_at": { + "description": { + "type": "string" + }, + "resource": { + "$ref": "#/definitions/engineLookup" + }, + "display": { + "type": "string" + }, + "state": { + "type": "integer", + "format": "int32" + }, + "last_activity_at": { "type": "string", "format": "int64" }, - "created_by": { - "$ref": "#/definitions/engineLookup" + "attempts": { + "type": "integer", + "format": "int32" }, - "updated_at": { + "last_cause": { + "type": "string" + }, + "stop_at": { "type": "string", "format": "int64" }, - "updated_by": { + "dtmf": { + "type": "string" + } + } + }, + "engineMemberCommunicationCreateRequest": { + "type": "object", + "properties": { + "destination": { + "type": "string" + }, + "type": { "$ref": "#/definitions/engineLookup" }, - "name": { - "type": "string" + "priority": { + "type": "integer", + "format": "int32" }, "description": { "type": "string" }, - "enabled": { - "type": "boolean" + "resource": { + "$ref": "#/definitions/engineLookup" }, - "questions": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineQuestion" - } + "display": { + "type": "string" }, - "teams": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } + "stop_at": { + "type": "string", + "format": "int64" }, - "editable": { - "type": "boolean", - "title": "bool archive = 11;" + "dtmf": { + "type": "string" } } }, - "engineAuditQuestionType": { - "type": "string", - "enum": [ - "question_default", - "question_score", - "question_option" - ], - "default": "question_default" - }, - "engineAuditRate": { + "engineMemberInQueue": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "created_at": { + "queue": { + "$ref": "#/definitions/engineLookup" + }, + "priority": { + "type": "integer", + "format": "int32" + }, + "expire_at": { "type": "string", "format": "int64" }, - "created_by": { - "$ref": "#/definitions/engineLookup" - }, - "updated_at": { + "created_at": { "type": "string", "format": "int64" }, - "updated_by": { - "$ref": "#/definitions/engineLookup" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } }, - "form": { - "$ref": "#/definitions/engineLookup" + "name": { + "type": "string" }, - "questions": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineQuestion" - } + "timezone": { + "$ref": "#/definitions/engineLookup" }, - "answers": { + "communications": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineQuestionAnswer" + "$ref": "#/definitions/engineMemberCommunication" } }, - "score_required": { - "type": "number", - "format": "float" + "bucket": { + "$ref": "#/definitions/engineLookup" }, - "score_optional": { - "type": "number", - "format": "float" + "min_offering_at": { + "type": "string", + "format": "int64" }, - "comment": { + "stop_cause": { "type": "string" }, - "rated_user": { - "$ref": "#/definitions/engineLookup" - } - } - }, - "engineAvailableSystemSetting": { - "type": "object", - "properties": { - "name": { - "type": "string" - } - } - }, - "engineBlindTransferCallResponse": { - "type": "object" - }, - "engineBroadcastButton": { - "type": "object", - "properties": { - "caption": { - "type": "string" + "last_activity_at": { + "type": "string", + "format": "int64" }, - "text": { - "type": "string" + "attempts": { + "type": "integer", + "format": "int32" }, - "type": { - "type": "string" + "reserved": { + "type": "boolean", + "format": "boolean" }, - "url": { - "type": "string" + "agent": { + "$ref": "#/definitions/engineLookup" }, - "code": { - "type": "string" - } - } - }, - "engineBroadcastButtons": { - "type": "object", - "properties": { - "button": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineBroadcastButton" - } + "skill": { + "$ref": "#/definitions/engineLookup" } } }, - "engineBroadcastFile": { + "engineMovePositionRoutingOutboundCallRequest": { "type": "object", "properties": { - "id": { + "from_id": { "type": "string", "format": "int64" }, - "url": { - "type": "string" - }, - "mime": { - "type": "string" - }, - "name": { - "type": "string" + "to_id": { + "type": "string", + "format": "int64" }, - "size": { + "domain_id": { "type": "string", "format": "int64" } - }, - "description": "Media File." - }, - "engineBroadcastResponse": { - "type": "object" + } }, - "engineBucket": { + "engineMovePositionRoutingOutboundCallResponse": { "type": "object", "properties": { - "id": { - "type": "string", - "format": "int64" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" + "success": { + "type": "boolean", + "format": "boolean" } } }, - "engineCalendar": { + "engineOutboundResource": { "type": "object", "properties": { "id": { @@ -18674,212 +19632,202 @@ "updated_by": { "$ref": "#/definitions/engineLookup" }, + "limit": { + "type": "integer", + "format": "int32" + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "rps": { + "type": "integer", + "format": "int32" + }, + "reserve": { + "type": "boolean", + "format": "boolean" + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "number": { + "type": "string" + }, + "max_successively_errors": { + "type": "integer", + "format": "int32" + }, "name": { "type": "string" }, - "start_at": { - "type": "string", - "format": "int64" + "error_ids": { + "type": "array", + "items": { + "type": "string" + } }, - "end_at": { + "last_error_id": { + "type": "string" + }, + "successively_errors": { + "type": "integer", + "format": "int32" + }, + "last_error_at": { "type": "string", "format": "int64" }, - "timezone": { + "gateway": { "$ref": "#/definitions/engineLookup" }, "description": { "type": "string" }, - "accepts": { + "patterns": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAcceptOfDay" + "type": "string" } }, - "excepts": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineExceptDate" - } + "failure_dial_delay": { + "type": "integer", + "format": "int64" }, - "specials": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAcceptOfDay" - } + "parameters": { + "$ref": "#/definitions/engineOutboundResourceParameters" } } }, - "engineCallAnnotation": { + "engineOutboundResourceGroup": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "call_id": { - "type": "string" - }, - "created_by": { - "$ref": "#/definitions/engineLookup" + "domain_id": { + "type": "string", + "format": "int64" }, "created_at": { "type": "string", "format": "int64" }, - "updated_by": { + "created_by": { "$ref": "#/definitions/engineLookup" }, "updated_at": { "type": "string", "format": "int64" }, - "note": { - "type": "string" - }, - "start_sec": { - "type": "integer", - "format": "int32" - }, - "end_sec": { - "type": "integer", - "format": "int32" - } - } - }, - "engineCallFile": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "int64" + "updated_by": { + "$ref": "#/definitions/engineLookup" }, "name": { "type": "string" }, - "size": { - "type": "string", - "format": "int64" + "strategy": { + "type": "string" }, - "mime_type": { + "description": { "type": "string" }, - "start_at": { - "type": "string", - "format": "int64" + "communication": { + "$ref": "#/definitions/engineLookup" }, - "stop_at": { - "type": "string", - "format": "int64" + "time": { + "type": "array", + "items": { + "$ref": "#/definitions/engineOutboundResourceTimeRange" + } } } }, - "engineCallHold": { + "engineOutboundResourceInGroup": { "type": "object", "properties": { - "start": { + "id": { "type": "string", "format": "int64" }, - "stop": { + "group_id": { "type": "string", "format": "int64" }, - "sec": { - "type": "number", - "format": "float" + "resource": { + "$ref": "#/definitions/engineLookup" + }, + "reserve_resource": { + "$ref": "#/definitions/engineLookup" + }, + "priority": { + "type": "integer", + "format": "int64" } } }, - "engineChatPlan": { + "engineOutboundResourceParameters": { "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "name": { + "cid_type": { "type": "string" }, - "description": { + "ignore_early_media": { "type": "string" - }, - "schema": { - "$ref": "#/definitions/engineLookup" - }, - "enabled": { - "type": "boolean" } } }, - "engineCommunicationChannels": { - "type": "string", - "enum": [ - "Undefined", - "Phone", - "Email", - "Messaging" - ], - "default": "Undefined" - }, - "engineCommunicationType": { + "engineOutboundResourceTimeRange": { "type": "object", "properties": { - "id": { - "type": "string", - "format": "int64" - }, - "domain_id": { - "type": "string", - "format": "int64" - }, - "name": { - "type": "string" - }, - "code": { - "type": "string" - }, - "channel": { - "$ref": "#/definitions/engineCommunicationChannels" - }, - "description": { - "type": "string" + "start_time_of_day": { + "type": "integer", + "format": "int32" }, - "default": { - "type": "boolean" + "end_time_of_day": { + "type": "integer", + "format": "int32" } } }, - "engineCommunicationTypeRequest": { + "engineOutboundResourceViewGroup": { "type": "object", "properties": { + "id": { + "type": "string", + "format": "int64" + }, "name": { "type": "string" }, - "code": { + "strategy": { "type": "string" }, - "channel": { - "$ref": "#/definitions/engineCommunicationChannels" - }, "description": { "type": "string" }, - "default": { - "type": "boolean" + "communication": { + "$ref": "#/definitions/engineLookup" } } }, - "engineConfirmPushResponse": { - "type": "object" - }, - "engineCreateAgentPauseCauseRequest": { + "enginePatchAgentPauseCauseRequest": { "type": "object", "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, "name": { "type": "string" }, @@ -18888,22 +19836,35 @@ "format": "int64" }, "allow_supervisor": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "allow_agent": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "allow_admin": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "description": { "type": "string" } } }, - "engineCreateAgentRequest": { + "enginePatchAgentRequest": { "type": "object", "properties": { + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string", + "format": "int64" + }, "user": { "$ref": "#/definitions/engineLookup" }, @@ -18917,10 +19878,6 @@ "greeting_media": { "$ref": "#/definitions/engineLookup" }, - "domain_id": { - "type": "string", - "format": "int64" - }, "allow_channels": { "type": "array", "items": { @@ -18934,7 +19891,6 @@ "supervisor": { "type": "array", "items": { - "type": "object", "$ref": "#/definitions/engineLookup" } }, @@ -18947,22 +19903,32 @@ "auditor": { "type": "array", "items": { - "type": "object", "$ref": "#/definitions/engineLookup" } }, "is_supervisor": { - "type": "boolean" - }, - "task_count": { - "type": "integer", - "format": "int64" + "type": "boolean", + "format": "boolean" } } }, - "engineCreateAgentSkillBulkItem": { + "enginePatchAgentSkillRequest": { "type": "object", "properties": { + "id": { + "type": "string", + "format": "int64" + }, + "agent_id": { + "type": "string", + "format": "int64" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, "skill": { "$ref": "#/definitions/engineLookup" }, @@ -18975,107 +19941,61 @@ "format": "int64" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" } } }, - "engineCreateAgentSkillsResponse": { + "enginePatchAgentSkillsRequest": { "type": "object", "properties": { - "ids": { + "agent_id": { + "type": "string", + "format": "int64" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { "type": "array", "items": { "type": "string", "format": "int64" } - } - } - }, - "engineCreateAgentTeamRequest": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "strategy": { - "type": "string" - }, - "max_no_answer": { - "type": "integer", - "format": "int32" - }, - "no_answer_delay_time": { - "type": "integer", - "format": "int32" - }, - "wrap_up_time": { - "type": "integer", - "format": "int32" - }, - "call_timeout": { - "type": "integer", - "format": "int32" }, - "admin": { + "skill_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" + "type": "string", + "format": "int64" } }, - "domain_id": { - "type": "string", - "format": "int64" - }, - "invite_chat_timeout": { - "type": "integer", - "format": "int32" - }, - "task_accept_timeout": { + "capacity": { "type": "integer", "format": "int32" }, - "forecast_calculation": { - "$ref": "#/definitions/engineLookup" - } - } - }, - "engineCreateAttemptResponse": { - "type": "object", - "properties": { - "attempt_id": { - "type": "string", - "format": "int64" + "enabled": { + "type": "boolean", + "format": "boolean" } } }, - "engineCreateAuditFormRateRequest": { + "enginePatchAuditFormRequest": { "type": "object", "properties": { - "form": { - "$ref": "#/definitions/engineLookup" + "id": { + "type": "integer", + "format": "int32" }, - "answers": { + "fields": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineQuestionAnswer" + "type": "string" } }, - "comment": { - "type": "string" - }, - "call_id": { - "type": "string" - } - } - }, - "engineCreateAuditFormRequest": { - "type": "object", - "properties": { "name": { "type": "string" }, @@ -19083,153 +20003,89 @@ "type": "string" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "questions": { "type": "array", "items": { - "type": "object", "$ref": "#/definitions/engineQuestion" } }, "teams": { "type": "array", "items": { - "type": "object", "$ref": "#/definitions/engineLookup" } } } }, - "engineCreateBucketRequest": { + "enginePatchChatPlanRequest": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" + "id": { + "type": "integer", + "format": "int32" }, - "domain_id": { - "type": "string", - "format": "int64" - } - } - }, - "engineCreateCalendarRequest": { - "type": "object", - "properties": { "name": { "type": "string" }, - "start_at": { - "type": "string", - "format": "int64" - }, - "end_at": { - "type": "string", - "format": "int64" - }, - "timezone": { - "$ref": "#/definitions/engineLookup" - }, "description": { "type": "string" }, - "accepts": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAcceptOfDay" - } - }, - "excepts": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineExceptDate" - } - }, - "domain_id": { - "type": "string", - "format": "int64" - }, - "specials": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAcceptOfDay" - } - } - } - }, - "engineCreateCallRequest": { - "type": "object", - "properties": { - "from": { - "$ref": "#/definitions/engineCreateCallRequestEndpointRequest" - }, - "to": { - "$ref": "#/definitions/engineCreateCallRequestEndpointRequest" - }, - "destination": { - "type": "string" - }, - "params": { - "$ref": "#/definitions/CreateCallRequestCallSettings" - }, - "domain_id": { - "type": "string", - "format": "int64" - } - } - }, - "engineCreateCallRequestEndpointRequest": { - "type": "object", - "properties": { - "app_id": { - "type": "string" - }, - "type": { - "type": "string" + "schema": { + "$ref": "#/definitions/engineLookup" }, - "id": { - "type": "string", - "format": "int64" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "extension": { - "type": "string" - } - } - }, - "engineCreateCallResponse": { - "type": "object", - "properties": { - "id": { - "type": "string" + "fields": { + "type": "array", + "items": { + "type": "string" + } } } }, - "engineCreateChatPlanRequest": { + "enginePatchCommunicationTypeRequest": { "type": "object", "properties": { + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string", + "format": "int64" + }, "name": { "type": "string" }, "description": { "type": "string" }, - "schema": { - "$ref": "#/definitions/engineLookup" + "code": { + "type": "string" }, - "enabled": { - "type": "boolean" + "channel": { + "$ref": "#/definitions/engineCommunicationChannels" + }, + "default": { + "type": "boolean", + "format": "boolean" } } }, - "engineCreateEmailProfileRequest": { + "enginePatchEmailProfileRequest": { "type": "object", "properties": { + "id": { + "type": "string", + "format": "int64" + }, "name": { "type": "string" }, @@ -19240,17 +20096,15 @@ "$ref": "#/definitions/engineLookup" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, - "smtp_host": { + "imap_host": { "type": "string" }, "login": { "type": "string" }, - "password": { - "type": "string" - }, "mailbox": { "type": "string" }, @@ -19262,42 +20116,53 @@ "type": "integer", "format": "int32" }, - "imap_host": { + "password": { + "type": "string" + }, + "smtp_host": { "type": "string" }, "fetch_interval": { "type": "integer", "format": "int32" }, - "auth_type": { - "$ref": "#/definitions/engineEmailAuthType" - }, "listen": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, - "params": { - "$ref": "#/definitions/engineEmailProfileParams" + "fields": { + "type": "array", + "items": { + "type": "string" + } } } }, - "engineCreateListRequest": { + "enginePatchHistoryCallRequest": { "type": "object", "properties": { - "name": { + "id": { "type": "string" }, - "description": { - "type": "string" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } }, - "domain_id": { - "type": "string", - "format": "int64" + "hide_missed": { + "type": "boolean", + "format": "boolean" } } }, - "engineCreateMemberBulkItem": { + "enginePatchMemberOneRequest": { "type": "object", "properties": { + "id": { + "type": "string", + "format": "int64" + }, "priority": { "type": "integer", "format": "int32" @@ -19321,7 +20186,6 @@ "communications": { "type": "array", "items": { - "type": "object", "$ref": "#/definitions/engineMemberCommunicationCreateRequest" } }, @@ -19332,74 +20196,122 @@ "type": "string", "format": "int64" }, + "stop_cause": { + "type": "string" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "domain_id": { + "type": "string", + "format": "int64" + }, "agent": { "$ref": "#/definitions/engineLookup" }, "skill": { "$ref": "#/definitions/engineLookup" + }, + "attempts": { + "type": "integer", + "format": "int32" } } }, - "engineCreateOutboundResourceDisplayRequest": { + "enginePatchMemberRequest": { "type": "object", "properties": { - "resource_id": { + "id": { "type": "string", "format": "int64" }, - "display": { - "type": "string" + "queue_id": { + "type": "string", + "format": "int64" }, - "domain_id": { + "priority": { + "type": "integer", + "format": "int32" + }, + "expire_at": { "type": "string", "format": "int64" - } - } - }, - "engineCreateOutboundResourceGroupRequest": { - "type": "object", - "properties": { + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, "name": { "type": "string" }, - "strategy": { - "type": "string" + "timezone": { + "$ref": "#/definitions/engineLookup" }, - "description": { - "type": "string" + "communications": { + "type": "array", + "items": { + "$ref": "#/definitions/engineMemberCommunicationCreateRequest" + } }, - "communication": { + "bucket": { "$ref": "#/definitions/engineLookup" }, - "time": { + "min_offering_at": { + "type": "string", + "format": "int64" + }, + "stop_cause": { + "type": "string" + }, + "fields": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineOutboundResourceTimeRange" + "type": "string" } }, "domain_id": { "type": "string", "format": "int64" + }, + "agent": { + "$ref": "#/definitions/engineLookup" + }, + "skill": { + "$ref": "#/definitions/engineLookup" + }, + "attempts": { + "type": "integer", + "format": "int32" } } }, - "engineCreateOutboundResourceRequest": { + "enginePatchOutboundResourceRequest": { "type": "object", "properties": { + "id": { + "type": "string", + "format": "int64" + }, "limit": { "type": "integer", "format": "int32" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "rps": { "type": "integer", "format": "int32" }, "reserve": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "variables": { "type": "object", @@ -19423,52 +20335,146 @@ "type": "string" } }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, "gateway": { "$ref": "#/definitions/engineLookup" }, - "description": { + "description": { + "type": "string" + }, + "patterns": { + "type": "array", + "items": { + "type": "string" + } + }, + "failure_dial_delay": { + "type": "integer", + "format": "int64" + }, + "parameters": { + "$ref": "#/definitions/engineOutboundResourceParameters" + } + } + }, + "enginePatchPresetQueryRequest": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "preset": { + "type": "object" + }, + "section": { + "$ref": "#/definitions/enginePresetQuerySection" + } + } + }, + "enginePatchQueueBucketRequest": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "int64" + }, + "queue_id": { + "type": "string", + "format": "int64" + }, + "ratio": { + "type": "integer", + "format": "int32" + }, + "bucket": { + "$ref": "#/definitions/engineLookup" + }, + "disabled": { + "type": "boolean", + "format": "boolean" + }, + "priority": { + "type": "integer", + "format": "int32" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "enginePatchQueueHookRequest": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "queue_id": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "schema": { + "$ref": "#/definitions/engineLookup" + }, + "event": { "type": "string" }, - "patterns": { + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "properties": { "type": "array", "items": { "type": "string" } - }, - "failure_dial_delay": { - "type": "integer", - "format": "int64" - }, - "parameters": { - "$ref": "#/definitions/engineOutboundResourceParameters" } } }, - "engineCreatePresetQueryRequest": { + "enginePatchQueueRequest": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" + "id": { + "type": "string", + "format": "int64" }, - "preset": {}, - "section": { - "$ref": "#/definitions/enginePresetQuerySection" - } - } - }, - "engineCreateQueueRequest": { - "type": "object", - "properties": { "strategy": { "type": "string" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" + }, + "payload": { + "type": "object" }, - "payload": {}, "calendar": { "$ref": "#/definitions/engineLookup" }, @@ -19512,6 +20518,12 @@ "ringtone": { "$ref": "#/definitions/engineLookup" }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, "domain_id": { "type": "string", "format": "int64" @@ -19523,25 +20535,23 @@ "$ref": "#/definitions/engineLookup" }, "sticky_agent": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "processing": { "type": "boolean", - "title": "deprecated" + "format": "boolean" }, "processing_sec": { "type": "integer", - "format": "int64", - "title": "deprecated" + "format": "int64" }, "processing_renewal_sec": { "type": "integer", - "format": "int64", - "title": "deprecated" + "format": "int64" }, "form_schema": { - "$ref": "#/definitions/engineLookup", - "title": "deprecated" + "$ref": "#/definitions/engineLookup" }, "task_processing": { "$ref": "#/definitions/engineTaskProcessing" @@ -19552,15 +20562,98 @@ "tags": { "type": "array", "items": { - "type": "object", "$ref": "#/definitions/engineTag" } } } }, - "engineCreateRegionRequest": { + "enginePatchQueueSkillRequest": { + "type": "object", + "properties": { + "queue_id": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "skill": { + "$ref": "#/definitions/engineLookup" + }, + "buckets": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } + }, + "lvl": { + "type": "integer", + "format": "int32" + }, + "min_capacity": { + "type": "integer", + "format": "int32" + }, + "max_capacity": { + "type": "integer", + "format": "int32" + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "enginePatchQuickReplyRequest": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "type": "string" + }, + "text": { + "type": "string" + }, + "team": { + "$ref": "#/definitions/engineLookup" + }, + "article": { + "$ref": "#/definitions/engineLookup" + }, + "queue": { + "$ref": "#/definitions/engineLookup" + } + } + }, + "enginePatchRegionRequest": { "type": "object", "properties": { + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string", + "format": "int64" + }, "name": { "type": "string" }, @@ -19572,9 +20665,13 @@ } } }, - "engineCreateRoutingOutboundCallRequest": { + "enginePatchRoutingOutboundCallRequest": { "type": "object", "properties": { + "id": { + "type": "string", + "format": "int64" + }, "name": { "type": "string" }, @@ -19588,7 +20685,14 @@ "type": "string" }, "disabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } }, "domain_id": { "type": "string", @@ -19596,9 +20700,13 @@ } } }, - "engineCreateRoutingSchemaRequest": { + "enginePatchRoutingSchemaRequest": { "type": "object", "properties": { + "id": { + "type": "string", + "format": "int64" + }, "name": { "type": "string" }, @@ -19608,94 +20716,217 @@ "type": { "$ref": "#/definitions/engineRoutingSchemaType" }, - "schema": {}, - "payload": {}, + "schema": { + "type": "object" + }, + "payload": { + "type": "object" + }, "debug": { - "type": "boolean" + "type": "boolean", + "format": "boolean" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } }, "editor": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "tags": { "type": "array", "items": { - "type": "object", "$ref": "#/definitions/engineSchemaTag" } + }, + "note": { + "type": "string" } } }, - "engineCreateRoutingVariableRequest": { + "enginePatchSchemaVariableRequest": { "type": "object", "properties": { - "key": { + "id": { + "type": "integer", + "format": "int32" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "name": { "type": "string" }, "value": { - "type": "string" + "type": "object" }, - "domain_id": { + "encrypt": { + "type": "boolean", + "format": "boolean" + } + } + }, + "enginePatchSkillAgentRequest": { + "type": "object", + "properties": { + "skill_id": { "type": "string", "format": "int64" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "skill": { + "$ref": "#/definitions/engineLookup" + }, + "capacity": { + "type": "integer", + "format": "int32" + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "id": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } + }, + "agent_id": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } } } }, - "engineCreateSchemaVariableRequest": { + "enginePatchSkillAgentResponse": { "type": "object", "properties": { - "name": { - "type": "string" + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/engineSkillAgentItem" + } + } + } + }, + "enginePatchSystemSettingRequest": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "string" + } }, - "encrypt": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int32" }, - "value": {} + "value": { + "type": "object" + } } }, - "engineCreateSkillAgentResponse": { + "enginePatchTeamHookRequest": { "type": "object", "properties": { - "items": { + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "team_id": { + "type": "string", + "format": "int64" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "schema": { + "$ref": "#/definitions/engineLookup" + }, + "event": { + "$ref": "#/definitions/engineTeamHookEvent" + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "properties": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineSkillAgentItem" + "type": "string" } } } }, - "engineCreateSkillRequest": { + "enginePatchTeamTriggerRequest": { "type": "object", "properties": { + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "team_id": { + "type": "string", + "format": "int64" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "schema": { + "$ref": "#/definitions/engineLookup" + }, + "enabled": { + "type": "boolean", + "format": "boolean" + }, "name": { "type": "string" }, "description": { "type": "string" - }, - "domain_id": { - "type": "string", - "format": "int64" } } }, - "engineCreateSystemSettingRequest": { + "enginePatchTriggerRequest": { "type": "object", "properties": { - "name": { - "$ref": "#/definitions/engineSystemSettingName" + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "integer", + "format": "int32" }, - "value": {} - } - }, - "engineCreateTriggerRequest": { - "type": "object", - "properties": { "name": { "type": "string" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "type": { "$ref": "#/definitions/engineTriggerType" @@ -19724,9 +20955,19 @@ } } }, - "engineCreateWebHookRequest": { + "enginePatchWebHookRequest": { "type": "object", "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, "name": { "type": "string" }, @@ -19743,290 +20984,133 @@ "$ref": "#/definitions/engineLookup" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "authorization": { "type": "string" } } }, - "engineDefaultDeviceConfigResponse": { - "type": "object", - "properties": { - "sip": { - "$ref": "#/definitions/DefaultDeviceConfigResponseSipDeviceConfig" - }, - "webrtc": { - "$ref": "#/definitions/DefaultDeviceConfigResponseWebRTCDeviceConfig" - } - } - }, - "engineDeleteSkillAgentResponse": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineSkillAgentItem" - } - } - } - }, - "engineDtmfCallResponse": { - "type": "object" - }, - "engineEavesdropCallRequestEndpointRequest": { - "type": "object", - "properties": { - "app_id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "id": { - "type": "string", - "format": "int64" - }, - "extension": { - "type": "string" - } - } - }, - "engineEmailAuthType": { - "type": "string", - "enum": [ - "EmailAuthTypeUndefined", - "Plain", - "OAuth2" - ], - "default": "EmailAuthTypeUndefined" - }, - "engineEmailProfile": { + "enginePresetQuery": { "type": "object", "properties": { "id": { - "type": "string", - "format": "int64" - }, - "created_at": { - "type": "string", - "format": "int64" - }, - "created_by": { - "$ref": "#/definitions/engineLookup" - }, - "updated_at": { - "type": "string", - "format": "int64" - }, - "updated_by": { - "$ref": "#/definitions/engineLookup" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "schema": { - "$ref": "#/definitions/engineLookup" - }, - "enabled": { - "type": "boolean" - }, - "imap_host": { - "type": "string" - }, - "login": { - "type": "string" - }, - "mailbox": { - "type": "string" - }, - "smtp_port": { - "type": "integer", - "format": "int32" - }, - "imap_port": { "type": "integer", "format": "int32" }, - "password": { - "type": "string" - }, - "smtp_host": { + "name": { "type": "string" }, - "fetch_interval": { - "type": "integer", - "format": "int32" - }, - "fetch_error": { + "description": { "type": "string" }, - "state": { - "type": "string" + "preset": { + "type": "object" }, - "activity_at": { + "created_at": { "type": "string", "format": "int64" }, - "auth_type": { - "$ref": "#/definitions/engineEmailAuthType" - }, - "listen": { - "type": "boolean" - }, - "params": { - "$ref": "#/definitions/engineEmailProfileParams" - }, - "logged": { - "type": "boolean" - } - } - }, - "engineEmailProfileParams": { - "type": "object", - "properties": { - "oauth2": { - "$ref": "#/definitions/EmailProfileParamsOAuth2" - } - } - }, - "engineEmptyResponse": { - "type": "object" - }, - "engineEndpoint": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "number": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - } - }, - "engineExceptDate": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "date": { + "updated_at": { "type": "string", "format": "int64" }, - "repeat": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "working": { - "type": "boolean" - }, - "work_start": { - "type": "integer", - "format": "int32" - }, - "work_stop": { - "type": "integer", - "format": "int32" + "section": { + "$ref": "#/definitions/enginePresetQuerySection" } } }, - "engineFilterBetween": { - "type": "object", - "properties": { - "from": { - "type": "string", - "format": "int64" - }, - "to": { - "type": "string", - "format": "int64" - } - } + "enginePresetQuerySection": { + "type": "string", + "enum": [ + "section_default", + "section_calls" + ], + "default": "section_default" }, - "engineForAgentPauseCause": { + "engineQuestion": { "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64" + "type": { + "$ref": "#/definitions/engineAuditQuestionType" }, - "name": { + "required": { + "type": "boolean", + "format": "boolean" + }, + "question": { "type": "string" }, - "limit_min": { + "min": { "type": "integer", - "format": "int64" + "format": "int32" }, - "duration_min": { + "max": { "type": "integer", - "format": "int64" + "format": "int32" + }, + "options": { + "type": "array", + "items": { + "$ref": "#/definitions/QuestionOption" + } } } }, - "engineForAgentPauseCauseList": { + "engineQuestionAnswer": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineForAgentPauseCause" - } + "score": { + "type": "number", + "format": "float" } } }, - "engineHangupCallResponse": { - "type": "object" - }, - "engineHistoryCall": { + "engineQueue": { "type": "object", "properties": { "id": { - "type": "string" - }, - "app_id": { - "type": "string" + "type": "string", + "format": "int64" }, - "type": { - "type": "string" + "domain_id": { + "type": "string", + "format": "int64" }, - "parent_id": { - "type": "string" + "created_at": { + "type": "string", + "format": "int64" }, - "user": { + "created_by": { "$ref": "#/definitions/engineLookup" }, - "extension": { - "type": "string" + "updated_at": { + "type": "string", + "format": "int64" }, - "gateway": { + "updated_by": { "$ref": "#/definitions/engineLookup" }, - "direction": { + "strategy": { "type": "string" }, - "destination": { - "type": "string" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "from": { - "$ref": "#/definitions/engineEndpoint" + "payload": { + "type": "object" }, - "to": { - "$ref": "#/definitions/engineEndpoint" + "calendar": { + "$ref": "#/definitions/engineLookup" + }, + "priority": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string" }, "variables": { "type": "object", @@ -20034,276 +21118,286 @@ "type": "string" } }, - "created_at": { - "type": "string", - "format": "int64" - }, - "answered_at": { - "type": "string", - "format": "int64" - }, - "bridged_at": { - "type": "string", - "format": "int64" - }, - "hangup_at": { - "type": "string", - "format": "int64" - }, - "hangup_by": { - "type": "string" + "timeout": { + "type": "integer", + "format": "int32" }, - "cause": { - "type": "string" + "dnc_list": { + "$ref": "#/definitions/engineLookup" }, - "duration": { + "sec_locate_agent": { "type": "integer", "format": "int32" }, - "hold_sec": { + "type": { "type": "integer", "format": "int32" }, - "wait_sec": { + "description": { + "type": "string" + }, + "team": { + "$ref": "#/definitions/engineLookup" + }, + "schema": { + "$ref": "#/definitions/engineLookup" + }, + "count": { "type": "integer", "format": "int32" }, - "bill_sec": { + "waiting": { "type": "integer", "format": "int32" }, - "sip_code": { + "active": { "type": "integer", "format": "int32" }, - "files": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineCallFile" - } - }, - "queue": { - "$ref": "#/definitions/engineLookup" - }, - "member": { + "ringtone": { "$ref": "#/definitions/engineLookup" }, - "team": { + "do_schema": { "$ref": "#/definitions/engineLookup" }, - "agent": { + "after_schema": { "$ref": "#/definitions/engineLookup" }, - "joined_at": { - "type": "string", - "format": "int64" - }, - "leaving_at": { - "type": "string", - "format": "int64" + "sticky_agent": { + "type": "boolean", + "format": "boolean" }, - "reporting_at": { - "type": "string", - "format": "int64" + "processing": { + "type": "boolean", + "format": "boolean" }, - "queue_bridged_at": { - "type": "string", + "processing_sec": { + "type": "integer", "format": "int64" }, - "queue_wait_sec": { + "processing_renewal_sec": { "type": "integer", - "format": "int32" + "format": "int64" }, - "queue_duration_sec": { - "type": "integer", - "format": "int32" + "form_schema": { + "$ref": "#/definitions/engineLookup" }, - "reporting_sec": { - "type": "integer", - "format": "int32" + "task_processing": { + "$ref": "#/definitions/engineTaskProcessing" }, - "result": { - "type": "string" + "grantee": { + "$ref": "#/definitions/engineLookup" }, "tags": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineTag" } - }, - "display": { - "type": "string" - }, - "stored_at": { + } + } + }, + "engineQueueBucket": { + "type": "object", + "properties": { + "id": { "type": "string", "format": "int64" }, - "transfer_from": { - "type": "string" - }, - "transfer_to": { - "type": "string" - }, - "has_children": { - "type": "boolean" - }, - "agent_description": { - "type": "string" - }, - "hold": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineCallHold" - } - }, - "annotations": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineCallAnnotation" - } - }, - "amd_result": { - "type": "string" - }, - "hangup_disposition": { - "type": "string" - }, - "blind_transfer": { - "type": "string" + "ratio": { + "type": "integer", + "format": "int32" }, - "files_job": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineHistoryFileJob" - } + "bucket": { + "$ref": "#/definitions/engineLookup" }, - "transcripts": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineTranscriptLookup" - } + "disabled": { + "type": "boolean", + "format": "boolean" }, - "talk_sec": { + "priority": { "type": "integer", "format": "int32" + } + } + }, + "engineQueueHook": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" }, - "grantee": { + "schema": { "$ref": "#/definitions/engineLookup" }, - "amd_ai_result": { + "event": { "type": "string" }, - "amd_ai_logs": { + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "properties": { "type": "array", "items": { "type": "string" } + } + } + }, + "engineQueueReportGeneral": { + "type": "object", + "properties": { + "queue": { + "$ref": "#/definitions/engineLookup" }, - "rate_id": { - "type": "string", - "format": "int64" + "agent_status": { + "$ref": "#/definitions/engineQueueReportGeneralAgentStatus" }, - "rated_user": { + "team": { "$ref": "#/definitions/engineLookup" }, - "rated_by": { - "$ref": "#/definitions/engineLookup" + "missed": { + "type": "integer", + "format": "int64" }, - "score_optional": { - "type": "number", - "format": "float" + "processed": { + "type": "integer", + "format": "int64" }, - "score_required": { - "type": "number", - "format": "float" + "waiting": { + "type": "integer", + "format": "int64" }, - "attempt_id": { + "count": { "type": "string", + "format": "uint64" + }, + "transferred": { + "type": "integer", "format": "int64" }, - "allow_evaluation": { - "type": "boolean" + "abandoned": { + "type": "integer", + "format": "int64" }, - "form_fields": {}, - "bridged_id": { - "type": "string" + "attempts": { + "type": "integer", + "format": "int64" }, - "contact": { - "$ref": "#/definitions/engineLookup" + "sum_bill_sec": { + "type": "number", + "format": "float" }, - "member_id": { - "type": "string", - "format": "int64" + "avg_wrap_sec": { + "type": "number", + "format": "float" }, - "schemas": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } + "avg_awt_sec": { + "type": "number", + "format": "float" }, - "hangup_phrase": { - "type": "string" + "avg_asa_sec": { + "type": "number", + "format": "float" }, - "blind_transfers": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/HistoryCallBlindTransfer" - } + "avg_aht_sec": { + "type": "number", + "format": "float" }, - "from_number": { - "type": "string" + "bridged": { + "type": "number", + "format": "float" }, - "to_number": { - "type": "string" + "sl20": { + "type": "number", + "format": "float" + }, + "sl30": { + "type": "number", + "format": "float" } } }, - "engineHistoryFileJob": { + "engineQueueReportGeneralAgentStatus": { "type": "object", "properties": { - "id": { - "type": "string", + "online": { + "type": "integer", "format": "int64" }, - "file_id": { - "type": "string", + "pause": { + "type": "integer", "format": "int64" }, - "created_at": { - "type": "string", + "offline": { + "type": "integer", "format": "int64" }, - "action": { - "$ref": "#/definitions/HistoryFileJobHistoryFileJobAction" + "free": { + "type": "integer", + "format": "int64" }, - "state": { - "$ref": "#/definitions/HistoryFileJobHistoryFileJobState" + "total": { + "type": "integer", + "format": "int64" + } + } + }, + "engineQueueResourceGroup": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "int64" }, - "error_detail": { - "type": "string" + "resource_group": { + "$ref": "#/definitions/engineLookup" + }, + "communication": { + "$ref": "#/definitions/engineLookup" } } }, - "engineHoldCallResponse": { + "engineQueueSkill": { "type": "object", "properties": { - "state": { - "type": "string" + "id": { + "type": "integer", + "format": "int64" + }, + "skill": { + "$ref": "#/definitions/engineLookup" + }, + "buckets": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } + }, + "lvl": { + "type": "integer", + "format": "int32" + }, + "min_capacity": { + "type": "integer", + "format": "int32" + }, + "max_capacity": { + "type": "integer", + "format": "int32" + }, + "enabled": { + "type": "boolean", + "format": "boolean" } } }, - "engineList": { + "engineQuickReply": { "type": "object", "properties": { "id": { - "type": "string", + "type": "integer", "format": "int64" }, "created_at": { @@ -20320,877 +21414,651 @@ "updated_by": { "$ref": "#/definitions/engineLookup" }, - "domain_id": { - "type": "string", - "format": "int64" - }, "name": { "type": "string" }, - "description": { + "text": { "type": "string" }, - "count": { - "type": "string", - "format": "int64" - } - } - }, - "engineListAgent": { - "type": "object", - "properties": { - "next": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAgent" - } - } - } - }, - "engineListAgentInQueue": { - "type": "object", - "properties": { - "next": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAgentInQueue" - } - } - } - }, - "engineListAgentInTeam": { - "type": "object", - "properties": { - "next": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAgentInTeam" - } - } - } - }, - "engineListAgentPauseCause": { - "type": "object", - "properties": { - "next": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAgentPauseCause" - } - } - } - }, - "engineListAgentSkill": { - "type": "object", - "properties": { - "next": { - "type": "boolean" + "team": { + "$ref": "#/definitions/engineLookup" }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAgentSkillItem" - } - } - } - }, - "engineListAgentStateHistory": { - "type": "object", - "properties": { - "next": { - "type": "boolean" + "article": { + "$ref": "#/definitions/engineLookup" }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAgentState" - } + "queue": { + "$ref": "#/definitions/engineLookup" } } }, - "engineListAgentStatsStatistic": { + "engineRedialCallRequest": { "type": "object", "properties": { - "next": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAgentStatsStatistic" - } + "call_id": { + "type": "string" } } }, - "engineListAgentTeam": { + "engineRegion": { "type": "object", "properties": { - "next": { - "type": "boolean" + "id": { + "type": "string", + "format": "int64" }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAgentTeam" - } + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "timezone": { + "$ref": "#/definitions/engineLookup" } } }, - "engineListAgentUser": { + "engineResetMembersRequest": { "type": "object", "properties": { - "next": { - "type": "boolean" + "queue_id": { + "type": "string", + "format": "int64" }, - "items": { + "ids": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAgentUser" + "type": "string", + "format": "int64" } - } - } - }, - "engineListAggregate": { - "type": "object", - "properties": { - "items": { + }, + "id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAggregateResult" + "type": "string", + "format": "int64" } - } - } - }, - "engineListAttempt": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "bucket_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAttempt" + "type": "string", + "format": "int64" } - } - } - }, - "engineListAuditForm": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "stop_cause": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAuditForm" + "type": "string" } - } - } - }, - "engineListAuditRate": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "agent_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAuditRate" + "type": "integer", + "format": "int32" } - } - } - }, - "engineListAvailableSystemSetting": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "numbers": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineAvailableSystemSetting" + "type": "string" } - } - } - }, - "engineListBucket": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineBucket" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" } } } }, - "engineListCalendar": { + "engineResetMembersResponse": { "type": "object", "properties": { - "next": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineCalendar" - } + "count": { + "type": "string", + "format": "int64" } } }, - "engineListCall": { + "engineResourceDisplay": { "type": "object", "properties": { - "next": { - "type": "boolean" + "id": { + "type": "string", + "format": "int64" }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineActiveCall" - } + "display": { + "type": "string" } } }, - "engineListChatPlan": { + "engineResponse": { "type": "object", "properties": { - "next": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineChatPlan" - } + "status": { + "type": "string" } } }, - "engineListCommunication": { + "engineRoutingOutboundCall": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "list_id": { + "created_at": { "type": "string", "format": "int64" }, - "number": { - "type": "string" - }, - "description": { - "type": "string" + "created_by": { + "$ref": "#/definitions/engineLookup" }, - "expire_at": { + "updated_at": { "type": "string", "format": "int64" - } - } - }, - "engineListCommunicationType": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineCommunicationType" - } - } - } - }, - "engineListEmailProfile": { - "type": "object", - "properties": { - "next": { - "type": "boolean" + "updated_by": { + "$ref": "#/definitions/engineLookup" }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineEmailProfile" - } - } - } - }, - "engineListHistoryAttempt": { - "type": "object", - "properties": { - "next": { - "type": "boolean" + "name": { + "type": "string" }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineAttemptHistory" - } - } - } - }, - "engineListHistoryCall": { - "type": "object", - "properties": { - "next": { - "type": "boolean" + "description": { + "type": "string" }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineHistoryCall" - } - } - } - }, - "engineListMember": { - "type": "object", - "properties": { - "next": { - "type": "boolean" + "schema": { + "$ref": "#/definitions/engineLookup" }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineMemberInQueue" - } - } - } - }, - "engineListMemberAttempt": { - "type": "object", - "properties": { - "next": { - "type": "boolean" + "pattern": { + "type": "string" }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineMemberAttempt" - } + "disabled": { + "type": "boolean", + "format": "boolean" + }, + "domain_id": { + "type": "string", + "format": "int64" } } }, - "engineListOfList": { + "engineRoutingOutboundCallCompact": { "type": "object", "properties": { - "next": { - "type": "boolean" + "id": { + "type": "string", + "format": "int64" }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineList" - } + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "schema": { + "$ref": "#/definitions/engineLookup" + }, + "pattern": { + "type": "string" + }, + "disabled": { + "type": "boolean", + "format": "boolean" + }, + "position": { + "type": "integer", + "format": "int32" + }, + "domain_id": { + "type": "string", + "format": "int64" } } }, - "engineListOfListCommunication": { + "engineRoutingSchema": { "type": "object", "properties": { - "next": { - "type": "boolean" + "id": { + "type": "string", + "format": "int64" }, - "items": { + "created_at": { + "type": "string", + "format": "int64" + }, + "created_by": { + "$ref": "#/definitions/engineLookup" + }, + "updated_at": { + "type": "string", + "format": "int64" + }, + "updated_by": { + "$ref": "#/definitions/engineLookup" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "type": { + "$ref": "#/definitions/engineRoutingSchemaType" + }, + "schema": { + "type": "object" + }, + "payload": { + "type": "object" + }, + "debug": { + "type": "boolean", + "format": "boolean" + }, + "editor": { + "type": "boolean", + "format": "boolean" + }, + "tags": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineListCommunication" + "$ref": "#/definitions/engineSchemaTag" } } } }, - "engineListOutboundResource": { + "engineRoutingSchemaTag": { "type": "object", "properties": { - "next": { - "type": "boolean" + "name": { + "type": "string" }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineOutboundResource" - } + "count": { + "type": "integer", + "format": "int64" } } }, - "engineListOutboundResourceDisplay": { + "engineRoutingSchemaType": { + "type": "string", + "enum": [ + "default", + "voice", + "chat", + "processing", + "service" + ], + "default": "default" + }, + "engineRoutingVariable": { "type": "object", "properties": { - "next": { - "type": "boolean" + "id": { + "type": "string", + "format": "int64" }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineResourceDisplay" - } + "domain_id": { + "type": "string", + "format": "int64" + }, + "key": { + "type": "string" + }, + "value": { + "type": "string" } } }, - "engineListOutboundResourceGroup": { + "engineRunTeamTriggerRequest": { "type": "object", "properties": { - "next": { - "type": "boolean" + "trigger_id": { + "type": "integer", + "format": "int32" }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineOutboundResourceViewGroup" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" } } } }, - "engineListOutboundResourceInGroup": { + "engineRunTeamTriggerResponse": { "type": "object", "properties": { - "next": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineOutboundResourceInGroup" - } + "job_id": { + "type": "string" } } }, - "engineListPresetQuery": { + "engineSchemaTag": { "type": "object", "properties": { - "next": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/enginePresetQuery" - } + "name": { + "type": "string" } } }, - "engineListQueue": { + "engineSchemaVariable": { "type": "object", "properties": { - "next": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int32" }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineQueue" - } + "name": { + "type": "string" + }, + "encrypt": { + "type": "boolean", + "format": "boolean" + }, + "value": { + "type": "object" } } }, - "engineListQueueBucket": { + "engineSchemaVersion": { "type": "object", "properties": { - "next": { - "type": "boolean" + "id": { + "type": "string", + "format": "int64" }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineQueueBucket" - } + "schema_id": { + "type": "string", + "format": "int64" + }, + "created_at": { + "type": "string", + "format": "int64" + }, + "created_by": { + "$ref": "#/definitions/engineLookup" + }, + "schema": { + "type": "object" + }, + "payload": { + "type": "object" + }, + "version": { + "type": "string", + "format": "uint64" + }, + "note": { + "type": "string" } } }, - "engineListQueueHook": { + "engineSearchHistoryCallRequest": { "type": "object", "properties": { - "next": { - "type": "boolean" + "page": { + "type": "integer", + "format": "int32" }, - "items": { + "size": { + "type": "integer", + "format": "int32" + }, + "q": { + "type": "string" + }, + "sort": { + "type": "string" + }, + "fields": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineQueueHook" + "type": "string" } - } - } - }, - "engineListQueueResourceGroup": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "created_at": { + "$ref": "#/definitions/engineFilterBetween" + }, + "user_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineQueueResourceGroup" + "type": "string", + "format": "int64" } - } - } - }, - "engineListQueueSkill": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "agent_id": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + } + }, + "queue_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineQueueSkill" + "type": "string", + "format": "int64" } - } - } - }, - "engineListRegion": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "team_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineRegion" + "type": "string", + "format": "int64" } - } - } - }, - "engineListReportGeneral": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "member_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineQueueReportGeneral" + "type": "string", + "format": "int64" } }, - "aggs": { - "$ref": "#/definitions/engineQueueReportGeneralAgentStatus" - } - } - }, - "engineListResourceDisplay": { - "type": "object", - "properties": { - "id": { + "gateway_id": { "type": "array", "items": { "type": "string", "format": "int64" } - } - } - }, - "engineListRoutingOutboundCall": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "duration": { + "$ref": "#/definitions/engineFilterBetween" + }, + "skip_parent": { + "type": "boolean", + "format": "boolean" + }, + "parent_id": { + "type": "string" + }, + "cause": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineRoutingOutboundCallCompact" + "type": "string" } - } - } - }, - "engineListRoutingSchema": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "has_file": { + "type": "boolean", + "format": "boolean" + }, + "domain_id": { + "type": "string", + "format": "int64" + }, + "number": { + "type": "string" + }, + "direction": { + "type": "string" + }, + "answered_at": { + "$ref": "#/definitions/engineFilterBetween" + }, + "missed": { + "type": "boolean", + "format": "boolean" + }, + "stored_at": { + "$ref": "#/definitions/engineFilterBetween" + }, + "id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineRoutingSchema" + "type": "string" } - } - } - }, - "engineListRoutingSchemaTags": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "transfer_from": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineRoutingSchemaTag" + "type": "string" } - } - } - }, - "engineListRoutingVariable": { - "type": "object", - "properties": { - "items": { + }, + "transfer_to": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineRoutingVariable" + "type": "string" } - } - } - }, - "engineListSchemaVariable": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "dependency_id": { + "type": "string" + }, + "tags": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineSchemaVariable" + "type": "string" } - } - } - }, - "engineListSkill": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "amd_result": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineSkill" + "type": "string" } - } - } - }, - "engineListSkillAgent": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "fts": { + "type": "string" + }, + "directions": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineSkillAgentItem" + "type": "string" } }, - "aggs": { - "$ref": "#/definitions/ListSkillAgentListSkillAgg" - } - } - }, - "engineListSystemSetting": { - "type": "object", - "properties": { - "next": { - "type": "boolean" + "has_transcript": { + "type": "boolean", + "format": "boolean" }, - "items": { + "agent_description": { + "type": "string" + }, + "owner_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineSystemSetting" + "type": "string", + "format": "int64" } - } - } - }, - "engineListTags": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "grantee_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineTag" + "type": "string", + "format": "int64" } - } - } - }, - "engineListTeamHook": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "amd_ai_result": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineTeamHook" + "type": "string" } - } - } - }, - "engineListTeamTrigger": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "talk": { + "$ref": "#/definitions/engineFilterBetween" + }, + "rated": { + "type": "boolean", + "format": "boolean" + }, + "rated_by": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineTeamTrigger" + "type": "string", + "format": "int64" } - } - } - }, - "engineListTimezoneResponse": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "score_required": { + "$ref": "#/definitions/engineFilterBetween" + }, + "score_optional": { + "$ref": "#/definitions/engineFilterBetween" + }, + "rated_user": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineTimezone" + "type": "string", + "format": "int64" } - } - } - }, - "engineListTrigger": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "contact_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineTrigger" + "type": "string", + "format": "int64" } - } - } - }, - "engineListTriggerJob": { - "type": "object", - "properties": { - "next": { - "type": "boolean" }, - "items": { + "schema_id": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineTriggerJob" + "type": "integer", + "format": "int32" } + }, + "has_transfer": { + "type": "boolean", + "format": "boolean" + }, + "timeline": { + "type": "boolean", + "format": "boolean" } } }, - "engineListUserStatus": { + "engineSearchSchemaVersionResponse": { "type": "object", "properties": { + "next": { + "type": "boolean", + "format": "boolean" + }, "items": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineUserStatus" + "$ref": "#/definitions/engineSchemaVersion" } - }, - "next": { - "type": "boolean" } } }, - "engineListWebHook": { + "engineSendPushResponse": { "type": "object", "properties": { - "next": { - "type": "boolean" - }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineWebHook" - } + "send": { + "type": "integer", + "format": "int32" } } }, - "engineLoginEmailProfileResponse": { + "engineSetVariablesCallRequest": { "type": "object", "properties": { - "auth_type": { - "$ref": "#/definitions/engineEmailAuthType" - }, - "redirect_url": { + "id": { "type": "string" }, - "cookie": { + "variables": { "type": "object", "additionalProperties": { "type": "string" @@ -21198,299 +22066,254 @@ } } }, - "engineLogoutEmailProfileResponse": { + "engineSetVariablesCallResponse": { "type": "object" }, - "engineLookup": { + "engineSkill": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "name": { - "type": "string" - } - } - }, - "engineMemberAttempt": { - "type": "object", - "properties": { - "id": { + "domain_id": { "type": "string", "format": "int64" }, - "member": { - "$ref": "#/definitions/engineLookup" - }, - "created_at": { - "type": "string", - "format": "int64" + "name": { + "type": "string" }, - "destination": { + "description": { "type": "string" }, - "weight": { + "active_agents": { "type": "integer", "format": "int32" }, - "originate_at": { - "type": "string", - "format": "int64" + "total_agents": { + "type": "integer", + "format": "int32" }, - "answered_at": { + "created_at": { "type": "string", "format": "int64" }, - "bridged_at": { - "type": "string", - "format": "int64" + "created_by": { + "$ref": "#/definitions/engineLookup" }, - "hangup_at": { + "updated_at": { "type": "string", "format": "int64" }, - "resource": { - "$ref": "#/definitions/engineLookup" - }, - "leg_a_id": { - "type": "string" - }, - "leg_b_id": { - "type": "string" - }, - "node": { - "type": "string" - }, - "result": { - "type": "string" - }, - "agent": { - "$ref": "#/definitions/engineLookup" - }, - "bucket": { + "updated_by": { "$ref": "#/definitions/engineLookup" - }, - "logs": {}, - "active": { - "type": "boolean" - }, - "attempts": { - "type": "integer", - "format": "int32" - } - } - }, - "engineMemberBulkResponse": { - "type": "object", - "properties": { - "ids": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } } } }, - "engineMemberCommunication": { + "engineSkillAgentItem": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "destination": { - "type": "string" - }, - "type": { + "skill": { "$ref": "#/definitions/engineLookup" }, - "priority": { + "capacity": { "type": "integer", "format": "int32" }, - "description": { - "type": "string" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "resource": { + "agent": { "$ref": "#/definitions/engineLookup" }, - "display": { - "type": "string" - }, - "state": { - "type": "integer", - "format": "int32" - }, - "last_activity_at": { - "type": "string", - "format": "int64" - }, - "attempts": { + "team": { + "$ref": "#/definitions/engineLookup" + } + } + }, + "engineSystemSetting": { + "type": "object", + "properties": { + "id": { "type": "integer", "format": "int32" }, - "last_cause": { - "type": "string" - }, - "stop_at": { - "type": "string", - "format": "int64" + "name": { + "$ref": "#/definitions/engineSystemSettingName" }, - "dtmf": { - "type": "string" + "value": { + "type": "object" } } }, - "engineMemberCommunicationCreateRequest": { + "engineSystemSettingName": { + "type": "string", + "enum": [ + "empty_system_settings_name", + "enable_omnichannel", + "member_chunk_size", + "amd_cancel_not_human", + "scheme_version_limit", + "enable_2fa", + "export_settings", + "search_number_length", + "chat_ai_connection", + "password_reg_exp", + "password_validation_text", + "autolink_call_to_contact", + "period_to_playback_records" + ], + "default": "empty_system_settings_name" + }, + "engineTag": { "type": "object", "properties": { - "destination": { + "name": { "type": "string" + } + } + }, + "engineTaskProcessing": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "format": "boolean" }, - "type": { + "form_schema": { "$ref": "#/definitions/engineLookup" }, - "priority": { + "sec": { "type": "integer", - "format": "int32" - }, - "description": { - "type": "string" - }, - "resource": { - "$ref": "#/definitions/engineLookup" - }, - "display": { - "type": "string" - }, - "stop_at": { - "type": "string", "format": "int64" }, - "dtmf": { - "type": "string" + "renewal_sec": { + "type": "integer", + "format": "int64" } } }, - "engineMemberInQueue": { + "engineTeamHook": { "type": "object", "properties": { "id": { - "type": "string", - "format": "int64" - }, - "queue": { - "$ref": "#/definitions/engineLookup" - }, - "priority": { "type": "integer", - "format": "int32" - }, - "expire_at": { - "type": "string", - "format": "int64" - }, - "created_at": { - "type": "string", "format": "int64" }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "schema": { + "$ref": "#/definitions/engineLookup" }, - "name": { - "type": "string" + "event": { + "$ref": "#/definitions/engineTeamHookEvent" }, - "timezone": { - "$ref": "#/definitions/engineLookup" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "communications": { + "properties": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineMemberCommunication" + "type": "string" } + } + } + }, + "engineTeamHookEvent": { + "type": "string", + "enum": [ + "teamHookEventUndefined", + "agent_status" + ], + "default": "teamHookEventUndefined" + }, + "engineTeamTrigger": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" }, - "bucket": { + "schema": { "$ref": "#/definitions/engineLookup" }, - "min_offering_at": { - "type": "string", - "format": "int64", - "title": "deprecated" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "stop_cause": { + "name": { "type": "string" }, - "last_activity_at": { - "type": "string", - "format": "int64" - }, - "attempts": { - "type": "integer", - "format": "int32" - }, - "reserved": { - "type": "boolean" - }, - "agent": { - "$ref": "#/definitions/engineLookup" - }, - "skill": { - "$ref": "#/definitions/engineLookup" + "description": { + "type": "string" } } }, - "engineMovePositionRoutingOutboundCallResponse": { + "engineTestEmailProfileResponse": { "type": "object", "properties": { - "success": { - "type": "boolean" + "error": { + "type": "string" } } }, - "engineOutboundResource": { + "engineTimezone": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "domain_id": { - "type": "string", - "format": "int64" + "name": { + "type": "string" }, - "created_at": { + "offset": { + "type": "string" + } + } + }, + "engineTranscriptLookup": { + "type": "object", + "properties": { + "id": { "type": "string", "format": "int64" }, - "created_by": { - "$ref": "#/definitions/engineLookup" + "locale": { + "type": "string" }, - "updated_at": { + "file_id": { "type": "string", "format": "int64" }, - "updated_by": { + "file": { "$ref": "#/definitions/engineLookup" - }, - "limit": { + } + } + }, + "engineTrigger": { + "type": "object", + "properties": { + "id": { "type": "integer", "format": "int32" }, + "name": { + "type": "string" + }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, - "rps": { - "type": "integer", - "format": "int32" + "type": { + "$ref": "#/definitions/engineTriggerType" }, - "reserve": { - "type": "boolean" + "schema": { + "$ref": "#/definitions/engineLookup" }, "variables": { "type": "object", @@ -21498,667 +22321,600 @@ "type": "string" } }, - "number": { - "type": "string" - }, - "max_successively_errors": { - "type": "integer", - "format": "int32" - }, - "name": { + "description": { "type": "string" }, - "error_ids": { - "type": "array", - "items": { - "type": "string" - } - }, - "last_error_id": { + "expression": { "type": "string" }, - "successively_errors": { - "type": "integer", - "format": "int32" - }, - "last_error_at": { - "type": "string", - "format": "int64" - }, - "gateway": { + "timezone": { "$ref": "#/definitions/engineLookup" }, - "description": { - "type": "string" - }, - "patterns": { - "type": "array", - "items": { - "type": "string" - } - }, - "failure_dial_delay": { + "timeout": { "type": "integer", - "format": "int64" - }, - "parameters": { - "$ref": "#/definitions/engineOutboundResourceParameters" + "format": "int32" } } }, - "engineOutboundResourceGroup": { + "engineTriggerJob": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "domain_id": { - "type": "string", - "format": "int64" + "trigger": { + "$ref": "#/definitions/engineLookup" + }, + "state": { + "$ref": "#/definitions/engineTriggerJobState" }, "created_at": { "type": "string", "format": "int64" }, - "created_by": { - "$ref": "#/definitions/engineLookup" - }, - "updated_at": { + "started_at": { "type": "string", "format": "int64" }, - "updated_by": { - "$ref": "#/definitions/engineLookup" - }, - "name": { - "type": "string" + "stopped_at": { + "type": "string", + "format": "int64" }, - "strategy": { - "type": "string" + "parameters": { + "type": "object" }, - "description": { + "error": { "type": "string" }, - "communication": { - "$ref": "#/definitions/engineLookup" - }, - "time": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineOutboundResourceTimeRange" - } + "result": { + "type": "object" } } }, - "engineOutboundResourceInGroup": { + "engineTriggerJobState": { + "type": "string", + "enum": [ + "idle", + "active", + "done", + "error" + ], + "default": "idle" + }, + "engineTriggerType": { + "type": "string", + "enum": [ + "default_trigger_type", + "cron" + ], + "default": "default_trigger_type" + }, + "engineUpdateAgentPauseCauseRequest": { "type": "object", "properties": { "id": { - "type": "string", - "format": "int64" - }, - "group_id": { - "type": "string", - "format": "int64" - }, - "resource": { - "$ref": "#/definitions/engineLookup" - }, - "reserve_resource": { - "$ref": "#/definitions/engineLookup" - }, - "priority": { "type": "integer", "format": "int64" - } - } - }, - "engineOutboundResourceParameters": { - "type": "object", - "properties": { - "cid_type": { - "type": "string" }, - "ignore_early_media": { + "name": { "type": "string" - } - } - }, - "engineOutboundResourceTimeRange": { - "type": "object", - "properties": { - "start_time_of_day": { - "type": "integer", - "format": "int32" }, - "end_time_of_day": { + "limit_min": { "type": "integer", - "format": "int32" - } - } - }, - "engineOutboundResourceViewGroup": { - "type": "object", - "properties": { - "id": { - "type": "string", "format": "int64" }, - "name": { - "type": "string" + "allow_supervisor": { + "type": "boolean", + "format": "boolean" }, - "strategy": { - "type": "string" + "allow_agent": { + "type": "boolean", + "format": "boolean" }, - "description": { - "type": "string" + "allow_admin": { + "type": "boolean", + "format": "boolean" }, - "communication": { - "$ref": "#/definitions/engineLookup" - } - } - }, - "enginePatchSkillAgentResponse": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineSkillAgentItem" - } + "description": { + "type": "string" } } }, - "enginePresetQuery": { + "engineUpdateAgentRequest": { "type": "object", "properties": { "id": { - "type": "integer", - "format": "int32" + "type": "string", + "format": "int64" }, - "name": { - "type": "string" + "user": { + "$ref": "#/definitions/engineLookup" }, "description": { "type": "string" }, - "preset": {}, - "created_at": { - "type": "string", - "format": "int64" + "progressive_count": { + "type": "integer", + "format": "int32" }, - "updated_at": { + "greeting_media": { + "$ref": "#/definitions/engineLookup" + }, + "domain_id": { "type": "string", "format": "int64" }, - "section": { - "$ref": "#/definitions/enginePresetQuerySection" - } - } - }, - "enginePresetQuerySection": { - "type": "string", - "enum": [ - "section_default", - "section_calls" - ], - "default": "section_default" - }, - "engineQuestion": { - "type": "object", - "properties": { - "type": { - "$ref": "#/definitions/engineAuditQuestionType" + "allow_channels": { + "type": "array", + "items": { + "type": "string" + } }, - "required": { - "type": "boolean" + "chat_count": { + "type": "integer", + "format": "int64" }, - "question": { - "type": "string" + "supervisor": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } }, - "min": { - "type": "integer", - "format": "int32" + "team": { + "$ref": "#/definitions/engineLookup" }, - "max": { - "type": "integer", - "format": "int32" + "region": { + "$ref": "#/definitions/engineLookup" }, - "options": { + "auditor": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/QuestionOption" + "$ref": "#/definitions/engineLookup" } + }, + "is_supervisor": { + "type": "boolean", + "format": "boolean" + }, + "task_count": { + "type": "integer", + "format": "int64" } } }, - "engineQuestionAnswer": { - "type": "object", - "properties": { - "score": { - "type": "number", - "format": "float" - } - } - }, - "engineQueue": { + "engineUpdateAgentSkillRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "domain_id": { - "type": "string", - "format": "int64" - }, - "created_at": { + "agent_id": { "type": "string", "format": "int64" }, - "created_by": { + "skill": { "$ref": "#/definitions/engineLookup" }, - "updated_at": { + "capacity": { + "type": "integer", + "format": "int32" + }, + "domain_id": { "type": "string", "format": "int64" }, - "updated_by": { - "$ref": "#/definitions/engineLookup" + "enabled": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineUpdateAgentTeamRequest": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "int64" }, - "strategy": { + "name": { "type": "string" }, - "enabled": { - "type": "boolean" + "description": { + "type": "string" }, - "payload": {}, - "calendar": { - "$ref": "#/definitions/engineLookup" + "strategy": { + "type": "string" }, - "priority": { + "max_no_answer": { "type": "integer", "format": "int32" }, - "name": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "timeout": { + "no_answer_delay_time": { "type": "integer", "format": "int32" }, - "dnc_list": { - "$ref": "#/definitions/engineLookup" - }, - "sec_locate_agent": { + "wrap_up_time": { "type": "integer", "format": "int32" }, - "type": { + "call_timeout": { "type": "integer", "format": "int32" }, - "description": { - "type": "string" - }, - "team": { - "$ref": "#/definitions/engineLookup" + "admin": { + "type": "array", + "items": { + "$ref": "#/definitions/engineLookup" + } }, - "schema": { - "$ref": "#/definitions/engineLookup" + "domain_id": { + "type": "string", + "format": "int64" }, - "count": { + "invite_chat_timeout": { "type": "integer", "format": "int32" }, - "waiting": { + "task_accept_timeout": { "type": "integer", "format": "int32" }, - "active": { + "forecast_calculation": { + "$ref": "#/definitions/engineLookup" + } + } + }, + "engineUpdateAuditFormRequest": { + "type": "object", + "properties": { + "id": { "type": "integer", "format": "int32" }, - "ringtone": { - "$ref": "#/definitions/engineLookup" - }, - "do_schema": { - "$ref": "#/definitions/engineLookup" - }, - "after_schema": { - "$ref": "#/definitions/engineLookup" + "name": { + "type": "string" }, - "sticky_agent": { - "type": "boolean" + "description": { + "type": "string" }, - "processing": { + "enabled": { "type": "boolean", - "title": "deprecated" - }, - "processing_sec": { - "type": "integer", - "format": "int64", - "title": "deprecated" - }, - "processing_renewal_sec": { - "type": "integer", - "format": "int64", - "title": "deprecated" - }, - "form_schema": { - "$ref": "#/definitions/engineLookup", - "title": "deprecated" - }, - "task_processing": { - "$ref": "#/definitions/engineTaskProcessing" + "format": "boolean" }, - "grantee": { - "$ref": "#/definitions/engineLookup" + "questions": { + "type": "array", + "items": { + "$ref": "#/definitions/engineQuestion" + } }, - "tags": { + "teams": { "type": "array", "items": { - "type": "object", - "$ref": "#/definitions/engineTag" + "$ref": "#/definitions/engineLookup" } } } }, - "engineQueueBucket": { + "engineUpdateBucketRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "ratio": { - "type": "integer", - "format": "int32" - }, - "bucket": { - "$ref": "#/definitions/engineLookup" + "name": { + "type": "string" }, - "disabled": { - "type": "boolean" + "description": { + "type": "string" }, - "priority": { - "type": "integer", - "format": "int32" + "domain_id": { + "type": "string", + "format": "int64" } } }, - "engineQueueHook": { + "engineUpdateCalendarRequest": { "type": "object", "properties": { "id": { - "type": "integer", + "type": "string", "format": "int64" }, - "schema": { + "name": { + "type": "string" + }, + "start_at": { + "type": "string", + "format": "int64" + }, + "end_at": { + "type": "string", + "format": "int64" + }, + "timezone": { "$ref": "#/definitions/engineLookup" }, - "event": { + "description": { "type": "string" }, - "enabled": { - "type": "boolean" + "accepts": { + "type": "array", + "items": { + "$ref": "#/definitions/engineAcceptOfDay" + } + }, + "excepts": { + "type": "array", + "items": { + "$ref": "#/definitions/engineExceptDate" + } + }, + "domain_id": { + "type": "string", + "format": "int64" }, - "properties": { + "specials": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineAcceptOfDay" } } } }, - "engineQueueReportGeneral": { + "engineUpdateCallAnnotationRequest": { "type": "object", "properties": { - "queue": { - "$ref": "#/definitions/engineLookup" - }, - "agent_status": { - "$ref": "#/definitions/engineQueueReportGeneralAgentStatus" - }, - "team": { - "$ref": "#/definitions/engineLookup" - }, - "missed": { - "type": "integer", - "format": "int64" - }, - "processed": { - "type": "integer", - "format": "int64" - }, - "waiting": { - "type": "integer", + "id": { + "type": "string", "format": "int64" }, - "count": { - "type": "string", - "format": "uint64" + "call_id": { + "type": "string" }, - "transferred": { - "type": "integer", - "format": "int64" + "note": { + "type": "string" }, - "abandoned": { + "start_sec": { "type": "integer", - "format": "int64" + "format": "int32" }, - "attempts": { + "end_sec": { "type": "integer", - "format": "int64" - }, - "sum_bill_sec": { - "type": "number", - "format": "float" - }, - "avg_wrap_sec": { - "type": "number", - "format": "float" - }, - "avg_awt_sec": { - "type": "number", - "format": "float" - }, - "avg_asa_sec": { - "type": "number", - "format": "float" - }, - "avg_aht_sec": { - "type": "number", - "format": "float" - }, - "bridged": { - "type": "number", - "format": "float" - }, - "sl20": { - "type": "number", - "format": "float" - }, - "sl30": { - "type": "number", - "format": "float" + "format": "int32" } } }, - "engineQueueReportGeneralAgentStatus": { + "engineUpdateChatPlanRequest": { "type": "object", "properties": { - "online": { + "id": { "type": "integer", - "format": "int64" + "format": "int32" }, - "pause": { - "type": "integer", - "format": "int64" + "name": { + "type": "string" }, - "offline": { - "type": "integer", - "format": "int64" + "description": { + "type": "string" }, - "free": { - "type": "integer", - "format": "int64" + "schema": { + "$ref": "#/definitions/engineLookup" }, - "total": { - "type": "integer", - "format": "int64" + "enabled": { + "type": "boolean", + "format": "boolean" } } }, - "engineQueueResourceGroup": { + "engineUpdateCommunicationTypeRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "resource_group": { - "$ref": "#/definitions/engineLookup" + "name": { + "type": "string" }, - "communication": { - "$ref": "#/definitions/engineLookup" + "code": { + "type": "string" + }, + "channel": { + "$ref": "#/definitions/engineCommunicationChannels" + }, + "description": { + "type": "string" + }, + "default": { + "type": "boolean", + "format": "boolean" } } }, - "engineQueueSkill": { + "engineUpdateEmailProfileRequest": { "type": "object", "properties": { "id": { - "type": "integer", + "type": "string", "format": "int64" }, - "skill": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "schema": { "$ref": "#/definitions/engineLookup" }, - "buckets": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineLookup" - } + "enabled": { + "type": "boolean", + "format": "boolean" }, - "lvl": { + "imap_host": { + "type": "string" + }, + "login": { + "type": "string" + }, + "mailbox": { + "type": "string" + }, + "smtp_port": { "type": "integer", "format": "int32" }, - "min_capacity": { + "imap_port": { "type": "integer", "format": "int32" }, - "max_capacity": { + "password": { + "type": "string" + }, + "smtp_host": { + "type": "string" + }, + "fetch_interval": { "type": "integer", "format": "int32" }, - "enabled": { - "type": "boolean" + "auth_type": { + "$ref": "#/definitions/engineEmailAuthType" + }, + "listen": { + "type": "boolean", + "format": "boolean" + }, + "params": { + "$ref": "#/definitions/engineEmailProfileParams" } } }, - "engineRegion": { + "engineUpdateListCommunicationRequest": { "type": "object", "properties": { + "list_id": { + "type": "string", + "format": "int64" + }, "id": { "type": "string", "format": "int64" }, - "name": { + "number": { "type": "string" }, "description": { "type": "string" }, - "timezone": { - "$ref": "#/definitions/engineLookup" - } - } - }, - "engineResetMembersResponse": { - "type": "object", - "properties": { - "count": { + "expire_at": { "type": "string", "format": "int64" } } }, - "engineResourceDisplay": { + "engineUpdateListRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "display": { + "name": { "type": "string" - } - } - }, - "engineResponse": { - "type": "object", - "properties": { - "status": { + }, + "description": { "type": "string" + }, + "domain_id": { + "type": "string", + "format": "int64" } } }, - "engineRoutingOutboundCall": { + "engineUpdateMemberRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "created_at": { + "queue_id": { "type": "string", "format": "int64" }, - "created_by": { - "$ref": "#/definitions/engineLookup" + "priority": { + "type": "integer", + "format": "int32" }, - "updated_at": { + "expire_at": { "type": "string", "format": "int64" }, - "updated_by": { - "$ref": "#/definitions/engineLookup" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } }, "name": { "type": "string" }, - "description": { + "timezone": { + "$ref": "#/definitions/engineLookup" + }, + "communications": { + "type": "array", + "items": { + "$ref": "#/definitions/engineMemberCommunicationCreateRequest" + } + }, + "bucket": { + "$ref": "#/definitions/engineLookup" + }, + "min_offering_at": { + "type": "string", + "format": "int64" + }, + "stop_cause": { "type": "string" }, - "schema": { + "domain_id": { + "type": "string", + "format": "int64" + }, + "agent": { "$ref": "#/definitions/engineLookup" }, - "pattern": { + "skill": { + "$ref": "#/definitions/engineLookup" + } + } + }, + "engineUpdateOutboundResourceDisplayRequest": { + "type": "object", + "properties": { + "resource_id": { + "type": "string", + "format": "int64" + }, + "id": { + "type": "string", + "format": "int64" + }, + "display": { "type": "string" }, - "disabled": { - "type": "boolean" - }, "domain_id": { "type": "string", "format": "int64" } } }, - "engineRoutingOutboundCallCompact": { + "engineUpdateOutboundResourceGroupRequest": { "type": "object", "properties": { "id": { @@ -22168,21 +22924,20 @@ "name": { "type": "string" }, - "description": { + "strategy": { "type": "string" }, - "schema": { - "$ref": "#/definitions/engineLookup" - }, - "pattern": { + "description": { "type": "string" }, - "disabled": { - "type": "boolean" + "communication": { + "$ref": "#/definitions/engineLookup" }, - "position": { - "type": "integer", - "format": "int32" + "time": { + "type": "array", + "items": { + "$ref": "#/definitions/engineOutboundResourceTimeRange" + } }, "domain_id": { "type": "string", @@ -22190,112 +22945,96 @@ } } }, - "engineRoutingSchema": { + "engineUpdateOutboundResourceInGroupRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "created_at": { + "group_id": { "type": "string", "format": "int64" }, - "created_by": { + "resource": { "$ref": "#/definitions/engineLookup" }, - "updated_at": { - "type": "string", - "format": "int64" - }, - "updated_by": { + "reserve_resource": { "$ref": "#/definitions/engineLookup" }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "type": { - "$ref": "#/definitions/engineRoutingSchemaType" - }, - "schema": {}, - "payload": {}, - "debug": { - "type": "boolean" - }, - "editor": { - "type": "boolean" - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineSchemaTag" - } - } - } - }, - "engineRoutingSchemaTag": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "count": { + "priority": { "type": "integer", "format": "int64" } } }, - "engineRoutingSchemaType": { - "type": "string", - "enum": [ - "default", - "voice", - "chat", - "processing", - "service" - ], - "default": "default" - }, - "engineRoutingVariable": { + "engineUpdateOutboundResourceRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "domain_id": { - "type": "string", - "format": "int64" + "limit": { + "type": "integer", + "format": "int32" }, - "key": { - "type": "string" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "value": { - "type": "string" - } - } - }, - "engineRunTeamTriggerResponse": { - "type": "object", - "properties": { - "job_id": { + "rps": { + "type": "integer", + "format": "int32" + }, + "reserve": { + "type": "boolean", + "format": "boolean" + }, + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "number": { "type": "string" - } - } - }, - "engineSchemaTag": { - "type": "object", - "properties": { + }, + "max_successively_errors": { + "type": "integer", + "format": "int32" + }, "name": { "type": "string" + }, + "error_ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "gateway": { + "$ref": "#/definitions/engineLookup" + }, + "description": { + "type": "string" + }, + "patterns": { + "type": "array", + "items": { + "type": "string" + } + }, + "failure_dial_delay": { + "type": "integer", + "format": "int64" + }, + "parameters": { + "$ref": "#/definitions/engineOutboundResourceParameters" } } }, - "engineSchemaVariable": { + "engineUpdatePresetQueryRequest": { "type": "object", "properties": { "id": { @@ -22305,362 +23044,367 @@ "name": { "type": "string" }, - "encrypt": { - "type": "boolean" + "description": { + "type": "string" + }, + "preset": { + "type": "object" }, - "value": {} + "section": { + "$ref": "#/definitions/enginePresetQuerySection" + } } }, - "engineSchemaVersion": { + "engineUpdateQueueBucketRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "schema_id": { + "queue_id": { "type": "string", "format": "int64" }, - "created_at": { - "type": "string", - "format": "int64" + "ratio": { + "type": "integer", + "format": "int32" }, - "created_by": { + "bucket": { "$ref": "#/definitions/engineLookup" }, - "schema": {}, - "payload": {}, - "version": { - "type": "string", - "format": "uint64" + "disabled": { + "type": "boolean", + "format": "boolean" }, - "note": { - "type": "string" + "priority": { + "type": "integer", + "format": "int32" } } }, - "engineSearchHistoryCallRequest": { + "engineUpdateQueueHookRequest": { "type": "object", "properties": { - "page": { + "queue_id": { "type": "integer", - "format": "int32" + "format": "int64" }, - "size": { + "id": { "type": "integer", - "format": "int32" + "format": "int64" }, - "q": { - "type": "string" + "schema": { + "$ref": "#/definitions/engineLookup" }, - "sort": { + "event": { "type": "string" }, - "fields": { + "enabled": { + "type": "boolean", + "format": "boolean" + }, + "properties": { "type": "array", "items": { "type": "string" } + } + } + }, + "engineUpdateQueueRequest": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "int64" }, - "created_at": { - "$ref": "#/definitions/engineFilterBetween" + "strategy": { + "type": "string" }, - "user_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "enabled": { + "type": "boolean", + "format": "boolean" }, - "agent_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "payload": { + "type": "object" }, - "queue_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "calendar": { + "$ref": "#/definitions/engineLookup" }, - "team_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "priority": { + "type": "integer", + "format": "int32" }, - "member_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "name": { + "type": "string" }, - "gateway_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" + "variables": { + "type": "object", + "additionalProperties": { + "type": "string" } }, - "duration": { - "$ref": "#/definitions/engineFilterBetween" + "timeout": { + "type": "integer", + "format": "int32" }, - "skip_parent": { - "type": "boolean" + "dnc_list": { + "$ref": "#/definitions/engineLookup" }, - "parent_id": { + "sec_locate_agent": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "integer", + "format": "int32" + }, + "team": { + "$ref": "#/definitions/engineLookup" + }, + "description": { "type": "string" }, - "cause": { - "type": "array", - "items": { - "type": "string" - } + "schema": { + "$ref": "#/definitions/engineLookup" }, - "has_file": { - "type": "boolean" + "ringtone": { + "$ref": "#/definitions/engineLookup" }, "domain_id": { "type": "string", "format": "int64" }, - "number": { - "type": "string" + "do_schema": { + "$ref": "#/definitions/engineLookup" }, - "direction": { - "type": "string" + "after_schema": { + "$ref": "#/definitions/engineLookup" }, - "answered_at": { - "$ref": "#/definitions/engineFilterBetween" + "sticky_agent": { + "type": "boolean", + "format": "boolean" }, - "missed": { - "type": "boolean" + "processing": { + "type": "boolean", + "format": "boolean" }, - "stored_at": { - "$ref": "#/definitions/engineFilterBetween" + "processing_sec": { + "type": "integer", + "format": "int64" }, - "id": { - "type": "array", - "items": { - "type": "string" - } + "processing_renewal_sec": { + "type": "integer", + "format": "int64" }, - "transfer_from": { - "type": "array", - "items": { - "type": "string" - } + "form_schema": { + "$ref": "#/definitions/engineLookup" }, - "transfer_to": { - "type": "array", - "items": { - "type": "string" - } + "task_processing": { + "$ref": "#/definitions/engineTaskProcessing" }, - "dependency_id": { - "type": "string" + "grantee": { + "$ref": "#/definitions/engineLookup" }, "tags": { "type": "array", "items": { - "type": "string" - } - }, - "variables[string]": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "amd_result": { - "type": "array", - "items": { - "type": "string" + "$ref": "#/definitions/engineTag" } + } + } + }, + "engineUpdateQueueResourceGroupRequest": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "int64" }, - "fts": { - "type": "string" - }, - "directions": { - "type": "array", - "items": { - "type": "string" - } + "queue_id": { + "type": "string", + "format": "int64" }, - "has_transcript": { - "type": "boolean" + "resource_group": { + "$ref": "#/definitions/engineLookup" }, - "agent_description": { - "type": "string" + "domain_id": { + "type": "string", + "format": "int64" + } + } + }, + "engineUpdateQueueSkillRequest": { + "type": "object", + "properties": { + "queue_id": { + "type": "integer", + "format": "int64" }, - "owner_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "id": { + "type": "integer", + "format": "int64" }, - "grantee_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "skill": { + "$ref": "#/definitions/engineLookup" }, - "amd_ai_result": { + "buckets": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/engineLookup" } }, - "talk": { - "$ref": "#/definitions/engineFilterBetween" - }, - "rated": { - "type": "boolean" + "lvl": { + "type": "integer", + "format": "int32" }, - "rated_by": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "min_capacity": { + "type": "integer", + "format": "int32" }, - "score_required": { - "$ref": "#/definitions/engineFilterBetween" + "max_capacity": { + "type": "integer", + "format": "int32" }, - "score_optional": { - "$ref": "#/definitions/engineFilterBetween" + "enabled": { + "type": "boolean", + "format": "boolean" + } + } + }, + "engineUpdateQuickReplyRequest": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" }, - "rated_user": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "name": { + "type": "string" }, - "contact_id": { - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "text": { + "type": "string" }, - "schema_id": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } + "team": { + "$ref": "#/definitions/engineLookup" }, - "has_transfer": { - "type": "boolean" + "article": { + "$ref": "#/definitions/engineLookup" }, - "timeline": { - "type": "boolean" + "queue": { + "$ref": "#/definitions/engineLookup" } } }, - "engineSearchSchemaVersionResponse": { + "engineUpdateRegionRequest": { "type": "object", "properties": { - "next": { - "type": "boolean" + "id": { + "type": "string", + "format": "int64" }, - "items": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/engineSchemaVersion" - } + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "timezone": { + "$ref": "#/definitions/engineLookup" } } }, - "engineSendPushResponse": { + "engineUpdateRoutingOutboundCallRequest": { "type": "object", "properties": { - "send": { - "type": "integer", - "format": "int32" + "id": { + "type": "string", + "format": "int64" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "schema": { + "$ref": "#/definitions/engineLookup" + }, + "pattern": { + "type": "string" + }, + "disabled": { + "type": "boolean", + "format": "boolean" + }, + "domain_id": { + "type": "string", + "format": "int64" } } }, - "engineSetVariablesCallResponse": { - "type": "object" - }, - "engineSkill": { + "engineUpdateRoutingSchemaRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "domain_id": { - "type": "string", - "format": "int64" - }, "name": { "type": "string" }, "description": { "type": "string" }, - "active_agents": { - "type": "integer", - "format": "int32" + "type": { + "$ref": "#/definitions/engineRoutingSchemaType" }, - "total_agents": { - "type": "integer", - "format": "int32" + "schema": { + "type": "object" }, - "created_at": { - "type": "string", - "format": "int64" + "payload": { + "type": "object" }, - "created_by": { - "$ref": "#/definitions/engineLookup" + "debug": { + "type": "boolean", + "format": "boolean" }, - "updated_at": { - "type": "string", - "format": "int64" + "editor": { + "type": "boolean", + "format": "boolean" }, - "updated_by": { - "$ref": "#/definitions/engineLookup" + "tags": { + "type": "array", + "items": { + "$ref": "#/definitions/engineSchemaTag" + } + }, + "note": { + "type": "string" } } }, - "engineSkillAgentItem": { + "engineUpdateRoutingVariableRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, - "skill": { - "$ref": "#/definitions/engineLookup" - }, - "capacity": { - "type": "integer", - "format": "int32" - }, - "enabled": { - "type": "boolean" + "key": { + "type": "string" }, - "agent": { - "$ref": "#/definitions/engineLookup" + "value": { + "type": "string" }, - "team": { - "$ref": "#/definitions/engineLookup" + "domain_id": { + "type": "string", + "format": "int64" } } }, - "engineSystemSetting": { + "engineUpdateSchemaVariableRequest": { "type": "object", "properties": { "id": { @@ -22668,59 +23412,55 @@ "format": "int32" }, "name": { - "$ref": "#/definitions/engineSystemSettingName" + "type": "string" }, - "value": {} + "value": { + "type": "object" + }, + "encrypt": { + "type": "boolean", + "format": "boolean" + } } }, - "engineSystemSettingName": { - "type": "string", - "enum": [ - "empty_system_settings_name", - "enable_omnichannel", - "member_chunk_size", - "amd_cancel_not_human", - "scheme_version_limit", - "enable_2fa", - "export_settings", - "search_number_length", - "chat_ai_connection", - "password_reg_exp", - "password_validation_text", - "autolink_call_to_contact" - ], - "default": "empty_system_settings_name" - }, - "engineTag": { + "engineUpdateSkillRequest": { "type": "object", "properties": { + "id": { + "type": "string", + "format": "int64" + }, "name": { "type": "string" + }, + "description": { + "type": "string" + }, + "domain_id": { + "type": "string", + "format": "int64" } } }, - "engineTaskProcessing": { + "engineUpdateSystemSettingRequest": { "type": "object", "properties": { - "enabled": { - "type": "boolean" - }, - "form_schema": { - "$ref": "#/definitions/engineLookup" - }, - "sec": { + "id": { "type": "integer", - "format": "int64" + "format": "int32" }, - "renewal_sec": { - "type": "integer", - "format": "int64" + "value": { + "type": "object" } } }, - "engineTeamHook": { + "engineUpdateTeamHookRequest": { "type": "object", "properties": { + "team_id": { + "type": "string", + "format": "int64" + }, "id": { "type": "integer", "format": "int64" @@ -22732,7 +23472,8 @@ "$ref": "#/definitions/engineTeamHookEvent" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "properties": { "type": "array", @@ -22742,17 +23483,13 @@ } } }, - "engineTeamHookEvent": { - "type": "string", - "enum": [ - "teamHookEventUndefined", - "agent_status" - ], - "default": "teamHookEventUndefined" - }, - "engineTeamTrigger": { + "engineUpdateTeamTriggerRequest": { "type": "object", "properties": { + "team_id": { + "type": "string", + "format": "int64" + }, "id": { "type": "integer", "format": "int64" @@ -22761,7 +23498,8 @@ "$ref": "#/definitions/engineLookup" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "name": { "type": "string" @@ -22771,50 +23509,7 @@ } } }, - "engineTestEmailProfileResponse": { - "type": "object", - "properties": { - "error": { - "type": "string" - } - } - }, - "engineTimezone": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "int64" - }, - "name": { - "type": "string" - }, - "offset": { - "type": "string" - } - } - }, - "engineTranscriptLookup": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "int64" - }, - "locale": { - "type": "string" - }, - "file_id": { - "type": "string", - "format": "int64", - "title": "deprecated" - }, - "file": { - "$ref": "#/definitions/engineLookup" - } - } - }, - "engineTrigger": { + "engineUpdateTriggerRequest": { "type": "object", "properties": { "id": { @@ -22825,7 +23520,8 @@ "type": "string" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "type": { "$ref": "#/definitions/engineTriggerType" @@ -22854,55 +23550,51 @@ } } }, - "engineTriggerJob": { + "engineUpdateWebHookRequest": { "type": "object", "properties": { "id": { - "type": "string", - "format": "int64" + "type": "integer", + "format": "int32" }, - "trigger": { - "$ref": "#/definitions/engineLookup" + "name": { + "type": "string" }, - "state": { - "$ref": "#/definitions/engineTriggerJobState" + "description": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "int64" + "origin": { + "type": "array", + "items": { + "type": "string" + } }, - "started_at": { - "type": "string", - "format": "int64" + "schema": { + "$ref": "#/definitions/engineLookup" }, - "stopped_at": { - "type": "string", - "format": "int64" + "enabled": { + "type": "boolean", + "format": "boolean" }, - "parameters": {}, - "error": { + "authorization": { "type": "string" - }, - "result": {} + } } }, - "engineTriggerJobState": { - "type": "string", - "enum": [ - "idle", - "active", - "done", - "error" - ], - "default": "idle" - }, - "engineTriggerType": { - "type": "string", - "enum": [ - "default_trigger_type", - "cron" - ], - "default": "default_trigger_type" + "engineUserCallRequest": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "app_id": { + "type": "string" + }, + "domain_id": { + "type": "string", + "format": "int64" + } + } }, "engineUserStatus": { "type": "object", @@ -22965,24 +23657,14 @@ "$ref": "#/definitions/engineLookup" }, "enabled": { - "type": "boolean" + "type": "boolean", + "format": "boolean" }, "authorization": { "type": "string" } } }, - "protobufAny": { - "type": "object", - "properties": { - "@type": { - "type": "string", - "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics." - } - }, - "additionalProperties": {}, - "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }" - }, "protobufNullValue": { "type": "string", "enum": [ @@ -22990,29 +23672,6 @@ ], "default": "NULL_VALUE", "description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\nThe JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value." - }, - "rpcStatus": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32", - "description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code]." - }, - "message": { - "type": "string", - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client." - }, - "details": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/protobufAny" - }, - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use." - } - }, - "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors)." } }, "securityDefinitions": {