diff --git a/fern/apis/api/openapi.json b/fern/apis/api/openapi.json index b462fde1..f8a6b3d8 100644 --- a/fern/apis/api/openapi.json +++ b/fern/apis/api/openapi.json @@ -15229,6 +15229,30 @@ } } }, + "KeypadInputPlan": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "This keeps track of whether the user has enabled keypad input.\nBy default, it is off.\n\n@default false" + }, + "timeoutSeconds": { + "type": "number", + "description": "This is the time in seconds to wait before processing the input.\nIf the input is not received within this time, the input will be ignored.\nIf set to \"off\", the input will be processed when the user enters a delimiter or immediately if no delimiter is used.\n\n@default 2", + "minimum": 0, + "maximum": 10 + }, + "delimiters": { + "type": "string", + "description": "This is the delimiter(s) that will be used to process the input.\nCan be '#', '*', or an empty array.", + "enum": [ + "#", + "*", + "" + ] + } + } + }, "WorkflowUserEditable": { "type": "object", "properties": { @@ -15397,6 +15421,30 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is a set of actions that will be performed on certain events.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/CallHookCallEnding", + "title": "CallHookCallEnding" + }, + { + "$ref": "#/components/schemas/CallHookAssistantSpeechInterrupted", + "title": "CallHookAssistantSpeechInterrupted" + }, + { + "$ref": "#/components/schemas/CallHookCustomerSpeechInterrupted", + "title": "CallHookCustomerSpeechInterrupted" + }, + { + "$ref": "#/components/schemas/CallHookCustomerSpeechTimeout", + "title": "CallHookCustomerSpeechTimeout" + } + ] + } + }, "credentials": { "type": "array", "description": "These are dynamic credentials that will be used for the workflow calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.", @@ -15739,6 +15787,14 @@ "items": { "type": "string" } + }, + "keypadInputPlan": { + "description": "This is the plan for keypad input handling during workflow calls.", + "allOf": [ + { + "$ref": "#/components/schemas/KeypadInputPlan" + } + ] } }, "required": [ @@ -21793,7 +21849,7 @@ "authorizationId" ] }, - "TransferAssistantHookAction": { + "TransferHookAction": { "type": "object", "properties": { "type": { @@ -21821,7 +21877,7 @@ "type" ] }, - "FunctionCallAssistantHookAction": { + "FunctionCallHookAction": { "type": "object", "properties": { "messages": { @@ -21881,7 +21937,7 @@ "type" ] }, - "SayAssistantHookAction": { + "SayHookAction": { "type": "object", "properties": { "type": { @@ -21946,7 +22002,7 @@ "type" ] }, - "AssistantHookFilter": { + "CallHookFilter": { "type": "object", "properties": { "type": { @@ -21977,7 +22033,7 @@ "oneOf" ] }, - "AssistantHookCallEnding": { + "CallHookCallEnding": { "type": "object", "properties": { "on": { @@ -21994,8 +22050,8 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/ToolCallAssistantHookAction", - "title": "ToolCallAssistantHookAction" + "$ref": "#/components/schemas/ToolCallHookAction", + "title": "ToolCallHookAction" } ] } @@ -22004,7 +22060,7 @@ "description": "This is the set of filters that must match for the hook to trigger", "type": "array", "items": { - "$ref": "#/components/schemas/AssistantHookFilter" + "$ref": "#/components/schemas/CallHookFilter" } } }, @@ -22013,7 +22069,7 @@ "do" ] }, - "AssistantHookAssistantSpeechInterrupted": { + "CallHookAssistantSpeechInterrupted": { "type": "object", "properties": { "on": { @@ -22030,12 +22086,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/SayAssistantHookAction", - "title": "SayAssistantHookAction" + "$ref": "#/components/schemas/SayHookAction", + "title": "SayHookAction" }, { - "$ref": "#/components/schemas/ToolCallAssistantHookAction", - "title": "ToolCallAssistantHookAction" + "$ref": "#/components/schemas/ToolCallHookAction", + "title": "ToolCallHookAction" } ] } @@ -22046,7 +22102,7 @@ "do" ] }, - "AssistantHookCustomerSpeechInterrupted": { + "CallHookCustomerSpeechInterrupted": { "type": "object", "properties": { "on": { @@ -22063,12 +22119,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/SayAssistantHookAction", - "title": "SayAssistantHookAction" + "$ref": "#/components/schemas/SayHookAction", + "title": "SayHookAction" }, { - "$ref": "#/components/schemas/ToolCallAssistantHookAction", - "title": "ToolCallAssistantHookAction" + "$ref": "#/components/schemas/ToolCallHookAction", + "title": "ToolCallHookAction" } ] } @@ -22079,7 +22135,7 @@ "do" ] }, - "ToolCallAssistantHookAction": { + "ToolCallHookAction": { "type": "object", "properties": { "type": { @@ -22203,7 +22259,7 @@ "timeoutSeconds" ] }, - "AssistantHookCustomerSpeechTimeout": { + "CallHookCustomerSpeechTimeout": { "type": "object", "properties": { "on": { @@ -22217,12 +22273,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/SayAssistantHookAction", - "title": "SayAssistantHookAction" + "$ref": "#/components/schemas/SayHookAction", + "title": "SayHookAction" }, { - "$ref": "#/components/schemas/ToolCallAssistantHookAction", - "title": "ToolCallAssistantHookAction" + "$ref": "#/components/schemas/ToolCallHookAction", + "title": "ToolCallHookAction" } ] } @@ -22466,30 +22522,6 @@ } } }, - "KeypadInputPlan": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "This keeps track of whether the user has enabled keypad input.\nBy default, it is off.\n\n@default false" - }, - "timeoutSeconds": { - "type": "number", - "description": "This is the time in seconds to wait before processing the input.\nIf the input is not received within this time, the input will be ignored.\nIf set to \"off\", the input will be processed when the user enters a delimiter or immediately if no delimiter is used.\n\n@default 2", - "minimum": 0, - "maximum": 10 - }, - "delimiters": { - "type": "string", - "description": "This is the delimiter(s) that will be used to process the input.\nCan be '#', '*', or an empty array.", - "enum": [ - "#", - "*", - "" - ] - } - } - }, "CreateAssistantDTO": { "type": "object", "properties": { @@ -23153,20 +23185,20 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/AssistantHookCallEnding", - "title": "AssistantHookCallEnding" + "$ref": "#/components/schemas/CallHookCallEnding", + "title": "CallHookCallEnding" }, { - "$ref": "#/components/schemas/AssistantHookAssistantSpeechInterrupted", - "title": "AssistantHookAssistantSpeechInterrupted" + "$ref": "#/components/schemas/CallHookAssistantSpeechInterrupted", + "title": "CallHookAssistantSpeechInterrupted" }, { - "$ref": "#/components/schemas/AssistantHookCustomerSpeechInterrupted", - "title": "AssistantHookCustomerSpeechInterrupted" + "$ref": "#/components/schemas/CallHookCustomerSpeechInterrupted", + "title": "CallHookCustomerSpeechInterrupted" }, { - "$ref": "#/components/schemas/AssistantHookCustomerSpeechTimeout", - "title": "AssistantHookCustomerSpeechTimeout" + "$ref": "#/components/schemas/CallHookCustomerSpeechTimeout", + "title": "CallHookCustomerSpeechTimeout" } ] } @@ -23942,20 +23974,20 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/AssistantHookCallEnding", - "title": "AssistantHookCallEnding" + "$ref": "#/components/schemas/CallHookCallEnding", + "title": "CallHookCallEnding" }, { - "$ref": "#/components/schemas/AssistantHookAssistantSpeechInterrupted", - "title": "AssistantHookAssistantSpeechInterrupted" + "$ref": "#/components/schemas/CallHookAssistantSpeechInterrupted", + "title": "CallHookAssistantSpeechInterrupted" }, { - "$ref": "#/components/schemas/AssistantHookCustomerSpeechInterrupted", - "title": "AssistantHookCustomerSpeechInterrupted" + "$ref": "#/components/schemas/CallHookCustomerSpeechInterrupted", + "title": "CallHookCustomerSpeechInterrupted" }, { - "$ref": "#/components/schemas/AssistantHookCustomerSpeechTimeout", - "title": "AssistantHookCustomerSpeechTimeout" + "$ref": "#/components/schemas/CallHookCustomerSpeechTimeout", + "title": "CallHookCustomerSpeechTimeout" } ] } @@ -24300,6 +24332,30 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is a set of actions that will be performed on certain events.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/CallHookCallEnding", + "title": "CallHookCallEnding" + }, + { + "$ref": "#/components/schemas/CallHookAssistantSpeechInterrupted", + "title": "CallHookAssistantSpeechInterrupted" + }, + { + "$ref": "#/components/schemas/CallHookCustomerSpeechInterrupted", + "title": "CallHookCustomerSpeechInterrupted" + }, + { + "$ref": "#/components/schemas/CallHookCustomerSpeechTimeout", + "title": "CallHookCustomerSpeechTimeout" + } + ] + } + }, "credentials": { "type": "array", "description": "These are dynamic credentials that will be used for the workflow calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.", @@ -24642,6 +24698,14 @@ "items": { "type": "string" } + }, + "keypadInputPlan": { + "description": "This is the plan for keypad input handling during workflow calls.", + "allOf": [ + { + "$ref": "#/components/schemas/KeypadInputPlan" + } + ] } }, "required": [ @@ -28537,20 +28601,20 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/AssistantHookCallEnding", - "title": "AssistantHookCallEnding" + "$ref": "#/components/schemas/CallHookCallEnding", + "title": "CallHookCallEnding" }, { - "$ref": "#/components/schemas/AssistantHookAssistantSpeechInterrupted", - "title": "AssistantHookAssistantSpeechInterrupted" + "$ref": "#/components/schemas/CallHookAssistantSpeechInterrupted", + "title": "CallHookAssistantSpeechInterrupted" }, { - "$ref": "#/components/schemas/AssistantHookCustomerSpeechInterrupted", - "title": "AssistantHookCustomerSpeechInterrupted" + "$ref": "#/components/schemas/CallHookCustomerSpeechInterrupted", + "title": "CallHookCustomerSpeechInterrupted" }, { - "$ref": "#/components/schemas/AssistantHookCustomerSpeechTimeout", - "title": "AssistantHookCustomerSpeechTimeout" + "$ref": "#/components/schemas/CallHookCustomerSpeechTimeout", + "title": "CallHookCustomerSpeechTimeout" } ] } @@ -29386,20 +29450,20 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/AssistantHookCallEnding", - "title": "AssistantHookCallEnding" + "$ref": "#/components/schemas/CallHookCallEnding", + "title": "CallHookCallEnding" }, { - "$ref": "#/components/schemas/AssistantHookAssistantSpeechInterrupted", - "title": "AssistantHookAssistantSpeechInterrupted" + "$ref": "#/components/schemas/CallHookAssistantSpeechInterrupted", + "title": "CallHookAssistantSpeechInterrupted" }, { - "$ref": "#/components/schemas/AssistantHookCustomerSpeechInterrupted", - "title": "AssistantHookCustomerSpeechInterrupted" + "$ref": "#/components/schemas/CallHookCustomerSpeechInterrupted", + "title": "CallHookCustomerSpeechInterrupted" }, { - "$ref": "#/components/schemas/AssistantHookCustomerSpeechTimeout", - "title": "AssistantHookCustomerSpeechTimeout" + "$ref": "#/components/schemas/CallHookCustomerSpeechTimeout", + "title": "CallHookCustomerSpeechTimeout" } ] } @@ -31049,7 +31113,7 @@ ] }, "headers": { - "description": "These are the headers to send in the request.", + "description": "These are the headers to send with the request.", "allOf": [ { "$ref": "#/components/schemas/JsonSchema" @@ -32591,7 +32655,7 @@ ] }, "headers": { - "description": "These are the headers to send in the request.", + "description": "These are the headers to send with the request.", "allOf": [ { "$ref": "#/components/schemas/JsonSchema" @@ -32970,7 +33034,7 @@ ] }, "headers": { - "description": "These are the headers to send in the request.", + "description": "These are the headers to send with the request.", "allOf": [ { "$ref": "#/components/schemas/JsonSchema" @@ -34285,6 +34349,30 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is a set of actions that will be performed on certain events.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/CallHookCallEnding", + "title": "CallHookCallEnding" + }, + { + "$ref": "#/components/schemas/CallHookAssistantSpeechInterrupted", + "title": "CallHookAssistantSpeechInterrupted" + }, + { + "$ref": "#/components/schemas/CallHookCustomerSpeechInterrupted", + "title": "CallHookCustomerSpeechInterrupted" + }, + { + "$ref": "#/components/schemas/CallHookCustomerSpeechTimeout", + "title": "CallHookCustomerSpeechTimeout" + } + ] + } + }, "credentials": { "type": "array", "description": "These are dynamic credentials that will be used for the workflow calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.", @@ -34641,6 +34729,14 @@ "items": { "type": "string" } + }, + "keypadInputPlan": { + "description": "This is the plan for keypad input handling during workflow calls.", + "allOf": [ + { + "$ref": "#/components/schemas/KeypadInputPlan" + } + ] } }, "required": [ @@ -34821,6 +34917,30 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is a set of actions that will be performed on certain events.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/CallHookCallEnding", + "title": "CallHookCallEnding" + }, + { + "$ref": "#/components/schemas/CallHookAssistantSpeechInterrupted", + "title": "CallHookAssistantSpeechInterrupted" + }, + { + "$ref": "#/components/schemas/CallHookCustomerSpeechInterrupted", + "title": "CallHookCustomerSpeechInterrupted" + }, + { + "$ref": "#/components/schemas/CallHookCustomerSpeechTimeout", + "title": "CallHookCustomerSpeechTimeout" + } + ] + } + }, "credentials": { "type": "array", "description": "These are dynamic credentials that will be used for the workflow calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.", @@ -35163,6 +35283,14 @@ "items": { "type": "string" } + }, + "keypadInputPlan": { + "description": "This is the plan for keypad input handling during workflow calls.", + "allOf": [ + { + "$ref": "#/components/schemas/KeypadInputPlan" + } + ] } } },